Skip to content
Was this article helpful?

vm_device

Configuration for VM Device resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
instance_classifier <Integer> Read-write Value based on which certain features may be enabled/disabled in ADM for the instance.
image_name <String> Read-write Image 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-write Assign hostname to managed device, if this is not provided, name will be set as host name .

Minimum length = 1

Maximum length = 256
gateway_deployment <Boolean> Read-write Is this device acting as Gateway..
std_bw_config <Integer> Read-write Standard Bandwidth running.
gateway_ipv6 <String> Read-write Gateway IPv6 Address.
instance_available <Integer> Read-write Instance license available.
device_finger_print <String> Read-write Fingerprint/thumb-print from UMS public certificate for SSL communication.
name <String> Read-write Name of managed device.

Minimum length = 1

Maximum length = 128
description <String> Read-write Description of managed device.

Minimum length = 1

Maximum length = 512
ent_bw_available <Integer> Read-write Enterprise Bandwidth configured.
is_autoscale_group <Boolean> Read-write Does this device belong to an Autoscale Group..
geo_support <Boolean> Read-write Is this device configured to support GEO location..
sslvpn_config <Integer> Read-write sslvpn license maximum.
mastools_version <String> Read-write Mastools version if the device is embedded agent.
sysservices <Double> Read-write System Services.
ent_bw_total <Integer> Read-write Enterprise Bandwidth Total.
ssh_port <Integer> Read-write SSH port of the container..
vcpu_config <Integer> Read-write Number of vCPU allocated for the device.
burst_priority <Integer> Read-write Burst Priority of the VM Instance between 1 and 4.
netmask <String> Read-write Netmask of managed device.

Minimum length = 1

Maximum length = 64
routable <Boolean> Read-write Whether the device is reachable or not.
ent_bw_config <Integer> Read-write Enterprise Bandwidth configured.
autoprovisioned <Boolean> Read-write Device is auto-provisioned or not.
datacenter_id <String> Read-write Datacenter Id is system generated key for data center.
instance_config <Integer> Read-write Instance license running.
is_managed <Boolean> Read-write Is Managed.
instance_mode <String> Read-write Denotes state- primary,secondary,clip,clusternode.
discovery_time <Double> Read-write discovery time.
instance_total <Integer> Read-write Instance license.
is_ha_configured <Boolean> Read-write Is HA configured.
trust_id <String> Read-write Device ID obtained from trust service.
ipv4_address <String> Read-write IPv4 Address.

Minimum length = 1

Maximum length = 64
profile_name <String> Read-write Device Profile Name that is attached with this managed device.

Minimum length = 1

Maximum length = 128
std_bw_available <Integer> Read-write Standard Bandwidth Available.
servicepackage <String> Read-write Service Package Name of the device.
last_updated_time <Double> Read-write Last Updated Time.
plt_bw_total <Integer> Read-write Total Platinum Bandwidth.
host_ip_address <String> Read-write Host IPAddress where VM is provisioned.

Minimum length = 1

Maximum length = 64
id <String> Read-write Id is system generated key for all the managed devices.
ipv6_address <String> Read-write IPv6 Address.
mgmt_ip_address <String> Read-write Management IP Address for this Managed Device.

Minimum length = 1

Maximum length = 64
license_edition <String> Read-write Edition of instance.
partition_id <String> Read-write ID of admin partition.
plt_bw_available <Integer> Read-write Platinum Bandwidth Available.
device_family <String> Read-write Device Family.

Minimum length = 1

Maximum length = 64
template_interval <Integer> Read-write Template refresh interval.
type <String> Read-write Type of device, (Xen | NS).

Minimum length = 1

Maximum length = 64
throughput <Double> Read-write Assign throughput in Mbps to VM Instance.
gateway <String> Read-write Default Gateway of managed device.

Minimum length = 1

Maximum length = 64
http_port <Integer> Read-write HTTP port of the container..
internal_annotation <String> Read-write Internal annotation used by ADM.Example, if a device is marked for delete.
max_burst_throughput <Double> Read-write Maximum burst throughput in Mbps of VM Instance.
config_type <Integer> Read-write Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.

