179 lines
91 KiB
HTML
179 lines
91 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>sdx</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">sdx</p>
|
|
<P>Configuration for Resource for adding and managing NetScaler SDX instances resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">profile_name<span class="property_type"><String></span></p><p class="property_description">Device Profile Name that is attached with this managed device.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">config_type<span class="property_type"><Integer></span></p><p class="property_description">Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.<br> Maximum value = </p>
|
|
<p class="property_name">discovery_time<span class="property_type"><Double></span></p><p class="property_description">discovery time.</p>
|
|
<p class="property_name">plt_bw_available<span class="property_type"><Integer></span></p><p class="property_description">Platinum Bandwidth Available.</p>
|
|
<p class="property_name">autoscalegroup_id<span class="property_type"><String></span></p><p class="property_description">Autoscalegroup ID.</p>
|
|
<p class="property_name">las_cpx_bw<span class="property_type"><Integer></span></p><p class="property_description">lascpxbw for CPX devices requesting LAS capacity during registration.</p>
|
|
<p class="property_name">ipv4_address<span class="property_type"><String></span></p><p class="property_description">IPv4 Address.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">plt_bw_total<span class="property_type"><Integer></span></p><p class="property_description">Total Platinum Bandwidth.</p>
|
|
<p class="property_name">node_id<span class="property_type"><String></span></p><p class="property_description">Node identification of a device.</p>
|
|
<p class="property_name">netmask<span class="property_type"><String></span></p><p class="property_description">Netmask of managed device.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of managed device.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">vcpu_config<span class="property_type"><Integer></span></p><p class="property_description">Number of vCPU allocated for the device.</p>
|
|
<p class="property_name">hostname<span class="property_type"><String></span></p><p class="property_description">Assign hostname to managed device, if this is not provided, name will be set as host name .<br> Minimum length = 1<br> Maximum length = 256</p>
|
|
<p class="property_name">lom_ip_address<span class="property_type"><String></span></p><p class="property_description">LOM IP Address.</p>
|
|
<p class="property_name">datacenter_id<span class="property_type"><String></span></p><p class="property_description">Datacenter Id is system generated key for data center.</p>
|
|
<p class="property_name">std_bw_config<span class="property_type"><Integer></span></p><p class="property_description">Standard Bandwidth running.</p>
|
|
<p class="property_name">instance_mode<span class="property_type"><String></span></p><p class="property_description">Denotes state- primary,secondary,clip,clusternode.</p>
|
|
<p class="property_name">license_edition<span class="property_type"><String></span></p><p class="property_description">Edition of instance.</p>
|
|
<p class="property_name">display_name<span class="property_type"><String></span></p><p class="property_description">Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">ent_bw_total<span class="property_type"><Integer></span></p><p class="property_description">Enterprise Bandwidth Total.</p>
|
|
<p class="property_name">description<span class="property_type"><String></span></p><p class="property_description">Description of managed device.<br> Minimum length = 1<br> Maximum length = 512</p>
|
|
<p class="property_name">type<span class="property_type"><String></span></p><p class="property_description">Type of device, (Xen | NS).<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">device_finger_print<span class="property_type"><String></span></p><p class="property_description">Fingerprint/thumb-print from UMS public certificate for SSL communication.</p>
|
|
<p class="property_name">gateway<span class="property_type"><String></span></p><p class="property_description">Default Gateway of managed device.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">agent_id<span class="property_type"><String></span></p><p class="property_description">Agent Id.</p>
|
|
<p class="property_name">sysservices<span class="property_type"><Double></span></p><p class="property_description">System Services.</p>
|
|
<p class="property_name">ipv6_address<span class="property_type"><String></span></p><p class="property_description">IPv6 Address.</p>
|
|
<p class="property_name">instance_total<span class="property_type"><Integer></span></p><p class="property_description">Instance license.</p>
|
|
<p class="property_name">is_ha_configured<span class="property_type"><Boolean></span></p><p class="property_description">Is HA configured.</p>
|
|
<p class="property_name">ent_bw_available<span class="property_type"><Integer></span></p><p class="property_description">Enterprise Bandwidth configured.</p>
|
|
<p class="property_name">gateway_deployment<span class="property_type"><Boolean></span></p><p class="property_description">Is this device acting as Gateway..</p>
|
|
<p class="property_name">partition_name<span class="property_type"><String></span></p><p class="property_description">NetScaler Admin Partition Name.<br> Maximum length = 512</p>
|
|
<p class="property_name">is_managed<span class="property_type"><Boolean></span></p><p class="property_description">Is Managed.</p>
|
|
<p class="property_name">sslvpn_config<span class="property_type"><Integer></span></p><p class="property_description">sslvpn license maximum.</p>
|
|
<p class="property_name">std_bw_available<span class="property_type"><Integer></span></p><p class="property_description">Standard Bandwidth Available.</p>
|
|
<p class="property_name">instance_available<span class="property_type"><Integer></span></p><p class="property_description">Instance license available.</p>
|
|
<p class="property_name">last_updated_time<span class="property_type"><Double></span></p><p class="property_description">Last Updated Time.</p>
|
|
<p class="property_name">last_up_time<span class="property_type"><Double></span></p><p class="property_description">Last time when the device was seen up.</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">IP Address for this managed device.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">sslvpn_total<span class="property_type"><Integer></span></p><p class="property_description">sslvpn license.</p>
|
|
<p class="property_name">is_autoscale_group<span class="property_type"><Boolean></span></p><p class="property_description">Does this device belong to an Autoscale Group..</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the managed devices.</p>
|
|
<p class="property_name">std_bw_total<span class="property_type"><Integer></span></p><p class="property_description">Standard Bandwidth.</p>
|
|
<p class="property_name">ent_bw_config<span class="property_type"><Integer></span></p><p class="property_description">Enterprise Bandwidth configured.</p>
|
|
<p class="property_name">partition_id<span class="property_type"><String></span></p><p class="property_description">ID of admin partition.</p>
|
|
<p class="property_name">trust_id<span class="property_type"><String></span></p><p class="property_description">Device ID obtained from trust service.</p>
|
|
<p class="property_name">instance_classifier<span class="property_type"><Integer></span></p><p class="property_description">Value based on which certain features may be enabled/disabled in NetScaler Console for the instance.</p>
|
|
<p class="property_name">geo_support<span class="property_type"><Boolean></span></p><p class="property_description">Is this device configured to support GEO location..</p>
|
|
<p class="property_name">isolation_policy<span class="property_type"><String></span></p><p class="property_description">Isolation Policy of the Device.</p>
|
|
<p class="property_name">maintenance_status<span class="property_type"><Boolean></span></p><p class="property_description">The status if the device is within the maintenance window.</p>
|
|
<p class="property_name">plt_bw_config<span class="property_type"><Integer></span></p><p class="property_description">Platinum Bandwidth configured.</p>
|
|
<p class="property_name">template_interval<span class="property_type"><Integer></span></p><p class="property_description">Template refresh interval.</p>
|
|
<p class="property_name">license_mode<span class="property_type"><String></span></p><p class="property_description">license mode: FOREIGN_POOL, FOREIGN_LAS, EXPRESS, POOLED, LAS, LOCAL, CICO etc..</p>
|
|
<p class="property_name">mgmt_ip_address<span class="property_type"><String></span></p><p class="property_description">Management IP Address for this Managed Device.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">license_server<span class="property_type"><String></span></p><p class="property_description">License Server Configured.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">httpxforwardedfor<span class="property_type"><String></span></p><p class="property_description">HTTP x-Forwardedfor header flag..<br> Minimum length = 1<br> Maximum length = 10</p>
|
|
<p class="property_name">vpx_information<span class="property_type"><vpx_info[]></span></p><p class="property_description">Get BW of VPX on SDX info.</p>
|
|
<p class="property_name">autoprovisioned<span class="property_type"><Boolean></span></p><p class="property_description">Device is auto-provisioned or not.</p>
|
|
<p class="property_name">device_family<span class="property_type"><String></span></p><p class="property_description">Device Family.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">gateway_ipv6<span class="property_type"><String></span></p><p class="property_description">Gateway IPv6 Address.</p>
|
|
<p class="property_name">servicepackage<span class="property_type"><String></span></p><p class="property_description">Service Package Name of the device.</p>
|
|
<p class="property_name">provision_request_id<span class="property_type"><String></span></p><p class="property_description">Value is set only if the instance was provisioned from NetScaler Console.</p>
|
|
<p class="property_name">mastools_version<span class="property_type"><String></span></p><p class="property_description">Mastools version if the device is embedded agent.</p>
|
|
<p class="property_name">internal_annotation<span class="property_type"><String></span></p><p class="property_description">Internal annotation used by NetScaler Console.Example, if a device is marked for delete.</p>
|
|
<p class="property_name">xen_ip_address<span class="property_type"><String></span></p><p class="property_description">XEN IP Address.</p>
|
|
<p class="property_name">instance_config<span class="property_type"><Integer></span></p><p class="property_description">Instance license running.</p>
|
|
<p class="property_name">file_name<span class="property_type"><String></span></p><p class="property_description">File name which contains comma separated instances to be discovered.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">entity_tag<span class="property_type"><property_map[]></span></p><p class="property_description">Array of tag_name and tag_value pair assocaited with an entity.</p>
|
|
<p class="property_name">peer_host_device_ip<span class="property_type"><String></span></p><p class="property_description">Peer Host Device IP Address for instance of type BLX ADC..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">profile_password<span class="property_type"><String></span></p><p class="property_description">Password specified by the user for this NetScaler Instance..<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">manual_inventory<span class="property_type"><Boolean></span></p><p class="property_description">manual_inventory.</p>
|
|
<p class="property_name">prev_trust_id<span class="property_type"><String></span></p><p class="property_description">Previous trust ID of the mastools device.</p>
|
|
<p class="property_name">device_host_ip<span class="property_type"><String></span></p><p class="property_description">Device Host IP Address for instance of type BLX ADC..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">profile_username<span class="property_type"><String></span></p><p class="property_description">User Name specified by the user for this NetScaler Instance..<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">peer_device_ip<span class="property_type"><String></span></p><p class="property_description">Peer Device IP address for instance of type BLX ADC..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">tr_task_id<span class="property_type"><String></span></p><p class="property_description">Task Id used by Triton to identify NS.</p>
|
|
<p class="property_name">is_re_register<span class="property_type"><Boolean></span></p><p class="property_description">If set to true, NetScaler Console will re-register the instance by first deleting it then adding it.</p>
|
|
<p class="property_name">file_location_path<span class="property_type"><String></span></p><p class="property_description">File Location on Client for upload/download.<br> Minimum length = 1</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">memory_total<span class="property_type"><Double></span></p><p class="property_description">Total memory of host in MB.</p>
|
|
<p class="property_name">ssh_status<span class="property_type"><String></span></p><p class="property_description">SSH Status of device, UP only if device accessible on SSH.</p>
|
|
<p class="property_name">version<span class="property_type"><String></span></p><p class="property_description">Device Version.</p>
|
|
<p class="property_name">max_throughput<span class="property_type"><String></span></p><p class="property_description">Maximum Throughput in Mbps.</p>
|
|
<p class="property_name">region<span class="property_type"><String></span></p><p class="property_description">Region in which the managed device is hosted.</p>
|
|
<p class="property_name">zone<span class="property_type"><String></span></p><p class="property_description">Zone in which the managed device is hosted.</p>
|
|
<p class="property_name">httpquerywithurl<span class="property_type"><String></span></p><p class="property_description">URL query params flag..</p>
|
|
<p class="property_name">product<span class="property_type"><String></span></p><p class="property_description">Product Name.</p>
|
|
<p class="property_name">bmcrevision<span class="property_type"><String></span></p><p class="property_description">BMC Firmware Version.</p>
|
|
<p class="property_name">lm_serialnumber<span class="property_type"><String></span></p><p class="property_description">LM Serial Number.</p>
|
|
<p class="property_name">do_config<span class="property_type"><Boolean></span></p><p class="property_description">Do default config for managed device.</p>
|
|
<p class="property_name">number_of_cpu<span class="property_type"><Integer></span></p><p class="property_description">Number of total CPU of host.</p>
|
|
<p class="property_name">is_fips_pooled_license_type<span class="property_type"><Integer></span></p><p class="property_description">FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license.</p>
|
|
<p class="property_name">cloud<span class="property_type"><String></span></p><p class="property_description">Cloud on which the managed device is hosted.</p>
|
|
<p class="property_name">tx<span class="property_type"><Double></span></p><p class="property_description">Out Throughput (Mbps) of host.</p>
|
|
<p class="property_name">rx<span class="property_type"><Double></span></p><p class="property_description">In Throughput (Mbps) of host.</p>
|
|
<p class="property_name">status<span class="property_type"><String></span></p><p class="property_description">Status of managed device.</p>
|
|
<p class="property_name">private_dns<span class="property_type"><String></span></p><p class="property_description">Private DNS of the managed device.</p>
|
|
<p class="property_name">instance_type<span class="property_type"><String></span></p><p class="property_description">Instance type indicates the deployment type of CPX.</p>
|
|
<p class="property_name">systemname<span class="property_type"><String></span></p><p class="property_description">Device System Name.</p>
|
|
<p class="property_name">is_pooled_saas<span class="property_type"><Integer></span></p><p class="property_description">Pooled Saas License available : 1, No Pooled Saas License available : 0.</p>
|
|
<p class="property_name">subnet_id<span class="property_type"><String></span></p><p class="property_description">in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).</p>
|
|
<p class="property_name">security_group<span class="property_type"><String></span></p><p class="property_description">virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS).</p>
|
|
<p class="property_name">ssl_cores_total<span class="property_type"><Integer></span></p><p class="property_description">Total SSL Cores available in host.</p>
|
|
<p class="property_name">cpu_usage<span class="property_type"><Double></span></p><p class="property_description">CPU Usage (%) of host.</p>
|
|
<p class="property_name">device_uuid<span class="property_type"><String></span></p><p class="property_description">Device UUID.</p>
|
|
<p class="property_name">max_number_of_instances<span class="property_type"><Integer></span></p><p class="property_description">Maximum Instances.</p>
|
|
<p class="property_name">acu_total<span class="property_type"><Integer></span></p><p class="property_description">Total Asymmetric Crypto Units available in host.</p>
|
|
<p class="property_name">build_number<span class="property_type"><String></span></p><p class="property_description">Build Number.</p>
|
|
<p class="property_name">lpeid<span class="property_type"><String></span></p><p class="property_description">LPEID for devices using LAS license.</p>
|
|
<p class="property_name">acu_free<span class="property_type"><Integer></span></p><p class="property_description">Free Asymmetric Crypto Units.</p>
|
|
<p class="property_name">sysid<span class="property_type"><String></span></p><p class="property_description">System ID.</p>
|
|
<p class="property_name">hostid<span class="property_type"><String></span></p><p class="property_description">Host Id.</p>
|
|
<p class="property_name">bios_version<span class="property_type"><String></span></p><p class="property_description">BIOS Version.</p>
|
|
<p class="property_name">total_crypto_devices<span class="property_type"><Integer></span></p><p class="property_description">Total Crypto Devices.</p>
|
|
<p class="property_name">memory_free<span class="property_type"><Double></span></p><p class="property_description">Free memory available (MB) in host.</p>
|
|
<p class="property_name">burnin_date<span class="property_type"><String></span></p><p class="property_description">burnin_date for devices using LAS license.</p>
|
|
<p class="property_name">scu_free<span class="property_type"><Integer></span></p><p class="property_description">Free Symmetric Crypto Units.</p>
|
|
<p class="property_name">location<span class="property_type"><String></span></p><p class="property_description">Device Location.</p>
|
|
<p class="property_name">encoded_serialnumber<span class="property_type"><String></span></p><p class="property_description">Encoded Serial Number.</p>
|
|
<p class="property_name">cpu_license_type<span class="property_type"><Integer></span></p><p class="property_description">VCPU license 0 = No VCPU License, 1 = VCPU Pool license.</p>
|
|
<p class="property_name">model_id<span class="property_type"><String></span></p><p class="property_description">Device Model Id.</p>
|
|
<p class="property_name">ami_id<span class="property_type"><String></span></p><p class="property_description">AMI ID of the managed device (if hosted on AWS).</p>
|
|
<p class="property_name">scu_total<span class="property_type"><Integer></span></p><p class="property_description">Total Symmetric Crypto Units available in host.</p>
|
|
<p class="property_name">public_dns<span class="property_type"><String></span></p><p class="property_description">Public DNS of the managed device.</p>
|
|
<p class="property_name">vpc_id<span class="property_type"><String></span></p><p class="property_description">VPC ID of the managed device.</p>
|
|
<p class="property_name">ha_master_state<span class="property_type"><String></span></p><p class="property_description">Master State (Primary/Secondary).</p>
|
|
<p class="property_name">contactperson<span class="property_type"><String></span></p><p class="property_description">Device contact person.</p>
|
|
<p class="property_name">serialnumber<span class="property_type"><String></span></p><p class="property_description">Device Serial Number.</p>
|
|
<p class="property_name">host_id<span class="property_type"><String></span></p><p class="property_description">Host ID.</p>
|
|
<p class="property_name">ha_sync<span class="property_type"><String></span></p><p class="property_description">HA Synchronization State.</p>
|
|
<p class="property_name">license_grace_time<span class="property_type"><Integer></span></p><p class="property_description">Grace for this NetScaler Instance..</p>
|
|
<p class="property_name">instance_unique_id<span class="property_type"><Integer></span></p><p class="property_description">32 bit unique Integer id generated by NetScaler NetScaler Console for this device.</p>
|
|
<p class="property_name">las_cpx_edition<span class="property_type"><String></span></p><p class="property_description">las_cpx_edition for CPX devices requesting LAS capacity during registration.</p>
|
|
<p class="property_name">available_number_of_instances<span class="property_type"><Integer></span></p><p class="property_description">Available Instances.</p>
|
|
<p class="property_name">geo_location<span class="property_type"><String></span></p><p class="property_description">Geo location of the managed device.</p>
|
|
<p class="property_name">lm_host_id<span class="property_type"><String></span></p><p class="property_description">LM Host ID.</p>
|
|
<p class="property_name">httpcookie<span class="property_type"><String></span></p><p class="property_description">Cookie-Header flag..</p>
|
|
<p class="property_name">number_of_cpu_cores<span class="property_type"><Integer></span></p><p class="property_description">Number of total CPU cores of host.</p>
|
|
<p class="property_name">instance_state<span class="property_type"><String></span></p><p class="property_description">State of device, UP only if device accessible.</p>
|
|
<p class="property_name">uuid<span class="property_type"><String></span></p><p class="property_description">UUID of host.</p>
|
|
<p class="property_name">vpx_on_cloud<span class="property_type"><Integer></span></p><p class="property_description">Cloud Platform of vpx: 0= On-Prem vpx, 1= AWS, 3=Azure, 4=GCP.</p>
|
|
<p class="property_name">cpufrequncy<span class="property_type"><Integer></span></p><p class="property_description">CPU Frequency (MHZ).</p>
|
|
<p class="property_name">platform<span class="property_type"><String></span></p><p class="property_description">Platform.</p>
|
|
<p class="property_name">public_ip<span class="property_type"><String></span></p><p class="property_description">Public IP of the managed device.</p>
|
|
<p class="property_name">private_ip<span class="property_type"><String></span></p><p class="property_description">Private IP of the managed device.</p>
|
|
<p class="property_name">tenant_id<span class="property_type"><String></span></p><p class="property_description">Tenant ID.</p>
|
|
<p class="property_name">memory_usage<span class="property_type"><Double></span></p><p class="property_description">Memory Usage (%) of host.</p>
|
|
<p class="property_name">mpx_encryption_status<span class="property_type"><String></span></p><p class="property_description">Encryption status of the filesystem of MPX device.</p>
|
|
<p class="property_name">disk_usage<span class="property_type"><Double></span></p><p class="property_description">Disk usage (MB) for host.</p>
|
|
<p class="property_name">uptime<span class="property_type"><String></span></p><p class="property_description">Uptime of device.</p>
|
|
<p class="property_name">disk_free<span class="property_type"><Double></span></p><p class="property_description">Show free Disk Space (MB) available on host.</p>
|
|
<p class="property_name">upsince<span class="property_type"><String></span></p><p class="property_description">Upsince of managed device.</p>
|
|
<p class="property_name">current_time<span class="property_type"><Integer></span></p><p class="property_description">Current Time.</p>
|
|
<p class="property_name">disk_space<span class="property_type"><Double></span></p><p class="property_description">Show Disk Space (MB) available on host.</p>
|
|
<p class="property_name">ha_ip_address<span class="property_type"><String></span></p><p class="property_description">Peer IP Address.</p>
|
|
<p class="property_name">vpx_on_sdx<span class="property_type"><Integer></span></p><p class="property_description">VPX hosted on SDX: 1= Yes, 0= No.</p>
|
|
<p class="property_name">enabled<span class="property_type"><Boolean></span></p><p class="property_description">host State.</p>
|
|
<p class="property_name">manufacturedate<span class="property_type"><String></span></p><p class="property_description">Manufacture Date.</p>
|
|
<p class="property_name">reason<span class="property_type"><String></span></p><p class="property_description">Reason of failure for this managed device.</p>
|
|
<p class="property_name">available_throughput<span class="property_type"><String></span></p><p class="property_description">Available Throughput in Mbps.</p>
|
|
<p class="property_name">ssl_cores_free<span class="property_type"><Integer></span></p><p class="property_description">Free SSL Cores.</p>
|
|
<p class="property_name">act_id<span class="property_type"><String></span></p><p class="property_description">Activity Id.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#add" class="operation">add</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#manage" class="operation">manage</a><a href="#unmanage" class="operation">unmanage</a><a href="#reboot" class="operation">reboot</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"sdx": {<br><font color=#FF0000><b> "ip_address":<String_value></b></font>,<br><font color=#000000> "lom_ip_address":<String_value></font>,<br><font color=#000000> "geo_support":<Boolean_value></font>,<br><font color=#000000> "isolation_policy":<String_value></font>,<br><font color=#000000> "datacenter_id":<String_value></font>,<br><font color=#000000> "hostname":<String_value></font>,<br><font color=#000000> "vcpu_config":<Integer_value></font>,<br><font color=#000000> "file_location_path":<String_value></font>,<br><font color=#000000> "peer_device_ip":<String_value></font>,<br><font color=#000000> "instance_classifier":<Integer_value></font>,<br><font color=#000000> "entity_tag":[{<br><font color=#000000> "prop_value":<String_value></font>,<br><font color=#000000> "prop_key":<String_value></font>}]</font>,<br><font color=#000000> "partition_id":<String_value></font>,<br><font color=#000000> "ent_bw_config":<Integer_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "netmask":<String_value></font>,<br><font color=#000000> "trust_id":<String_value></font>,<br><font color=#000000> "file_name":<String_value></font>,<br><font color=#000000> "las_cpx_bw":<Integer_value></font>,<br><font color=#000000> "ipv4_address":<String_value></font>,<br><font color=#000000> "profile_password":<String_value></font>,<br><font color=#000000> "std_bw_total":<Integer_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "node_id":<String_value></font>,<br><font color=#000000> "plt_bw_total":<Integer_value></font>,<br><font color=#000000> "is_autoscale_group":<Boolean_value></font>,<br><font color=#000000> "sslvpn_total":<Integer_value></font>,<br><font color=#000000> "is_re_register":<Boolean_value></font>,<br><font color=#000000> "autoscalegroup_id":<String_value></font>,<br><font color=#000000> "last_updated_time":<Double_value></font>,<br><font color=#000000> "instance_available":<Integer_value></font>,<br><font color=#000000> "last_up_time":<Double_value></font>,<br><font color=#000000> "profile_name":<String_value></font>,<br><font color=#000000> "manual_inventory":<Boolean_value></font>,<br><font color=#000000> "std_bw_available":<Integer_value></font>,<br><font color=#000000> "plt_bw_available":<Integer_value></font>,<br><font color=#000000> "discovery_time":<Double_value></font>,<br><font color=#000000> "config_type":<Integer_value></font>,<br><font color=#000000> "is_managed":<Boolean_value></font>,<br><font color=#000000> "partition_name":<String_value></font>,<br><font color=#000000> "device_host_ip":<String_value></font>,<br><font color=#000000> "profile_username":<String_value></font>,<br><font color=#000000> "sslvpn_config":<Integer_value></font>,<br><font color=#000000> "instance_config":<Integer_value></font>,<br><font color=#000000> "xen_ip_address":<String_value></font>,<br><font color=#000000> "internal_annotation":<String_value></font>,<br><font color=#000000> "gateway_deployment":<Boolean_value></font>,<br><font color=#000000> "ent_bw_available":<Integer_value></font>,<br><font color=#000000> "provision_request_id":<String_value></font>,<br><font color=#000000> "servicepackage":<String_value></font>,<br><font color=#000000> "sysservices":<Double_value></font>,<br><font color=#000000> "is_ha_configured":<Boolean_value></font>,<br><font color=#000000> "instance_total":<Integer_value></font>,<br><font color=#000000> "mastools_version":<String_value></font>,<br><font color=#000000> "ipv6_address":<String_value></font>,<br><font color=#000000> "device_finger_print":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "autoprovisioned":<Boolean_value></font>,<br><font color=#000000> "gateway_ipv6":<String_value></font>,<br><font color=#000000> "gateway":<String_value></font>,<br><font color=#000000> "agent_id":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "tr_task_id":<String_value></font>,<br><font color=#000000> "vpx_information":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "ip_address":<String_value></font>,<br><font color=#000000> "license_edition":<String_value></font>}]</font>,<br><font color=#000000> "httpxforwardedfor":<String_value></font>,<br><font color=#000000> "license_server":<String_value></font>,<br><font color=#000000> "mgmt_ip_address":<String_value></font>,<br><font color=#000000> "instance_mode":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "license_edition":<String_value></font>,<br><font color=#000000> "ent_bw_total":<Integer_value></font>,<br><font color=#000000> "peer_host_device_ip":<String_value></font>,<br><font color=#000000> "std_bw_config":<Integer_value></font>,<br><font color=#000000> "template_interval":<Integer_value></font>,<br><font color=#000000> "prev_trust_id":<String_value></font>,<br><font color=#000000> "plt_bw_config":<Integer_value></font>,<br><font color=#000000> "maintenance_status":<Boolean_value></font>,<br><font color=#000000> "license_mode":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sdx":[{<br> "memory_total":<Double_value></font>,<br> "profile_name":<String_value></font>,<br> "ssh_status":<String_value></font>,<br> "config_type":<Integer_value></font>,<br> "discovery_time":<Double_value></font>,<br> "plt_bw_available":<Integer_value></font>,<br> "version":<String_value></font>,<br> "max_throughput":<String_value></font>,<br> "region":<String_value></font>,<br> "zone":<String_value></font>,<br> "httpquerywithurl":<String_value></font>,<br> "product":<String_value></font>,<br> "autoscalegroup_id":<String_value></font>,<br> "bmcrevision":<String_value></font>,<br> "lm_serialnumber":<String_value></font>,<br> "do_config":<Boolean_value></font>,<br> "number_of_cpu":<Integer_value></font>,<br> "is_fips_pooled_license_type":<Integer_value></font>,<br> "cloud":<String_value></font>,<br> "tx":<Double_value></font>,<br> "rx":<Double_value></font>,<br> "status":<String_value></font>,<br> "private_dns":<String_value></font>,<br> "instance_type":<String_value></font>,<br> "systemname":<String_value></font>,<br> "las_cpx_bw":<Integer_value></font>,<br> "ipv4_address":<String_value></font>,<br> "plt_bw_total":<Integer_value></font>,<br> "is_pooled_saas":<Integer_value></font>,<br> "node_id":<String_value></font>,<br> "subnet_id":<String_value></font>,<br> "ping_state":<Integer_value></font>,<br> "netmask":<String_value></font>,<br> "security_group":<String_value></font>,<br> "ssl_cores_total":<Integer_value></font>,<br> "name":<String_value></font>,<br> "vcpu_config":<Integer_value></font>,<br> "hostname":<String_value></font>,<br> "cpu_usage":<Double_value></font>,<br> "lom_ip_address":<String_value></font>,<br> "device_uuid":<String_value></font>,<br> "datacenter_id":<String_value></font>,<br> "std_bw_config":<Integer_value></font>,<br> "max_number_of_instances":<Integer_value></font>,<br> "acu_total":<Integer_value></font>,<br> "instance_mode":<String_value></font>,<br> "license_edition":<String_value></font>,<br> "display_name":<String_value></font>,<br> "build_number":<String_value></font>,<br> "ent_bw_total":<Integer_value></font>,<br> "lpeid":<String_value></font>,<br> "acu_free":<Integer_value></font>,<br> "description":<String_value></font>,<br> "type":<String_value></font>,<br> "sysid":<String_value></font>,<br> "hostid":<String_value></font>,<br> "device_finger_print":<String_value></font>,<br> "bios_version":<String_value></font>,<br> "total_crypto_devices":<Integer_value></font>,<br> "memory_free":<Double_value></font>,<br> "gateway":<String_value></font>,<br> "agent_id":<String_value></font>,<br> "burnin_date":<String_value></font>,<br> "sysservices":<Double_value></font>,<br> "ipv6_address":<String_value></font>,<br> "instance_total":<Integer_value></font>,<br> "is_ha_configured":<Boolean_value></font>,<br> "is_las_license":<Boolean_value></font>,<br> "is_grace":<Boolean_value></font>,<br> "ent_bw_available":<Integer_value></font>,<br> "scu_free":<Integer_value></font>,<br> "gateway_deployment":<Boolean_value></font>,<br> "location":<String_value></font>,<br> "encoded_serialnumber":<String_value></font>,<br> "cpu_license_type":<Integer_value></font>,<br> "model_id":<String_value></font>,<br> "ami_id":<String_value></font>,<br> "partition_name":<String_value></font>,<br> "is_managed":<Boolean_value></font>,<br> "scu_total":<Integer_value></font>,<br> "seq_no":<Double_value></font>,<br> "sslvpn_config":<Integer_value></font>,<br> "public_dns":<String_value></font>,<br> "vpc_id":<String_value></font>,<br> "std_bw_available":<Integer_value></font>,<br> "instance_available":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "last_up_time":<Double_value></font>,<br> "ip_address":<String_value></font>,<br> "ha_master_state":<String_value></font>,<br> "contactperson":<String_value></font>,<br> "serialnumber":<String_value></font>,<br> "host_id":<String_value></font>,<br> "ha_sync":<String_value></font>,<br> "license_grace_time":<Integer_value></font>,<br> "sslvpn_total":<Integer_value></font>,<br> "instance_unique_id":<Integer_value></font>,<br> "las_cpx_edition":<String_value></font>,<br> "customer_name":<String_value></font>,<br> "available_number_of_instances":<Integer_value></font>,<br> "geo_location":<String_value></font>,<br> "is_autoscale_group":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "std_bw_total":<Integer_value></font>,<br> "lm_host_id":<String_value></font>,<br> "parent_filters":<String_value></font>,<br> "ent_bw_config":<Integer_value></font>,<br> "httpcookie":<String_value></font>,<br> "partition_id":<String_value></font>,<br> "trust_id":<String_value></font>,<br> "number_of_cpu_cores":<Integer_value></font>,<br> "is_pooled_license":<Boolean_value></font>,<br> "instance_state":<String_value></font>,<br> "instance_classifier":<Integer_value></font>,<br> "geo_support":<Boolean_value></font>,<br> "uuid":<String_value></font>,<br> "vpx_on_cloud":<Integer_value></font>,<br> "isolation_policy":<String_value></font>,<br> "cpufrequncy":<Integer_value></font>,<br> "maintenance_status":<Boolean_value></font>,<br> "plt_bw_config":<Integer_value></font>,<br> "platform":<String_value></font>,<br> "public_ip":<String_value></font>,<br> "template_interval":<Integer_value></font>,<br> "private_ip":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "license_mode":<String_value></font>,<br> "mgmt_ip_address":<String_value></font>,<br> "license_server":<String_value></font>,<br> "memory_usage":<Double_value></font>,<br> "mpx_encryption_status":<String_value></font>,<br> "disk_usage":<Double_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vpx_information":[{<br> "license_edition":<String_value></font>,<br> "name":<String_value></font>,<br> "id":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "throughput":<String_value></font>}],<br> "autoprovisioned":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "uptime":<String_value></font>,<br> "disk_free":<Double_value></font>,<br> "gateway_ipv6":<String_value></font>,<br> "servicepackage":<String_value></font>,<br> "upsince":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "mastools_version":<String_value></font>,<br> "internal_annotation":<String_value></font>,<br> "current_time":<Integer_value></font>,<br> "user_driven":<Boolean_value></font>,<br> "xen_ip_address":<String_value></font>,<br> "disk_space":<Double_value></font>,<br> "ha_ip_address":<String_value></font>,<br> "vpx_on_sdx":<Integer_value></font>,<br> "enabled":<Boolean_value></font>,<br> "manufacturedate":<String_value></font>,<br> "instance_config":<Integer_value></font>,<br> "reason":<String_value></font>,<br> "available_throughput":<String_value></font>,<br> "file_name":<String_value></font>,<br> "parent_inventory":<Boolean_value></font>,<br> "entity_tag":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "default_password":<String_value></font>,<br> "peer_host_device_ip":<String_value></font>,<br> "profile_password":<String_value></font>,<br> "manual_inventory":<Boolean_value></font>,<br> "prev_trust_id":<String_value></font>,<br> "do_instance_config":<Boolean_value></font>,<br> "register_failed_device":<Boolean_value></font>,<br> "ssl_cores_free":<Integer_value></font>,<br> "force_password_change":<Boolean_value></font>,<br> "device_host_ip":<String_value></font>,<br> "act_id":<String_value></font>,<br> "profile_username":<String_value></font>,<br> "sync_operation":<Boolean_value></font>,<br> "peer_device_ip":<String_value></font>,<br> "tr_task_id":<String_value></font>,<br> "is_re_register":<Boolean_value></font>,<br> "file_location_path":<String_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/sdx<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">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.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/sdx<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the sdx resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/sdx<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of sdx resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sdx":[{<br> "memory_total":<Double_value></font>,<br> "profile_name":<String_value></font>,<br> "ssh_status":<String_value></font>,<br> "config_type":<Integer_value></font>,<br> "discovery_time":<Double_value></font>,<br> "plt_bw_available":<Integer_value></font>,<br> "version":<String_value></font>,<br> "max_throughput":<String_value></font>,<br> "region":<String_value></font>,<br> "zone":<String_value></font>,<br> "httpquerywithurl":<String_value></font>,<br> "product":<String_value></font>,<br> "autoscalegroup_id":<String_value></font>,<br> "bmcrevision":<String_value></font>,<br> "lm_serialnumber":<String_value></font>,<br> "do_config":<Boolean_value></font>,<br> "number_of_cpu":<Integer_value></font>,<br> "is_fips_pooled_license_type":<Integer_value></font>,<br> "cloud":<String_value></font>,<br> "tx":<Double_value></font>,<br> "rx":<Double_value></font>,<br> "status":<String_value></font>,<br> "private_dns":<String_value></font>,<br> "instance_type":<String_value></font>,<br> "systemname":<String_value></font>,<br> "las_cpx_bw":<Integer_value></font>,<br> "ipv4_address":<String_value></font>,<br> "plt_bw_total":<Integer_value></font>,<br> "is_pooled_saas":<Integer_value></font>,<br> "node_id":<String_value></font>,<br> "subnet_id":<String_value></font>,<br> "ping_state":<Integer_value></font>,<br> "netmask":<String_value></font>,<br> "security_group":<String_value></font>,<br> "ssl_cores_total":<Integer_value></font>,<br> "name":<String_value></font>,<br> "vcpu_config":<Integer_value></font>,<br> "hostname":<String_value></font>,<br> "cpu_usage":<Double_value></font>,<br> "lom_ip_address":<String_value></font>,<br> "device_uuid":<String_value></font>,<br> "datacenter_id":<String_value></font>,<br> "std_bw_config":<Integer_value></font>,<br> "max_number_of_instances":<Integer_value></font>,<br> "acu_total":<Integer_value></font>,<br> "instance_mode":<String_value></font>,<br> "license_edition":<String_value></font>,<br> "display_name":<String_value></font>,<br> "build_number":<String_value></font>,<br> "ent_bw_total":<Integer_value></font>,<br> "lpeid":<String_value></font>,<br> "acu_free":<Integer_value></font>,<br> "description":<String_value></font>,<br> "type":<String_value></font>,<br> "sysid":<String_value></font>,<br> "hostid":<String_value></font>,<br> "device_finger_print":<String_value></font>,<br> "bios_version":<String_value></font>,<br> "total_crypto_devices":<Integer_value></font>,<br> "memory_free":<Double_value></font>,<br> "gateway":<String_value></font>,<br> "agent_id":<String_value></font>,<br> "burnin_date":<String_value></font>,<br> "sysservices":<Double_value></font>,<br> "ipv6_address":<String_value></font>,<br> "instance_total":<Integer_value></font>,<br> "is_ha_configured":<Boolean_value></font>,<br> "is_las_license":<Boolean_value></font>,<br> "is_grace":<Boolean_value></font>,<br> "ent_bw_available":<Integer_value></font>,<br> "scu_free":<Integer_value></font>,<br> "gateway_deployment":<Boolean_value></font>,<br> "location":<String_value></font>,<br> "encoded_serialnumber":<String_value></font>,<br> "cpu_license_type":<Integer_value></font>,<br> "model_id":<String_value></font>,<br> "ami_id":<String_value></font>,<br> "partition_name":<String_value></font>,<br> "is_managed":<Boolean_value></font>,<br> "scu_total":<Integer_value></font>,<br> "seq_no":<Double_value></font>,<br> "sslvpn_config":<Integer_value></font>,<br> "public_dns":<String_value></font>,<br> "vpc_id":<String_value></font>,<br> "std_bw_available":<Integer_value></font>,<br> "instance_available":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "last_up_time":<Double_value></font>,<br> "ip_address":<String_value></font>,<br> "ha_master_state":<String_value></font>,<br> "contactperson":<String_value></font>,<br> "serialnumber":<String_value></font>,<br> "host_id":<String_value></font>,<br> "ha_sync":<String_value></font>,<br> "license_grace_time":<Integer_value></font>,<br> "sslvpn_total":<Integer_value></font>,<br> "instance_unique_id":<Integer_value></font>,<br> "las_cpx_edition":<String_value></font>,<br> "customer_name":<String_value></font>,<br> "available_number_of_instances":<Integer_value></font>,<br> "geo_location":<String_value></font>,<br> "is_autoscale_group":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "std_bw_total":<Integer_value></font>,<br> "lm_host_id":<String_value></font>,<br> "parent_filters":<String_value></font>,<br> "ent_bw_config":<Integer_value></font>,<br> "httpcookie":<String_value></font>,<br> "partition_id":<String_value></font>,<br> "trust_id":<String_value></font>,<br> "number_of_cpu_cores":<Integer_value></font>,<br> "is_pooled_license":<Boolean_value></font>,<br> "instance_state":<String_value></font>,<br> "instance_classifier":<Integer_value></font>,<br> "geo_support":<Boolean_value></font>,<br> "uuid":<String_value></font>,<br> "vpx_on_cloud":<Integer_value></font>,<br> "isolation_policy":<String_value></font>,<br> "cpufrequncy":<Integer_value></font>,<br> "maintenance_status":<Boolean_value></font>,<br> "plt_bw_config":<Integer_value></font>,<br> "platform":<String_value></font>,<br> "public_ip":<String_value></font>,<br> "template_interval":<Integer_value></font>,<br> "private_ip":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "license_mode":<String_value></font>,<br> "mgmt_ip_address":<String_value></font>,<br> "license_server":<String_value></font>,<br> "memory_usage":<Double_value></font>,<br> "mpx_encryption_status":<String_value></font>,<br> "disk_usage":<Double_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vpx_information":[{<br> "license_edition":<String_value></font>,<br> "name":<String_value></font>,<br> "id":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "throughput":<String_value></font>}],<br> "autoprovisioned":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "uptime":<String_value></font>,<br> "disk_free":<Double_value></font>,<br> "gateway_ipv6":<String_value></font>,<br> "servicepackage":<String_value></font>,<br> "upsince":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "mastools_version":<String_value></font>,<br> "internal_annotation":<String_value></font>,<br> "current_time":<Integer_value></font>,<br> "user_driven":<Boolean_value></font>,<br> "xen_ip_address":<String_value></font>,<br> "disk_space":<Double_value></font>,<br> "ha_ip_address":<String_value></font>,<br> "vpx_on_sdx":<Integer_value></font>,<br> "enabled":<Boolean_value></font>,<br> "manufacturedate":<String_value></font>,<br> "instance_config":<Integer_value></font>,<br> "reason":<String_value></font>,<br> "available_throughput":<String_value></font>,<br> "file_name":<String_value></font>,<br> "parent_inventory":<Boolean_value></font>,<br> "entity_tag":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "default_password":<String_value></font>,<br> "peer_host_device_ip":<String_value></font>,<br> "profile_password":<String_value></font>,<br> "manual_inventory":<Boolean_value></font>,<br> "prev_trust_id":<String_value></font>,<br> "do_instance_config":<Boolean_value></font>,<br> "register_failed_device":<Boolean_value></font>,<br> "ssl_cores_free":<Integer_value></font>,<br> "force_password_change":<Boolean_value></font>,<br> "device_host_ip":<String_value></font>,<br> "act_id":<String_value></font>,<br> "profile_username":<String_value></font>,<br> "sync_operation":<Boolean_value></font>,<br> "peer_device_ip":<String_value></font>,<br> "tr_task_id":<String_value></font>,<br> "is_re_register":<Boolean_value></font>,<br> "file_location_path":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "sdx":[{<br> "memory_total":<Double_value></font>,<br> "profile_name":<String_value></font>,<br> "ssh_status":<String_value></font>,<br> "config_type":<Integer_value></font>,<br> "discovery_time":<Double_value></font>,<br> "plt_bw_available":<Integer_value></font>,<br> "version":<String_value></font>,<br> "max_throughput":<String_value></font>,<br> "region":<String_value></font>,<br> "zone":<String_value></font>,<br> "httpquerywithurl":<String_value></font>,<br> "product":<String_value></font>,<br> "autoscalegroup_id":<String_value></font>,<br> "bmcrevision":<String_value></font>,<br> "lm_serialnumber":<String_value></font>,<br> "do_config":<Boolean_value></font>,<br> "number_of_cpu":<Integer_value></font>,<br> "is_fips_pooled_license_type":<Integer_value></font>,<br> "cloud":<String_value></font>,<br> "tx":<Double_value></font>,<br> "rx":<Double_value></font>,<br> "status":<String_value></font>,<br> "private_dns":<String_value></font>,<br> "instance_type":<String_value></font>,<br> "systemname":<String_value></font>,<br> "las_cpx_bw":<Integer_value></font>,<br> "ipv4_address":<String_value></font>,<br> "plt_bw_total":<Integer_value></font>,<br> "is_pooled_saas":<Integer_value></font>,<br> "node_id":<String_value></font>,<br> "subnet_id":<String_value></font>,<br> "ping_state":<Integer_value></font>,<br> "netmask":<String_value></font>,<br> "security_group":<String_value></font>,<br> "ssl_cores_total":<Integer_value></font>,<br> "name":<String_value></font>,<br> "vcpu_config":<Integer_value></font>,<br> "hostname":<String_value></font>,<br> "cpu_usage":<Double_value></font>,<br> "lom_ip_address":<String_value></font>,<br> "device_uuid":<String_value></font>,<br> "datacenter_id":<String_value></font>,<br> "std_bw_config":<Integer_value></font>,<br> "max_number_of_instances":<Integer_value></font>,<br> "acu_total":<Integer_value></font>,<br> "instance_mode":<String_value></font>,<br> "license_edition":<String_value></font>,<br> "display_name":<String_value></font>,<br> "build_number":<String_value></font>,<br> "ent_bw_total":<Integer_value></font>,<br> "lpeid":<String_value></font>,<br> "acu_free":<Integer_value></font>,<br> "description":<String_value></font>,<br> "type":<String_value></font>,<br> "sysid":<String_value></font>,<br> "hostid":<String_value></font>,<br> "device_finger_print":<String_value></font>,<br> "bios_version":<String_value></font>,<br> "total_crypto_devices":<Integer_value></font>,<br> "memory_free":<Double_value></font>,<br> "gateway":<String_value></font>,<br> "agent_id":<String_value></font>,<br> "burnin_date":<String_value></font>,<br> "sysservices":<Double_value></font>,<br> "ipv6_address":<String_value></font>,<br> "instance_total":<Integer_value></font>,<br> "is_ha_configured":<Boolean_value></font>,<br> "is_las_license":<Boolean_value></font>,<br> "is_grace":<Boolean_value></font>,<br> "ent_bw_available":<Integer_value></font>,<br> "scu_free":<Integer_value></font>,<br> "gateway_deployment":<Boolean_value></font>,<br> "location":<String_value></font>,<br> "encoded_serialnumber":<String_value></font>,<br> "cpu_license_type":<Integer_value></font>,<br> "model_id":<String_value></font>,<br> "ami_id":<String_value></font>,<br> "partition_name":<String_value></font>,<br> "is_managed":<Boolean_value></font>,<br> "scu_total":<Integer_value></font>,<br> "seq_no":<Double_value></font>,<br> "sslvpn_config":<Integer_value></font>,<br> "public_dns":<String_value></font>,<br> "vpc_id":<String_value></font>,<br> "std_bw_available":<Integer_value></font>,<br> "instance_available":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "last_up_time":<Double_value></font>,<br> "ip_address":<String_value></font>,<br> "ha_master_state":<String_value></font>,<br> "contactperson":<String_value></font>,<br> "serialnumber":<String_value></font>,<br> "host_id":<String_value></font>,<br> "ha_sync":<String_value></font>,<br> "license_grace_time":<Integer_value></font>,<br> "sslvpn_total":<Integer_value></font>,<br> "instance_unique_id":<Integer_value></font>,<br> "las_cpx_edition":<String_value></font>,<br> "customer_name":<String_value></font>,<br> "available_number_of_instances":<Integer_value></font>,<br> "geo_location":<String_value></font>,<br> "is_autoscale_group":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "std_bw_total":<Integer_value></font>,<br> "lm_host_id":<String_value></font>,<br> "parent_filters":<String_value></font>,<br> "ent_bw_config":<Integer_value></font>,<br> "httpcookie":<String_value></font>,<br> "partition_id":<String_value></font>,<br> "trust_id":<String_value></font>,<br> "number_of_cpu_cores":<Integer_value></font>,<br> "is_pooled_license":<Boolean_value></font>,<br> "instance_state":<String_value></font>,<br> "instance_classifier":<Integer_value></font>,<br> "geo_support":<Boolean_value></font>,<br> "uuid":<String_value></font>,<br> "vpx_on_cloud":<Integer_value></font>,<br> "isolation_policy":<String_value></font>,<br> "cpufrequncy":<Integer_value></font>,<br> "maintenance_status":<Boolean_value></font>,<br> "plt_bw_config":<Integer_value></font>,<br> "platform":<String_value></font>,<br> "public_ip":<String_value></font>,<br> "template_interval":<Integer_value></font>,<br> "private_ip":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "license_mode":<String_value></font>,<br> "mgmt_ip_address":<String_value></font>,<br> "license_server":<String_value></font>,<br> "memory_usage":<Double_value></font>,<br> "mpx_encryption_status":<String_value></font>,<br> "disk_usage":<Double_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vpx_information":[{<br> "license_edition":<String_value></font>,<br> "name":<String_value></font>,<br> "id":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "throughput":<String_value></font>}],<br> "autoprovisioned":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "uptime":<String_value></font>,<br> "disk_free":<Double_value></font>,<br> "gateway_ipv6":<String_value></font>,<br> "servicepackage":<String_value></font>,<br> "upsince":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "mastools_version":<String_value></font>,<br> "internal_annotation":<String_value></font>,<br> "current_time":<Integer_value></font>,<br> "user_driven":<Boolean_value></font>,<br> "xen_ip_address":<String_value></font>,<br> "disk_space":<Double_value></font>,<br> "ha_ip_address":<String_value></font>,<br> "vpx_on_sdx":<Integer_value></font>,<br> "enabled":<Boolean_value></font>,<br> "manufacturedate":<String_value></font>,<br> "instance_config":<Integer_value></font>,<br> "reason":<String_value></font>,<br> "available_throughput":<String_value></font>,<br> "file_name":<String_value></font>,<br> "parent_inventory":<Boolean_value></font>,<br> "entity_tag":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "default_password":<String_value></font>,<br> "peer_host_device_ip":<String_value></font>,<br> "profile_password":<String_value></font>,<br> "manual_inventory":<Boolean_value></font>,<br> "prev_trust_id":<String_value></font>,<br> "do_instance_config":<Boolean_value></font>,<br> "register_failed_device":<Boolean_value></font>,<br> "ssl_cores_free":<Integer_value></font>,<br> "force_password_change":<Boolean_value></font>,<br> "device_host_ip":<String_value></font>,<br> "act_id":<String_value></font>,<br> "profile_username":<String_value></font>,<br> "sync_operation":<Boolean_value></font>,<br> "peer_device_ip":<String_value></font>,<br> "tr_task_id":<String_value></font>,<br> "is_re_register":<Boolean_value></font>,<br> "file_location_path":<String_value></font>}]}</p><p class="heading"><a name="manage">manage</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String>?action=manage&onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"sdx": { }}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>}<p class="heading"><a name="unmanage">unmanage</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String>?action=unmanage&onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"sdx": { }}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>}<p class="heading"><a name="reboot">reboot</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String>?action=reboot&onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"sdx": { }}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>}<p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/sdx/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p>
|
|
</body>
|
|
</html>
|