sdx

Configuration for Resource for adding and managing NetScaler SDX instances resource.

Read/write properties

profile_name<String>

Device Profile Name that is attached with this managed device.
Minimum length = 1
Maximum length = 128

config_type<Integer>

Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =

discovery_time<Double>

discovery time.

plt_bw_available<Integer>

Platinum Bandwidth Available.

autoscalegroup_id<String>

Autoscalegroup ID.

las_cpx_bw<Integer>

lascpxbw for CPX devices requesting LAS capacity during registration.

ipv4_address<String>

IPv4 Address.
Minimum length = 1
Maximum length = 64

plt_bw_total<Integer>

Total Platinum Bandwidth.

node_id<String>

Node identification of a device.

netmask<String>

Netmask of managed device.
Minimum length = 1
Maximum length = 64

name<String>

Name of managed device.
Minimum length = 1
Maximum length = 128

vcpu_config<Integer>

Number of vCPU allocated for the device.

hostname<String>

Assign hostname to managed device, if this is not provided, name will be set as host name .
Minimum length = 1
Maximum length = 256

lom_ip_address<String>

LOM IP Address.

datacenter_id<String>

Datacenter Id is system generated key for data center.

std_bw_config<Integer>

Standard Bandwidth running.

instance_mode<String>

Denotes state- primary,secondary,clip,clusternode.

license_edition<String>

Edition of instance.

display_name<String>

Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP.
Minimum length = 1
Maximum length = 128

ent_bw_total<Integer>

Enterprise Bandwidth Total.

description<String>

Description of managed device.
Minimum length = 1
Maximum length = 512

type<String>

Type of device, (Xen | NS).
Minimum length = 1
Maximum length = 64

device_finger_print<String>

Fingerprint/thumb-print from UMS public certificate for SSL communication.

gateway<String>

Default Gateway of managed device.
Minimum length = 1
Maximum length = 64

agent_id<String>

Agent Id.

sysservices<Double>

System Services.

ipv6_address<String>

IPv6 Address.

instance_total<Integer>

Instance license.

is_ha_configured<Boolean>

Is HA configured.

ent_bw_available<Integer>

Enterprise Bandwidth configured.

gateway_deployment<Boolean>

Is this device acting as Gateway..

partition_name<String>

NetScaler Admin Partition Name.
Maximum length = 512

is_managed<Boolean>

Is Managed.

sslvpn_config<Integer>

sslvpn license maximum.

std_bw_available<Integer>

Standard Bandwidth Available.

instance_available<Integer>

Instance license available.

last_updated_time<Double>

Last Updated Time.

last_up_time<Double>

Last time when the device was seen up.

ip_address<String>

IP Address for this managed device.
Minimum length = 1
Maximum length = 64

sslvpn_total<Integer>

sslvpn license.

is_autoscale_group<Boolean>

Does this device belong to an Autoscale Group..

id<String>

Id is system generated key for all the managed devices.

std_bw_total<Integer>

Standard Bandwidth.

ent_bw_config<Integer>

Enterprise Bandwidth configured.

partition_id<String>

ID of admin partition.

trust_id<String>

Device ID obtained from trust service.

instance_classifier<Integer>

Value based on which certain features may be enabled/disabled in NetScaler Console for the instance.

geo_support<Boolean>

Is this device configured to support GEO location..

isolation_policy<String>

Isolation Policy of the Device.

maintenance_status<Boolean>

The status if the device is within the maintenance window.

plt_bw_config<Integer>

Platinum Bandwidth configured.

template_interval<Integer>

Template refresh interval.

license_mode<String>

license mode: FOREIGN_POOL, FOREIGN_LAS, EXPRESS, POOLED, LAS, LOCAL, CICO etc..

mgmt_ip_address<String>

Management IP Address for this Managed Device.
Minimum length = 1
Maximum length = 64

license_server<String>

License Server Configured.
Minimum length = 1
Maximum length = 128

httpxforwardedfor<String>

HTTP x-Forwardedfor header flag..
Minimum length = 1
Maximum length = 10

vpx_information<vpx_info[]>

Get BW of VPX on SDX info.

autoprovisioned<Boolean>

Device is auto-provisioned or not.

device_family<String>

Device Family.
Minimum length = 1
Maximum length = 64

gateway_ipv6<String>

Gateway IPv6 Address.

servicepackage<String>

Service Package Name of the device.

provision_request_id<String>

Value is set only if the instance was provisioned from NetScaler Console.

