ns
Configuration for Citrix ADC resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
instance_classifier |
|
Read-write | Value based on which certain features may be enabled/disabled in ADM for the instance. |
gateway_deployment |
|
Read-write | Is this device acting as Gateway.. |
std_bw_config |
|
Read-write | Standard Bandwidth running. |
ns_ip_address |
|
Read-write | Citrix ADC IP Address for this managed device.
Minimum length = 1 Maximum length = 128 |
gateway_ipv6 |
|
Read-write | Gateway IPv6 Address. |
instance_available |
|
Read-write | Instance license available. |
device_finger_print |
|
Read-write | Fingerprint/thumb-print from UMS public certificate for SSL communication. |
name |
|
Read-write | Name of managed device.
Minimum length = 1 Maximum length = 128 |
is_autoscale_group |
|
Read-write | Does this device belong to an Autoscale Group.. |
ns_observationdomainName |
|
Read-write | ns_observationdomainName.
Minimum length = 1 Maximum length = 512 |
mastools_version |
|
Read-write | Mastools version if the device is embedded agent. |
ent_bw_total |
|
Read-write | Enterprise Bandwidth Total. |
ssh_port |
|
Read-write | SSH port of the container.. |
vcpu_config |
|
Read-write | Number of vCPU allocated for the device. |
netmask |
|
Read-write | Netmask of managed device.
Minimum length = 1 Maximum length = 64 |
ent_bw_config |
|
Read-write | Enterprise Bandwidth configured. |
datacenter_id |
|
Read-write | Datacenter Id is system generated key for data center. |
instance_config |
|
Read-write | Instance license running. |
instance_mode |
|
Read-write | Denotes state- primary,secondary,clip,clusternode. |
discovery_time |
|
Read-write | discovery time. |
number_of_ssl_cores_up |
|
Read-write | Number of SSL Cores Up. |
std_bw_available |
|
Read-write | Standard Bandwidth Available. |
plt_bw_total |
|
Read-write | Total Platinum Bandwidth. |
host_ip_address |
|
Read-write | Host IPAddress where VM is provisioned.
Minimum length = 1 Maximum length = 64 |
id |
|
Read-write | Id is system generated key for all the managed devices. |
ipv6_address |
|
Read-write | IPv6 Address. |
mgmt_ip_address |
|
Read-write | Management IP Address for this Managed Device.
Minimum length = 1 Maximum length = 64 |
plt_bw_available |
|
Read-write | Platinum Bandwidth Available. |
is_clip |
|
Read-write | Is Clip. |
device_family |
|
Read-write | Device Family.
Minimum length = 1 Maximum length = 64 |
template_interval |
|
Read-write | Template refresh interval. |
type |
|
Read-write | Type of device, (Xen | NS).
Minimum length = 1 Maximum length = 64 |
throughput |
|
Read-write | Assign throughput in Mbps to VM Instance. |
ns_observationdomainid |
|
Read-write | ns_observationdomainid.
Minimum length = 1 Maximum length = 64 |
gateway |
|
Read-write | Default Gateway of managed device.
Minimum length = 1 Maximum length = 64 |
http_port |
|
Read-write | HTTP port of the container.. |
internal_annotation |
|
Read-write | Internal annotation used by ADM.Example, if a device is marked for delete. |
iscco |
|
Read-write | Is CCO. |
isolation_policy |
|
Read-write | Isolation Policy of the Device. |
provision_request_id |
|
Read-write | Value is set only if the instance was provisioned from Citrix ADM. |
lb_role |
|
Read-write | LB role performed by the device: North-South (Ingress or server), or East-West (client). |
license |
|
Read-write | Feature License for Citrix ADC Instance, needs to be set while provisioning (standard, enterprise, platinum).
Minimum length = 1 Maximum length = 64 |
https_port |
|
Read-write | HTTPS port of the container.. |
domain_name |
|
Read-write | Domain name of VM Device.
Minimum length = 1 Maximum length = 128 |
snmp_port |
|
Read-write | SNMP port of the container.. |
image_name |
|
Read-write | 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 |
hostname |
|
Read-write | Assign hostname to managed device, if this is not provided, name will be set as host name .
Minimum length = 1 Maximum length = 256 |
pre_auth_key |
|
Read-write | Shared secret that used for orchestration deployment. |
ent_bw_available |
|
Read-write | Enterprise Bandwidth configured. |
description |
|
Read-write | Description of managed device.
Minimum length = 1 Maximum length = 512 |
geo_support |
|
Read-write | Is this device configured to support GEO location.. |
sslvpn_config |
|
Read-write | sslvpn license maximum. |
sysservices |
|
Read-write | System Services. |
num_pes |
|
Read-write | Total number of PEs. |
burst_priority |
|
Read-write | Burst Priority of the VM Instance between 1 and 4. |
routable |
|
Read-write | Whether the device is reachable or not. |
autoprovisioned |
|
Read-write | Device is auto-provisioned or not. |
metrics_collection |
|
Read-write | Flag to check if metrics collection is enabled or disabled.. |
is_managed |
|
Read-write | Is Managed. |
instance_total |
|
Read-write | Instance license. |
is_ha_configured |
|
Read-write | Is HA configured. |
trust_id |
|
Read-write | Device ID obtained from trust service. |
ipv4_address |
|
Read-write | IPv4 Address.
Minimum length = 1 Maximum length = 64 |
profile_name |
|
Read-write | Device Profile Name that is attached with this managed device.
Minimum length = 1 Maximum length = 128 |
backplane |
|
Read-write | Backplane Interface.
Minimum length = 1 |
servicepackage |
|
Read-write | Service Package Name of the device. |
state |
|
Read-write | Node State.
Minimum length = 1 Maximum length = 32 |
last_updated_time |
|
Read-write | Last Updated Time. |
license_edition |
|
Read-write | Edition of instance. |
partition_id |
|
Read-write | ID of admin partition. |
customid |
|
Read-write | Custom ID. |
number_of_ssl_cards |
|
Read-write | Number of SSL Cards. |
max_burst_throughput |
|
Read-write | Maximum burst throughput in Mbps of VM Instance. |
config_type |
|
Read-write | Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value = |
cmd_policy |
|
Read-write | true if you want to allow shell/sftp/scp access to Citrix ADC Instance administrator.
Minimum length = 1 Maximum length = 1024 |
node_id |
|
Read-write | Node identification of a device. |
ip_address |
|
Read-write | IP Address for this managed device.
Minimum length = 1 Maximum length = 64 |
httpxforwardedfor |
|
Read-write | HTTP x-Forwardedfor header flag..
Minimum length = 1 Maximum length = 10 |
display_name |
|
Read-write | 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 |
std_bw_total |
|
Read-write | Standard Bandwidth. |
partition_name |
|
Read-write | Citrix ADC Admin Partition Name.
Maximum length = 512 |
plt_bw_config |
|
Read-write | Platinum Bandwidth configured. |
sslvpn_total |
|
Read-write | sslvpn license. |
agent_id |
|
Read-write | Agent Id. |
peer_device_ip |
|
Read-write | Peer Device IP address for instance of type BLX ADC..
Minimum length = 1 Maximum length = 64 |
profile_password |
|
Read-write | Password specified by the user for this Citrix ADC Instance..
Minimum length = 1 Maximum length = 128 |
file_name |
|
Read-write | File name which contains comma separated instances to be discovered.
Minimum length = 1 Maximum length = 128 |
save_config |
|
Read-write | Should config be saved first in case instance is rebooted while modify. |
profile_username |
|
Read-write | User Name specified by the user for this Citrix ADC Instance..
Minimum length = 1 Maximum length = 128 |
file_location_path |
|
Read-write | File Location on Client for upload/download.
Minimum length = 1 |
peer_host_device_ip |
|
Read-write | Peer Host Device IP Address for instance of type BLX ADC..
Minimum length = 1 Maximum length = 64 |
LS_IP |
|
Read-write | License server IP address. |
device_host_ip |
|
Read-write | Device Host IP Address for instance of type BLX ADC..
Minimum length = 1 Maximum length = 64 |
tr_task_id |
|
Read-write | Task Id used by Triton to identify NS. |
entity_tag | <property_map[]> | Read-write | Array of tag_name and tag_value pair assocaited with an entity. |
clusterid |
|
Read-only | Cluster Id. |
manufacturedate |
|
Read-only | Manufacture Date. |
is_fips_pooled_license_type |
|
Read-only | FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license. |
instance_state |
|
Read-only | State of device, UP only if device accessible. |
diskavail |
|
Read-only | Citrix ADC Disk Available(MB). |
disk1_used |
|
Read-only | Disk1 used space in percentage. |
clip |
|
Read-only | Cluster IP Address. |
device_uuid |
|
Read-only | Device UUID. |
version |
|
Read-only | Device Version. |
health |
|
Read-only | Node Health. |
public_dns |
|
Read-only | Public DNS of the managed device. |
instance_type |
|
Read-only | Instance type indicates the deployment type of CPX. |
disksize |
|
Read-only | Citrix ADC Disk Size(MB). |
sysid |
|
Read-only | System ID. |
nodeid |
|
Read-only | Node Id. |
vm_state |
|
Read-only | State of Virtual Machine (Running | Halted). |
uuid |
|
Read-only | UUID of VM Instance generated by Hypervisor. |
disk1_free |
|
Read-only | Disk1 free space in MB. |
encoded_serialnumber |
|
Read-only | Encoded Serial Number. |
instance_unique_id |
|
Read-only | 32 bit unique Integer id generated by Citrix ADM for this device. |
disk0_total |
|
Read-only | Disk0 total space in MB. |
cpufrequncy |
|
Read-only | CPU Frequency (MHZ). |
http_req |
|
Read-only | HTTP Requests/second. |
ha_sync |
|
Read-only | HA Synchronization State. |
ha_ip_address |
|
Read-only | Peer IP Address. |
nic_discards_in |
|
Read-only | nic discards on incoming packets. |
disk0_free |
|
Read-only | Disk0 Free space in MB. |
nic_discards_out |
|
Read-only | nic discards on outgoing packets. |
node_state |
|
Read-only | Node State of Citrix ADC Instance. |
status |
|
Read-only | Status of managed device. |
systemname |
|
Read-only | Device System Name. |
geo_location |
|
Read-only | Geo location of the managed device. |
ns_memory_usage |
|
Read-only | Memory Usage (%). |
instance_id |
|
Read-only | Id of CPX instance. |
serialnumber |
|
Read-only | Device Serial Number. |
subnet_id |
|
Read-only | in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS). |
ha_master_state |
|
Read-only | Master State (Primary/Secondary). |
vpc_id |
|
Read-only | VPC ID of the managed device. |
httpquerywithurl |
|
Read-only | URL query params flag.. |
region |
|
Read-only | Region in which the managed device is hosted. |
reason |
|
Read-only | Reason of failure for this managed device. |
ns_total_tx |
|
Read-only | Total Tx of Citrix ADC Instance in Mbits. |
upsince |
|
Read-only | Upsince of managed device. |
security_group |
|
Read-only | virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS). |
private_dns |
|
Read-only | Private DNS of the managed device. |
zone |
|
Read-only | Zone in which the managed device is hosted. |
model_id |
|
Read-only | Device Model Id. |
tenant_id |
|
Read-only | Tenant ID. |
ns_mgmt_cpu_usage |
|
Read-only | Management CPU Usage (%). |
do_config |
|
Read-only | Do default config for managed device. |
host_id |
|
Read-only | Host ID. |
system_hardwareversion |
|
Read-only | System Hardware Version. |
ns_tx |
|
Read-only | Out Throughput of Citrix ADC Instance in Mbps. |
number_of_cpu |
|
Read-only | Number of CPU that is assigned to VM Instance. |
is_swg |
|
Read-only | Boolean to indicate whether a VM is SWG. |
diskused |
|
Read-only | Citrix ADC Disk Used(MB). |
cloud |
|
Read-only | Cloud on which the managed device is hosted. |
uptime |
|
Read-only | Uptime of device. |
private_ip |
|
Read-only | Private IP of the managed device. |
cpu_license_type |
|
Read-only | VCPU license 0 = No VCPU License, 1 = VCPU Pool license. |
location |
|
Read-only | Device Location. |
contactperson |
|
Read-only | Device contact person. |
license_grace_time |
|
Read-only | Grace for this Citrix Instance.. |
public_ip |
|
Read-only | Public IP of the managed device. |
ns_cpu_usage |
|
Read-only | CPU Usage (%) of Citrix ADC Instance. |
bmcrevision |
|
Read-only | BMC Firmware Version. |
ns_rx |
|
Read-only | In Throughput of Citrix ADC Instance in Mbps. |
vm_description |
|
Read-only | Description of the VM instance. |
diskperusage |
|
Read-only | Citrix ADC Disk Utilization (%). |
disk1_total |
|
Read-only | Disk1 total space in MB. |
ami_id |
|
Read-only | AMI ID of the managed device (if hosted on AWS). |
disk0_used |
|
Read-only | Disk0 used space in percentage. |
ns_total_rx |
|
Read-only | Total Rx of Citrix ADC Instance in Mbits. |
httpcookie |
|
Read-only | Cookie-Header flag.. |
act_id |
|
Read-only | Activity Id. |
diff_exists |
|
Read-only | Indicates whether config diff exists for this instances or not. |
Operations
(click to see Properties )
- REBOOT
- UNMANAGE
- GET (ALL)
- GET
- MANAGE
Some options that you can use for each operations:
-
Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
-
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER: <username>
X-NITRO-PASS: <password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note:
*
Mandatory parameters are marked in
red
and placeholder content is marked in
green
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
reboot
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:
{"ns": { }}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}
unmanage
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:
{"ns": { }}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}
get (all)
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 (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns":[{
"instance_classifier":<Integer_value>,
"clusterid":<Integer_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"ns_ip_address":<String_value>,
"is_fips_pooled_license_type":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"is_autoscale_group":<Boolean_value>,
"ns_observationdomainName":<String_value>,
"diskavail":<Integer_value>,
"mastools_version":<String_value>,
"ent_bw_total":<Integer_value>,
"disk1_used":<Double_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"clip":<String_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"health":<String_value>,
"public_dns":<String_value>,
"number_of_ssl_cores_up":<Integer_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"disksize":<Integer_value>,
"sysid":<String_value>,
"nodeid":<Integer_value>,
"instance_name":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"disk1_free":<Double_value>,
"encoded_serialnumber":<String_value>,
"instance_unique_id":<Integer_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"disk0_total":<Double_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"is_clip":<Boolean_value>,
"device_family":<String_value>,
"template_interval":<Integer_value>,
"http_req":<Double_value>,
"ha_sync":<String_value>,
"ha_ip_address":<String_value>,
"nic_discards_in":<Double_value>,
"disk0_free":<Double_value>,
"type":<String_value>,
"throughput":<Double_value>,
"ns_observationdomainid":<String_value>,
"nic_discards_out":<Double_value>,
"node_state":<String_value>,
"status":<String_value>,
"gateway":<String_value>,
"http_port":<Integer_value>,
"internal_annotation":<String_value>,
"systemname":<String_value>,
"geo_location":<String_value>,
"ns_memory_usage":<Double_value>,
"iscco":<Boolean_value>,
"isolation_policy":<String_value>,
"instance_id":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"httpquerywithurl":<String_value>,
"pre_auth_key":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"ns_total_tx":<Double_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"ns_mgmt_cpu_usage":<Double_value>,
"num_pes":<Integer_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"port_range":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"metrics_collection":<Boolean_value>,
"host_id":<String_value>,
"is_managed":<Boolean_value>,
"system_hardwareversion":<String_value>,
"ns_tx":<Double_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"backplane":<String_value>,
"diskused":<Integer_value>,
"servicepackage":<String_value>,
"state":<String_value>,
"task_id":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"cpu_license_type":<Integer_value>,
"upsince_persisted":<String_value>,
"location":<String_value>,
"customid":<String_value>,
"contactperson":<String_value>,
"license_grace_time":<Integer_value>,
"public_ip":<String_value>,
"ns_cpu_usage":<Double_value>,
"bmcrevision":<String_value>,
"number_of_ssl_cards":<Integer_value>,
"ns_rx":<Double_value>,
"vm_description":<String_value>,
"user_profile_name":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"cmd_policy":<String_value>,
"node_id":<String_value>,
"diskperusage":<Integer_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"httpxforwardedfor":<String_value>,
"disk1_total":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"disk0_used":<Double_value>,
"ns_total_rx":<Double_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"httpcookie":<String_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"config_progress_status":<String_value>,
"formation_instance_id":<String_value>,
"peer_device_ip":<String_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"register_failed_device":<Boolean_value>,
"EULA":<Boolean_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"diff_exists":<Boolean_value>,
"num_ports":<Integer_value>,
"save_config":<Boolean_value>,
"do_instance_config":<Boolean_value>,
"profile_username":<String_value>,
"start_port":<Integer_value>,
"default_password":<String_value>,
"file_location_path":<String_value>,
"peer_host_device_ip":<String_value>,
"LS_IP":<String_value>,
"sync_operation":<Boolean_value>,
"device_host_ip":<String_value>,
"tr_task_id":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"force_password_change":<Boolean_value>}]}
get
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 (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns":[{
"instance_classifier":<Integer_value>,
"clusterid":<Integer_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"ns_ip_address":<String_value>,
"is_fips_pooled_license_type":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"is_autoscale_group":<Boolean_value>,
"ns_observationdomainName":<String_value>,
"diskavail":<Integer_value>,
"mastools_version":<String_value>,
"ent_bw_total":<Integer_value>,
"disk1_used":<Double_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"clip":<String_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"health":<String_value>,
"public_dns":<String_value>,
"number_of_ssl_cores_up":<Integer_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"disksize":<Integer_value>,
"sysid":<String_value>,
"nodeid":<Integer_value>,
"instance_name":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"disk1_free":<Double_value>,
"encoded_serialnumber":<String_value>,
"instance_unique_id":<Integer_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"disk0_total":<Double_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"is_clip":<Boolean_value>,
"device_family":<String_value>,
"template_interval":<Integer_value>,
"http_req":<Double_value>,
"ha_sync":<String_value>,
"ha_ip_address":<String_value>,
"nic_discards_in":<Double_value>,
"disk0_free":<Double_value>,
"type":<String_value>,
"throughput":<Double_value>,
"ns_observationdomainid":<String_value>,
"nic_discards_out":<Double_value>,
"node_state":<String_value>,
"status":<String_value>,
"gateway":<String_value>,
"http_port":<Integer_value>,
"internal_annotation":<String_value>,
"systemname":<String_value>,
"geo_location":<String_value>,
"ns_memory_usage":<Double_value>,
"iscco":<Boolean_value>,
"isolation_policy":<String_value>,
"instance_id":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"httpquerywithurl":<String_value>,
"pre_auth_key":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"ns_total_tx":<Double_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"ns_mgmt_cpu_usage":<Double_value>,
"num_pes":<Integer_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"port_range":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"metrics_collection":<Boolean_value>,
"host_id":<String_value>,
"is_managed":<Boolean_value>,
"system_hardwareversion":<String_value>,
"ns_tx":<Double_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"backplane":<String_value>,
"diskused":<Integer_value>,
"servicepackage":<String_value>,
"state":<String_value>,
"task_id":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"cpu_license_type":<Integer_value>,
"upsince_persisted":<String_value>,
"location":<String_value>,
"customid":<String_value>,
"contactperson":<String_value>,
"license_grace_time":<Integer_value>,
"public_ip":<String_value>,
"ns_cpu_usage":<Double_value>,
"bmcrevision":<String_value>,
"number_of_ssl_cards":<Integer_value>,
"ns_rx":<Double_value>,
"vm_description":<String_value>,
"user_profile_name":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"cmd_policy":<String_value>,
"node_id":<String_value>,
"diskperusage":<Integer_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"httpxforwardedfor":<String_value>,
"disk1_total":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"disk0_used":<Double_value>,
"ns_total_rx":<Double_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"httpcookie":<String_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"config_progress_status":<String_value>,
"formation_instance_id":<String_value>,
"peer_device_ip":<String_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"register_failed_device":<Boolean_value>,
"EULA":<Boolean_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"diff_exists":<Boolean_value>,
"num_ports":<Integer_value>,
"save_config":<Boolean_value>,
"do_instance_config":<Boolean_value>,
"profile_username":<String_value>,
"start_port":<Integer_value>,
"default_password":<String_value>,
"file_location_path":<String_value>,
"peer_host_device_ip":<String_value>,
"LS_IP":<String_value>,
"sync_operation":<Boolean_value>,
"device_host_ip":<String_value>,
"tr_task_id":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"force_password_change":<Boolean_value>}]}
manage
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:
{"ns": { }}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}