Skip to content

managed_device

Configuration for Managed Device resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
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
std_bw_config<Integer>Read-writeStandard Bandwidth running.
gateway_deployment<Boolean>Read-writeIs this device acting as Gateway..
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
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.
mastools_version<String>Read-writeMastools version if the device is embedded agent.
sysservices<Double>Read-writeSystem Services.
ent_bw_total<Integer>Read-writeEnterprise Bandwidth Total.
netmask<String>Read-writeNetmask of managed device.
Minimum length = 1
Maximum length = 64
autoprovisioned<Boolean>Read-writeDevice is auto-provisioned or not.
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.
is_managed<Boolean>Read-writeIs Managed.
discovery_time<Double>Read-writediscovery time.
instance_mode<String>Read-writeDenotes state- primary,secondary,clip,clusternode.
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
std_bw_available<Integer>Read-writeStandard Bandwidth Available.
servicepackage<String>Read-writeService Package Name of the device.
last_updated_time<Double>Read-writeLast Updated Time.
plt_bw_total<Integer>Read-writeTotal Platinum Bandwidth.
id<String>Read-writeId is system generated key for all the managed devices.
mgmt_ip_address<String>Read-writeManagement IP Address for this Managed Device.
Minimum length = 1
Maximum length = 64
ipv6_address<String>Read-writeIPv6 Address.
partition_id<String>Read-writeID of admin partition.
plt_bw_available<Integer>Read-writePlatinum Bandwidth Available.
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
gateway<String>Read-writeDefault Gateway of managed device.
Minimum length = 1
Maximum length = 64
config_type<Integer>Read-writeConfiguration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =
node_id<String>Read-writeNode identification of a device.
isolation_policy<String>Read-writeIsolation Policy of the Device.
ip_address<String>Read-writeIP Address for this managed device.
Minimum length = 1
Maximum length = 64
std_bw_total<Integer>Read-writeStandard Bandwidth.
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
plt_bw_config<Integer>Read-writePlatinum Bandwidth configured.
partition_name<String>Read-writeNS Admin Partition Name.
Maximum length = 512
agent_id<String>Read-writeAgent Id.
sslvpn_total<Integer>Read-writesslvpn license.
provision_request_id<String>Read-writeValue is set only if the instance was provisioned from MAS.
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
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
entity_tag<property_map[]>Read-writeArray of tag_name and tag_value pair assocaited with an entity.
subnet_id<String>Read-onlyin which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).
manufacturedate<String>Read-onlyManufacture Date.
ha_master_state<String>Read-onlyMaster State (Primary/Secondary).
vpc_id<String>Read-onlyVPC ID of the managed device.
instance_state<String>Read-onlyState of device, UP only if device accessible.
region<String>Read-onlyRegion in which the managed device is hosted.
reason<String>Read-onlyReason of failure for this managed device.
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.
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.
tenant_id<String>Read-onlyTenant ID.
device_uuid<String>Read-onlyDevice UUID.
do_config<Boolean>Read-onlyDo default config for managed device.
host_id<String>Read-onlyHost ID.
version<String>Read-onlyDevice Version.
key_name<String>Read-onlyname of the S3 bucket in which managed device is stored (if hosted on AWS).
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.
sysid<String>Read-onlySystem ID.
tenancy<String>Read-onlydefault or dedicated. Dedicated means -> running on a single tenant (if hosted on AWS).
cloud<String>Read-onlyCloud on which the managed device is hosted.
encoded_serialnumber<String>Read-onlyEncoded Serial Number.
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.
cpufrequncy<Integer>Read-onlyCPU Frequency (MHZ).
location<String>Read-onlyDevice Location.
contactperson<String>Read-onlyDevice contact person.
ha_sync<String>Read-onlyHA Synchronization State.
public_ip<String>Read-onlyPublic IP of the managed device.
ha_ip_address<String>Read-onlyPeer IP Address.
bmcrevision<String>Read-onlyBMC Firmware Version.
status<String>Read-onlyStatus of managed device.
systemname<String>Read-onlyDevice System Name.
geo_location<String>Read-onlyGeo location of the managed device.
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.
serialnumber<String>Read-onlyDevice Serial Number.
act_id<String>Read-onlyActivity Id.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| MODIFY| ANNOTATE| ADD_DEVICE| UPLOAD

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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/managed_device?onerror=<String_value>

HTTP Method: null

Request Payload:

{managed_device: {
<b>"ip_address":<String_value></b>,
"std_bw_available":<Integer_value>,
"profile_password":<String_value>,
"servicepackage":<String_value>,
"hostname":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"last_updated_time":<Double_value>,
"file_name":<String_value>,
"gateway_ipv6":<String_value>,
"plt_bw_total":<Integer_value>,
"instance_available":<Integer_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"device_finger_print":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"geo_support":<Boolean_value>,
"type":<String_value>,
"sslvpn_config":<Integer_value>,
"gateway":<String_value>,
"mastools_version":<String_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"netmask":<String_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"instance_total":<Integer_value>,
"file_location_path":<String_value>,
"is_ha_configured":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"profile_name":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_device":[{
"subnet_id":<String_value>,
"manufacturedate":<String_value>,
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"ha_master_state":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"device_finger_print":<String_value>,
"instance_state":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"name":<String_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>,
"mastools_version":<String_value>,
"model_id":<String_value>,
"virtualization":<String_value>,
"sysservices":<Double_value>,
"termination_protection":<Boolean_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"tenant_id":<String_value>,
"device_uuid":<String_value>,
"netmask":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"public_dns":<String_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"cpufrequncy":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"location":<String_value>,
"contactperson":<String_value>,
"ha_sync":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"geo_location":<String_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"plt_bw_config":<Integer_value>,
"partition_name":<String_value>,
"agent_id":<String_value>,
"sslvpn_total":<Integer_value>,
"serialnumber":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

delete

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

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_device":[{
"subnet_id":<String_value>,
"manufacturedate":<String_value>,
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"ha_master_state":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"device_finger_print":<String_value>,
"instance_state":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"name":<String_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>,
"mastools_version":<String_value>,
"model_id":<String_value>,
"virtualization":<String_value>,
"sysservices":<Double_value>,
"termination_protection":<Boolean_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"tenant_id":<String_value>,
"device_uuid":<String_value>,
"netmask":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"public_dns":<String_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"cpufrequncy":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"location":<String_value>,
"contactperson":<String_value>,
"ha_sync":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"geo_location":<String_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"plt_bw_config":<Integer_value>,
"partition_name":<String_value>,
"agent_id":<String_value>,
"sslvpn_total":<Integer_value>,
"serialnumber":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

modify

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

HTTP Method: null

Request Payload:

{managed_device:{
<b>"id":<String_value></b>,
"std_bw_available":<Integer_value>,
"profile_password":<String_value>,
"servicepackage":<String_value>,
"hostname":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"last_updated_time":<Double_value>,
"file_name":<String_value>,
"gateway_ipv6":<String_value>,
"plt_bw_total":<Integer_value>,
"instance_available":<Integer_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"device_finger_print":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"geo_support":<Boolean_value>,
"type":<String_value>,
"sslvpn_config":<Integer_value>,
"gateway":<String_value>,
"mastools_version":<String_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"netmask":<String_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"instance_total":<Integer_value>,
"file_location_path":<String_value>,
"is_ha_configured":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"profile_name":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_device":[{
"subnet_id":<String_value>,
"manufacturedate":<String_value>,
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"ha_master_state":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"device_finger_print":<String_value>,
"instance_state":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"name":<String_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>,
"mastools_version":<String_value>,
"model_id":<String_value>,
"virtualization":<String_value>,
"sysservices":<Double_value>,
"termination_protection":<Boolean_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"tenant_id":<String_value>,
"device_uuid":<String_value>,
"netmask":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"public_dns":<String_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"cpufrequncy":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"location":<String_value>,
"contactperson":<String_value>,
"ha_sync":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"geo_location":<String_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"plt_bw_config":<Integer_value>,
"partition_name":<String_value>,
"agent_id":<String_value>,
"sslvpn_total":<Integer_value>,
"serialnumber":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

annotate

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

HTTP Method: null

Request Payload:

{"managed_device": { }}

Response Payload:

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

add_device

URL: https://<MGMT-IP>/nitro/v1/config/managed_device?action=add_device;onerror=<String_value>

HTTP Method: null

Request Payload:

{managed_device: {
<b>"ip_address":<String_value></b>,
"std_bw_available":<Integer_value>,
"profile_password":<String_value>,
"servicepackage":<String_value>,
"hostname":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"last_updated_time":<Double_value>,
"file_name":<String_value>,
"gateway_ipv6":<String_value>,
"plt_bw_total":<Integer_value>,
"instance_available":<Integer_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"device_finger_print":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"geo_support":<Boolean_value>,
"type":<String_value>,
"sslvpn_config":<Integer_value>,
"gateway":<String_value>,
"mastools_version":<String_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"netmask":<String_value>,
"ent_bw_config":<Integer_value>,
"autoprovisioned":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"instance_total":<Integer_value>,
"file_location_path":<String_value>,
"is_ha_configured":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"profile_name":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_device":[{
"subnet_id":<String_value>,
"manufacturedate":<String_value>,
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"ha_master_state":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"device_finger_print":<String_value>,
"instance_state":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"name":<String_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>,
"mastools_version":<String_value>,
"model_id":<String_value>,
"virtualization":<String_value>,
"sysservices":<Double_value>,
"termination_protection":<Boolean_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"tenant_id":<String_value>,
"device_uuid":<String_value>,
"netmask":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"public_dns":<String_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"cpufrequncy":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"location":<String_value>,
"contactperson":<String_value>,
"ha_sync":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"geo_location":<String_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"plt_bw_config":<Integer_value>,
"partition_name":<String_value>,
"agent_id":<String_value>,
"sslvpn_total":<Integer_value>,
"serialnumber":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

upload

URL: https://<MGMT-IP>/nitro/v1/upload/managed_device

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done }