host_device

Last published : Oct 30, 2026
Configuration for host resource.

Properties

(click to see Operations )
Name Data Type Permissions Description
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
std_bw_config <Integer> Read-write Standard Bandwidth running.
gateway_ipv6 <String> Read-write Gateway IPv6 Address.
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.
mastools_version <String> Read-write Mastools version if the device is embedded agent.
ent_bw_total <Integer> Read-write Enterprise Bandwidth Total.
vcpu_config <Integer> Read-write Number of vCPU allocated for the device.
netmask <String> Read-write Netmask of managed device.
Minimum length = 1
Maximum length = 64
ent_bw_config <Integer> Read-write Enterprise Bandwidth configured.
datacenter_id <String> Read-write Datacenter Id is system generated key for data center.
is_managed <Boolean> Read-write Is Managed.
instance_mode <String> Read-write Denotes state- primary,secondary,clip,clusternode.
nexthop_v6 <String> Read-write Next Hop IPv6 Address.
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.
internal_ip_address <String> Read-write Internal IP Address for this managed device.
Minimum length = 1
Maximum length = 64
last_updated_time <Double> Read-write Last Updated Time.
plt_bw_total <Integer> Read-write Total Platinum Bandwidth.
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.
plt_bw_available <Integer> Read-write Platinum Bandwidth Available.
device_family <String> Read-write Device Family.
Minimum length = 1
Maximum length = 64
license_grace_time <Integer> Read-write Grace for this Citrix Instance..
type <String> Read-write Type of device, (Xen | NS).
Minimum length = 1
Maximum length = 64
gateway <String> Read-write Default Gateway of managed device.
Minimum length = 1
Maximum length = 64
config_type <Integer> Read-write Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =
if_internal_ip_enabled <Boolean> Read-write Set as true if VPX is managed by internal network (not required to be set for SDWAN).
node_id <String> Read-write Node identification of a device.
ip_address <String> Read-write IP Address for this managed device.
Minimum length = 1
Maximum length = 64
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.
nexthop <String> Read-write Next Hop IP address.
Minimum length = 1
Maximum length = 64
plt_bw_config <Integer> Read-write Platinum Bandwidth configured.
profile_username <String> Read-write User Name specified by the user for this Citrix ADC Instance..
Minimum length = 1
Maximum length = 128
profile_password <String> Read-write Password specified by the user for this Citrix ADC Instance..
Minimum length = 1
Maximum length = 128
acu_total <Integer> Read-only Total Asymmetric Crypto Units available in host.
instance_state <String> Read-only State of device, UP only if device accessible.
enabled <Boolean> Read-only host State.
reason <String> Read-only Reason of failure for this managed device.
disk_space <Double> Read-only Show Disk Space (MB) available on host.
disk_free <Double> Read-only Show free Disk Space (MB) available on host.
upsince <String> Read-only Upsince of managed device.
disk_usage <Double> Read-only Disk usage (MB) for host.
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.
tx <Double> Read-only Out Throughput (Mbps) of host.
version <String> Read-only Device Version.
host_id <String> Read-only Host ID.
number_of_cpu <Integer> Read-only Number of total CPU of host.
memory_free <Double> Read-only Free memory available (MB) in host.
sysid <String> Read-only System ID.
uuid <String> Read-only UUID of host.
scu_total <Integer> Read-only Total Symmetric Crypto Units available in host.
uptime <String> Read-only Uptime of device.
cpu_license_type <Integer> Read-only VCPU license 0 = No VCPU License, 1 = VCPU Pool license.
scu_free <Integer> Read-only Free Symmetric Crypto Units.
total_crypto_devices <Integer> Read-only Total Crypto Devices.
cpu_usage <Double> Read-only CPU Usage (%) of host.
acu_free <Integer> Read-only Free Asymmetric Crypto Units.
memory_total <Double> Read-only Total memory of host in MB.
status <String> Read-only Status of managed device.
systemname <String> Read-only Device System Name.
ssl_cores_total <Integer> Read-only Total SSL Cores available in host.
rx <Double> Read-only In Throughput (Mbps) of host.
memory_usage <Double> Read-only Memory Usage (%) of host.
number_of_cpu_cores <Integer> Read-only Number of total CPU cores of host.
act_id <String> Read-only Activity Id.
ssl_cores_free <Integer> Read-only Free SSL Cores.

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/host_device Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/host_device ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of host_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/host_device ?pagesize=#no;pageno=#no Use this query-parameter to get the host_device resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/host_device ?count=yes Use this query-parameter to get the count of host_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, "host_device":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"acu_total":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"enabled":<Boolean_value>,
"name":<String_value>,
"reason":<String_value>,
"disk_space":<Double_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"disk_free":<Double_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"mastools_version":<String_value>,
"disk_usage":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"do_config":<Boolean_value>,
"tx":<Double_value>,
"version":<String_value>,
"host_id":<String_value>,
"datacenter_id":<String_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"number_of_cpu":<Integer_value>,
"nexthop_v6":<String_value>,
"memory_free":<Double_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"internal_ip_address":<String_value>,
"sysid":<String_value>,
"uuid":<String_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"uptime":<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>,
"cpu_license_type":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"scu_free":<Integer_value>,
"total_crypto_devices":<Integer_value>,
"cpu_usage":<Double_value>,
"acu_free":<Integer_value>,
"type":<String_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"ssl_cores_total":<Integer_value>,
"rx":<Double_value>,
"memory_usage":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"number_of_cpu_cores":<Integer_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"parent_inventory":<Boolean_value>,
"act_id":<String_value>,
"profile_username":<String_value>,
"default_password":<String_value>,
"profile_password":<String_value>,
"sync_operation":<Boolean_value>,
"ssl_cores_free":<Integer_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/host_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, "host_device":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"acu_total":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"enabled":<Boolean_value>,
"name":<String_value>,
"reason":<String_value>,
"disk_space":<Double_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"disk_free":<Double_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"mastools_version":<String_value>,
"disk_usage":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"do_config":<Boolean_value>,
"tx":<Double_value>,
"version":<String_value>,
"host_id":<String_value>,
"datacenter_id":<String_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"number_of_cpu":<Integer_value>,
"nexthop_v6":<String_value>,
"memory_free":<Double_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"internal_ip_address":<String_value>,
"sysid":<String_value>,
"uuid":<String_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"uptime":<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>,
"cpu_license_type":<Integer_value>,
"device_family":<String_value>,
"license_grace_time":<Integer_value>,
"scu_free":<Integer_value>,
"total_crypto_devices":<Integer_value>,
"cpu_usage":<Double_value>,
"acu_free":<Integer_value>,
"type":<String_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"ssl_cores_total":<Integer_value>,
"rx":<Double_value>,
"memory_usage":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"number_of_cpu_cores":<Integer_value>,
"nexthop":<String_value>,
"plt_bw_config":<Integer_value>,
"parent_inventory":<Boolean_value>,
"act_id":<String_value>,
"profile_username":<String_value>,
"default_password":<String_value>,
"profile_password":<String_value>,
"sync_operation":<Boolean_value>,
"ssl_cores_free":<Integer_value>}]}