Maximum value =
node_id <String> Read-write Node identification of a device.
isolation_policy <String> Read-write Isolation Policy of the Device.
ip_address <String> Read-write IP Address for this managed device.

Minimum length = 1

Maximum length = 64
provision_request_id <String> Read-write Value is set only if the instance was provisioned from Citrix ADM.
httpxforwardedfor <String> Read-write HTTP x-Forwardedfor header flag..

Minimum length = 1

Maximum length = 10
lb_role <String> Read-write LB role performed by the device: North-South (Ingress or server), or East-West (client).
display_name <String> 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
std_bw_total <Integer> Read-write Standard Bandwidth.
https_port <Integer> Read-write HTTPS port of the container..
domain_name <String> Read-write Domain name of VM Device.

Minimum length = 1

Maximum length = 128
partition_name <String> Read-write Citrix ADC Admin Partition Name.

Maximum length = 512
plt_bw_config <Integer> Read-write Platinum Bandwidth configured.
sslvpn_total <Integer> Read-write sslvpn license.
agent_id <String> Read-write Agent Id.
snmp_port <Integer> Read-write SNMP port of the container..
peer_device_ip <String> Read-write Peer Device IP address for instance of type BLX ADC..

Minimum length = 1

Maximum length = 64
profile_password <String> Read-write Password specified by the user for this Citrix ADC Instance..

Minimum length = 1

Maximum length = 128
file_name <String> Read-write File name which contains comma separated instances to be discovered.

Minimum length = 1

Maximum length = 128
profile_username <String> Read-write User Name specified by the user for this Citrix ADC Instance..

Minimum length = 1

Maximum length = 128
file_location_path <String> Read-write File Location on Client for upload/download.

Minimum length = 1
peer_host_device_ip <String> Read-write Peer Host Device IP Address for instance of type BLX ADC..

Minimum length = 1

Maximum length = 64
device_host_ip <String> Read-write Device Host IP Address for instance of type BLX ADC..

Minimum length = 1

Maximum length = 64
tr_task_id <String> Read-write Task Id used by Triton to identify NS.
entity_tag <property_map[]> Read-write Array of tag_name and tag_value pair assocaited with an entity.
subnet_id <String> Read-only in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).
manufacturedate <String> Read-only Manufacture Date.
is_fips_pooled_license_type <Integer> Read-only FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license.
ha_master_state <String> Read-only Master State (Primary/Secondary).
vpc_id <String> Read-only VPC ID of the managed device.
instance_state <String> Read-only State of device, UP only if device accessible.
httpquerywithurl <String> Read-only URL query params flag..
reason <String> Read-only Reason of failure for this managed device.
region <String> Read-only Region in which the managed device is hosted.
upsince <String> Read-only Upsince of managed device.
private_dns <String> Read-only Private DNS of the managed device.
security_group <String> Read-only virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS).
model_id <String> Read-only Device Model Id.
zone <String> Read-only Zone in which the managed device is hosted.
tenant_id <String> Read-only Tenant ID.
device_uuid <String> Read-only Device UUID.
do_config <Boolean> Read-only Do default config for managed device.
version <String> Read-only Device Version.
host_id <String> Read-only Host ID.
number_of_cpu <Integer> Read-only Number of CPU that is assigned to VM Instance.
public_dns <String> Read-only Public DNS of the managed device.
instance_type <String> Read-only Instance type indicates the deployment type of CPX.
is_swg <Boolean> Read-only Boolean to indicate whether a VM is SWG.
sysid <String> Read-only System ID.
vm_state <String> Read-only State of Virtual Machine (Running | Halted).
uuid <String> Read-only UUID of VM Instance generated by Hypervisor.
cloud <String> Read-only Cloud on which the managed device is hosted.
encoded_serialnumber <String> Read-only Encoded Serial Number.
instance_unique_id <Integer> Read-only 32 bit unique Integer id generated by Citrix ADM for this device.
uptime <String> Read-only Uptime of device.
private_ip <String> Read-only Private IP of the managed device.
cpufrequncy <Integer> Read-only CPU Frequency (MHZ).
cpu_license_type <Integer> Read-only VCPU license 0 = No VCPU License, 1 = VCPU Pool license.
location <String> Read-only Device Location.
ha_sync <String> Read-only HA Synchronization State.
contactperson <String> Read-only Device contact person.
license_grace_time <Integer> Read-only Grace for this Citrix Instance..
public_ip <String> Read-only Public IP of the managed device.
ha_ip_address <String> Read-only Peer IP Address.
bmcrevision <String> Read-only BMC Firmware Version.
status <String> Read-only Status of managed device.
vm_description <String> Read-only Description of the VM instance.
systemname <String> Read-only Device System Name.
geo_location <String> Read-only Geo location of the managed device.
ami_id <String> Read-only AMI ID of the managed device (if hosted on AWS).
httpcookie <String> Read-only Cookie-Header flag..
serialnumber <String> Read-only Device Serial Number.
act_id <String> Read-only Activity Id.

