Download full document:

vm_device

Configuration for VM Device resource.

(click to see Operations)

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
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.
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..
burst_priority	<Integer>	Read-write	Burst Priority of the VM Instance..
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.
number_of_cpu	<Integer>	Read-write	Number of CPU that is assigned to VM Instance.
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
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
number_of_ssl_cores	<Integer>	Read-write	Assign number of ssl virtual functions to VM Instance.
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..
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
number_of_cores	<Integer>	Read-write	Number of cores that are assigned to VM Instance.
provision_request_id	<String>	Read-write	Value is set only if the instance was provisioned from MAS.
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	NS 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.
formation_instance_id	<String>	Read-write	This property is deprecated;ltbr;gtFormation Instance Id that this VM is Part of. Minimum length = 1 Maximum length = 128
snmp_port	<Integer>	Read-write	SNMP port of the container..
profile_password	<String>	Read-write	Password specified by the user for this Netscaler.. 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 Netscaler Instance.. Minimum length = 1 Maximum length = 128
file_location_path	<String>	Read-write	File Location on Client for upload/download. Minimum length = 1
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.
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.
reason	<String>	Read-only	Reason of failure for this managed device.
region	<String>	Read-only	Region in which the managed device is hosted.
virtual_functions	<String>	Read-only	Virtual Functions assigned to VM Instance.
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.
virtualization	<String>	Read-only	paravirtual(PV) or Hardware Virtual Machine(HVM) (if hosted on AWS).
termination_protection	<Boolean>	Read-only	If termination_protection is enabled, instance can't be terminated unless it is disabled (if hosted on AWS).
tenant_id	<String>	Read-only	Tenant ID.
vcpu_config	<Integer>	Read-only	Number of vCPU allocated for the device.
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.
key_name	<String>	Read-only	name of the S3 bucket in which managed device is stored (if hosted on AWS).
public_dns	<String>	Read-only	Public DNS of the managed device.
instance_type	<String>	Read-only	Instance type indicates the size of the managed device which is a combination of CPU, memory, storage, and networking capacity.
is_swg	<Boolean>	Read-only	Boolean to indicate whether a VM is SWG.
sysid	<String>	Read-only	System ID.
tenancy	<String>	Read-only	default or dedicated. Dedicated means -> running on a single tenant (if hosted on AWS).
vm_state	<String>	Read-only	State of Virtual Machine (Running \| Halted).
uuid	<String>	Read-only	UUID of VM Instance.
cloud	<String>	Read-only	Cloud on which the managed device is hosted.
encoded_serialnumber	<String>	Read-only	Encoded Serial Number.
ssl_virtual_functions	<String>	Read-only	SSL Virtual Functions assigned to VM Instance.
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.
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.
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).
root_device_type	<String>	Read-only	contains the image used to boot the managed device (if hosted on AWS).
ebs_optimized	<Boolean>	Read-only	AWS offers consistent and low-latency performance if EBS optimized is true.
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>.

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vm_device":[{
"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>,
"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>,
"name":<String_value>,
"reason":<String_value>,
"region":<String_value>,
"virtual_functions":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_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>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_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>,
"key_name":<String_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>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_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>,
"ha_sync":<String_value>,
"contactperson":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"type":<String_value>,
"bmcrevision":<String_value>,
"throughput":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"vm_description":<String_value>,
"http_port":<Integer_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>,
"number_of_cores":<Integer_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"https_port":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"domain_name":<String_value>,
"ebs_optimized":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"serialnumber":<String_value>,
"snmp_port":<Integer_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vm_device":[{
"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>,
"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>,
"name":<String_value>,
"reason":<String_value>,
"region":<String_value>,
"virtual_functions":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_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>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_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>,
"key_name":<String_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>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_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>,
"ha_sync":<String_value>,
"contactperson":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"type":<String_value>,
"bmcrevision":<String_value>,
"throughput":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"vm_description":<String_value>,
"http_port":<Integer_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>,
"number_of_cores":<Integer_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"https_port":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"domain_name":<String_value>,
"ebs_optimized":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"serialnumber":<String_value>,
"snmp_port":<Integer_value>,
"parent_inventory":<Boolean_value>,
"profile_password":<String_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}