mastools_version<String>

Mastools version if the device is embedded agent.

internal_annotation<String>

Internal annotation used by NetScaler Console.Example, if a device is marked for delete.

xen_ip_address<String>

XEN IP Address.

instance_config<Integer>

Instance license running.

file_name<String>

File name which contains comma separated instances to be discovered.
Minimum length = 1
Maximum length = 128

entity_tag<property_map[]>

Array of tag_name and tag_value pair assocaited with an entity.

peer_host_device_ip<String>

Peer Host Device IP Address for instance of type BLX ADC..
Minimum length = 1
Maximum length = 64

profile_password<String>

Password specified by the user for this NetScaler Instance..
Minimum length = 1
Maximum length = 128

manual_inventory<Boolean>

manual_inventory.

prev_trust_id<String>

Previous trust ID of the mastools device.

device_host_ip<String>

Device Host IP Address for instance of type BLX ADC..
Minimum length = 1
Maximum length = 64

profile_username<String>

User Name specified by the user for this NetScaler Instance..
Minimum length = 1
Maximum length = 128

peer_device_ip<String>

Peer Device IP address for instance of type BLX ADC..
Minimum length = 1
Maximum length = 64

tr_task_id<String>

Task Id used by Triton to identify NS.

is_re_register<Boolean>

If set to true, NetScaler Console will re-register the instance by first deleting it then adding it.

file_location_path<String>

File Location on Client for upload/download.
Minimum length = 1

Read only properties

memory_total<Double>

Total memory of host in MB.

ssh_status<String>

SSH Status of device, UP only if device accessible on SSH.

version<String>

Device Version.

max_throughput<String>

Maximum Throughput in Mbps.

region<String>

Region in which the managed device is hosted.

zone<String>

Zone in which the managed device is hosted.

httpquerywithurl<String>

URL query params flag..

product<String>

Product Name.

bmcrevision<String>

BMC Firmware Version.

lm_serialnumber<String>

LM Serial Number.

do_config<Boolean>

Do default config for managed device.

number_of_cpu<Integer>

Number of total CPU of host.

is_fips_pooled_license_type<Integer>

FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license.

cloud<String>

Cloud on which the managed device is hosted.

tx<Double>

Out Throughput (Mbps) of host.

rx<Double>

In Throughput (Mbps) of host.

status<String>

Status of managed device.

private_dns<String>

Private DNS of the managed device.

instance_type<String>

Instance type indicates the deployment type of CPX.

systemname<String>

Device System Name.

is_pooled_saas<Integer>

Pooled Saas License available : 1, No Pooled Saas License available : 0.

subnet_id<String>

in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).

security_group<String>

virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS).

ssl_cores_total<Integer>

Total SSL Cores available in host.

cpu_usage<Double>

CPU Usage (%) of host.

device_uuid<String>

Device UUID.

max_number_of_instances<Integer>

Maximum Instances.

acu_total<Integer>

Total Asymmetric Crypto Units available in host.

build_number<String>

Build Number.

lpeid<String>

LPEID for devices using LAS license.

acu_free<Integer>

Free Asymmetric Crypto Units.

sysid<String>

System ID.

hostid<String>

Host Id.

bios_version<String>

BIOS Version.

total_crypto_devices<Integer>

Total Crypto Devices.

memory_free<Double>

Free memory available (MB) in host.

burnin_date<String>

burnin_date for devices using LAS license.

scu_free<Integer>

Free Symmetric Crypto Units.

location<String>

Device Location.

encoded_serialnumber<String>

Encoded Serial Number.

cpu_license_type<Integer>

VCPU license 0 = No VCPU License, 1 = VCPU Pool license.

model_id<String>

Device Model Id.

ami_id<String>

AMI ID of the managed device (if hosted on AWS).

scu_total<Integer>

Total Symmetric Crypto Units available in host.

public_dns<String>

Public DNS of the managed device.

vpc_id<String>

VPC ID of the managed device.

ha_master_state<String>

Master State (Primary/Secondary).

contactperson<String>

Device contact person.

serialnumber<String>

Device Serial Number.

host_id<String>

Host ID.

ha_sync<String>

HA Synchronization State.

license_grace_time<Integer>

Grace for this NetScaler Instance..

instance_unique_id<Integer>

32 bit unique Integer id generated by NetScaler NetScaler Console for this device.

las_cpx_edition<String>

las_cpx_edition for CPX devices requesting LAS capacity during registration.

