ns
Configuration for NetScaler resource.
Read/write properties
,,,,,pre_auth_key<String>
Shared secret that used for orchestration deployment.
is_autoscale_group<Boolean>
Does this device belong to an Autoscale Group..
license_server<String>
License Server Configured.
Minimum length = 1
Maximum length = 128
backplane<String>
Backplane Interface.
Minimum length = 1
name<String>
Name of managed device.
Minimum length = 1
Maximum length = 128
gateway_deployment<Boolean>
Is this device acting as Gateway..
bot_signature_version<String>
NetScaler Bot Default signature version.
Minimum length = 1
Maximum length = 256
http_port<Integer>
HTTP port of the container..
throughput<Double>
Assign throughput in Mbps to VM Instance.
lb_role<String>
LB role performed by the device: North-South (Ingress or server), or East-West (client).
plt_bw_config<Integer>
Platinum Bandwidth configured.
is_ha_configured<Boolean>
Is HA configured.
vcpu_config<Integer>
Number of vCPU allocated for the device.
ns_observationdomainid<String>
ns_observationdomainid.
Minimum length = 1
Maximum length = 64
maintenance_status<Boolean>
The status if the device is within the maintenance window.
iscco<Boolean>
Is CCO.
waf_signature_version<String>
NetScaler WAF Default signature version.
Minimum length = 1
Maximum length = 256
license_edition<String>
Edition of instance.
netprofile<String>
Net Profile.
burst_priority<Integer>
Burst Priority of the VM Instance between 1 and 4.
lastconfigsavetime<Double>
Last Config Save Time.
ipv6_address<String>
IPv6 Address.
max_burst_throughput<Double>
Maximum burst throughput in Mbps of VM Instance.
snmp_port<Integer>
SNMP port of the container..
ent_bw_config<Integer>
Enterprise Bandwidth configured.
license<String>
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum).
Minimum length = 1
Maximum length = 64
isolation_policy<String>
Isolation Policy of the Device.
cmd_policy<String>
true if you want to allow shell/sftp/scp access to NetScaler Instance administrator.
Minimum length = 1
Maximum length = 1024
internal_annotation<String>
Internal annotation used by NetScaler Console.Example, if a device is marked for delete.
std_bw_config<Integer>
Standard Bandwidth running.
number_of_ssl_cores_up<Integer>
Number of SSL Cores Up.
sslvpn_total<Integer>
sslvpn license.
config_type<Integer>
Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =
license_mode<String>
license mode: FOREIGN_POOL, FOREIGN_LAS, EXPRESS, POOLED, LAS, LOCAL, CICO etc..
last_nonzero_throughput_time<Double>
Last NonZero Throughput Time in seconds.
display_name<String>
Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP.
Minimum length = 1
Maximum length = 128
partition_id<String>
ID of admin partition.
num_pes<Integer>
Total number of PEs.
instance_available<Integer>
Instance license available.
partition_name<String>
NetScaler Admin Partition Name.
Maximum length = 512
mgmt_ip_address<String>
Management IP Address for this Managed Device.
Minimum length = 1
Maximum length = 64
template_interval<Integer>
Template refresh interval.
ns_ip_address<String>
NetScaler IP Address for this managed device.
Minimum length = 1
Maximum length = 128
ssh_port<Integer>
SSH port of the container..
agent_id<String>
Agent Id.
domain_name<String>
Domain name of VM Device.
Minimum length = 1
Maximum length = 128
ent_bw_available<Integer>
Enterprise Bandwidth configured.
ipv4_address<String>
IPv4 Address.
Minimum length = 1
Maximum length = 64
netmask<String>
Netmask of managed device.
Minimum length = 1
Maximum length = 64
type<String>
Type of device, (Xen | NS).
Minimum length = 1
Maximum length = 64
httpxforwardedfor<String>
HTTP x-Forwardedfor header flag..
Minimum length = 1
Maximum length = 10
last_updated_time<Double>
Last Updated Time.
metrics_collection<Boolean>
Flag to check if metrics collection is enabled or disabled..
servicepackage<String>
Service Package Name of the device.
host_ip_address<String>
Host IPAddress where VM is provisioned.
Minimum length = 1
Maximum length = 64
autoscalegroup_id<String>
Autoscalegroup ID.
lastconfigchangedtime<Double>
Last Config Changed Time.
instance_config<Integer>
Instance license running.
sslvpn_config<Integer>
sslvpn license maximum.
datacenter_id<String>
Datacenter Id is system generated key for data center.
plt_bw_available<Integer>
Platinum Bandwidth Available.
id<String>
Id is system generated key for all the managed devices.
las_cpx_bw<Integer>
lascpxbw for CPX devices requesting LAS capacity during registration.
gateway_ipv6<String>
Gateway IPv6 Address.
discovery_time<Double>
discovery time.
std_bw_total<Integer>
Standard Bandwidth.
trust_id<String>
Device ID obtained from trust service.
instance_mode<String>
Denotes state- primary,secondary,clip,clusternode.
description<String>
Description of managed device.
Minimum length = 1
Maximum length = 512
image_name<String>
Image Name, This parameter is used while provisioning VM Instance with XVA image, template_name is given priority if provided along with image_name.
Minimum length = 1
Maximum length = 128
routable<Boolean>
Whether the device is reachable or not.
last_up_time<Double>
Last time when the device was seen up.
ent_bw_total<Integer>
Enterprise Bandwidth Total.
ns_observationdomainName<String>
ns_observationdomainName.
Minimum length = 1
Maximum length = 512
sysservices<Double>
System Services.
device_finger_print<String>
Fingerprint/thumb-print from UMS public certificate for SSL communication.
mastools_version<String>
Mastools version if the device is embedded agent.
customid<String>
Custom ID.
geo_support<Boolean>
Is this device configured to support GEO location..
instance_classifier<Integer>
Value based on which certain features may be enabled/disabled in NetScaler Console for the instance.
instance_total<Integer>
Instance license.
profile_name<String>
Device Profile Name that is attached with this managed device.
Minimum length = 1
Maximum length = 128
state<String>
Node State.
Minimum length = 1
Maximum length = 32
device_family<String>
Device Family.
Minimum length = 1
Maximum length = 64
plt_bw_total<Integer>
Total Platinum Bandwidth.
netprofile_metrics_collector<String>
Net Profile for Metrics Collector.
gateway<String>
Default Gateway of managed device.
Minimum length = 1
Maximum length = 64
provision_request_id<String>
Value is set only if the instance was provisioned from NetScaler Console.
is_clip<Boolean>
Is Clip.
is_managed<Boolean>
Is Managed.
https_port<Integer>
HTTPS port of the container..
std_bw_available<Integer>
Standard Bandwidth Available.
ip_address<String>
IP Address for this managed device.
Minimum length = 1
Maximum length = 64
number_of_ssl_cards<Integer>
Number of SSL Cards.
is_ns_in_use<Boolean>
is_ns_in_use.
hostname<String>
Assign hostname to managed device, if this is not provided, name will be set as host name .
Minimum length = 1
Maximum length = 256
autoprovisioned<Boolean>
Device is auto-provisioned or not.
node_id<String>
Node identification of a device.
file_name<String>
File name which contains comma separated instances to be discovered.
Minimum length = 1
Maximum length = 128
is_re_register<Boolean>
If set to true, NetScaler Console will re-register the instance by first deleting it then adding it.
LS_IP<String>
License server IP address.
manual_inventory<Boolean>
manual_inventory.
peer_device_ip<String>
Peer Device IP address for instance of type BLX ADC..
Minimum length = 1
Maximum length = 64
save_config<Boolean>
Should config be saved first in case instance is rebooted while modify.
entity_tag<property_map[]>
Array of tag_name and tag_value pair assocaited with an entity.
profile_username<String>
User Name specified by the user for this NetScaler Instance..
Minimum length = 1
Maximum length = 128
profile_password<String>
Password specified by the user for this NetScaler Instance..
Minimum length = 1
Maximum length = 128
peer_host_device_ip<String>
Peer Host Device IP Address for instance of type BLX ADC..
Minimum length = 1
Maximum length = 64
prev_trust_id<String>
Previous trust ID of the mastools device.
tr_task_id<String>
Task Id used by Triton to identify NS.
file_location_path<String>
File Location on Client for upload/download.
Minimum length = 1
device_host_ip<String>
Device Host IP Address for instance of type BLX ADC..
Minimum length = 1
Maximum length = 64
Read only properties
cpufrequncy<Integer>
CPU Frequency (MHZ).
cpu_license_type<Integer>
VCPU license 0 = No VCPU License, 1 = VCPU Pool license.
vm_state<String>
State of Virtual Machine (Running | Halted).
httpquerywithurl<String>
URL query params flag..
instance_state<String>
State of device, UP only if device accessible.
lpeid<String>
LPEID for devices using LAS license.
number_of_cpu<Integer>
Number of CPU that is assigned to VM Instance.
geo_location<String>
Geo location of the managed device.
model_id<String>
Device Model Id.
public_dns<String>
Public DNS of the managed device.
ns_tx<Double>
Out Throughput of NetScaler Instance in Mbps.
diskperusage<Integer>
NetScaler Disk Utilization (%).
ns_total_rx<Double>
Total Rx of NetScaler Instance in Mbits.
vpx_on_cloud<Integer>
Cloud Platform of vpx: 0= On-Prem vpx, 1= AWS, 3=Azure, 4=GCP.
disk0_free<Double>
Disk0 Free space in MB.
device_uuid<String>
Device UUID.
sysid<String>
System ID.
mpx_encryption_status<String>
Encryption status of the filesystem of MPX device.
http_req<Double>
HTTP Requests/second.
manufacturedate<String>
Manufacture Date.
disk1_used<Double>
Disk1 used space in percentage.
ns_cpu_usage<Double>
CPU Usage (%) of NetScaler Instance.
license_grace_time<Integer>
Grace for this NetScaler Instance..
disksize<Integer>
NetScaler Disk Size(MB).
upsince<String>
Upsince of managed device.
diskused<Integer>
NetScaler Disk Used(MB).
public_ip<String>
Public IP of the managed device.
vpx_on_sdx<Integer>
VPX hosted on SDX: 1= Yes, 0= No.
burnin_date<String>
burnin_date for devices using LAS license.
disk0_total<Double>
Disk0 total space in MB.
is_fips_pooled_license_type<Integer>
FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license.
encoded_serialnumber<String>
Encoded Serial Number.
ns_total_tx<Double>
Total Tx of NetScaler Instance in Mbits.
version<String>
Device Version.
las_cpx_edition<String>
las_cpx_edition for CPX devices requesting LAS capacity during registration.
ami_id<String>
AMI ID of the managed device (if hosted on AWS).
ha_sync<String>
HA Synchronization State.
node_state<String>
Node State of NetScaler Instance.
ns_mgmt_cpu_usage<Double>
Management CPU Usage (%).
nic_discards_in<Double>
nic discards on incoming packets.
ha_ip_address<String>
Peer IP Address.
bmcrevision<String>
BMC Firmware Version.
is_pooled_saas<Integer>
Pooled Saas License available : 1, No Pooled Saas License available : 0.
uptime<String>
Uptime of device.
nodeid<Integer>
Node Id.
is_swg<Boolean>
Boolean to indicate whether a VM is SWG.
vm_description<String>
Description of the VM instance.
host_id<String>
Host ID.
security_group<String>
virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS).
serialnumber<String>
Device Serial Number.
contactperson<String>
Device contact person.
private_ip<String>
Private IP of the managed device.
clusterid<Integer>
Cluster Id.
region<String>
Region in which the managed device is hosted.
disk1_total<Double>
Disk1 total space in MB.
instance_type<String>
Instance type indicates the deployment type of CPX.
subnet_id<String>
in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).
httpcookie<String>
Cookie-Header flag..
vpc_id<String>
VPC ID of the managed device.
location<String>
Device Location.
reason<String>
Reason of failure for this managed device.
disk0_used<Double>
Disk0 used space in percentage.
clip<String>
Cluster IP Address.
ns_memory_usage<Double>
Memory Usage (%).
private_dns<String>
Private DNS of the managed device.
system_hardwareversion<String>
System Hardware Version.
nic_discards_out<Double>
nic discards on outgoing packets.
instance_unique_id<Integer>
32 bit unique Integer id generated by NetScaler NetScaler Console for this device.
health<String>
Node Health.
tenant_id<String>
Tenant ID.
cloud<String>
Cloud on which the managed device is hosted.
disk1_free<Double>
Disk1 free space in MB.
ha_master_state<String>
Master State (Primary/Secondary).
do_config<Boolean>
Do default config for managed device.
diskavail<Integer>
NetScaler Disk Available(MB).
uuid<String>
UUID of VM Instance generated by Hypervisor.
lm_host_id<String>
LM Host ID.
ssh_status<String>
SSH Status of device, UP only if device accessible on SSH.
ns_rx<Double>
In Throughput of NetScaler Instance in Mbps.
systemname<String>
Device System Name.
status<String>
Status of managed device.
zone<String>
Zone in which the managed device is hosted.
lm_serialnumber<String>
LM Serial Number.
instance_id<String>
Id of CPX instance.
act_id<String>
Activity Id.
diff_exists<Boolean>
Indicates whether config diff exists for this instances or not.
Operations
NOTE: In request payload, Mandatory parameters are marked red and bold.
The following parameters can be used in the nitro request :
onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE
URL:https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=manage&onerror=<String_value>
HTTPS Method:POST
Request Headers:
Content-Type:application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:JSON
{"ns": { }}
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx
Response Payload:JSON
{ "errorcode": 0, "message": "Done", "severity": <String_value>}
URL:https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=reboot&onerror=<String_value>
HTTPS Method:POST
Request Headers:
Content-Type:application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:JSON
{"ns": { }}
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx
Response Payload:JSON
{ "errorcode": 0, "message": "Done", "severity": <String_value>}
URL:https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=unmanage&onerror=<String_value>
HTTPS Method:POST
Request Headers:
Content-Type:application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:JSON
{"ns": { }}
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx
Response Payload:JSON
{ "errorcode": 0, "message": "Done", "severity": <String_value>}
URL:https://<MGMT-IP>/nitro/v2/config/ns
Query-parameters:
filter
https://<MGMT-IP>/nitro/v2/config/ns?filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of ns resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no&pageno=#no
https://<MGMT-IP>/nitro/v2/config/ns?pagesize=#no&pageno=#no
Use this query-parameter to get the ns resources in chunks.
count
https://<MGMT-IP>/nitro/v2/config/ns?count=yes
Use this query-parameter to get the count of ns resources.
HTTPS Method:GET
Request Headers:
Accept:application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx
Response Headers:
Content-Type:application/json
Response Payload:JSON
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns":[{
"pre_auth_key":<String_value>,
"is_autoscale_group":<Boolean_value>,
"license_server":<String_value>,
"backplane":<String_value>,
"config_progress_status":<String_value>,
"cpufrequncy":<Integer_value>,
"cpu_license_type":<Integer_value>,
"vm_state":<String_value>,
"vnc_console_url":<String_value>,
"httpquerywithurl":<String_value>,
"is_las_license":<Boolean_value>,
"name":<String_value>,
"instance_state":<String_value>,
"lpeid":<String_value>,
"gateway_deployment":<Boolean_value>,
"bot_signature_version":<String_value>,
"number_of_cpu":<Integer_value>,
"http_port":<Integer_value>,
"throughput":<Double_value>,
"lb_role":<String_value>,
"geo_location":<String_value>,
"model_id":<String_value>,
"plt_bw_config":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"public_dns":<String_value>,
"ns_tx":<Double_value>,
"vcpu_config":<Integer_value>,
"diskperusage":<Integer_value>,
"ns_observationdomainid":<String_value>,
"maintenance_status":<Boolean_value>,
"ns_total_rx":<Double_value>,
"iscco":<Boolean_value>,
"vpx_on_cloud":<Integer_value>,
"waf_signature_version":<String_value>,
"disk0_free":<Double_value>,
"device_uuid":<String_value>,
"port_range":<String_value>,
"license_edition":<String_value>,
"sysid":<String_value>,
"netprofile":<String_value>,
"mpx_encryption_status":<String_value>,
"formation_instance_id":<String_value>,
"is_pooled_license":<Boolean_value>,
"burst_priority":<Integer_value>,
"lastconfigsavetime":<Double_value>,
"http_req":<Double_value>,
"manufacturedate":<String_value>,
"ipv6_address":<String_value>,
"disk1_used":<Double_value>,
"ns_cpu_usage":<Double_value>,
"max_burst_throughput":<Double_value>,
"is_grace":<Boolean_value>,
"license_grace_time":<Integer_value>,
"snmp_port":<Integer_value>,
"ent_bw_config":<Integer_value>,
"disksize":<Integer_value>,
"upsince":<String_value>,
"license":<String_value>,
"isolation_policy":<String_value>,
"diskused":<Integer_value>,
"cmd_policy":<String_value>,
"public_ip":<String_value>,
"internal_annotation":<String_value>,
"std_bw_config":<Integer_value>,
"vpx_on_sdx":<Integer_value>,
"number_of_ssl_cores_up":<Integer_value>,
"burnin_date":<String_value>,
"disk0_total":<Double_value>,
"sslvpn_total":<Integer_value>,
"config_type":<Integer_value>,
"license_mode":<String_value>,
"is_fips_pooled_license_type":<Integer_value>,
"encoded_serialnumber":<String_value>,
"last_nonzero_throughput_time":<Double_value>,
"display_name":<String_value>,
"ns_total_tx":<Double_value>,
"partition_id":<String_value>,
"version":<String_value>,
"ping_state":<Integer_value>,
"user_driven":<Boolean_value>,
"las_cpx_edition":<String_value>,
"ami_id":<String_value>,
"instance_name":<String_value>,
"num_pes":<Integer_value>,
"instance_available":<Integer_value>,
"partition_name":<String_value>,
"mgmt_ip_address":<String_value>,
"user_profile_name":<String_value>,
"ha_sync":<String_value>,
"template_interval":<Integer_value>,
"task_id":<String_value>,
"ns_ip_address":<String_value>,
"ssh_port":<Integer_value>,
"node_state":<String_value>,
"agent_id":<String_value>,
"dns":<String_value>,
"ns_mgmt_cpu_usage":<Double_value>,
"domain_name":<String_value>,
"ent_bw_available":<Integer_value>,
"nic_discards_in":<Double_value>,
"ipv4_address":<String_value>,
"netmask":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"seq_no":<Double_value>,
"is_pooled_saas":<Integer_value>,
"httpxforwardedfor":<String_value>,
"last_updated_time":<Double_value>,
"uptime":<String_value>,
"metrics_collection":<Boolean_value>,
"servicepackage":<String_value>,
"nodeid":<Integer_value>,
"host_ip_address":<String_value>,
"is_swg":<Boolean_value>,
"autoscalegroup_id":<String_value>,
"lastconfigchangedtime":<Double_value>,
"vm_description":<String_value>,
"host_id":<String_value>,
"instance_config":<Integer_value>,
"security_group":<String_value>,
"serialnumber":<String_value>,
"contactperson":<String_value>,
"private_ip":<String_value>,
"customer_name":<String_value>,
"sslvpn_config":<Integer_value>,
"clusterid":<Integer_value>,
"datacenter_id":<String_value>,
"plt_bw_available":<Integer_value>,
"region":<String_value>,
"disk1_total":<Double_value>,
"instance_type":<String_value>,
"id":<String_value>,
"las_cpx_bw":<Integer_value>,
"subnet_id":<String_value>,
"gateway_ipv6":<String_value>,
"httpcookie":<String_value>,
"discovery_time":<Double_value>,
"vpc_id":<String_value>,
"location":<String_value>,
"std_bw_total":<Integer_value>,
"trust_id":<String_value>,
"instance_mode":<String_value>,
"reason":<String_value>,
"description":<String_value>,
"image_name":<String_value>,
"routable":<Boolean_value>,
"disk0_used":<Double_value>,
"last_up_time":<Double_value>,
"clip":<String_value>,
"ns_memory_usage":<Double_value>,
"private_dns":<String_value>,
"ent_bw_total":<Integer_value>,
"system_hardwareversion":<String_value>,
"ns_observationdomainName":<String_value>,
"sysservices":<Double_value>,
"device_finger_print":<String_value>,
"nic_discards_out":<Double_value>,
"instance_unique_id":<Integer_value>,
"parent_filters":<String_value>,
"mastools_version":<String_value>,
"customid":<String_value>,
"health":<String_value>,
"geo_support":<Boolean_value>,
"instance_classifier":<Integer_value>,
"tenant_id":<String_value>,
"cloud":<String_value>,
"instance_total":<Integer_value>,
"upsince_persisted":<String_value>,
"profile_name":<String_value>,
"state":<String_value>,
"disk1_free":<Double_value>,
"device_family":<String_value>,
"ha_master_state":<String_value>,
"do_config":<Boolean_value>,
"plt_bw_total":<Integer_value>,
"netprofile_metrics_collector":<String_value>,
"diskavail":<Integer_value>,
"gateway":<String_value>,
"uuid":<String_value>,
"provision_request_id":<String_value>,
"lm_host_id":<String_value>,
"is_clip":<Boolean_value>,
"is_managed":<Boolean_value>,
"https_port":<Integer_value>,
"ssh_status":<String_value>,
"std_bw_available":<Integer_value>,
"ns_rx":<Double_value>,
"host_type":<String_value>,
"ip_address":<String_value>,
"number_of_ssl_cards":<Integer_value>,
"systemname":<String_value>,
"status":<String_value>,
"zone":<String_value>,
"lm_serialnumber":<String_value>,
"is_ns_in_use":<Boolean_value>,
"hostname":<String_value>,
"instance_id":<String_value>,
"autoprovisioned":<Boolean_value>,
"node_id":<String_value>,
"file_name":<String_value>,
"is_re_register":<Boolean_value>,
"LS_IP":<String_value>,
"manual_inventory":<Boolean_value>,
"peer_device_ip":<String_value>,
"save_config":<Boolean_value>,
"entity_tag":[{
"prop_key":<String_value>,
"prop_value":<String_value>}],
"profile_username":<String_value>,
"profile_password":<String_value>,
"peer_host_device_ip":<String_value>,
"do_instance_config":<Boolean_value>,
"prev_trust_id":<String_value>,
"act_id":<String_value>,
"num_ports":<Integer_value>,
"tr_task_id":<String_value>,
"start_port":<Integer_value>,
"file_location_path":<String_value>,
"diff_exists":<Boolean_value>,
"register_failed_device":<Boolean_value>,
"force_password_change":<Boolean_value>,
"parent_inventory":<Boolean_value>,
"default_password":<String_value>,
"sync_operation":<Boolean_value>,
"device_host_ip":<String_value>,
"EULA":<Boolean_value>}]}
URL:https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>
HTTPS Method:GET
Request Headers:
Accept:application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx
Response Headers:
Content-Type:application/json
Response Payload:JSON
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns":[{
"pre_auth_key":<String_value>,
"is_autoscale_group":<Boolean_value>,
"license_server":<String_value>,
"backplane":<String_value>,
"config_progress_status":<String_value>,
"cpufrequncy":<Integer_value>,
"cpu_license_type":<Integer_value>,
"vm_state":<String_value>,
"vnc_console_url":<String_value>,
"httpquerywithurl":<String_value>,
"is_las_license":<Boolean_value>,
"name":<String_value>,
"instance_state":<String_value>,
"lpeid":<String_value>,
"gateway_deployment":<Boolean_value>,
"bot_signature_version":<String_value>,
"number_of_cpu":<Integer_value>,
"http_port":<Integer_value>,
"throughput":<Double_value>,
"lb_role":<String_value>,
"geo_location":<String_value>,
"model_id":<String_value>,
"plt_bw_config":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"public_dns":<String_value>,
"ns_tx":<Double_value>,
"vcpu_config":<Integer_value>,
"diskperusage":<Integer_value>,
"ns_observationdomainid":<String_value>,
"maintenance_status":<Boolean_value>,
"ns_total_rx":<Double_value>,
"iscco":<Boolean_value>,
"vpx_on_cloud":<Integer_value>,
"waf_signature_version":<String_value>,
"disk0_free":<Double_value>,
"device_uuid":<String_value>,
"port_range":<String_value>,
"license_edition":<String_value>,
"sysid":<String_value>,
"netprofile":<String_value>,
"mpx_encryption_status":<String_value>,
"formation_instance_id":<String_value>,
"is_pooled_license":<Boolean_value>,
"burst_priority":<Integer_value>,
"lastconfigsavetime":<Double_value>,
"http_req":<Double_value>,
"manufacturedate":<String_value>,
"ipv6_address":<String_value>,
"disk1_used":<Double_value>,
"ns_cpu_usage":<Double_value>,
"max_burst_throughput":<Double_value>,
"is_grace":<Boolean_value>,
"license_grace_time":<Integer_value>,
"snmp_port":<Integer_value>,
"ent_bw_config":<Integer_value>,
"disksize":<Integer_value>,
"upsince":<String_value>,
"license":<String_value>,
"isolation_policy":<String_value>,
"diskused":<Integer_value>,
"cmd_policy":<String_value>,
"public_ip":<String_value>,
"internal_annotation":<String_value>,
"std_bw_config":<Integer_value>,
"vpx_on_sdx":<Integer_value>,
"number_of_ssl_cores_up":<Integer_value>,
"burnin_date":<String_value>,
"disk0_total":<Double_value>,
"sslvpn_total":<Integer_value>,
"config_type":<Integer_value>,
"license_mode":<String_value>,
"is_fips_pooled_license_type":<Integer_value>,
"encoded_serialnumber":<String_value>,
"last_nonzero_throughput_time":<Double_value>,
"display_name":<String_value>,
"ns_total_tx":<Double_value>,
"partition_id":<String_value>,
"version":<String_value>,
"ping_state":<Integer_value>,
"user_driven":<Boolean_value>,
"las_cpx_edition":<String_value>,
"ami_id":<String_value>,
"instance_name":<String_value>,
"num_pes":<Integer_value>,
"instance_available":<Integer_value>,
"partition_name":<String_value>,
"mgmt_ip_address":<String_value>,
"user_profile_name":<String_value>,
"ha_sync":<String_value>,
"template_interval":<Integer_value>,
"task_id":<String_value>,
"ns_ip_address":<String_value>,
"ssh_port":<Integer_value>,
"node_state":<String_value>,
"agent_id":<String_value>,
"dns":<String_value>,
"ns_mgmt_cpu_usage":<Double_value>,
"domain_name":<String_value>,
"ent_bw_available":<Integer_value>,
"nic_discards_in":<Double_value>,
"ipv4_address":<String_value>,
"netmask":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"seq_no":<Double_value>,
"is_pooled_saas":<Integer_value>,
"httpxforwardedfor":<String_value>,
"last_updated_time":<Double_value>,
"uptime":<String_value>,
"metrics_collection":<Boolean_value>,
"servicepackage":<String_value>,
"nodeid":<Integer_value>,
"host_ip_address":<String_value>,
"is_swg":<Boolean_value>,
"autoscalegroup_id":<String_value>,
"lastconfigchangedtime":<Double_value>,
"vm_description":<String_value>,
"host_id":<String_value>,
"instance_config":<Integer_value>,
"security_group":<String_value>,
"serialnumber":<String_value>,
"contactperson":<String_value>,
"private_ip":<String_value>,
"customer_name":<String_value>,
"sslvpn_config":<Integer_value>,
"clusterid":<Integer_value>,
"datacenter_id":<String_value>,
"plt_bw_available":<Integer_value>,
"region":<String_value>,
"disk1_total":<Double_value>,
"instance_type":<String_value>,
"id":<String_value>,
"las_cpx_bw":<Integer_value>,
"subnet_id":<String_value>,
"gateway_ipv6":<String_value>,
"httpcookie":<String_value>,
"discovery_time":<Double_value>,
"vpc_id":<String_value>,
"location":<String_value>,
"std_bw_total":<Integer_value>,
"trust_id":<String_value>,
"instance_mode":<String_value>,
"reason":<String_value>,
"description":<String_value>,
"image_name":<String_value>,
"routable":<Boolean_value>,
"disk0_used":<Double_value>,
"last_up_time":<Double_value>,
"clip":<String_value>,
"ns_memory_usage":<Double_value>,
"private_dns":<String_value>,
"ent_bw_total":<Integer_value>,
"system_hardwareversion":<String_value>,
"ns_observationdomainName":<String_value>,
"sysservices":<Double_value>,
"device_finger_print":<String_value>,
"nic_discards_out":<Double_value>,
"instance_unique_id":<Integer_value>,
"parent_filters":<String_value>,
"mastools_version":<String_value>,
"customid":<String_value>,
"health":<String_value>,
"geo_support":<Boolean_value>,
"instance_classifier":<Integer_value>,
"tenant_id":<String_value>,
"cloud":<String_value>,
"instance_total":<Integer_value>,
"upsince_persisted":<String_value>,
"profile_name":<String_value>,
"state":<String_value>,
"disk1_free":<Double_value>,
"device_family":<String_value>,
"ha_master_state":<String_value>,
"do_config":<Boolean_value>,
"plt_bw_total":<Integer_value>,
"netprofile_metrics_collector":<String_value>,
"diskavail":<Integer_value>,
"gateway":<String_value>,
"uuid":<String_value>,
"provision_request_id":<String_value>,
"lm_host_id":<String_value>,
"is_clip":<Boolean_value>,
"is_managed":<Boolean_value>,
"https_port":<Integer_value>,
"ssh_status":<String_value>,
"std_bw_available":<Integer_value>,
"ns_rx":<Double_value>,
"host_type":<String_value>,
"ip_address":<String_value>,
"number_of_ssl_cards":<Integer_value>,
"systemname":<String_value>,
"status":<String_value>,
"zone":<String_value>,
"lm_serialnumber":<String_value>,
"is_ns_in_use":<Boolean_value>,
"hostname":<String_value>,
"instance_id":<String_value>,
"autoprovisioned":<Boolean_value>,
"node_id":<String_value>,
"file_name":<String_value>,
"is_re_register":<Boolean_value>,
"LS_IP":<String_value>,
"manual_inventory":<Boolean_value>,
"peer_device_ip":<String_value>,
"save_config":<Boolean_value>,
"entity_tag":[{
"prop_key":<String_value>,
"prop_value":<String_value>}],
"profile_username":<String_value>,
"profile_password":<String_value>,
"peer_host_device_ip":<String_value>,
"do_instance_config":<Boolean_value>,
"prev_trust_id":<String_value>,
"act_id":<String_value>,
"num_ports":<Integer_value>,
"tr_task_id":<String_value>,
"start_port":<Integer_value>,
"file_location_path":<String_value>,
"diff_exists":<Boolean_value>,
"register_failed_device":<Boolean_value>,
"force_password_change":<Boolean_value>,
"parent_inventory":<Boolean_value>,
"default_password":<String_value>,
"sync_operation":<Boolean_value>,
"device_host_ip":<String_value>,
"EULA":<Boolean_value>}]}