Instances

managed_device

March 20, 2024

Contributed by:

Configuration for Managed Device resource.

Properties

(click to see Operations )

Name	Permissions	Description
hostname	Read-write	Assign hostname to managed device, if this is not provided, name will be set as host name . Minimum length = 1 Maximum length = 256
std_bw_config	Read-write	Standard Bandwidth running.
gateway_ipv6	Read-write	Gateway IPv6 Address.
name	Read-write	Name of managed device. Minimum length = 1 Maximum length = 128
ent_bw_available	Read-write	Enterprise Bandwidth configured.
description	Read-write	Description of managed device. Minimum length = 1 Maximum length = 512
mastools_version	Read-write	Mastools version if the device is embedded agent.
ent_bw_total	Read-write	Enterprise Bandwidth Total.
vcpu_config	Read-write	Number of vCPU allocated for the device.
netmask	Read-write	Netmask of managed device. Minimum length = 1 Maximum length = 64
ent_bw_config	Read-write	Enterprise Bandwidth configured.
datacenter_id	Read-write	Datacenter Id is system generated key for data center.
is_managed	Read-write	Is Managed.
instance_mode	Read-write	Denotes state- primary,secondary,clip,clusternode.
nexthop_v6	Read-write	Next Hop IPv6 Address.
ipv4_address	Read-write	IPv4 Address. Minimum length = 1 Maximum length = 64
profile_name	Read-write	Device Profile Name that is attached with this managed device. Minimum length = 1 Maximum length = 128
std_bw_available	Read-write	Standard Bandwidth Available.
internal_ip_address	Read-write	Internal IP Address for this managed device. Minimum length = 1 Maximum length = 64
last_updated_time	Read-write	Last Updated Time.
plt_bw_total	Read-write	Total Platinum Bandwidth.
id	Read-write	Id is system generated key for all the managed devices.
mgmt_ip_address	Read-write	Management IP Address for this Managed Device. Minimum length = 1 Maximum length = 64
ipv6_address	Read-write	IPv6 Address.
license_edition	Read-write	Edition of instance.
plt_bw_available	Read-write	Platinum Bandwidth Available.
device_family	Read-write	Device Family. Minimum length = 1 Maximum length = 64
license_grace_time	Read-write	Grace for this Citrix Instance..
type	Read-write	Type of device, (Xen \| NS). Minimum length = 1 Maximum length = 64
gateway	Read-write	Default Gateway of managed device. Minimum length = 1 Maximum length = 64
config_type	Read-write	Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both. Maximum value =
if_internal_ip_enabled	Read-write	Set as true if VPX is managed by internal network (not required to be set for SDWAN).
node_id	Read-write	Node identification of a device.
ip_address	Read-write	IP Address for this managed device. Minimum length = 1 Maximum length = 64
std_bw_total	Read-write	Standard Bandwidth.
display_name	Read-write	Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP. Minimum length = 1 Maximum length = 128
nexthop	Read-write	Next Hop IP address. Minimum length = 1 Maximum length = 64
plt_bw_config	Read-write	Platinum Bandwidth configured.
profile_password	Read-write	Password specified by the user for this Citrix ADC Instance.. Minimum length = 1 Maximum length = 128
profile_username	Read-write	User Name specified by the user for this Citrix ADC Instance.. Minimum length = 1 Maximum length = 128
instance_state	Read-only	State of device, UP only if device accessible.
reason	Read-only	Reason of failure for this managed device.
upsince	Read-only	Upsince of managed device.
tenant_id	Read-only	Tenant ID.
device_uuid	Read-only	Device UUID.
do_config	Read-only	Do default config for managed device.
host_id	Read-only	Host ID.
version	Read-only	Device Version.
sysid	Read-only	System ID.
uptime	Read-only	Uptime of device.
cpu_license_type	Read-only	VCPU license 0 = No VCPU License, 1 = VCPU Pool license.
status	Read-only	Status of managed device.
systemname	Read-only	Device System Name.
act_id	Read-only	Activity Id.

Operations

(click to see Properties )

ADD
GET (ALL)
DELETE
MODIFY

Some options that you can use for each operations:

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

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

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

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

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

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

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/managed_device?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"managed_device": {
<b>"ip_address":<String_value></b>,
"std_bw_available":<Integer_value>,
"internal_ip_address":<String_value>,
"profile_password":<String_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"last_updated_time":<Double_value>,
"gateway_ipv6":<String_value>,
"plt_bw_total":<Integer_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"license_edition":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"name":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"type":<String_value>,
"mastools_version":<String_value>,
"gateway":<String_value>,
"ent_bw_total":<Integer_value>,
"config_type":<Integer_value>,
"vcpu_config":<Integer_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"netmask":<String_value>,
"ent_bw_config":<Integer_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"is_managed":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"instance_mode":<String_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"nexthop_v6":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "managed_device":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"reason":<String_value>,
"name":<String_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"mastools_version":<String_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>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"nexthop_v6":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"internal_ip_address":<String_value>,
"sysid":<String_value>,
"last_updated_time":<Double_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"act_id":<String_value>,
"profile_username":<String_value>,
"default_password":<String_value>,
"sync_operation":<Boolean_value>}]}

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/managed_device Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/managed_device ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of managed_device resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/managed_device ?pagesize=#no;pageno=#no Use this query-parameter to get the managed_device resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/managed_device ?count=yes Use this query-parameter to get the count of managed_device resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "managed_device":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"reason":<String_value>,
"name":<String_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"mastools_version":<String_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>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"nexthop_v6":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"internal_ip_address":<String_value>,
"sysid":<String_value>,
"last_updated_time":<Double_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"act_id":<String_value>,
"profile_username":<String_value>,
"default_password":<String_value>,
"sync_operation":<Boolean_value>}]}

<!--NeedCopy-->

delete

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

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Payload:

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

<!--NeedCopy-->

modify

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

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"managed_device":{
<b>"id":<String_value></b>,
"std_bw_available":<Integer_value>,
"internal_ip_address":<String_value>,
"profile_password":<String_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"last_updated_time":<Double_value>,
"gateway_ipv6":<String_value>,
"plt_bw_total":<Integer_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"license_edition":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"name":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"type":<String_value>,
"mastools_version":<String_value>,
"gateway":<String_value>,
"ent_bw_total":<Integer_value>,
"config_type":<Integer_value>,
"vcpu_config":<Integer_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"netmask":<String_value>,
"ent_bw_config":<Integer_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"is_managed":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"instance_mode":<String_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"nexthop_v6":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "managed_device":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"reason":<String_value>,
"name":<String_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"mastools_version":<String_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>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"nexthop_v6":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"internal_ip_address":<String_value>,
"sysid":<String_value>,
"last_updated_time":<Double_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"act_id":<String_value>,
"profile_username":<String_value>,
"default_password":<String_value>,
"sync_operation":<Boolean_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

managed_device

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

managed_device

Properties

Operations

add

get (all)

delete

modify

In this article