available_number_of_instances<Integer>

Available Instances.

geo_location<String>

Geo location of the managed device.

lm_host_id<String>

LM Host ID.

httpcookie<String>

Cookie-Header flag..

number_of_cpu_cores<Integer>

Number of total CPU cores of host.

instance_state<String>

State of device, UP only if device accessible.

uuid<String>

UUID of host.

vpx_on_cloud<Integer>

Cloud Platform of vpx: 0= On-Prem vpx, 1= AWS, 3=Azure, 4=GCP.

cpufrequncy<Integer>

CPU Frequency (MHZ).

platform<String>

Platform.

public_ip<String>

Public IP of the managed device.

private_ip<String>

Private IP of the managed device.

tenant_id<String>

Tenant ID.

memory_usage<Double>

Memory Usage (%) of host.

mpx_encryption_status<String>

Encryption status of the filesystem of MPX device.

disk_usage<Double>

Disk usage (MB) for host.

uptime<String>

Uptime of device.

disk_free<Double>

Show free Disk Space (MB) available on host.

upsince<String>

Upsince of managed device.

current_time<Integer>

Current Time.

disk_space<Double>

Show Disk Space (MB) available on host.

ha_ip_address<String>

Peer IP Address.

vpx_on_sdx<Integer>

VPX hosted on SDX: 1= Yes, 0= No.

enabled<Boolean>

host State.

manufacturedate<String>

Manufacture Date.

reason<String>

Reason of failure for this managed device.

available_throughput<String>

Available Throughput in Mbps.

ssl_cores_free<Integer>

Free SSL Cores.

act_id<String>

Activity Id.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

addget (all)getmanageunmanagerebootdelete

add

URL:https://<MGMT-IP>/nitro/v2/config/sdx?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"sdx": {
      "ip_address":<String_value>,
      "lom_ip_address":<String_value>,
      "geo_support":<Boolean_value>,
      "isolation_policy":<String_value>,
      "datacenter_id":<String_value>,
      "hostname":<String_value>,
      "vcpu_config":<Integer_value>,
      "file_location_path":<String_value>,
      "peer_device_ip":<String_value>,
      "instance_classifier":<Integer_value>,
      "entity_tag":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}]
,
      "partition_id":<String_value>,
      "ent_bw_config":<Integer_value>,
      "name":<String_value>,
      "netmask":<String_value>,
      "trust_id":<String_value>,
      "file_name":<String_value>,
      "las_cpx_bw":<Integer_value>,
      "ipv4_address":<String_value>,
      "profile_password":<String_value>,
      "std_bw_total":<Integer_value>,
      "id":<String_value>,
      "node_id":<String_value>,
      "plt_bw_total":<Integer_value>,
      "is_autoscale_group":<Boolean_value>,
      "sslvpn_total":<Integer_value>,
      "is_re_register":<Boolean_value>,
      "autoscalegroup_id":<String_value>,
      "last_updated_time":<Double_value>,
      "instance_available":<Integer_value>,
      "last_up_time":<Double_value>,
      "profile_name":<String_value>,
      "manual_inventory":<Boolean_value>,
      "std_bw_available":<Integer_value>,
      "plt_bw_available":<Integer_value>,
      "discovery_time":<Double_value>,
      "config_type":<Integer_value>,
      "is_managed":<Boolean_value>,
      "partition_name":<String_value>,
      "device_host_ip":<String_value>,
      "profile_username":<String_value>,
      "sslvpn_config":<Integer_value>,
      "instance_config":<Integer_value>,
      "xen_ip_address":<String_value>,
      "internal_annotation":<String_value>,
      "gateway_deployment":<Boolean_value>,
      "ent_bw_available":<Integer_value>,
      "provision_request_id":<String_value>,
      "servicepackage":<String_value>,
      "sysservices":<Double_value>,
      "is_ha_configured":<Boolean_value>,
      "instance_total":<Integer_value>,
      "mastools_version":<String_value>,
      "ipv6_address":<String_value>,
      "device_finger_print":<String_value>,
      "device_family":<String_value>,
      "autoprovisioned":<Boolean_value>,
      "gateway_ipv6":<String_value>,
      "gateway":<String_value>,
      "agent_id":<String_value>,
      "description":<String_value>,
      "type":<String_value>,
      "tr_task_id":<String_value>,
      "vpx_information":[{
      "name":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "license_edition":<String_value>}]
