Instances

ns

Configuration for Citrix ADC resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
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
password Read-write Password for specified user on Citrix ADC Instance.

Minimum length = 1

Maximum length = 127
gateway_ipv6 Read-write Gateway IPv6 Address.
throughput_limit Read-write Throughput Limit in Mbps set for VM Instance.
vlan_id_0_1 Read-write VLAN id for the management interface 0/1.

Maximum value =
name Read-write Name of managed device.

Minimum length = 1

Maximum length = 128
mastools_version Read-write Mastools version if the device is embedded agent.
plugin_ip_address Read-write Signaling IP Address.

Minimum length = 1

Maximum length = 64
vlan_type Read-write VLAN Type, Citrix ADC or L2 VLAN.

Maximum value =
ent_bw_total Read-write Enterprise Bandwidth Total.
vcpu_config Read-write Number of vCPU allocated for the device.
nsvlan_tagged Read-write NSVLAN Tagged.
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_mode Read-write Denotes state- primary,secondary,clip,clusternode.
number_of_ssl_cores_up Read-write Number of SSL Cores Up.
std_bw_available Read-write Standard Bandwidth Available.
internal_ip_address Read-write Internal IP Address for this managed device.

Minimum length = 1

Maximum length = 64
if_0_1 Read-write Network 0/1 on VM Instance.
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
number_of_acu Read-write Assign number of asymmetric crypto units to VM Instance.
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
type Read-write Type of device, (Xen | NS).

Minimum length = 1

Maximum length = 64
throughput Read-write Assign throughput in Mbps to VM Instance.
template_name Read-write Template Name, This parameter is used while provisioning VM Instance with template, template_name is given priority if provided along with image_name.

Minimum length = 1

Maximum length = 128
gateway Read-write Default Gateway of managed device.

Minimum length = 1

Maximum length = 64
iscco Read-write Is CCO.
number_of_scu Read-write Assign number of asymmetric crypto units to VM Instance.
license Read-write Feature License for Citrix ADC Instance, needs to be set while provisioning (standard, enterprise, platinum).

Minimum length = 1

Maximum length = 64
domain_name Read-write Domain name of VM Device.

Minimum length = 1

Maximum length = 128
if_0_2 Read-write Network 0/2 on VM Instance.
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
vm_memory_total Read-write Total Memory of VM Instance in MB. 2048MB, 5120MB.
ent_bw_available Read-write Enterprise Bandwidth configured.
description Read-write Description of managed device.

Minimum length = 1

Maximum length = 512
username Read-write User Name (except nsroot) to be configured on Citrix ADC Instance.

Minimum length = 1

Maximum length = 127
fips_partition_name Read-write FIPS Partition Name.

Minimum length = 1

Maximum length = 128
nsvlan_id Read-write VLAN Id.

Maximum value =
num_pes Read-write Total number of PEs.
burst_priority Read-write Burst Priority of the VM Instance between 1 and 4.
metrics_collection Read-write Flag to check if metrics collection is enabled or disabled..
is_managed Read-write Is Managed.
nexthop_v6 Read-write Next Hop IPv6 Address.
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
network_interfaces <network_interface[]> Read-write Network Interfaces.
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.
customid Read-write Custom ID.
license_grace_time Read-write Grace for this Citrix Instance..
la_mgmt Read-write Bond consisting of management ports on VM Instance.
vlan_id_0_2 Read-write VLAN id for the management interface 0/2.

Maximum value =
number_of_ssl_cores Read-write Assign number of ssl virtual functions to VM Instance.
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 =
if_internal_ip_enabled Read-write Set as true if VPX is managed by internal network (not required to be set for SDWAN).
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
throughput_allocation_mode Read-write Throughput Allocation Mode: 0-Fixed, 1-Burst-able.
number_of_cores Read-write Number of cores that are assigned to VM Instance.
pps Read-write Assign packets per seconds to Citrix ADC Instance.

Maximum value =
plugin_netmask Read-write Signaling Netmask.

Minimum length = 1

Maximum length = 64
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.
nexthop Read-write Next Hop IP address.

Minimum length = 1

Maximum length = 64
plt_bw_config Read-write Platinum Bandwidth configured.
vlan_1_2 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/2 on VM Instance.

Maximum value =
vrid_list_ipv4_1_2 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/2 for IPV4 VMAC Generation.
vlan_1_7 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/7 on VM Instance.

Maximum value =
vrid_list_ipv6_1_2 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/2 for IPV6 VMAC Generation.
vrid_list_ipv4_1_4 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/4 for IPV4 VMAC Generation.
vrid_list_ipv6_10_6 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/6 for IPV6 VMAC Generation.
if_10_4 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/4 on VM Instance.
vlan_10_5 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/5 on VM Instance.

Maximum value =
vrid_list_ipv6_10_3 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/3 for IPV6 VMAC Generation.
vrid_list_ipv6_1_1 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/1 for IPV6 VMAC Generation.
if_1_5 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/5 on VM Instance.
receiveuntagged_1_4 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/4 on VM Instance.
vrid_list_ipv6_10_4 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/4 for IPV6 VMAC Generation.
vrid_list_ipv6_1_3 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/3for IPV6 VMAC Generation.
if_10_3 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/3 on VM Instance.
vrid_list_ipv6_10_5 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/5 for IPV6 VMAC Generation.
receiveuntagged_10_4 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/4 on VM Instance.
vrid_list_ipv6_1_8 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/8 for IPV6 VMAC Generation.
vlan_10_6 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/6 on VM Instance.

Maximum value =
if_10_5 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/5 on VM Instance.
save_config Read-write Should config be saved first in case instance is rebooted while modify.
is_new_crypto Read-write True if number_of_acu/number_of_scu are used, false if number_of_ssl_cores is used.
vrid_list_ipv6_1_6 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/6 for IPV6 VMAC Generation.
profile_username Read-write User Name specified by the user for this Citrix ADC Instance..

Minimum length = 1

Maximum length = 128
if_10_7 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/7 on VM Instance.
receiveuntagged_10_8 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/8 on VM Instance.
vrid_list_ipv6_1_4 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/4 for IPV6 VMAC Generation.
receiveuntagged_1_6 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/6 on VM Instance.
vlan_1_4 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/4 on VM Instance.

Maximum value =
if_1_2 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/2 on VM Instance.
receiveuntagged_1_5 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/5 on VM Instance.
receiveuntagged_10_6 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/6 on VM Instance.
receiveuntagged_10_1 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/1 on VM Instance.
vrid_list_ipv4_1_6 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/6 for IPV4 VMAC Generation.
vrid_list_ipv6_1_5 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/5 for IPV6 VMAC Generation.
vrid_list_ipv6_10_8 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/8 for IPV6 VMAC Generation.
vrid_list_ipv4_1_7 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/7 for IPV4 VMAC Generation.
receiveuntagged_10_2 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/2 on VM Instance.
profile_password Read-write Password specified by the user for this Citrix ADC Instance..

Minimum length = 1

Maximum length = 128
vrid_list_ipv4_1_5 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/5 for IPV4 VMAC Generation.
receiveuntagged_1_7 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/7 on VM Instance.
vlan_10_4 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/4 on VM Instance.

Maximum value =
if_1_7 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/7 on VM Instance.
receiveuntagged_1_1 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/1 on VM Instance.
vrid_list_ipv6_1_7 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/7 for IPV6 VMAC Generation.
if_10_1 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/1 on VM Instance.
if_10_8 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/8 on VM Instance.
l2_enabled Read-write L2mode status of VM Instance.
vlan_10_7 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/7 on VM Instance.

Maximum value =
vlan_10_1 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/1 on VM Instance.

Maximum value =
receiveuntagged_1_2 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/2 on VM Instance.
reboot_vm_on_cpu_change Read-write Reboot VMs on CPU change during resource allocation.
vlan_1_6 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/6 on VM Instance.

Maximum value =
vrid_list_ipv4_1_3 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/3for IPV4 VMAC Generation.
receiveuntagged_10_7 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/7 on VM Instance.
vrid_list_ipv4_1_1 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/1 for IPV4 VMAC Generation.
vlan_1_1 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/1 on VM Instance.

Maximum value =
vrid_list_ipv6_10_7 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/7 for IPV6 VMAC Generation.
vlan_1_8 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/8 on VM Instance.

Maximum value =
vrid_list_ipv4_10_3 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/3 for IPV4 VMAC Generation.
receiveuntagged_10_5 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/5 on VM Instance.
vlan_10_2 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/2 on VM Instance.

Maximum value =
vrid_list_ipv4_10_6 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/6 for IPV4 VMAC Generation.
vrid_list_ipv4_1_8 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 1/8 for IPV4 VMAC Generation.
receiveuntagged_1_8 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/8 on VM Instance.
vrid_list_ipv4_10_4 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/4 for IPV4 VMAC Generation.
vlan_1_3 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/3 on VM Instance.

Maximum value =
receiveuntagged_10_3 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 10/3 on VM Instance.
if_10_6 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/6 on VM Instance.
if_1_6 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/6 on VM Instance.
vlan_10_3 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/3 on VM Instance.

Maximum value =
vlan_1_5 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 1/5 on VM Instance.

Maximum value =
if_1_3 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/3 on VM Instance.
nsvlan_interfaces <String[]> Read-write VLAN Interfaces.

Minimum length = 1

Maximum length = 50
vrid_list_ipv4_10_5 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/5 for IPV4 VMAC Generation.
if_1_4 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/4 on VM Instance.
vrid_list_ipv4_10_8 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/8 for IPV4 VMAC Generation.
if_1_1 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/1 on VM Instance.
vrid_list_ipv4_10_7 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/7 for IPV4 VMAC Generation.
vlan_10_8 Read-write This property is deprecated by network_interfaces;ltbr;gtVLAN for Network 10/8 on VM Instance.

