Skip to content

ns

Configuration for NetScaler resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
gateway_deployment<Boolean>Read-writeIs this device acting as Gateway..
std_bw_config<Integer>Read-writeStandard Bandwidth running.
ns_ip_address<String>Read-writeNS IP Address for this managed device.
Minimum length = 1
Maximum length = 64
gateway_ipv6<String>Read-writeGateway IPv6 Address.
instance_available<Integer>Read-writeInstance license available.
device_finger_print<String>Read-writeFingerprint/thumb-print from UMS public certificate for SSL communication.
name<String>Read-writeName of managed device.
Minimum length = 1
Maximum length = 128
mastools_version<String>Read-writeMastools version if the device is embedded agent.
ent_bw_total<Integer>Read-writeEnterprise Bandwidth Total.
ssh_port<Integer>Read-writeSSH port of the container..
netmask<String>Read-writeNetmask of managed device.
Minimum length = 1
Maximum length = 64
ent_bw_config<Integer>Read-writeEnterprise Bandwidth configured.
datacenter_id<String>Read-writeDatacenter Id is system generated key for data center.
instance_config<Integer>Read-writeInstance license running.
instance_mode<String>Read-writeDenotes state- primary,secondary,clip,clusternode.
discovery_time<Double>Read-writediscovery time.
number_of_ssl_cores_up<Integer>Read-writeNumber of SSL Cores Up.
std_bw_available<Integer>Read-writeStandard Bandwidth Available.
instance_name<String>Read-writeNetScaler CPX Instance Name.
plt_bw_total<Integer>Read-writeTotal Platinum Bandwidth.
host_ip_address<String>Read-writeHost IPAddress where VM is provisioned.
Minimum length = 1
Maximum length = 64
id<String>Read-writeId is system generated key for all the managed devices.
ipv6_address<String>Read-writeIPv6 Address.
mgmt_ip_address<String>Read-writeManagement IP Address for this Managed Device.
Minimum length = 1
Maximum length = 64
plt_bw_available<Integer>Read-writePlatinum Bandwidth Available.
is_clip<Boolean>Read-writeIs Clip.
device_family<String>Read-writeDevice Family.
Minimum length = 1
Maximum length = 64
type<String>Read-writeType of device, (Xen | NS).
Minimum length = 1
Maximum length = 64
throughput<Double>Read-writeAssign throughput in Mbps to VM Instance.
ns_observationdomainid<String>Read-writens_observationdomainid.
Minimum length = 1
Maximum length = 64
gateway<String>Read-writeDefault Gateway of managed device.
Minimum length = 1
Maximum length = 64
http_port<Integer>Read-writeHTTP port of the container..
iscco<Boolean>Read-writeIs CCO.
isolation_policy<String>Read-writeIsolation Policy of the Device.
provision_request_id<String>Read-writeValue is set only if the instance was provisioned from MAS.
lb_role<String>Read-writeLB role performed by the device: North-South (Ingress or server), or East-West (client).
license<String>Read-writeFeature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum, SWG).
Minimum length = 1
Maximum length = 64
https_port<Integer>Read-writeHTTPS port of the container..
domain_name<String>Read-writeDomain name of VM Device.
Minimum length = 1
Maximum length = 128
snmp_port<Integer>Read-writeSNMP port of the container..
image_name<String>Read-writeImage Name, This parameter is used while provisioning VM Instance with XVA image, template_name is given priority if provided along with image_name.
Minimum length = 1
Maximum length = 128
hostname<String>Read-writeAssign hostname to managed device, if this is not provided, name will be set as host name .
Minimum length = 1
Maximum length = 256
pre_auth_key<String>Read-writeShared secret that used for orchestration deployment.
ent_bw_available<Integer>Read-writeEnterprise Bandwidth configured.
description<String>Read-writeDescription of managed device.
Minimum length = 1
Maximum length = 512
geo_support<Boolean>Read-writeIs this device configured to support GEO location..
sslvpn_config<Integer>Read-writesslvpn license maximum.
sysservices<Double>Read-writeSystem Services.
num_pes<Integer>Read-writeTotal number of PEs.
burst_priority<Integer>Read-writeBurst Priority of the VM Instance..
routable<Boolean>Read-writeWhether the device is reachable or not.
autoprovisioned<Boolean>Read-writeDevice is auto-provisioned or not.
is_managed<Boolean>Read-writeIs Managed.
number_of_cpu<Integer>Read-writeNumber of CPU that is assigned to VM Instance.
instance_total<Integer>Read-writeInstance license.
is_ha_configured<Boolean>Read-writeIs HA configured.
trust_id<String>Read-writeDevice ID obtained from trust service.
ipv4_address<String>Read-writeIPv4 Address.
Minimum length = 1
Maximum length = 64
profile_name<String>Read-writeDevice Profile Name that is attached with this managed device.
Minimum length = 1
Maximum length = 128
backplane<String>Read-writeBackplane Interface.
Minimum length = 1
servicepackage<String>Read-writeService Package Name of the device.
state<String>Read-writeNode State.
Minimum length = 1
Maximum length = 32
task_id<String>Read-writeTask Id used by Triton to identify NS.
last_updated_time<Double>Read-writeLast Updated Time.
partition_id<String>Read-writeID of admin partition.
customid<String>Read-writeCustom ID.
number_of_ssl_cores<Integer>Read-writeAssign number of ssl virtual functions to VM Instance.
number_of_ssl_cards<Integer>Read-writeNumber of SSL Cards.
max_burst_throughput<Double>Read-writeMaximum burst throughput in Mbps of VM Instance.
config_type<Integer>Read-writeConfiguration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =
cmd_policy<String>Read-writetrue if you want to allow shell/sftp/scp access to NetScaler Instance administrator.
Minimum length = 1
Maximum length = 1024
node_id<String>Read-writeNode identification of a device.
ip_address<String>Read-writeIP Address for this managed device.
Minimum length = 1
Maximum length = 64
number_of_cores<Integer>Read-writeNumber of cores that are assigned to VM Instance.
display_name<String>Read-writeDisplay Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP.
Minimum length = 1
Maximum length = 128
std_bw_total<Integer>Read-writeStandard Bandwidth.
partition_name<String>Read-writeNS Admin Partition Name.
Maximum length = 512
plt_bw_config<Integer>Read-writePlatinum Bandwidth configured.
sslvpn_total<Integer>Read-writesslvpn license.
agent_id<String>Read-writeAgent Id.
formation_instance_id<String>Read-writeThis property is deprecated;ltbr;gtFormation Instance Id that this VM is Part of.
Minimum length = 1
Maximum length = 128
save_config<Boolean>Read-writeShould config be saved first in case instance is rebooted while modify.
num_ports<Integer>Read-writeNumber of CPX Ports to be exposed.
profile_username<String>Read-writeUser Name specified by the user for this Netscaler Instance..
Minimum length = 1
Maximum length = 128
profile_password<String>Read-writePassword specified by the user for this Netscaler..
Minimum length = 1
Maximum length = 128
start_port<Integer>Read-writePort assignment will be started from this value.
EULA<Boolean>Read-writeValue will be set to true if end user accepts EULA.
file_location_path<String>Read-writeFile Location on Client for upload/download.
Minimum length = 1
file_name<String>Read-writeFile name which contains comma separated instances to be discovered.
Minimum length = 1
Maximum length = 128
LS_IP<String>Read-writeLicense server IP address.
entity_tag<property_map[]>Read-writeArray of tag_name and tag_value pair assocaited with an entity.
clusterid<Integer>Read-onlyCluster Id.
manufacturedate<String>Read-onlyManufacture Date.
instance_state<String>Read-onlyState of device, UP only if device accessible.
diskavail<Integer>Read-onlyNS Disk Available(MB).
virtualization<String>Read-onlyparavirtual(PV) or Hardware Virtual Machine(HVM) (if hosted on AWS).
termination_protection<Boolean>Read-onlyIf termination_protection is enabled, instance can't be terminated unless it is disabled (if hosted on AWS).
vcpu_config<Integer>Read-onlyNumber of vCPU allocated for the device.
clip<String>Read-onlyCluster IP Address.
device_uuid<String>Read-onlyDevice UUID.
version<String>Read-onlyDevice Version.
health<String>Read-onlyNode Health.
public_dns<String>Read-onlyPublic DNS of the managed device.
instance_type<String>Read-onlyInstance type indicates the size of the managed device which is a combination of CPU, memory, storage, and networking capacity.
disksize<Integer>Read-onlyNS Disk Size(MB).
sysid<String>Read-onlySystem ID.
nodeid<Integer>Read-onlyNode Id.
tenancy<String>Read-onlydefault or dedicated. Dedicated means -> running on a single tenant (if hosted on AWS).
vm_state<String>Read-onlyState of Virtual Machine (Running | Halted).
uuid<String>Read-onlyUUID of VM Instance.
encoded_serialnumber<String>Read-onlyEncoded Serial Number.
ssl_virtual_functions<String>Read-onlySSL Virtual Functions assigned to VM Instance.
cpufrequncy<Integer>Read-onlyCPU Frequency (MHZ).
http_req<Double>Read-onlyHTTP Requests/second.
ha_sync<String>Read-onlyHA Synchronization State.
ha_ip_address<String>Read-onlyPeer IP Address.
node_state<String>Read-onlyNode State of NetScaler Instance.
status<String>Read-onlyStatus of managed device.
systemname<String>Read-onlyDevice System Name.
geo_location<String>Read-onlyGeo location of the managed device.
ns_memory_usage<Double>Read-onlyMemory Usage (%).
instance_id<String>Read-onlyId of CPX instance.
serialnumber<String>Read-onlyDevice Serial Number.
subnet_id<String>Read-onlyin which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).
ha_master_state<String>Read-onlyMaster State (Primary/Secondary).
vpc_id<String>Read-onlyVPC ID of the managed device.
region<String>Read-onlyRegion in which the managed device is hosted.
reason<String>Read-onlyReason of failure for this managed device.
virtual_functions<String>Read-onlyVirtual Functions assigned to VM Instance.
ns_total_tx<Double>Read-onlyTotal Tx of NetScaler Instance in Mbits.
upsince<String>Read-onlyUpsince of managed device.
security_group<String>Read-onlyvirtual firewall that controls the traffic for one or more managed devices (if hosted on AWS).
private_dns<String>Read-onlyPrivate DNS of the managed device.
zone<String>Read-onlyZone in which the managed device is hosted.
model_id<String>Read-onlyDevice Model Id.
tenant_id<String>Read-onlyTenant ID.
ns_mgmt_cpu_usage<Double>Read-onlyManagement CPU Usage (%).
port_range<String>Read-onlyNetScaler CPX Exposed Port Range.
do_config<Boolean>Read-onlyDo default config for managed device.
host_id<String>Read-onlyHost ID.
system_hardwareversion<String>Read-onlySystem Hardware Version.
ns_tx<Double>Read-onlyOut Throughput of NetScaler Instance in Mbps.
key_name<String>Read-onlyname of the S3 bucket in which managed device is stored (if hosted on AWS).
is_swg<Boolean>Read-onlyBoolean to indicate whether a VM is SWG.
diskused<Integer>Read-onlyNS Disk Used(MB).
cloud<String>Read-onlyCloud on which the managed device is hosted.
uptime<String>Read-onlyUptime of device.
private_ip<String>Read-onlyPrivate IP of the managed device.
cpu_license_type<Integer>Read-onlyVCPU license 0 = No VCPU License, 1 = VCPU Pool license.
location<String>Read-onlyDevice Location.
contactperson<String>Read-onlyDevice contact person.
public_ip<String>Read-onlyPublic IP of the managed device.
ns_cpu_usage<Double>Read-onlyCPU Usage (%) of NetScaler Instance.
bmcrevision<String>Read-onlyBMC Firmware Version.
ns_rx<Double>Read-onlyIn Throughput of NetScaler Instance in Mbps.
vm_description<String>Read-onlyDescription.
diskperusage<Integer>Read-onlyNS Disk Utilization (%).
ami_id<String>Read-onlyAMI ID of the managed device (if hosted on AWS).
root_device_type<String>Read-onlycontains the image used to boot the managed device (if hosted on AWS).
ebs_optimized<Boolean>Read-onlyAWS offers consistent and low-latency performance if EBS optimized is true.
ns_total_rx<Double>Read-onlyTotal Rx of NetScaler Instance in Mbits.
act_id<String>Read-onlyActivity Id.
diff_exists<Boolean>Read-onlyIndicates whether config diff exists for this instances or not.