,
      "httpxforwardedfor":<String_value>,
      "license_server":<String_value>,
      "mgmt_ip_address":<String_value>,
      "instance_mode":<String_value>,
      "display_name":<String_value>,
      "license_edition":<String_value>,
      "ent_bw_total":<Integer_value>,
      "peer_host_device_ip":<String_value>,
      "std_bw_config":<Integer_value>,
      "template_interval":<Integer_value>,
      "prev_trust_id":<String_value>,
      "plt_bw_config":<Integer_value>,
      "maintenance_status":<Boolean_value>,
      "license_mode":<String_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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sdx":[{
      "memory_total":<Double_value>,
      "profile_name":<String_value>,
      "ssh_status":<String_value>,
      "config_type":<Integer_value>,
      "discovery_time":<Double_value>,
      "plt_bw_available":<Integer_value>,
      "version":<String_value>,
      "max_throughput":<String_value>,
      "region":<String_value>,
      "zone":<String_value>,
      "httpquerywithurl":<String_value>,
      "product":<String_value>,
      "autoscalegroup_id":<String_value>,
      "bmcrevision":<String_value>,
      "lm_serialnumber":<String_value>,
      "do_config":<Boolean_value>,
      "number_of_cpu":<Integer_value>,
      "is_fips_pooled_license_type":<Integer_value>,
      "cloud":<String_value>,
      "tx":<Double_value>,
      "rx":<Double_value>,
      "status":<String_value>,
      "private_dns":<String_value>,
      "instance_type":<String_value>,
      "systemname":<String_value>,
      "las_cpx_bw":<Integer_value>,
      "ipv4_address":<String_value>,
      "plt_bw_total":<Integer_value>,
      "is_pooled_saas":<Integer_value>,
      "node_id":<String_value>,
      "subnet_id":<String_value>,
      "ping_state":<Integer_value>,
      "netmask":<String_value>,
      "security_group":<String_value>,
      "ssl_cores_total":<Integer_value>,
      "name":<String_value>,
      "vcpu_config":<Integer_value>,
      "hostname":<String_value>,
      "cpu_usage":<Double_value>,
      "lom_ip_address":<String_value>,
      "device_uuid":<String_value>,
      "datacenter_id":<String_value>,
      "std_bw_config":<Integer_value>,
      "max_number_of_instances":<Integer_value>,
      "acu_total":<Integer_value>,
      "instance_mode":<String_value>,
      "license_edition":<String_value>,
      "display_name":<String_value>,
      "build_number":<String_value>,
      "ent_bw_total":<Integer_value>,
      "lpeid":<String_value>,
      "acu_free":<Integer_value>,
      "description":<String_value>,
      "type":<String_value>,
      "sysid":<String_value>,
      "hostid":<String_value>,
      "device_finger_print":<String_value>,
      "bios_version":<String_value>,
      "total_crypto_devices":<Integer_value>,
      "memory_free":<Double_value>,
      "gateway":<String_value>,
      "agent_id":<String_value>,
      "burnin_date":<String_value>,
      "sysservices":<Double_value>,
      "ipv6_address":<String_value>,
      "instance_total":<Integer_value>,
      "is_ha_configured":<Boolean_value>,
      "is_las_license":<Boolean_value>,
      "is_grace":<Boolean_value>,
      "ent_bw_available":<Integer_value>,
      "scu_free":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "location":<String_value>,
      "encoded_serialnumber":<String_value>,
      "cpu_license_type":<Integer_value>,
      "model_id":<String_value>,
      "ami_id":<String_value>,
      "partition_name":<String_value>,
      "is_managed":<Boolean_value>,
      "scu_total":<Integer_value>,
      "seq_no":<Double_value>,
      "sslvpn_config":<Integer_value>,
      "public_dns":<String_value>,
      "vpc_id":<String_value>,
      "std_bw_available":<Integer_value>,
      "instance_available":<Integer_value>,
      "last_updated_time":<Double_value>,
      "last_up_time":<Double_value>,
      "ip_address":<String_value>,
      "ha_master_state":<String_value>,
      "contactperson":<String_value>,
      "serialnumber":<String_value>,
      "host_id":<String_value>,
      "ha_sync":<String_value>,
      "license_grace_time":<Integer_value>,
      "sslvpn_total":<Integer_value>,
      "instance_unique_id":<Integer_value>,
      "las_cpx_edition":<String_value>,
      "customer_name":<String_value>,
      "available_number_of_instances":<Integer_value>,
      "geo_location":<String_value>,
      "is_autoscale_group":<Boolean_value>,
      "id":<String_value>,
      "std_bw_total":<Integer_value>,
      "lm_host_id":<String_value>,
      "parent_filters":<String_value>,
      "ent_bw_config":<Integer_value>,
      "httpcookie":<String_value>,
      "partition_id":<String_value>,
      "trust_id":<String_value>,
      "number_of_cpu_cores":<Integer_value>,
      "is_pooled_license":<Boolean_value>,
      "instance_state":<String_value>,
      "instance_classifier":<Integer_value>,
      "geo_support":<Boolean_value>,
      "uuid":<String_value>,
      "vpx_on_cloud":<Integer_value>,
      "isolation_policy":<String_value>,
      "cpufrequncy":<Integer_value>,
      "maintenance_status":<Boolean_value>,
      "plt_bw_config":<Integer_value>,
      "platform":<String_value>,
      "public_ip":<String_value>,
      "template_interval":<Integer_value>,
      "private_ip":<String_value>,
      "tenant_id":<String_value>,
      "license_mode":<String_value>,
      "mgmt_ip_address":<String_value>,
      "license_server":<String_value>,
      "memory_usage":<Double_value>,
      "mpx_encryption_status":<String_value>,
      "disk_usage":<Double_value>,
      "httpxforwardedfor":<String_value>,
      "vpx_information":[{
      "license_edition":<String_value>,
      "name":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "throughput":<String_value>}],
      "autoprovisioned":<Boolean_value>,
      "device_family":<String_value>,
      "uptime":<String_value>,
      "disk_free":<Double_value>,
      "gateway_ipv6":<String_value>,
      "servicepackage":<String_value>,
      "upsince":<String_value>,
      "provision_request_id":<String_value>,
      "mastools_version":<String_value>,
      "internal_annotation":<String_value>,
      "current_time":<Integer_value>,
      "user_driven":<Boolean_value>,
      "xen_ip_address":<String_value>,
      "disk_space":<Double_value>,
      "ha_ip_address":<String_value>,
      "vpx_on_sdx":<Integer_value>,
      "enabled":<Boolean_value>,
      "manufacturedate":<String_value>,
      "instance_config":<Integer_value>,
      "reason":<String_value>,
      "available_throughput":<String_value>,
      "file_name":<String_value>,
      "parent_inventory":<Boolean_value>,
      "entity_tag":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "default_password":<String_value>,
      "peer_host_device_ip":<String_value>,
      "profile_password":<String_value>,
      "manual_inventory":<Boolean_value>,
      "prev_trust_id":<String_value>,
      "do_instance_config":<Boolean_value>,
      "register_failed_device":<Boolean_value>,
      "ssl_cores_free":<Integer_value>,
      "force_password_change":<Boolean_value>,
      "device_host_ip":<String_value>,
      "act_id":<String_value>,
      "profile_username":<String_value>,
      "sync_operation":<Boolean_value>,
      "peer_device_ip":<String_value>,
      "tr_task_id":<String_value>,
      "is_re_register":<Boolean_value>,
      "file_location_path":<String_value>}]}

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/sdx

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/sdx?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of sdx 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/sdx?pagesize=#no&pageno=#no