Maximum value =
receiveuntagged_1_3 Read-write This property is deprecated by network_interfaces;ltbr;gtReceive Untagged Packets on 1/3 on VM Instance.
crypto_change_requires_reboot Read-write True if the current changes made by user requires a reboot of the VM else false.
vrid_list_ipv4_10_2 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/2 for IPV4 VMAC Generation.
if_1_8 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 1/8 on VM Instance.
vrid_list_ipv4_10_1 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/1 for IPV4 VMAC Generation.
vrid_list_ipv6_10_2 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/2 for IPV6 VMAC Generation.
if_10_2 Read-write This property is deprecated by network_interfaces;ltbr;gtNetwork 10/2 on VM Instance.
vrid_list_ipv6_10_1 <String[]> Read-write This property is deprecated by network_interfaces;ltbr;gtVRID List for Interface 10/1 for IPV6 VMAC Generation.
clusterid Read-only Cluster Id.
instance_state Read-only State of device, UP only if device accessible.
disk_space Read-only Show Disk Space (GB) available to VM Instance.
diskavail Read-only Citrix ADC Disk Available(MB).
cpu_core_pe Read-only Packet Engine cores assigned to VM Instance.
disk1_used Read-only Disk1 used space in percentage.
clip Read-only Cluster IP Address.
preferred_cpu_socket Read-only Preferred CPU Socket.
device_uuid Read-only Device UUID.
version Read-only Device Version.
vm_memory_used Read-only Memory Used (MB) by VM Instance.
health Read-only Node Health.
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.
cpu_core_mgmt Read-only Management CPU cores assigned to VM Instance.
ssl_virtual_functions Read-only SSL Virtual Functions assigned to VM Instance.
disk0_total Read-only Disk0 total space in MB.
http_req Read-only HTTP Requests/second.
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.
status Read-only Status of managed device.
systemname Read-only Device System Name.
mac_eth0 Read-only MAC Address of eth0 on VM Instance.
ns_memory_usage Read-only Memory Usage (%).
vm_tx Read-only Out Throughput of VM Instance in Mbps.
vm_memory_free Read-only Free Memory (MB) available in VM Instance.
vm_memory_usage Read-only Memory Usage (%) of VM Instance.
vm_cpu_usage Read-only CPU Usage (%) of VM Instance.
sdxtools_http_port Read-only Http Port number to communicate to SDXTools.
reason Read-only Reason of failure for this managed device.
virtual_functions Read-only Virtual Functions assigned to VM Instance depending on SDX platform.
ns_total_tx Read-only Total Tx of Citrix ADC Instance in Mbits.
upsince Read-only Upsince of managed device.
domid Read-only DOM Id assigned to VM Instance viewed in hypervisor.
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.
has_sdxtools Read-only True if SDX Tools are installed on this VM.
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.
if_0_3 Read-only Network 0/3 on VM Instance.
diskused Read-only Citrix ADC Disk Used(MB).
uptime Read-only Uptime of device.
cpu_license_type Read-only VCPU license 0 = No VCPU License, 1 = VCPU Pool license.
assigned_cpu_socket Read-only Assigned CPU Socket 0 or 1.
ns_cpu_usage Read-only CPU Usage (%) of Citrix ADC Instance.
sdxtools_public_key Read-only SDXTools HTTPS Public Key.
ns_rx Read-only In Throughput of Citrix ADC Instance in Mbps.
vm_description Read-only Description of the VM instance.
vm_rx Read-only In Throughput of VM Instance in Mbps.
disk_allocation Read-only Disk allocation for VM Instance.
diskperusage Read-only Citrix ADC Disk Utilization (%).
disk1_total Read-only Disk1 total space in MB.
disk0_used Read-only Disk0 used space in percentage.
ns_total_rx Read-only Total Rx of Citrix ADC Instance in Mbits.
sdxtools_version Read-only SDXTools version running on VM Instance.
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
  • STOP
  • ADD
  • PROVISION_CPX
  • FORCE_REBOOT
  • GET (ALL)
  • GET
  • DELETE
  • UPDATE
  • FORCE_STOP
  • START

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}

stop

URL: https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=stop;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}

add