Operations

(click to see Properties )

  • GET (ALL)
  • GET

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

get (all)

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

Query-parameters:

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

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

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

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

Use this query-parameter to get the count of vm_device resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "vm_device":[{
      "instance_classifier":<Integer_value>,
      "subnet_id":<String_value>,
      "image_name":<String_value>,
      "is_grace":<Boolean_value>,
      "manufacturedate":<String_value>,
      "hostname":<String_value>,
      "gateway_deployment":<Boolean_value>,
      "std_bw_config":<Integer_value>,
      "is_fips_pooled_license_type":<Integer_value>,
      "ha_master_state":<String_value>,
      "gateway_ipv6":<String_value>,
      "instance_available":<Integer_value>,
      "vpc_id":<String_value>,
      "instance_state":<String_value>,
      "device_finger_print":<String_value>,
      "vnc_console_url":<String_value>,
      "httpquerywithurl":<String_value>,
      "name":<String_value>,
      "reason":<String_value>,
      "region":<String_value>,
      "description":<String_value>,
      "ent_bw_available":<Integer_value>,
      "is_autoscale_group":<Boolean_value>,
      "geo_support":<Boolean_value>,
      "is_pooled_license":<Boolean_value>,
      "sslvpn_config":<Integer_value>,
      "upsince":<String_value>,
      "user_driven":<Boolean_value>,
      "private_dns":<String_value>,
      "security_group":<String_value>,
      "model_id":<String_value>,
      "mastools_version":<String_value>,
      "zone":<String_value>,
      "sysservices":<Double_value>,
      "ent_bw_total":<Integer_value>,
      "host_type":<String_value>,
      "ssh_port":<Integer_value>,
      "tenant_id":<String_value>,
      "vcpu_config":<Integer_value>,
      "burst_priority":<Integer_value>,
      "netmask":<String_value>,
      "device_uuid":<String_value>,
      "routable":<Boolean_value>,
      "ent_bw_config":<Integer_value>,
      "autoprovisioned":<Boolean_value>,
      "do_config":<Boolean_value>,
      "version":<String_value>,
      "host_id":<String_value>,
      "datacenter_id":<String_value>,
      "instance_config":<Integer_value>,
      "is_managed":<Boolean_value>,
      "instance_mode":<String_value>,
      "discovery_time":<Double_value>,
      "number_of_cpu":<Integer_value>,
      "instance_total":<Integer_value>,
      "public_dns":<String_value>,
      "is_ha_configured":<Boolean_value>,
      "trust_id":<String_value>,
      "ipv4_address":<String_value>,
      "instance_type":<String_value>,
      "profile_name":<String_value>,
      "std_bw_available":<Integer_value>,
      "seq_no":<Double_value>,
      "is_swg":<Boolean_value>,
      "dns":<String_value>,
      "sysid":<String_value>,
      "servicepackage":<String_value>,
      "vm_state":<String_value>,
      "uuid":<String_value>,
      "last_updated_time":<Double_value>,
      "cloud":<String_value>,
      "encoded_serialnumber":<String_value>,
      "instance_unique_id":<Integer_value>,
      "uptime":<String_value>,
      "plt_bw_total":<Integer_value>,
      "host_ip_address":<String_value>,
      "private_ip":<String_value>,
      "id":<String_value>,
      "ipv6_address":<String_value>,
      "mgmt_ip_address":<String_value>,
      "license_edition":<String_value>,
      "partition_id":<String_value>,
      "plt_bw_available":<Integer_value>,
      "cpufrequncy":<Integer_value>,
      "cpu_license_type":<Integer_value>,
      "location":<String_value>,
      "device_family":<String_value>,
      "template_interval":<Integer_value>,
      "ha_sync":<String_value>,
      "contactperson":<String_value>,
      "license_grace_time":<Integer_value>,
      "public_ip":<String_value>,
      "ha_ip_address":<String_value>,
      "type":<String_value>,
      "bmcrevision":<String_value>,
      "throughput":<Double_value>,
      "status":<String_value>,
      "gateway":<String_value>,
      "vm_description":<String_value>,
      "http_port":<Integer_value>,
      "internal_annotation":<String_value>,
      "max_burst_throughput":<Double_value>,
      "config_type":<Integer_value>,
      "systemname":<String_value>,
      "node_id":<String_value>,
      "geo_location":<String_value>,
      "isolation_policy":<String_value>,
      "ip_address":<String_value>,
      "ping_state":<Integer_value>,
      "provision_request_id":<String_value>,
      "httpxforwardedfor":<String_value>,
      "lb_role":<String_value>,
      "display_name":<String_value>,
      "std_bw_total":<Integer_value>,
      "https_port":<Integer_value>,
      "ami_id":<String_value>,
      "domain_name":<String_value>,
      "partition_name":<String_value>,
      "plt_bw_config":<Integer_value>,
      "httpcookie":<String_value>,
      "sslvpn_total":<Integer_value>,
      "agent_id":<String_value>,
      "formation_instance_id":<String_value>,
      "serialnumber":<String_value>,
      "snmp_port":<Integer_value>,
      "peer_device_ip":<String_value>,
      "parent_inventory":<Boolean_value>,
      "profile_password":<String_value>,
      "register_failed_device":<Boolean_value>,
      "file_name":<String_value>,
      "act_id":<String_value>,
      "do_instance_config":<Boolean_value>,
      "profile_username":<String_value>,
      "default_password":<String_value>,
      "file_location_path":<String_value>,
      "peer_host_device_ip":<String_value>,
      "sync_operation":<Boolean_value>,
      "device_host_ip":<String_value>,
      "tr_task_id":<String_value>,
      "entity_tag":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_password_change":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/vm_device/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "vm_device":[{
      "instance_classifier":<Integer_value>,
      "subnet_id":<String_value>,
      "image_name":<String_value>,
      "is_grace":<Boolean_value>,
      "manufacturedate":<String_value>,
      "hostname":<String_value>,
      "gateway_deployment":<Boolean_value>,
      "std_bw_config":<Integer_value>,
      "is_fips_pooled_license_type":<Integer_value>,
      "ha_master_state":<String_value>,
      "gateway_ipv6":<String_value>,
      "instance_available":<Integer_value>,
      "vpc_id":<String_value>,
      "instance_state":<String_value>,
      "device_finger_print":<String_value>,
      "vnc_console_url":<String_value>,
      "httpquerywithurl":<String_value>,
      "name":<String_value>,
      "reason":<String_value>,
      "region":<String_value>,
      "description":<String_value>,
      "ent_bw_available":<Integer_value>,
      "is_autoscale_group":<Boolean_value>,
      "geo_support":<Boolean_value>,
      "is_pooled_license":<Boolean_value>,
      "sslvpn_config":<Integer_value>,
      "upsince":<String_value>,
      "user_driven":<Boolean_value>,
      "private_dns":<String_value>,
      "security_group":<String_value>,
      "model_id":<String_value>,
      "mastools_version":<String_value>,
      "zone":<String_value>,
      "sysservices":<Double_value>,
      "ent_bw_total":<Integer_value>,
      "host_type":<String_value>,
      "ssh_port":<Integer_value>,
      "tenant_id":<String_value>,
      "vcpu_config":<Integer_value>,
      "burst_priority":<Integer_value>,
      "netmask":<String_value>,
      "device_uuid":<String_value>,
      "routable":<Boolean_value>,
      "ent_bw_config":<Integer_value>,
      "autoprovisioned":<Boolean_value>,
      "do_config":<Boolean_value>,
      "version":<String_value>,
      "host_id":<String_value>,
      "datacenter_id":<String_value>,
      "instance_config":<Integer_value>,
      "is_managed":<Boolean_value>,
      "instance_mode":<String_value>,
      "discovery_time":<Double_value>,
      "number_of_cpu":<Integer_value>,
      "instance_total":<Integer_value>,
      "public_dns":<String_value>,
      "is_ha_configured":<Boolean_value>,
      "trust_id":<String_value>,
      "ipv4_address":<String_value>,
      "instance_type":<String_value>,
      "profile_name":<String_value>,
      "std_bw_available":<Integer_value>,
      "seq_no":<Double_value>,
      "is_swg":<Boolean_value>,
      "dns":<String_value>,
      "sysid":<String_value>,
      "servicepackage":<String_value>,
      "vm_state":<String_value>,
      "uuid":<String_value>,
      "last_updated_time":<Double_value>,
      "cloud":<String_value>,
      "encoded_serialnumber":<String_value>,
      "instance_unique_id":<Integer_value>,
      "uptime":<String_value>,
      "plt_bw_total":<Integer_value>,
      "host_ip_address":<String_value>,
      "private_ip":<String_value>,
      "id":<String_value>,
      "ipv6_address":<String_value>,
      "mgmt_ip_address":<String_value>,
      "license_edition":<String_value>,
      "partition_id":<String_value>,
      "plt_bw_available":<Integer_value>,
      "cpufrequncy":<Integer_value>,
      "cpu_license_type":<Integer_value>,
      "location":<String_value>,
      "device_family":<String_value>,
      "template_interval":<Integer_value>,
      "ha_sync":<String_value>,
      "contactperson":<String_value>,
      "license_grace_time":<Integer_value>,
      "public_ip":<String_value>,
      "ha_ip_address":<String_value>,
      "type":<String_value>,
      "bmcrevision":<String_value>,
      "throughput":<Double_value>,
      "status":<String_value>,
      "gateway":<String_value>,
      "vm_description":<String_value>,
      "http_port":<Integer_value>,
      "internal_annotation":<String_value>,
      "max_burst_throughput":<Double_value>,
      "config_type":<Integer_value>,
      "systemname":<String_value>,
      "node_id":<String_value>,
      "geo_location":<String_value>,
      "isolation_policy":<String_value>,
      "ip_address":<String_value>,
      "ping_state":<Integer_value>,
      "provision_request_id":<String_value>,
      "httpxforwardedfor":<String_value>,
      "lb_role":<String_value>,
      "display_name":<String_value>,
      "std_bw_total":<Integer_value>,
      "https_port":<Integer_value>,
      "ami_id":<String_value>,
      "domain_name":<String_value>,
      "partition_name":<String_value>,
      "plt_bw_config":<Integer_value>,
      "httpcookie":<String_value>,
      "sslvpn_total":<Integer_value>,
      "agent_id":<String_value>,
      "formation_instance_id":<String_value>,
      "serialnumber":<String_value>,
      "snmp_port":<Integer_value>,
      "peer_device_ip":<String_value>,
      "parent_inventory":<Boolean_value>,
      "profile_password":<String_value>,
      "register_failed_device":<Boolean_value>,
      "file_name":<String_value>,
      "act_id":<String_value>,
      "do_instance_config":<Boolean_value>,
      "profile_username":<String_value>,
      "default_password":<String_value>,
      "file_location_path":<String_value>,
      "peer_host_device_ip":<String_value>,
      "sync_operation":<Boolean_value>,
      "device_host_ip":<String_value>,
      "tr_task_id":<String_value>,
      "entity_tag":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_password_change":<Boolean_value>}]}
Was this article helpful?