Use this query-parameter to get the sdx resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/sdx?count=yes

Use this query-parameter to get the count of sdx 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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sdx":[{
      "memory_total":<Double_value>,
      "profile_name":<String_value>,
      "ssh_status":<String_value>,
      "config_type":<Integer_value>,
      "discovery_time":<Double_value>,
      "plt_bw_available":<Integer_value>,
      "version":<String_value>,
      "max_throughput":<String_value>,
      "region":<String_value>,
      "zone":<String_value>,
      "httpquerywithurl":<String_value>,
      "product":<String_value>,
      "autoscalegroup_id":<String_value>,
      "bmcrevision":<String_value>,
      "lm_serialnumber":<String_value>,
      "do_config":<Boolean_value>,
      "number_of_cpu":<Integer_value>,
      "is_fips_pooled_license_type":<Integer_value>,
      "cloud":<String_value>,
      "tx":<Double_value>,
      "rx":<Double_value>,
      "status":<String_value>,
      "private_dns":<String_value>,
      "instance_type":<String_value>,
      "systemname":<String_value>,
      "las_cpx_bw":<Integer_value>,
      "ipv4_address":<String_value>,
      "plt_bw_total":<Integer_value>,
      "is_pooled_saas":<Integer_value>,
      "node_id":<String_value>,
      "subnet_id":<String_value>,
      "ping_state":<Integer_value>,
      "netmask":<String_value>,
      "security_group":<String_value>,
      "ssl_cores_total":<Integer_value>,
      "name":<String_value>,
      "vcpu_config":<Integer_value>,
      "hostname":<String_value>,
      "cpu_usage":<Double_value>,
      "lom_ip_address":<String_value>,
      "device_uuid":<String_value>,
      "datacenter_id":<String_value>,
      "std_bw_config":<Integer_value>,
      "max_number_of_instances":<Integer_value>,
      "acu_total":<Integer_value>,
      "instance_mode":<String_value>,
      "license_edition":<String_value>,
      "display_name":<String_value>,
      "build_number":<String_value>,
      "ent_bw_total":<Integer_value>,
      "lpeid":<String_value>,
      "acu_free":<Integer_value>,
      "description":<String_value>,
      "type":<String_value>,
      "sysid":<String_value>,
      "hostid":<String_value>,
      "device_finger_print":<String_value>,
      "bios_version":<String_value>,
      "total_crypto_devices":<Integer_value>,
      "memory_free":<Double_value>,
      "gateway":<String_value>,
      "agent_id":<String_value>,
      "burnin_date":<String_value>,
      "sysservices":<Double_value>,
      "ipv6_address":<String_value>,
      "instance_total":<Integer_value>,
      "is_ha_configured":<Boolean_value>,
      "is_las_license":<Boolean_value>,
      "is_grace":<Boolean_value>,
      "ent_bw_available":<Integer_value>,
      "scu_free":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "location":<String_value>,
      "encoded_serialnumber":<String_value>,
      "cpu_license_type":<Integer_value>,
      "model_id":<String_value>,
      "ami_id":<String_value>,
      "partition_name":<String_value>,
      "is_managed":<Boolean_value>,
      "scu_total":<Integer_value>,
      "seq_no":<Double_value>,
      "sslvpn_config":<Integer_value>,
      "public_dns":<String_value>,
      "vpc_id":<String_value>,
      "std_bw_available":<Integer_value>,
      "instance_available":<Integer_value>,
      "last_updated_time":<Double_value>,
      "last_up_time":<Double_value>,
      "ip_address":<String_value>,
      "ha_master_state":<String_value>,
      "contactperson":<String_value>,
      "serialnumber":<String_value>,
      "host_id":<String_value>,
      "ha_sync":<String_value>,
      "license_grace_time":<Integer_value>,
      "sslvpn_total":<Integer_value>,
      "instance_unique_id":<Integer_value>,
      "las_cpx_edition":<String_value>,
      "customer_name":<String_value>,
      "available_number_of_instances":<Integer_value>,
      "geo_location":<String_value>,
      "is_autoscale_group":<Boolean_value>,
      "id":<String_value>,
      "std_bw_total":<Integer_value>,
      "lm_host_id":<String_value>,
      "parent_filters":<String_value>,
      "ent_bw_config":<Integer_value>,
      "httpcookie":<String_value>,
      "partition_id":<String_value>,
      "trust_id":<String_value>,
      "number_of_cpu_cores":<Integer_value>,
      "is_pooled_license":<Boolean_value>,
      "instance_state":<String_value>,
      "instance_classifier":<Integer_value>,
      "geo_support":<Boolean_value>,
      "uuid":<String_value>,
      "vpx_on_cloud":<Integer_value>,
      "isolation_policy":<String_value>,
      "cpufrequncy":<Integer_value>,
      "maintenance_status":<Boolean_value>,
      "plt_bw_config":<Integer_value>,
      "platform":<String_value>,
      "public_ip":<String_value>,
      "template_interval":<Integer_value>,
      "private_ip":<String_value>,
      "tenant_id":<String_value>,
      "license_mode":<String_value>,
      "mgmt_ip_address":<String_value>,
      "license_server":<String_value>,
      "memory_usage":<Double_value>,
      "mpx_encryption_status":<String_value>,
      "disk_usage":<Double_value>,
      "httpxforwardedfor":<String_value>,
      "vpx_information":[{
      "license_edition":<String_value>,
      "name":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "throughput":<String_value>}],
      "autoprovisioned":<Boolean_value>,
      "device_family":<String_value>,
      "uptime":<String_value>,
      "disk_free":<Double_value>,
      "gateway_ipv6":<String_value>,
      "servicepackage":<String_value>,
      "upsince":<String_value>,
      "provision_request_id":<String_value>,
      "mastools_version":<String_value>,
      "internal_annotation":<String_value>,
      "current_time":<Integer_value>,
      "user_driven":<Boolean_value>,
      "xen_ip_address":<String_value>,
      "disk_space":<Double_value>,
      "ha_ip_address":<String_value>,
      "vpx_on_sdx":<Integer_value>,
      "enabled":<Boolean_value>,
      "manufacturedate":<String_value>,
      "instance_config":<Integer_value>,
      "reason":<String_value>,
      "available_throughput":<String_value>,
      "file_name":<String_value>,
      "parent_inventory":<Boolean_value>,
      "entity_tag":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "default_password":<String_value>,
      "peer_host_device_ip":<String_value>,
      "profile_password":<String_value>,
      "manual_inventory":<Boolean_value>,
      "prev_trust_id":<String_value>,
      "do_instance_config":<Boolean_value>,
      "register_failed_device":<Boolean_value>,
      "ssl_cores_free":<Integer_value>,
      "force_password_change":<Boolean_value>,
      "device_host_ip":<String_value>,
      "act_id":<String_value>,
      "profile_username":<String_value>,
      "sync_operation":<Boolean_value>,
      "peer_device_ip":<String_value>,
      "tr_task_id":<String_value>,
      "is_re_register":<Boolean_value>,
      "file_location_path":<String_value>}]}