URL: https://<MGMT-IP>/nitro/v2/config/ns?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": { <b>"ip_address":<String_value></b>, "vlan_1_2":<Integer_value>, "ns_ip_address":<String_value>, "std_bw_config":<Integer_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "vlan_id_0_1":<Integer_value>, "if_10_4":<Boolean_value>, "name":<String_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value[]>, "vrid_list_ipv6_1_1":<String_value[]>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "vrid_list_ipv6_10_5":<String_value[]>, "vrid_list_ipv6_1_8":<String_value[]>, "vcpu_config":<Integer_value>, "nsvlan_tagged":<Boolean_value>, "netmask":<String_value>, "save_config":<Boolean_value>, "ent_bw_config":<Integer_value>, "vrid_list_ipv6_1_6":<String_value[]>, "profile_username":<String_value>, "datacenter_id":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "instance_mode":<String_value>, "vrid_list_ipv6_1_4":<String_value[]>, "vlan_1_4":<Integer_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "vrid_list_ipv4_1_7":<String_value[]>, "vrid_list_ipv6_10_8":<String_value[]>, "internal_ip_address":<String_value>, "receiveuntagged_10_2":<Boolean_value>, "vrid_list_ipv4_1_5":<String_value[]>, "profile_password":<String_value>, "if_0_1":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "if_1_7":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value[]>, "plt_bw_total":<Integer_value>, "host_ip_address":<String_value>, "id":<String_value>, "receiveuntagged_1_2":<Boolean_value>, "vlan_10_1":<Integer_value>, "vlan_10_7":<Integer_value>, "ipv6_address":<String_value>, "mgmt_ip_address":<String_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "vrid_list_ipv6_10_7":<String_value[]>, "vlan_10_2":<Integer_value>, "receiveuntagged_1_8":<Boolean_value>, "vrid_list_ipv4_10_6":<String_value[]>, "vrid_list_ipv4_10_4":<String_value[]>, "type":<String_value>, "throughput":<Double_value>, "if_1_6":<Boolean_value>, "template_name":<String_value>, "gateway":<String_value>, "nsvlan_interfaces":<String_value[]>, "if_1_4":<Boolean_value>, "iscco":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value[]>, "if_1_1":<Boolean_value>, "vlan_10_8":<Integer_value>, "number_of_scu":<Integer_value>, "crypto_change_requires_reboot":<Boolean_value>, "license":<String_value>, "vrid_list_ipv4_10_1":<String_value[]>, "domain_name":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value[]>, "if_0_2":<Boolean_value>, "vrid_list_ipv4_1_2":<String_value[]>, "image_name":<String_value>, "vlan_1_7":<Integer_value>, "hostname":<String_value>, "vrid_list_ipv6_1_2":<String_value[]>, "vm_memory_total":<Double_value>, "vrid_list_ipv4_1_4":<String_value[]>, "vrid_list_ipv6_10_6":<String_value[]>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "fips_partition_name":<String_value>, "vrid_list_ipv6_10_4":<String_value[]>, "vrid_list_ipv6_1_3":<String_value[]>, "if_10_3":<Boolean_value>, "nsvlan_id":<Integer_value>, "receiveuntagged_10_4":<Boolean_value>, "vlan_10_6":<Integer_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "if_10_5":<Boolean_value>, "is_new_crypto":<Boolean_value>, "metrics_collection":<Boolean_value>, "if_10_7":<Boolean_value>, "is_managed":<Boolean_value>, "receiveuntagged_1_6":<Boolean_value>, "nexthop_v6":<String_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "ipv4_address":<String_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "profile_name":<String_value>, "vrid_list_ipv4_1_6":<String_value[]>, "vrid_list_ipv6_1_5":<String_value[]>, "backplane":<String_value>, "network_interfaces":[{ <b>"port_name":<String_value></b>, "name_server":<String_value>, "is_mgmt_ifc":<Boolean_value>, "gateway":<String_value>, "vrid_list_ipv6":<String_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "netmask":<String_value>, "ip_address":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "interface_name":<String_value>, "parent_name":<String_value>, "vlan_whitelist_array":<String_value[]>, "mac_mode":<String_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "vrid_list_ipv4_array":<String_value[]>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vrid_list_ipv6_array":<String_value[]>, "is_vlan_applied":<Boolean_value>, "vlan_whitelist":<String_value>}], "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "state":<String_value>, "last_updated_time":<Double_value>, "if_10_1":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vrid_list_ipv4_1_3":<String_value[]>, "vlan_1_6":<Integer_value>, "license_edition":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value[]>, "vlan_1_1":<Integer_value>, "customid":<String_value>, "vlan_1_8":<Integer_value>, "license_grace_time":<Integer_value>, "receiveuntagged_10_5":<Boolean_value>, "vrid_list_ipv4_10_3":<String_value[]>, "vrid_list_ipv4_1_8":<String_value[]>, "la_mgmt":<Boolean_value>, "vlan_id_0_2":<Integer_value>, "number_of_ssl_cores":<Integer_value>, "vlan_1_3":<Integer_value>, "if_10_6":<Boolean_value>, "receiveuntagged_10_3":<Boolean_value>, "number_of_ssl_cards":<Integer_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "vrid_list_ipv4_10_5":<String_value[]>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "node_id":<String_value>, "vrid_list_ipv4_10_7":<String_value[]>, "throughput_allocation_mode":<Integer_value>, "number_of_cores":<Integer_value>, "receiveuntagged_1_3":<Boolean_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "vrid_list_ipv4_10_2":<String_value[]>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv6_10_2":<String_value[]>, "nexthop":<String_value>, "plt_bw_config":<Integer_value>}}

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, "ns":[{ "clusterid":<Integer_value>, "is_grace":<Boolean_value>, "std_bw_config":<Integer_value>, "ns_ip_address":<String_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "instance_state":<String_value>, "vlan_id_0_1":<Integer_value>, "name":<String_value>, "disk_space":<Double_value>, "nsvlan_interfaces_db":<String_value>, "diskavail":<Integer_value>, "cpu_core_pe":<String_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "disk1_used":<Double_value>, "vcpu_config":<Integer_value>, "clip":<String_value>, "nsvlan_tagged":<Boolean_value>, "preferred_cpu_socket":<String_value>, "netmask":<String_value>, "device_uuid":<String_value>, "ent_bw_config":<Integer_value>, "version":<String_value>, "datacenter_id":<String_value>, "old_max_burst_throughput":<Double_value>, "instance_mode":<String_value>, "vm_memory_used":<Double_value>, "health":<String_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "internal_ip_address":<String_value>, "disksize":<Integer_value>, "sysid":<String_value>, "nodeid":<Integer_value>, "if_0_1":<Boolean_value>, "vm_state":<String_value>, "uuid":<String_value>, "disk1_free":<Double_value>, "cpu_core_mgmt":<String_value>, "ssl_virtual_functions":<String_value>, "old_throughput":<Double_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>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "http_req":<Double_value>, "nic_discards_in":<Double_value>, "disk0_free":<Double_value>, "type":<String_value>, "throughput":<Double_value>, "template_name":<String_value>, "nic_discards_out":<Double_value>, "status":<String_value>, "gateway":<String_value>, "systemname":<String_value>, "mac_eth0":<String_value>, "ns_memory_usage":<Double_value>, "iscco":<Boolean_value>, "vm_tx":<Double_value>, "number_of_scu":<Integer_value>, "license":<String_value>, "domain_name":<String_value>, "vm_memory_free":<Double_value>, "vm_memory_usage":<Double_value>, "vm_cpu_usage":<Double_value>, "if_0_2":<Boolean_value>, "image_name":<String_value>, "hostname":<String_value>, "is_internal_intf_added":<Boolean_value>, "vm_memory_total":<Double_value>, "sdxtools_http_port":<Integer_value>, "vnc_console_url":<String_value>, "provision_with_xva":<Boolean_value>, "reason":<String_value>, "virtual_functions":<String_value>, "ns_total_tx":<Double_value>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "is_pooled_license":<Boolean_value>, "upsince":<String_value>, "fips_partition_name":<String_value>, "domid":<Double_value>, "user_driven":<Boolean_value>, "nsvlan_id":<Integer_value>, "host_type":<String_value>, "tenant_id":<String_value>, "ns_mgmt_cpu_usage":<Double_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "do_config":<Boolean_value>, "metrics_collection":<Boolean_value>, "host_id":<String_value>, "has_sdxtools":<Boolean_value>, "is_managed":<Boolean_value>, "system_hardwareversion":<String_value>, "ns_tx":<Double_value>, "number_of_cpu":<Integer_value>, "nexthop_v6":<String_value>, "ipv4_address":<String_value>, "profile_name":<String_value>, "seq_no":<Double_value>, "is_swg":<Boolean_value>, "dns":<String_value>, "backplane":<String_value>, "if_0_3":<Boolean_value>, "diskused":<Integer_value>, "network_interfaces":[{ "device_channel_name":<String_value>, "is_mgmt_ifc":<Boolean_value>, "name_server":<String_value>, "vrid_list_ipv6":<String_value>, "gateway":<String_value>, "channel_tag_all_vlans":<Boolean_value>, "xen_vf_index":<Integer_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "parent_channel_id":<String_value>, "channel_type":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "ip_address":<String_value>, "netmask":<String_value>, "port_name":<String_value>, "parent_name":<String_value>, "channel_timeout":<String_value>, "mac_mode":<String_value>, "channel_ha_monitoring":<Boolean_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vlan_whitelist":<String_value> "interface_name":<String_value> "vrid_list_ipv4_array":<String_value> "vrid_list_ipv6_array":<String_value> "vlan_whitelist_array":<String_value> "is_vlan_applied":<Boolean_value>}], "state":<String_value>, "task_id":<String_value>, "last_updated_time":<Double_value>, "uptime":<String_value>, "license_edition":<String_value>, "cpu_license_type":<Integer_value>, "customid":<String_value>, "license_grace_time":<Integer_value>, "la_mgmt":<Boolean_value>, "assigned_cpu_socket":<String_value>, "vlan_id_0_2":<Integer_value>, "ns_cpu_usage":<Double_value>, "number_of_ssl_cores":<Integer_value>, "number_of_ssl_cards":<Integer_value>, "sdxtools_public_key":<String_value>, "ns_rx":<Double_value>, "user_profile_name":<String_value>, "vm_description":<String_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "vm_rx":<Double_value>, "node_id":<String_value>, "privStr":<String_value>, "disk_allocation":<String_value>, "diskperusage":<Integer_value>, "ip_address":<String_value>, "throughput_allocation_mode":<Integer_value>, "ping_state":<Integer_value>, "number_of_cores":<Integer_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "disk1_total":<Double_value>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "disk0_used":<Double_value>, "nexthop":<String_value>, "ns_total_rx":<Double_value>, "plt_bw_config":<Integer_value>, "formation_instance_id":<String_value>, "sdxtools_version":<String_value>, "parent_inventory":<Boolean_value>, "vlan_1_2":<Integer_value>, "vrid_list_ipv4_1_2":<String_value>, "vlan_1_7":<Integer_value>, "vrid_list_ipv6_1_2":<String_value>, "vrid_list_ipv4_1_4":<String_value>, "act_id":<String_value>, "vrid_list_ipv6_10_6":<String_value>, "if_10_4":<Boolean_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value>, "vrid_list_ipv6_1_1":<String_value>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "vrid_list_ipv6_10_4":<String_value>, "vrid_list_ipv6_1_3":<String_value>, "if_10_3":<Boolean_value>, "xva_desc_present":<Boolean_value>, "vrid_list_ipv6_10_5":<String_value>, "receiveuntagged_10_4":<Boolean_value>, "advertise_vm_uuid":<String_value>, "vrid_list_ipv6_1_8":<String_value>, "vlan_10_6":<Integer_value>, "if_10_5":<Boolean_value>, "save_config":<Boolean_value>, "is_new_crypto":<Boolean_value>, "delete_template_name":<String_value>, "vrid_list_ipv6_1_6":<String_value>, "profile_username":<String_value>, "if_10_7":<Boolean_value>, "default_password":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "vrid_list_ipv6_1_4":<String_value>, "receiveuntagged_1_6":<Boolean_value>, "vlan_1_4":<Integer_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "vrid_list_ipv4_1_6":<String_value>, "vrid_list_ipv6_1_5":<String_value>, "vrid_list_ipv6_10_8":<String_value>, "vrid_list_ipv4_1_7":<String_value>, "make_vm_ready":<Boolean_value>, "receiveuntagged_10_2":<Boolean_value>, "profile_password":<String_value>, "vrid_list_ipv4_1_5":<String_value>, "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "if_1_7":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value>, "if_10_1":<Boolean_value>, "diff_exists":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vlan_10_7":<Integer_value>, "vlan_10_1":<Integer_value>, "receiveuntagged_1_2":<Boolean_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "vlan_1_6":<Integer_value>, "vrid_list_ipv4_1_3":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value>, "vlan_1_1":<Integer_value>, "vrid_list_ipv6_10_7":<String_value>, "vlan_1_8":<Integer_value>, "vrid_list_ipv4_10_3":<String_value>, "receiveuntagged_10_5":<Boolean_value>, "vlan_10_2":<Integer_value>, "vrid_list_ipv4_10_6":<String_value>, "vrid_list_ipv4_1_8":<String_value>, "receiveuntagged_1_8":<Boolean_value>, "sync_operation":<Boolean_value>, "additional_info":<String_value>, "vrid_list_ipv4_10_4":<String_value>, "vlan_1_3":<Integer_value>, "receiveuntagged_10_3":<Boolean_value>, "if_10_6":<Boolean_value>, "if_1_6":<Boolean_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "vpx_image_dir":<String_value>, "nsvlan_interfaces":<String_value>, "vrid_list_ipv4_10_5":<String_value>, "if_1_4":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value>, "if_1_1":<Boolean_value>, "vrid_list_ipv4_10_7":<String_value>, "vlan_10_8":<Integer_value>, "convert_template_name":<String_value>, "receiveuntagged_1_3":<Boolean_value>, "crypto_change_requires_reboot":<Boolean_value>, "vrid_list_ipv4_10_2":<String_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv4_10_1":<String_value>, "vrid_list_ipv6_10_2":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value>}]}

provision_cpx

URL: https://<MGMT-IP>/nitro/v2/config/ns?action=provision_cpx;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": { "vlan_1_2":<Integer_value>, "ns_ip_address":<String_value>, "std_bw_config":<Integer_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "vlan_id_0_1":<Integer_value>, "if_10_4":<Boolean_value>, "name":<String_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value[]>, "vrid_list_ipv6_1_1":<String_value[]>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "plugin_ip_address":<String_value>, "mastools_version":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "vrid_list_ipv6_10_5":<String_value[]>, "vrid_list_ipv6_1_8":<String_value[]>, "vcpu_config":<Integer_value>, "nsvlan_tagged":<Boolean_value>, "netmask":<String_value>, "save_config":<Boolean_value>, "ent_bw_config":<Integer_value>, "vrid_list_ipv6_1_6":<String_value[]>, "profile_username":<String_value>, "datacenter_id":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "instance_mode":<String_value>, "vrid_list_ipv6_1_4":<String_value[]>, "vlan_1_4":<Integer_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "vrid_list_ipv4_1_7":<String_value[]>, "vrid_list_ipv6_10_8":<String_value[]>, "internal_ip_address":<String_value>, "receiveuntagged_10_2":<Boolean_value>, "vrid_list_ipv4_1_5":<String_value[]>, "profile_password":<String_value>, "if_0_1":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "if_1_7":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value[]>, "host_ip_address":<String_value>, "plt_bw_total":<Integer_value>, "id":<String_value>, "receiveuntagged_1_2":<Boolean_value>, "vlan_10_1":<Integer_value>, "vlan_10_7":<Integer_value>, "mgmt_ip_address":<String_value>, "ipv6_address":<String_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "vrid_list_ipv6_10_7":<String_value[]>, "vlan_10_2":<Integer_value>, "receiveuntagged_1_8":<Boolean_value>, "vrid_list_ipv4_10_6":<String_value[]>, "vrid_list_ipv4_10_4":<String_value[]>, "throughput":<Double_value>, "type":<String_value>, "if_1_6":<Boolean_value>, "template_name":<String_value>, "gateway":<String_value>, "nsvlan_interfaces":<String_value[]>, "if_1_4":<Boolean_value>, "iscco":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value[]>, "if_1_1":<Boolean_value>, "vlan_10_8":<Integer_value>, "number_of_scu":<Integer_value>, "crypto_change_requires_reboot":<Boolean_value>, "license":<String_value>, "vrid_list_ipv4_10_1":<String_value[]>, "domain_name":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value[]>, "if_0_2":<Boolean_value>, "vrid_list_ipv4_1_2":<String_value[]>, "vlan_1_7":<Integer_value>, "image_name":<String_value>, "vrid_list_ipv6_1_2":<String_value[]>, "hostname":<String_value>, "vrid_list_ipv4_1_4":<String_value[]>, "vm_memory_total":<Double_value>, "vrid_list_ipv6_10_6":<String_value[]>, "description":<String_value>, "ent_bw_available":<Integer_value>, "username":<String_value>, "fips_partition_name":<String_value>, "vrid_list_ipv6_10_4":<String_value[]>, "if_10_3":<Boolean_value>, "vrid_list_ipv6_1_3":<String_value[]>, "receiveuntagged_10_4":<Boolean_value>, "nsvlan_id":<Integer_value>, "vlan_10_6":<Integer_value>, "if_10_5":<Boolean_value>, "burst_priority":<Integer_value>, "num_pes":<Integer_value>, "is_new_crypto":<Boolean_value>, "metrics_collection":<Boolean_value>, "if_10_7":<Boolean_value>, "is_managed":<Boolean_value>, "receiveuntagged_1_6":<Boolean_value>, "nexthop_v6":<String_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "receiveuntagged_10_6":<Boolean_value>, "ipv4_address":<String_value>, "receiveuntagged_10_1":<Boolean_value>, "vrid_list_ipv6_1_5":<String_value[]>, "vrid_list_ipv4_1_6":<String_value[]>, "profile_name":<String_value>, "backplane":<String_value>, "receiveuntagged_1_7":<Boolean_value>, "network_interfaces":[{ <b>"port_name":<String_value></b>, "name_server":<String_value>, "is_mgmt_ifc":<Boolean_value>, "gateway":<String_value>, "vrid_list_ipv6":<String_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "netmask":<String_value>, "ip_address":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "interface_name":<String_value>, "parent_name":<String_value>, "vlan_whitelist_array":<String_value[]>, "mac_mode":<String_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "vrid_list_ipv4_array":<String_value[]>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vrid_list_ipv6_array":<String_value[]>, "is_vlan_applied":<Boolean_value>, "vlan_whitelist":<String_value>}], "vlan_10_4":<Integer_value>, "state":<String_value>, "last_updated_time":<Double_value>, "if_10_1":<Boolean_value>, "l2_enabled":<Boolean_value>, "if_10_8":<Boolean_value>, "vrid_list_ipv4_1_3":<String_value[]>, "vlan_1_6":<Integer_value>, "license_edition":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value[]>, "vlan_1_1":<Integer_value>, "customid":<String_value>, "vlan_1_8":<Integer_value>, "license_grace_time":<Integer_value>, "receiveuntagged_10_5":<Boolean_value>, "vrid_list_ipv4_10_3":<String_value[]>, "vrid_list_ipv4_1_8":<String_value[]>, "la_mgmt":<Boolean_value>, "vlan_id_0_2":<Integer_value>, "number_of_ssl_cores":<Integer_value>, "vlan_1_3":<Integer_value>, "if_10_6":<Boolean_value>, "receiveuntagged_10_3":<Boolean_value>, "number_of_ssl_cards":<Integer_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "vrid_list_ipv4_10_5":<String_value[]>, "cmd_policy":<String_value>, "if_internal_ip_enabled":<Boolean_value>, "node_id":<String_value>, "ip_address":<String_value>, "vrid_list_ipv4_10_7":<String_value[]>, "throughput_allocation_mode":<Integer_value>, "number_of_cores":<Integer_value>, "receiveuntagged_1_3":<Boolean_value>, "plugin_netmask":<String_value>, "pps":<Double_value>, "vrid_list_ipv4_10_2":<String_value[]>, "std_bw_total":<Integer_value>, "display_name":<String_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv6_10_2":<String_value[]>, "nexthop":<String_value>, "plt_bw_config":<Integer_value>}}

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, "ns":[{ "clusterid":<Integer_value>, "is_grace":<Boolean_value>, "std_bw_config":<Integer_value>, "ns_ip_address":<String_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "instance_state":<String_value>, "vlan_id_0_1":<Integer_value>, "name":<String_value>, "disk_space":<Double_value>, "nsvlan_interfaces_db":<String_value>, "diskavail":<Integer_value>, "cpu_core_pe":<String_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "disk1_used":<Double_value>, "vcpu_config":<Integer_value>, "clip":<String_value>, "nsvlan_tagged":<Boolean_value>, "preferred_cpu_socket":<String_value>, "netmask":<String_value>, "device_uuid":<String_value>, "ent_bw_config":<Integer_value>, "version":<String_value>, "datacenter_id":<String_value>, "old_max_burst_throughput":<Double_value>, "instance_mode":<String_value>, "vm_memory_used":<Double_value>, "health":<String_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "internal_ip_address":<String_value>, "disksize":<Integer_value>, "sysid":<String_value>, "nodeid":<Integer_value>, "if_0_1":<Boolean_value>, "vm_state":<String_value>, "uuid":<String_value>, "disk1_free":<Double_value>, "cpu_core_mgmt":<String_value>, "ssl_virtual_functions":<String_value>, "old_throughput":<Double_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>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "http_req":<Double_value>, "nic_discards_in":<Double_value>, "disk0_free":<Double_value>, "type":<String_value>, "throughput":<Double_value>, "template_name":<String_value>, "nic_discards_out":<Double_value>, "status":<String_value>, "gateway":<String_value>, "systemname":<String_value>, "mac_eth0":<String_value>, "ns_memory_usage":<Double_value>, "iscco":<Boolean_value>, "vm_tx":<Double_value>, "number_of_scu":<Integer_value>, "license":<String_value>, "domain_name":<String_value>, "vm_memory_free":<Double_value>, "vm_memory_usage":<Double_value>, "vm_cpu_usage":<Double_value>, "if_0_2":<Boolean_value>, "image_name":<String_value>, "hostname":<String_value>, "is_internal_intf_added":<Boolean_value>, "vm_memory_total":<Double_value>, "sdxtools_http_port":<Integer_value>, "vnc_console_url":<String_value>, "provision_with_xva":<Boolean_value>, "reason":<String_value>, "virtual_functions":<String_value>, "ns_total_tx":<Double_value>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "is_pooled_license":<Boolean_value>, "upsince":<String_value>, "fips_partition_name":<String_value>, "domid":<Double_value>, "user_driven":<Boolean_value>, "nsvlan_id":<Integer_value>, "host_type":<String_value>, "tenant_id":<String_value>, "ns_mgmt_cpu_usage":<Double_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "do_config":<Boolean_value>, "metrics_collection":<Boolean_value>, "host_id":<String_value>, "has_sdxtools":<Boolean_value>, "is_managed":<Boolean_value>, "system_hardwareversion":<String_value>, "ns_tx":<Double_value>, "number_of_cpu":<Integer_value>, "nexthop_v6":<String_value>, "ipv4_address":<String_value>, "profile_name":<String_value>, "seq_no":<Double_value>, "is_swg":<Boolean_value>, "dns":<String_value>, "backplane":<String_value>, "if_0_3":<Boolean_value>, "diskused":<Integer_value>, "network_interfaces":[{ "device_channel_name":<String_value>, "is_mgmt_ifc":<Boolean_value>, "name_server":<String_value>, "vrid_list_ipv6":<String_value>, "gateway":<String_value>, "channel_tag_all_vlans":<Boolean_value>, "xen_vf_index":<Integer_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "parent_channel_id":<String_value>, "channel_type":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "ip_address":<String_value>, "netmask":<String_value>, "port_name":<String_value>, "parent_name":<String_value>, "channel_timeout":<String_value>, "mac_mode":<String_value>, "channel_ha_monitoring":<Boolean_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vlan_whitelist":<String_value> "interface_name":<String_value> "vrid_list_ipv4_array":<String_value> "vrid_list_ipv6_array":<String_value> "vlan_whitelist_array":<String_value> "is_vlan_applied":<Boolean_value>}], "state":<String_value>, "task_id":<String_value>, "last_updated_time":<Double_value>, "uptime":<String_value>, "license_edition":<String_value>, "cpu_license_type":<Integer_value>, "customid":<String_value>, "license_grace_time":<Integer_value>, "la_mgmt":<Boolean_value>, "assigned_cpu_socket":<String_value>, "vlan_id_0_2":<Integer_value>, "ns_cpu_usage":<Double_value>, "number_of_ssl_cores":<Integer_value>, "number_of_ssl_cards":<Integer_value>, "sdxtools_public_key":<String_value>, "ns_rx":<Double_value>, "user_profile_name":<String_value>, "vm_description":<String_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "vm_rx":<Double_value>, "node_id":<String_value>, "privStr":<String_value>, "disk_allocation":<String_value>, "diskperusage":<Integer_value>, "ip_address":<String_value>, "throughput_allocation_mode":<Integer_value>, "ping_state":<Integer_value>, "number_of_cores":<Integer_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "disk1_total":<Double_value>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "disk0_used":<Double_value>, "nexthop":<String_value>, "ns_total_rx":<Double_value>, "plt_bw_config":<Integer_value>, "formation_instance_id":<String_value>, "sdxtools_version":<String_value>, "parent_inventory":<Boolean_value>, "vlan_1_2":<Integer_value>, "vrid_list_ipv4_1_2":<String_value>, "vlan_1_7":<Integer_value>, "vrid_list_ipv6_1_2":<String_value>, "vrid_list_ipv4_1_4":<String_value>, "act_id":<String_value>, "vrid_list_ipv6_10_6":<String_value>, "if_10_4":<Boolean_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value>, "vrid_list_ipv6_1_1":<String_value>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "vrid_list_ipv6_10_4":<String_value>, "vrid_list_ipv6_1_3":<String_value>, "if_10_3":<Boolean_value>, "xva_desc_present":<Boolean_value>, "vrid_list_ipv6_10_5":<String_value>, "receiveuntagged_10_4":<Boolean_value>, "advertise_vm_uuid":<String_value>, "vrid_list_ipv6_1_8":<String_value>, "vlan_10_6":<Integer_value>, "if_10_5":<Boolean_value>, "save_config":<Boolean_value>, "is_new_crypto":<Boolean_value>, "delete_template_name":<String_value>, "vrid_list_ipv6_1_6":<String_value>, "profile_username":<String_value>, "if_10_7":<Boolean_value>, "default_password":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "vrid_list_ipv6_1_4":<String_value>, "receiveuntagged_1_6":<Boolean_value>, "vlan_1_4":<Integer_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "vrid_list_ipv4_1_6":<String_value>, "vrid_list_ipv6_1_5":<String_value>, "vrid_list_ipv6_10_8":<String_value>, "vrid_list_ipv4_1_7":<String_value>, "make_vm_ready":<Boolean_value>, "receiveuntagged_10_2":<Boolean_value>, "profile_password":<String_value>, "vrid_list_ipv4_1_5":<String_value>, "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "if_1_7":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value>, "if_10_1":<Boolean_value>, "diff_exists":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vlan_10_7":<Integer_value>, "vlan_10_1":<Integer_value>, "receiveuntagged_1_2":<Boolean_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "vlan_1_6":<Integer_value>, "vrid_list_ipv4_1_3":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value>, "vlan_1_1":<Integer_value>, "vrid_list_ipv6_10_7":<String_value>, "vlan_1_8":<Integer_value>, "vrid_list_ipv4_10_3":<String_value>, "receiveuntagged_10_5":<Boolean_value>, "vlan_10_2":<Integer_value>, "vrid_list_ipv4_10_6":<String_value>, "vrid_list_ipv4_1_8":<String_value>, "receiveuntagged_1_8":<Boolean_value>, "sync_operation":<Boolean_value>, "additional_info":<String_value>, "vrid_list_ipv4_10_4":<String_value>, "vlan_1_3":<Integer_value>, "receiveuntagged_10_3":<Boolean_value>, "if_10_6":<Boolean_value>, "if_1_6":<Boolean_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "vpx_image_dir":<String_value>, "nsvlan_interfaces":<String_value>, "vrid_list_ipv4_10_5":<String_value>, "if_1_4":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value>, "if_1_1":<Boolean_value>, "vrid_list_ipv4_10_7":<String_value>, "vlan_10_8":<Integer_value>, "convert_template_name":<String_value>, "receiveuntagged_1_3":<Boolean_value>, "crypto_change_requires_reboot":<Boolean_value>, "vrid_list_ipv4_10_2":<String_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv4_10_1":<String_value>, "vrid_list_ipv6_10_2":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value>}]}

force_reboot

URL: https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=force_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}

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":[{ "clusterid":<Integer_value>, "is_grace":<Boolean_value>, "std_bw_config":<Integer_value>, "ns_ip_address":<String_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "instance_state":<String_value>, "vlan_id_0_1":<Integer_value>, "name":<String_value>, "disk_space":<Double_value>, "nsvlan_interfaces_db":<String_value>, "diskavail":<Integer_value>, "cpu_core_pe":<String_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "disk1_used":<Double_value>, "vcpu_config":<Integer_value>, "clip":<String_value>, "nsvlan_tagged":<Boolean_value>, "preferred_cpu_socket":<String_value>, "netmask":<String_value>, "device_uuid":<String_value>, "ent_bw_config":<Integer_value>, "version":<String_value>, "datacenter_id":<String_value>, "old_max_burst_throughput":<Double_value>, "instance_mode":<String_value>, "vm_memory_used":<Double_value>, "health":<String_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "internal_ip_address":<String_value>, "disksize":<Integer_value>, "sysid":<String_value>, "nodeid":<Integer_value>, "if_0_1":<Boolean_value>, "vm_state":<String_value>, "uuid":<String_value>, "disk1_free":<Double_value>, "cpu_core_mgmt":<String_value>, "ssl_virtual_functions":<String_value>, "old_throughput":<Double_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>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "http_req":<Double_value>, "nic_discards_in":<Double_value>, "disk0_free":<Double_value>, "type":<String_value>, "throughput":<Double_value>, "template_name":<String_value>, "nic_discards_out":<Double_value>, "status":<String_value>, "gateway":<String_value>, "systemname":<String_value>, "mac_eth0":<String_value>, "ns_memory_usage":<Double_value>, "iscco":<Boolean_value>, "vm_tx":<Double_value>, "number_of_scu":<Integer_value>, "license":<String_value>, "domain_name":<String_value>, "vm_memory_free":<Double_value>, "vm_memory_usage":<Double_value>, "vm_cpu_usage":<Double_value>, "if_0_2":<Boolean_value>, "image_name":<String_value>, "hostname":<String_value>, "is_internal_intf_added":<Boolean_value>, "vm_memory_total":<Double_value>, "sdxtools_http_port":<Integer_value>, "vnc_console_url":<String_value>, "provision_with_xva":<Boolean_value>, "reason":<String_value>, "virtual_functions":<String_value>, "ns_total_tx":<Double_value>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "is_pooled_license":<Boolean_value>, "upsince":<String_value>, "fips_partition_name":<String_value>, "domid":<Double_value>, "user_driven":<Boolean_value>, "nsvlan_id":<Integer_value>, "host_type":<String_value>, "tenant_id":<String_value>, "ns_mgmt_cpu_usage":<Double_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "do_config":<Boolean_value>, "metrics_collection":<Boolean_value>, "host_id":<String_value>, "has_sdxtools":<Boolean_value>, "is_managed":<Boolean_value>, "system_hardwareversion":<String_value>, "ns_tx":<Double_value>, "number_of_cpu":<Integer_value>, "nexthop_v6":<String_value>, "ipv4_address":<String_value>, "profile_name":<String_value>, "seq_no":<Double_value>, "is_swg":<Boolean_value>, "dns":<String_value>, "backplane":<String_value>, "if_0_3":<Boolean_value>, "diskused":<Integer_value>, "network_interfaces":[{ "device_channel_name":<String_value>, "is_mgmt_ifc":<Boolean_value>, "name_server":<String_value>, "vrid_list_ipv6":<String_value>, "gateway":<String_value>, "channel_tag_all_vlans":<Boolean_value>, "xen_vf_index":<Integer_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "parent_channel_id":<String_value>, "channel_type":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "ip_address":<String_value>, "netmask":<String_value>, "port_name":<String_value>, "parent_name":<String_value>, "channel_timeout":<String_value>, "mac_mode":<String_value>, "channel_ha_monitoring":<Boolean_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vlan_whitelist":<String_value> "interface_name":<String_value> "vrid_list_ipv4_array":<String_value> "vrid_list_ipv6_array":<String_value> "vlan_whitelist_array":<String_value> "is_vlan_applied":<Boolean_value>}], "state":<String_value>, "task_id":<String_value>, "last_updated_time":<Double_value>, "uptime":<String_value>, "license_edition":<String_value>, "cpu_license_type":<Integer_value>, "customid":<String_value>, "license_grace_time":<Integer_value>, "la_mgmt":<Boolean_value>, "assigned_cpu_socket":<String_value>, "vlan_id_0_2":<Integer_value>, "ns_cpu_usage":<Double_value>, "number_of_ssl_cores":<Integer_value>, "number_of_ssl_cards":<Integer_value>, "sdxtools_public_key":<String_value>, "ns_rx":<Double_value>, "user_profile_name":<String_value>, "vm_description":<String_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "vm_rx":<Double_value>, "node_id":<String_value>, "privStr":<String_value>, "disk_allocation":<String_value>, "diskperusage":<Integer_value>, "ip_address":<String_value>, "throughput_allocation_mode":<Integer_value>, "ping_state":<Integer_value>, "number_of_cores":<Integer_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "disk1_total":<Double_value>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "disk0_used":<Double_value>, "nexthop":<String_value>, "ns_total_rx":<Double_value>, "plt_bw_config":<Integer_value>, "formation_instance_id":<String_value>, "sdxtools_version":<String_value>, "parent_inventory":<Boolean_value>, "vlan_1_2":<Integer_value>, "vrid_list_ipv4_1_2":<String_value>, "vlan_1_7":<Integer_value>, "vrid_list_ipv6_1_2":<String_value>, "vrid_list_ipv4_1_4":<String_value>, "act_id":<String_value>, "vrid_list_ipv6_10_6":<String_value>, "if_10_4":<Boolean_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value>, "vrid_list_ipv6_1_1":<String_value>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "vrid_list_ipv6_10_4":<String_value>, "vrid_list_ipv6_1_3":<String_value>, "if_10_3":<Boolean_value>, "xva_desc_present":<Boolean_value>, "vrid_list_ipv6_10_5":<String_value>, "receiveuntagged_10_4":<Boolean_value>, "advertise_vm_uuid":<String_value>, "vrid_list_ipv6_1_8":<String_value>, "vlan_10_6":<Integer_value>, "if_10_5":<Boolean_value>, "save_config":<Boolean_value>, "is_new_crypto":<Boolean_value>, "delete_template_name":<String_value>, "vrid_list_ipv6_1_6":<String_value>, "profile_username":<String_value>, "if_10_7":<Boolean_value>, "default_password":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "vrid_list_ipv6_1_4":<String_value>, "receiveuntagged_1_6":<Boolean_value>, "vlan_1_4":<Integer_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "vrid_list_ipv4_1_6":<String_value>, "vrid_list_ipv6_1_5":<String_value>, "vrid_list_ipv6_10_8":<String_value>, "vrid_list_ipv4_1_7":<String_value>, "make_vm_ready":<Boolean_value>, "receiveuntagged_10_2":<Boolean_value>, "profile_password":<String_value>, "vrid_list_ipv4_1_5":<String_value>, "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "if_1_7":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value>, "if_10_1":<Boolean_value>, "diff_exists":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vlan_10_7":<Integer_value>, "vlan_10_1":<Integer_value>, "receiveuntagged_1_2":<Boolean_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "vlan_1_6":<Integer_value>, "vrid_list_ipv4_1_3":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value>, "vlan_1_1":<Integer_value>, "vrid_list_ipv6_10_7":<String_value>, "vlan_1_8":<Integer_value>, "vrid_list_ipv4_10_3":<String_value>, "receiveuntagged_10_5":<Boolean_value>, "vlan_10_2":<Integer_value>, "vrid_list_ipv4_10_6":<String_value>, "vrid_list_ipv4_1_8":<String_value>, "receiveuntagged_1_8":<Boolean_value>, "sync_operation":<Boolean_value>, "additional_info":<String_value>, "vrid_list_ipv4_10_4":<String_value>, "vlan_1_3":<Integer_value>, "receiveuntagged_10_3":<Boolean_value>, "if_10_6":<Boolean_value>, "if_1_6":<Boolean_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "vpx_image_dir":<String_value>, "nsvlan_interfaces":<String_value>, "vrid_list_ipv4_10_5":<String_value>, "if_1_4":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value>, "if_1_1":<Boolean_value>, "vrid_list_ipv4_10_7":<String_value>, "vlan_10_8":<Integer_value>, "convert_template_name":<String_value>, "receiveuntagged_1_3":<Boolean_value>, "crypto_change_requires_reboot":<Boolean_value>, "vrid_list_ipv4_10_2":<String_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv4_10_1":<String_value>, "vrid_list_ipv6_10_2":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_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":[{ "clusterid":<Integer_value>, "is_grace":<Boolean_value>, "std_bw_config":<Integer_value>, "ns_ip_address":<String_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "instance_state":<String_value>, "vlan_id_0_1":<Integer_value>, "name":<String_value>, "disk_space":<Double_value>, "nsvlan_interfaces_db":<String_value>, "diskavail":<Integer_value>, "cpu_core_pe":<String_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "disk1_used":<Double_value>, "vcpu_config":<Integer_value>, "clip":<String_value>, "nsvlan_tagged":<Boolean_value>, "preferred_cpu_socket":<String_value>, "netmask":<String_value>, "device_uuid":<String_value>, "ent_bw_config":<Integer_value>, "version":<String_value>, "datacenter_id":<String_value>, "old_max_burst_throughput":<Double_value>, "instance_mode":<String_value>, "vm_memory_used":<Double_value>, "health":<String_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "internal_ip_address":<String_value>, "disksize":<Integer_value>, "sysid":<String_value>, "nodeid":<Integer_value>, "if_0_1":<Boolean_value>, "vm_state":<String_value>, "uuid":<String_value>, "disk1_free":<Double_value>, "cpu_core_mgmt":<String_value>, "ssl_virtual_functions":<String_value>, "old_throughput":<Double_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>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "http_req":<Double_value>, "nic_discards_in":<Double_value>, "disk0_free":<Double_value>, "type":<String_value>, "throughput":<Double_value>, "template_name":<String_value>, "nic_discards_out":<Double_value>, "status":<String_value>, "gateway":<String_value>, "systemname":<String_value>, "mac_eth0":<String_value>, "ns_memory_usage":<Double_value>, "iscco":<Boolean_value>, "vm_tx":<Double_value>, "number_of_scu":<Integer_value>, "license":<String_value>, "domain_name":<String_value>, "vm_memory_free":<Double_value>, "vm_memory_usage":<Double_value>, "vm_cpu_usage":<Double_value>, "if_0_2":<Boolean_value>, "image_name":<String_value>, "hostname":<String_value>, "is_internal_intf_added":<Boolean_value>, "vm_memory_total":<Double_value>, "sdxtools_http_port":<Integer_value>, "vnc_console_url":<String_value>, "provision_with_xva":<Boolean_value>, "reason":<String_value>, "virtual_functions":<String_value>, "ns_total_tx":<Double_value>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "is_pooled_license":<Boolean_value>, "upsince":<String_value>, "fips_partition_name":<String_value>, "domid":<Double_value>, "user_driven":<Boolean_value>, "nsvlan_id":<Integer_value>, "host_type":<String_value>, "tenant_id":<String_value>, "ns_mgmt_cpu_usage":<Double_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "do_config":<Boolean_value>, "metrics_collection":<Boolean_value>, "host_id":<String_value>, "has_sdxtools":<Boolean_value>, "is_managed":<Boolean_value>, "system_hardwareversion":<String_value>, "ns_tx":<Double_value>, "number_of_cpu":<Integer_value>, "nexthop_v6":<String_value>, "ipv4_address":<String_value>, "profile_name":<String_value>, "seq_no":<Double_value>, "is_swg":<Boolean_value>, "dns":<String_value>, "backplane":<String_value>, "if_0_3":<Boolean_value>, "diskused":<Integer_value>, "network_interfaces":[{ "device_channel_name":<String_value>, "is_mgmt_ifc":<Boolean_value>, "name_server":<String_value>, "vrid_list_ipv6":<String_value>, "gateway":<String_value>, "channel_tag_all_vlans":<Boolean_value>, "xen_vf_index":<Integer_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "parent_channel_id":<String_value>, "channel_type":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "ip_address":<String_value>, "netmask":<String_value>, "port_name":<String_value>, "parent_name":<String_value>, "channel_timeout":<String_value>, "mac_mode":<String_value>, "channel_ha_monitoring":<Boolean_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vlan_whitelist":<String_value> "interface_name":<String_value> "vrid_list_ipv4_array":<String_value> "vrid_list_ipv6_array":<String_value> "vlan_whitelist_array":<String_value> "is_vlan_applied":<Boolean_value>}], "state":<String_value>, "task_id":<String_value>, "last_updated_time":<Double_value>, "uptime":<String_value>, "license_edition":<String_value>, "cpu_license_type":<Integer_value>, "customid":<String_value>, "license_grace_time":<Integer_value>, "la_mgmt":<Boolean_value>, "assigned_cpu_socket":<String_value>, "vlan_id_0_2":<Integer_value>, "ns_cpu_usage":<Double_value>, "number_of_ssl_cores":<Integer_value>, "number_of_ssl_cards":<Integer_value>, "sdxtools_public_key":<String_value>, "ns_rx":<Double_value>, "user_profile_name":<String_value>, "vm_description":<String_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "vm_rx":<Double_value>, "node_id":<String_value>, "privStr":<String_value>, "disk_allocation":<String_value>, "diskperusage":<Integer_value>, "ip_address":<String_value>, "throughput_allocation_mode":<Integer_value>, "ping_state":<Integer_value>, "number_of_cores":<Integer_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "disk1_total":<Double_value>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "disk0_used":<Double_value>, "nexthop":<String_value>, "ns_total_rx":<Double_value>, "plt_bw_config":<Integer_value>, "formation_instance_id":<String_value>, "sdxtools_version":<String_value>, "parent_inventory":<Boolean_value>, "vlan_1_2":<Integer_value>, "vrid_list_ipv4_1_2":<String_value>, "vlan_1_7":<Integer_value>, "vrid_list_ipv6_1_2":<String_value>, "vrid_list_ipv4_1_4":<String_value>, "act_id":<String_value>, "vrid_list_ipv6_10_6":<String_value>, "if_10_4":<Boolean_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value>, "vrid_list_ipv6_1_1":<String_value>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "vrid_list_ipv6_10_4":<String_value>, "vrid_list_ipv6_1_3":<String_value>, "if_10_3":<Boolean_value>, "xva_desc_present":<Boolean_value>, "vrid_list_ipv6_10_5":<String_value>, "receiveuntagged_10_4":<Boolean_value>, "advertise_vm_uuid":<String_value>, "vrid_list_ipv6_1_8":<String_value>, "vlan_10_6":<Integer_value>, "if_10_5":<Boolean_value>, "save_config":<Boolean_value>, "is_new_crypto":<Boolean_value>, "delete_template_name":<String_value>, "vrid_list_ipv6_1_6":<String_value>, "profile_username":<String_value>, "if_10_7":<Boolean_value>, "default_password":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "vrid_list_ipv6_1_4":<String_value>, "receiveuntagged_1_6":<Boolean_value>, "vlan_1_4":<Integer_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "vrid_list_ipv4_1_6":<String_value>, "vrid_list_ipv6_1_5":<String_value>, "vrid_list_ipv6_10_8":<String_value>, "vrid_list_ipv4_1_7":<String_value>, "make_vm_ready":<Boolean_value>, "receiveuntagged_10_2":<Boolean_value>, "profile_password":<String_value>, "vrid_list_ipv4_1_5":<String_value>, "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "if_1_7":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value>, "if_10_1":<Boolean_value>, "diff_exists":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vlan_10_7":<Integer_value>, "vlan_10_1":<Integer_value>, "receiveuntagged_1_2":<Boolean_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "vlan_1_6":<Integer_value>, "vrid_list_ipv4_1_3":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value>, "vlan_1_1":<Integer_value>, "vrid_list_ipv6_10_7":<String_value>, "vlan_1_8":<Integer_value>, "vrid_list_ipv4_10_3":<String_value>, "receiveuntagged_10_5":<Boolean_value>, "vlan_10_2":<Integer_value>, "vrid_list_ipv4_10_6":<String_value>, "vrid_list_ipv4_1_8":<String_value>, "receiveuntagged_1_8":<Boolean_value>, "sync_operation":<Boolean_value>, "additional_info":<String_value>, "vrid_list_ipv4_10_4":<String_value>, "vlan_1_3":<Integer_value>, "receiveuntagged_10_3":<Boolean_value>, "if_10_6":<Boolean_value>, "if_1_6":<Boolean_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "vpx_image_dir":<String_value>, "nsvlan_interfaces":<String_value>, "vrid_list_ipv4_10_5":<String_value>, "if_1_4":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value>, "if_1_1":<Boolean_value>, "vrid_list_ipv4_10_7":<String_value>, "vlan_10_8":<Integer_value>, "convert_template_name":<String_value>, "receiveuntagged_1_3":<Boolean_value>, "crypto_change_requires_reboot":<Boolean_value>, "vrid_list_ipv4_10_2":<String_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv4_10_1":<String_value>, "vrid_list_ipv6_10_2":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns/id_value<String> HTTPS Method: DELETE

Request Headers: 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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

update

URL: https://<MGMT-IP>/nitro/v2/config/ns/id_value<String> HTTPS Method: PUT

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":{ <b>"id":<String_value></b>, "vlan_1_2":<Integer_value>, "ns_ip_address":<String_value>, "std_bw_config":<Integer_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "vlan_id_0_1":<Integer_value>, "if_10_4":<Boolean_value>, "name":<String_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value[]>, "vrid_list_ipv6_1_1":<String_value[]>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "vrid_list_ipv6_10_5":<String_value[]>, "vrid_list_ipv6_1_8":<String_value[]>, "vcpu_config":<Integer_value>, "nsvlan_tagged":<Boolean_value>, "netmask":<String_value>, "save_config":<Boolean_value>, "ent_bw_config":<Integer_value>, "vrid_list_ipv6_1_6":<String_value[]>, "profile_username":<String_value>, "datacenter_id":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "instance_mode":<String_value>, "vrid_list_ipv6_1_4":<String_value[]>, "vlan_1_4":<Integer_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "vrid_list_ipv4_1_7":<String_value[]>, "vrid_list_ipv6_10_8":<String_value[]>, "internal_ip_address":<String_value>, "receiveuntagged_10_2":<Boolean_value>, "vrid_list_ipv4_1_5":<String_value[]>, "profile_password":<String_value>, "if_0_1":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "if_1_7":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value[]>, "plt_bw_total":<Integer_value>, "host_ip_address":<String_value>, "receiveuntagged_1_2":<Boolean_value>, "vlan_10_1":<Integer_value>, "vlan_10_7":<Integer_value>, "ipv6_address":<String_value>, "mgmt_ip_address":<String_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "vrid_list_ipv6_10_7":<String_value[]>, "vlan_10_2":<Integer_value>, "receiveuntagged_1_8":<Boolean_value>, "vrid_list_ipv4_10_6":<String_value[]>, "vrid_list_ipv4_10_4":<String_value[]>, "type":<String_value>, "throughput":<Double_value>, "if_1_6":<Boolean_value>, "template_name":<String_value>, "gateway":<String_value>, "nsvlan_interfaces":<String_value[]>, "if_1_4":<Boolean_value>, "iscco":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value[]>, "if_1_1":<Boolean_value>, "vlan_10_8":<Integer_value>, "number_of_scu":<Integer_value>, "crypto_change_requires_reboot":<Boolean_value>, "license":<String_value>, "vrid_list_ipv4_10_1":<String_value[]>, "domain_name":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value[]>, "if_0_2":<Boolean_value>, "vrid_list_ipv4_1_2":<String_value[]>, "image_name":<String_value>, "vlan_1_7":<Integer_value>, "hostname":<String_value>, "vrid_list_ipv6_1_2":<String_value[]>, "vm_memory_total":<Double_value>, "vrid_list_ipv4_1_4":<String_value[]>, "vrid_list_ipv6_10_6":<String_value[]>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "fips_partition_name":<String_value>, "vrid_list_ipv6_10_4":<String_value[]>, "vrid_list_ipv6_1_3":<String_value[]>, "if_10_3":<Boolean_value>, "nsvlan_id":<Integer_value>, "receiveuntagged_10_4":<Boolean_value>, "vlan_10_6":<Integer_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "if_10_5":<Boolean_value>, "is_new_crypto":<Boolean_value>, "metrics_collection":<Boolean_value>, "if_10_7":<Boolean_value>, "is_managed":<Boolean_value>, "receiveuntagged_1_6":<Boolean_value>, "nexthop_v6":<String_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "ipv4_address":<String_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "profile_name":<String_value>, "vrid_list_ipv4_1_6":<String_value[]>, "vrid_list_ipv6_1_5":<String_value[]>, "backplane":<String_value>, "network_interfaces":[{ <b>"port_name":<String_value></b>, "name_server":<String_value>, "is_mgmt_ifc":<Boolean_value>, "gateway":<String_value>, "vrid_list_ipv6":<String_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "netmask":<String_value>, "ip_address":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "interface_name":<String_value>, "parent_name":<String_value>, "vlan_whitelist_array":<String_value[]>, "mac_mode":<String_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "vrid_list_ipv4_array":<String_value[]>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vrid_list_ipv6_array":<String_value[]>, "is_vlan_applied":<Boolean_value>, "vlan_whitelist":<String_value>}], "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "state":<String_value>, "last_updated_time":<Double_value>, "if_10_1":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vrid_list_ipv4_1_3":<String_value[]>, "vlan_1_6":<Integer_value>, "license_edition":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value[]>, "vlan_1_1":<Integer_value>, "customid":<String_value>, "vlan_1_8":<Integer_value>, "license_grace_time":<Integer_value>, "receiveuntagged_10_5":<Boolean_value>, "vrid_list_ipv4_10_3":<String_value[]>, "vrid_list_ipv4_1_8":<String_value[]>, "la_mgmt":<Boolean_value>, "vlan_id_0_2":<Integer_value>, "number_of_ssl_cores":<Integer_value>, "vlan_1_3":<Integer_value>, "if_10_6":<Boolean_value>, "receiveuntagged_10_3":<Boolean_value>, "number_of_ssl_cards":<Integer_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "vrid_list_ipv4_10_5":<String_value[]>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "node_id":<String_value>, "ip_address":<String_value>, "vrid_list_ipv4_10_7":<String_value[]>, "throughput_allocation_mode":<Integer_value>, "number_of_cores":<Integer_value>, "receiveuntagged_1_3":<Boolean_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "vrid_list_ipv4_10_2":<String_value[]>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv6_10_2":<String_value[]>, "nexthop":<String_value>, "plt_bw_config":<Integer_value>}}

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, "ns":[{ "clusterid":<Integer_value>, "is_grace":<Boolean_value>, "std_bw_config":<Integer_value>, "ns_ip_address":<String_value>, "password":<String_value>, "gateway_ipv6":<String_value>, "throughput_limit":<Double_value>, "instance_state":<String_value>, "vlan_id_0_1":<Integer_value>, "name":<String_value>, "disk_space":<Double_value>, "nsvlan_interfaces_db":<String_value>, "diskavail":<Integer_value>, "cpu_core_pe":<String_value>, "mastools_version":<String_value>, "plugin_ip_address":<String_value>, "vlan_type":<Integer_value>, "ent_bw_total":<Integer_value>, "disk1_used":<Double_value>, "vcpu_config":<Integer_value>, "clip":<String_value>, "nsvlan_tagged":<Boolean_value>, "preferred_cpu_socket":<String_value>, "netmask":<String_value>, "device_uuid":<String_value>, "ent_bw_config":<Integer_value>, "version":<String_value>, "datacenter_id":<String_value>, "old_max_burst_throughput":<Double_value>, "instance_mode":<String_value>, "vm_memory_used":<Double_value>, "health":<String_value>, "number_of_ssl_cores_up":<Integer_value>, "std_bw_available":<Integer_value>, "internal_ip_address":<String_value>, "disksize":<Integer_value>, "sysid":<String_value>, "nodeid":<Integer_value>, "if_0_1":<Boolean_value>, "vm_state":<String_value>, "uuid":<String_value>, "disk1_free":<Double_value>, "cpu_core_mgmt":<String_value>, "ssl_virtual_functions":<String_value>, "old_throughput":<Double_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>, "number_of_acu":<Integer_value>, "plt_bw_available":<Integer_value>, "is_clip":<Boolean_value>, "device_family":<String_value>, "http_req":<Double_value>, "nic_discards_in":<Double_value>, "disk0_free":<Double_value>, "type":<String_value>, "throughput":<Double_value>, "template_name":<String_value>, "nic_discards_out":<Double_value>, "status":<String_value>, "gateway":<String_value>, "systemname":<String_value>, "mac_eth0":<String_value>, "ns_memory_usage":<Double_value>, "iscco":<Boolean_value>, "vm_tx":<Double_value>, "number_of_scu":<Integer_value>, "license":<String_value>, "domain_name":<String_value>, "vm_memory_free":<Double_value>, "vm_memory_usage":<Double_value>, "vm_cpu_usage":<Double_value>, "if_0_2":<Boolean_value>, "image_name":<String_value>, "hostname":<String_value>, "is_internal_intf_added":<Boolean_value>, "vm_memory_total":<Double_value>, "sdxtools_http_port":<Integer_value>, "vnc_console_url":<String_value>, "provision_with_xva":<Boolean_value>, "reason":<String_value>, "virtual_functions":<String_value>, "ns_total_tx":<Double_value>, "ent_bw_available":<Integer_value>, "description":<String_value>, "username":<String_value>, "is_pooled_license":<Boolean_value>, "upsince":<String_value>, "fips_partition_name":<String_value>, "domid":<Double_value>, "user_driven":<Boolean_value>, "nsvlan_id":<Integer_value>, "host_type":<String_value>, "tenant_id":<String_value>, "ns_mgmt_cpu_usage":<Double_value>, "num_pes":<Integer_value>, "burst_priority":<Integer_value>, "do_config":<Boolean_value>, "metrics_collection":<Boolean_value>, "host_id":<String_value>, "has_sdxtools":<Boolean_value>, "is_managed":<Boolean_value>, "system_hardwareversion":<String_value>, "ns_tx":<Double_value>, "number_of_cpu":<Integer_value>, "nexthop_v6":<String_value>, "ipv4_address":<String_value>, "profile_name":<String_value>, "seq_no":<Double_value>, "is_swg":<Boolean_value>, "dns":<String_value>, "backplane":<String_value>, "if_0_3":<Boolean_value>, "diskused":<Integer_value>, "network_interfaces":[{ "device_channel_name":<String_value>, "is_mgmt_ifc":<Boolean_value>, "name_server":<String_value>, "vrid_list_ipv6":<String_value>, "gateway":<String_value>, "channel_tag_all_vlans":<Boolean_value>, "xen_vf_index":<Integer_value>, "parent_id":<String_value>, "vrid_list_ipv4":<String_value>, "is_member_ifc":<Boolean_value>, "mac_address":<String_value>, "parent_channel_id":<String_value>, "channel_type":<String_value>, "l2_enabled":<Boolean_value>, "id":<String_value>, "ip_address":<String_value>, "netmask":<String_value>, "port_name":<String_value>, "parent_name":<String_value>, "channel_timeout":<String_value>, "mac_mode":<String_value>, "channel_ha_monitoring":<Boolean_value>, "managed_device_id":<String_value>, "vlan":<Integer_value>, "receiveuntagged":<Boolean_value>, "sdx_formation_network_id":<String_value>, "vlan_whitelist":<String_value> "interface_name":<String_value> "vrid_list_ipv4_array":<String_value> "vrid_list_ipv6_array":<String_value> "vlan_whitelist_array":<String_value> "is_vlan_applied":<Boolean_value>}], "state":<String_value>, "task_id":<String_value>, "last_updated_time":<Double_value>, "uptime":<String_value>, "license_edition":<String_value>, "cpu_license_type":<Integer_value>, "customid":<String_value>, "license_grace_time":<Integer_value>, "la_mgmt":<Boolean_value>, "assigned_cpu_socket":<String_value>, "vlan_id_0_2":<Integer_value>, "ns_cpu_usage":<Double_value>, "number_of_ssl_cores":<Integer_value>, "number_of_ssl_cards":<Integer_value>, "sdxtools_public_key":<String_value>, "ns_rx":<Double_value>, "user_profile_name":<String_value>, "vm_description":<String_value>, "max_burst_throughput":<Double_value>, "config_type":<Integer_value>, "if_internal_ip_enabled":<Boolean_value>, "cmd_policy":<String_value>, "vm_rx":<Double_value>, "node_id":<String_value>, "privStr":<String_value>, "disk_allocation":<String_value>, "diskperusage":<Integer_value>, "ip_address":<String_value>, "throughput_allocation_mode":<Integer_value>, "ping_state":<Integer_value>, "number_of_cores":<Integer_value>, "pps":<Double_value>, "plugin_netmask":<String_value>, "disk1_total":<Double_value>, "display_name":<String_value>, "std_bw_total":<Integer_value>, "disk0_used":<Double_value>, "nexthop":<String_value>, "ns_total_rx":<Double_value>, "plt_bw_config":<Integer_value>, "formation_instance_id":<String_value>, "sdxtools_version":<String_value>, "parent_inventory":<Boolean_value>, "vlan_1_2":<Integer_value>, "vrid_list_ipv4_1_2":<String_value>, "vlan_1_7":<Integer_value>, "vrid_list_ipv6_1_2":<String_value>, "vrid_list_ipv4_1_4":<String_value>, "act_id":<String_value>, "vrid_list_ipv6_10_6":<String_value>, "if_10_4":<Boolean_value>, "vlan_10_5":<Integer_value>, "vrid_list_ipv6_10_3":<String_value>, "vrid_list_ipv6_1_1":<String_value>, "if_1_5":<Boolean_value>, "receiveuntagged_1_4":<Boolean_value>, "vrid_list_ipv6_10_4":<String_value>, "vrid_list_ipv6_1_3":<String_value>, "if_10_3":<Boolean_value>, "xva_desc_present":<Boolean_value>, "vrid_list_ipv6_10_5":<String_value>, "receiveuntagged_10_4":<Boolean_value>, "advertise_vm_uuid":<String_value>, "vrid_list_ipv6_1_8":<String_value>, "vlan_10_6":<Integer_value>, "if_10_5":<Boolean_value>, "save_config":<Boolean_value>, "is_new_crypto":<Boolean_value>, "delete_template_name":<String_value>, "vrid_list_ipv6_1_6":<String_value>, "profile_username":<String_value>, "if_10_7":<Boolean_value>, "default_password":<String_value>, "receiveuntagged_10_8":<Boolean_value>, "vrid_list_ipv6_1_4":<String_value>, "receiveuntagged_1_6":<Boolean_value>, "vlan_1_4":<Integer_value>, "if_1_2":<Boolean_value>, "receiveuntagged_1_5":<Boolean_value>, "receiveuntagged_10_6":<Boolean_value>, "receiveuntagged_10_1":<Boolean_value>, "vrid_list_ipv4_1_6":<String_value>, "vrid_list_ipv6_1_5":<String_value>, "vrid_list_ipv6_10_8":<String_value>, "vrid_list_ipv4_1_7":<String_value>, "make_vm_ready":<Boolean_value>, "receiveuntagged_10_2":<Boolean_value>, "profile_password":<String_value>, "vrid_list_ipv4_1_5":<String_value>, "receiveuntagged_1_7":<Boolean_value>, "vlan_10_4":<Integer_value>, "if_1_7":<Boolean_value>, "receiveuntagged_1_1":<Boolean_value>, "vrid_list_ipv6_1_7":<String_value>, "if_10_1":<Boolean_value>, "diff_exists":<Boolean_value>, "if_10_8":<Boolean_value>, "l2_enabled":<Boolean_value>, "vlan_10_7":<Integer_value>, "vlan_10_1":<Integer_value>, "receiveuntagged_1_2":<Boolean_value>, "reboot_vm_on_cpu_change":<Boolean_value>, "vlan_1_6":<Integer_value>, "vrid_list_ipv4_1_3":<String_value>, "receiveuntagged_10_7":<Boolean_value>, "vrid_list_ipv4_1_1":<String_value>, "vlan_1_1":<Integer_value>, "vrid_list_ipv6_10_7":<String_value>, "vlan_1_8":<Integer_value>, "vrid_list_ipv4_10_3":<String_value>, "receiveuntagged_10_5":<Boolean_value>, "vlan_10_2":<Integer_value>, "vrid_list_ipv4_10_6":<String_value>, "vrid_list_ipv4_1_8":<String_value>, "receiveuntagged_1_8":<Boolean_value>, "sync_operation":<Boolean_value>, "additional_info":<String_value>, "vrid_list_ipv4_10_4":<String_value>, "vlan_1_3":<Integer_value>, "receiveuntagged_10_3":<Boolean_value>, "if_10_6":<Boolean_value>, "if_1_6":<Boolean_value>, "vlan_10_3":<Integer_value>, "vlan_1_5":<Integer_value>, "if_1_3":<Boolean_value>, "vpx_image_dir":<String_value>, "nsvlan_interfaces":<String_value>, "vrid_list_ipv4_10_5":<String_value>, "if_1_4":<Boolean_value>, "vrid_list_ipv4_10_8":<String_value>, "if_1_1":<Boolean_value>, "vrid_list_ipv4_10_7":<String_value>, "vlan_10_8":<Integer_value>, "convert_template_name":<String_value>, "receiveuntagged_1_3":<Boolean_value>, "crypto_change_requires_reboot":<Boolean_value>, "vrid_list_ipv4_10_2":<String_value>, "if_1_8":<Boolean_value>, "vrid_list_ipv4_10_1":<String_value>, "vrid_list_ipv6_10_2":<String_value>, "if_10_2":<Boolean_value>, "vrid_list_ipv6_10_1":<String_value>}]}

force_stop

URL: https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=force_stop;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}

start

URL: https://<MGMT-IP>/nitro/v2/config/ns/id_value<String>?action=start;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}
ns