Operations

(click to see Properties)

REBOOT| UNMANAGE| GET (ALL)| GET| MANAGE

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

reboot

URL: https://<MGMT-IP>/nitro/v1/config/ns/id_value<String>?action=reboot;onerror=<String_value>

HTTP Method: null

Request Payload:

{"ns": { }}

Response Payload:

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

unmanage

URL: https://<MGMT-IP>/nitro/v1/config/ns/id_value<String>?action=unmanage;onerror=<String_value>

HTTP Method: null

Request Payload:

{"ns": { }}

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns":[{
"clusterid":<Integer_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"ns_ip_address":<String_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"diskavail":<Integer_value>,
"mastools_version":<String_value>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"clip":<String_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"health":<String_value>,
"public_dns":<String_value>,
"number_of_ssl_cores_up":<Integer_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"disksize":<Integer_value>,
"sysid":<String_value>,
"nodeid":<Integer_value>,
"tenancy":<String_value>,
"instance_name":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"is_clip":<Boolean_value>,
"device_family":<String_value>,
"http_req":<Double_value>,
"ha_sync":<String_value>,
"ha_ip_address":<String_value>,
"type":<String_value>,
"throughput":<Double_value>,
"ns_observationdomainid":<String_value>,
"node_state":<String_value>,
"status":<String_value>,
"gateway":<String_value>,
"http_port":<Integer_value>,
"systemname":<String_value>,
"geo_location":<String_value>,
"iscco":<Boolean_value>,
"ns_memory_usage":<Double_value>,
"isolation_policy":<String_value>,
"instance_id":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"pre_auth_key":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"virtual_functions":<String_value>,
"ns_total_tx":<Double_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"ns_mgmt_cpu_usage":<Double_value>,
"num_pes":<Integer_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"port_range":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"host_id":<String_value>,
"is_managed":<Boolean_value>,
"system_hardwareversion":<String_value>,
"ns_tx":<Double_value>,
"key_name":<String_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"backplane":<String_value>,
"diskused":<Integer_value>,
"servicepackage":<String_value>,
"state":<String_value>,
"task_id":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"cpu_license_type":<Integer_value>,
"upsince_persisted":<String_value>,
"location":<String_value>,
"customid":<String_value>,
"contactperson":<String_value>,
"public_ip":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"ns_cpu_usage":<Double_value>,
"bmcrevision":<String_value>,
"number_of_ssl_cards":<Integer_value>,
"ns_rx":<Double_value>,
"vm_description":<String_value>,
"user_profile_name":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"cmd_policy":<String_value>,
"node_id":<String_value>,
"diskperusage":<Integer_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"number_of_cores":<Integer_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"ns_total_rx":<Double_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"config_progress_status":<String_value>,
"save_config":<Boolean_value>,
"num_ports":<Integer_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"start_port":<Integer_value>,
"EULA":<Boolean_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"LS_IP":<String_value>,
"diff_exists":<Boolean_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns":[{
"clusterid":<Integer_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"ns_ip_address":<String_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"diskavail":<Integer_value>,
"mastools_version":<String_value>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"clip":<String_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"health":<String_value>,
"public_dns":<String_value>,
"number_of_ssl_cores_up":<Integer_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"disksize":<Integer_value>,
"sysid":<String_value>,
"nodeid":<Integer_value>,
"tenancy":<String_value>,
"instance_name":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"is_clip":<Boolean_value>,
"device_family":<String_value>,
"http_req":<Double_value>,
"ha_sync":<String_value>,
"ha_ip_address":<String_value>,
"type":<String_value>,
"throughput":<Double_value>,
"ns_observationdomainid":<String_value>,
"node_state":<String_value>,
"status":<String_value>,
"gateway":<String_value>,
"http_port":<Integer_value>,
"systemname":<String_value>,
"geo_location":<String_value>,
"iscco":<Boolean_value>,
"ns_memory_usage":<Double_value>,
"isolation_policy":<String_value>,
"instance_id":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"pre_auth_key":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"virtual_functions":<String_value>,
"ns_total_tx":<Double_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"ns_mgmt_cpu_usage":<Double_value>,
"num_pes":<Integer_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"port_range":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"host_id":<String_value>,
"is_managed":<Boolean_value>,
"system_hardwareversion":<String_value>,
"ns_tx":<Double_value>,
"key_name":<String_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"backplane":<String_value>,
"diskused":<Integer_value>,
"servicepackage":<String_value>,
"state":<String_value>,
"task_id":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"cpu_license_type":<Integer_value>,
"upsince_persisted":<String_value>,
"location":<String_value>,
"customid":<String_value>,
"contactperson":<String_value>,
"public_ip":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"ns_cpu_usage":<Double_value>,
"bmcrevision":<String_value>,
"number_of_ssl_cards":<Integer_value>,
"ns_rx":<Double_value>,
"vm_description":<String_value>,
"user_profile_name":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"cmd_policy":<String_value>,
"node_id":<String_value>,
"diskperusage":<Integer_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"number_of_cores":<Integer_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"ns_total_rx":<Double_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"config_progress_status":<String_value>,
"save_config":<Boolean_value>,
"num_ports":<Integer_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"start_port":<Integer_value>,
"EULA":<Boolean_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"LS_IP":<String_value>,
"diff_exists":<Boolean_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

manage

URL: https://<MGMT-IP>/nitro/v1/config/ns/id_value<String>?action=manage;onerror=<String_value>

HTTP Method: null

Request Payload:

{"ns": { }}

Response Payload:

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