get

URL:https://<MGMT-IP>/nitro/v2/config/sdx/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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sdx":[{
      "memory_total":<Double_value>,
      "profile_name":<String_value>,
      "ssh_status":<String_value>,
      "config_type":<Integer_value>,
      "discovery_time":<Double_value>,
      "plt_bw_available":<Integer_value>,
      "version":<String_value>,
      "max_throughput":<String_value>,
      "region":<String_value>,
      "zone":<String_value>,
      "httpquerywithurl":<String_value>,
      "product":<String_value>,
      "autoscalegroup_id":<String_value>,
      "bmcrevision":<String_value>,
      "lm_serialnumber":<String_value>,
      "do_config":<Boolean_value>,
      "number_of_cpu":<Integer_value>,
      "is_fips_pooled_license_type":<Integer_value>,
      "cloud":<String_value>,
      "tx":<Double_value>,
      "rx":<Double_value>,
      "status":<String_value>,
      "private_dns":<String_value>,
      "instance_type":<String_value>,
      "systemname":<String_value>,
      "las_cpx_bw":<Integer_value>,
      "ipv4_address":<String_value>,
      "plt_bw_total":<Integer_value>,
      "is_pooled_saas":<Integer_value>,
      "node_id":<String_value>,
      "subnet_id":<String_value>,
      "ping_state":<Integer_value>,
      "netmask":<String_value>,
      "security_group":<String_value>,
      "ssl_cores_total":<Integer_value>,
      "name":<String_value>,
      "vcpu_config":<Integer_value>,
      "hostname":<String_value>,
      "cpu_usage":<Double_value>,
      "lom_ip_address":<String_value>,
      "device_uuid":<String_value>,
      "datacenter_id":<String_value>,
      "std_bw_config":<Integer_value>,
      "max_number_of_instances":<Integer_value>,
      "acu_total":<Integer_value>,
      "instance_mode":<String_value>,
      "license_edition":<String_value>,
      "display_name":<String_value>,
      "build_number":<String_value>,
      "ent_bw_total":<Integer_value>,
      "lpeid":<String_value>,
      "acu_free":<Integer_value>,
      "description":<String_value>,
      "type":<String_value>,
      "sysid":<String_value>,
      "hostid":<String_value>,
      "device_finger_print":<String_value>,
      "bios_version":<String_value>,
      "total_crypto_devices":<Integer_value>,
      "memory_free":<Double_value>,
      "gateway":<String_value>,
      "agent_id":<String_value>,
      "burnin_date":<String_value>,
      "sysservices":<Double_value>,
      "ipv6_address":<String_value>,
      "instance_total":<Integer_value>,
      "is_ha_configured":<Boolean_value>,
      "is_las_license":<Boolean_value>,
      "is_grace":<Boolean_value>,
      "ent_bw_available":<Integer_value>,
      "scu_free":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "location":<String_value>,
      "encoded_serialnumber":<String_value>,
      "cpu_license_type":<Integer_value>,
      "model_id":<String_value>,
      "ami_id":<String_value>,
      "partition_name":<String_value>,
      "is_managed":<Boolean_value>,
      "scu_total":<Integer_value>,
      "seq_no":<Double_value>,
      "sslvpn_config":<Integer_value>,
      "public_dns":<String_value>,
      "vpc_id":<String_value>,
      "std_bw_available":<Integer_value>,
      "instance_available":<Integer_value>,
      "last_updated_time":<Double_value>,
      "last_up_time":<Double_value>,
      "ip_address":<String_value>,
      "ha_master_state":<String_value>,
      "contactperson":<String_value>,
      "serialnumber":<String_value>,
      "host_id":<String_value>,
      "ha_sync":<String_value>,
      "license_grace_time":<Integer_value>,
      "sslvpn_total":<Integer_value>,
      "instance_unique_id":<Integer_value>,
      "las_cpx_edition":<String_value>,
      "customer_name":<String_value>,
      "available_number_of_instances":<Integer_value>,
      "geo_location":<String_value>,
      "is_autoscale_group":<Boolean_value>,
      "id":<String_value>,
      "std_bw_total":<Integer_value>,
      "lm_host_id":<String_value>,
      "parent_filters":<String_value>,
      "ent_bw_config":<Integer_value>,
      "httpcookie":<String_value>,
      "partition_id":<String_value>,
      "trust_id":<String_value>,
      "number_of_cpu_cores":<Integer_value>,
      "is_pooled_license":<Boolean_value>,
      "instance_state":<String_value>,
      "instance_classifier":<Integer_value>,
      "geo_support":<Boolean_value>,
      "uuid":<String_value>,
      "vpx_on_cloud":<Integer_value>,
      "isolation_policy":<String_value>,
      "cpufrequncy":<Integer_value>,
      "maintenance_status":<Boolean_value>,
      "plt_bw_config":<Integer_value>,
      "platform":<String_value>,
      "public_ip":<String_value>,
      "template_interval":<Integer_value>,
      "private_ip":<String_value>,
      "tenant_id":<String_value>,
      "license_mode":<String_value>,
      "mgmt_ip_address":<String_value>,
      "license_server":<String_value>,
      "memory_usage":<Double_value>,
      "mpx_encryption_status":<String_value>,
      "disk_usage":<Double_value>,
      "httpxforwardedfor":<String_value>,
      "vpx_information":[{
      "license_edition":<String_value>,
      "name":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "throughput":<String_value>}],
      "autoprovisioned":<Boolean_value>,
      "device_family":<String_value>,
      "uptime":<String_value>,
      "disk_free":<Double_value>,
      "gateway_ipv6":<String_value>,
      "servicepackage":<String_value>,
      "upsince":<String_value>,
      "provision_request_id":<String_value>,
      "mastools_version":<String_value>,
      "internal_annotation":<String_value>,
      "current_time":<Integer_value>,
      "user_driven":<Boolean_value>,
      "xen_ip_address":<String_value>,
      "disk_space":<Double_value>,
      "ha_ip_address":<String_value>,
      "vpx_on_sdx":<Integer_value>,
      "enabled":<Boolean_value>,
      "manufacturedate":<String_value>,
      "instance_config":<Integer_value>,
      "reason":<String_value>,
      "available_throughput":<String_value>,
      "file_name":<String_value>,
      "parent_inventory":<Boolean_value>,
      "entity_tag":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "default_password":<String_value>,
      "peer_host_device_ip":<String_value>,
      "profile_password":<String_value>,
      "manual_inventory":<Boolean_value>,
      "prev_trust_id":<String_value>,
      "do_instance_config":<Boolean_value>,
      "register_failed_device":<Boolean_value>,
      "ssl_cores_free":<Integer_value>,
      "force_password_change":<Boolean_value>,
      "device_host_ip":<String_value>,
      "act_id":<String_value>,
      "profile_username":<String_value>,
      "sync_operation":<Boolean_value>,
      "peer_device_ip":<String_value>,
      "tr_task_id":<String_value>,
      "is_re_register":<Boolean_value>,
      "file_location_path":<String_value>}]}

manage

URL:https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String>?action=manage&onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"sdx": { }}

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>}

unmanage

URL:https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String>?action=unmanage&onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"sdx": { }}

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>}

reboot

URL:https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String>?action=reboot&onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"sdx": { }}

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>}

delete

URL:https://<MGMT-IP>/nitro/v2/config/sdx/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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }