NetScaler SDX 14.1 NITRO API Reference

xen

March 20, 2024

Contributed by:

Configuration for Xen resource.

Properties

(click to see Operations )

Name	Data Type	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
description		Read-write	Description of managed device. Minimum length = 1 Maximum length = 512
ent_bw_available		Read-write	Enterprise Bandwidth configured.
mastools_version		Read-write	Mastools version if the device is embedded agent.
xen_mgmt_ip_address		Read-write	IP Address for xen server.
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
xen_mgmt_dns		Read-write	IP Address for this managed device.
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
xen_mgmt_netmask		Read-write	IP Address for this managed device.
ifCount		Read-write	Number of interfaces added in device.
last_updated_time		Read-write	Last Updated Time.
xen_mgmt_gateway		Read-write	IP Address for this managed device.
plt_bw_total		Read-write	Total Platinum Bandwidth.
id		Read-write	Id is system generated key for all the managed devices.
ipv6_address		Read-write	IPv6 Address.
mgmt_ip_address		Read-write	Management IP Address for this Managed Device. Minimum length = 1 Maximum length = 64
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.
xen_mgmt_ifc		Read-write	IP Address for this managed device.
ip_address		Read-write	IP Address for this managed device. Minimum length = 1 Maximum length = 64
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
std_bw_total		Read-write	Standard Bandwidth.
nexthop		Read-write	Next Hop IP address. Minimum length = 1 Maximum length = 64
plt_bw_config		Read-write	Platinum Bandwidth configured.
profile_username		Read-write	User Name specified by the user for this Citrix ADC Instance.. Minimum length = 1 Maximum length = 128
profile_password		Read-write	Password specified by the user for this Citrix ADC Instance.. Minimum length = 1 Maximum length = 128
ns_ip_arr_to_save	<String[]>	Read-write	List of IP address for which config needs to be saved.
bios_version		Read-only	BIOS Version.
acu_total		Read-only	Total Asymmetric Crypto Units available in host.
instance_state		Read-only	State of device, UP only if device accessible.
enabled		Read-only	host State.
productcode		Read-only	XenServer Product Code.
reason		Read-only	Reason of failure for this managed device.
disk_space		Read-only	Show Disk Space (MB) available on host.
disk_free		Read-only	Show free Disk Space (MB) available on host.
upsince		Read-only	Upsince of managed device.
disk_usage		Read-only	Disk usage (MB) for host.
tenant_id		Read-only	Tenant ID.
edition		Read-only	XenServer Edition.
device_uuid		Read-only	Device UUID.
platform_version		Read-only	SDX platform version.
do_config		Read-only	Do default config for managed device.
tx		Read-only	Out Throughput (Mbps) of host.
version		Read-only	Device Version.
host_id		Read-only	Host ID.
number_of_cpu		Read-only	Number of total CPU of host.
memory_free		Read-only	Free memory available (MB) in host.
build_number		Read-only	XenServer Build Number.
sysid		Read-only	System ID.
uuid		Read-only	UUID of host.
scu_total		Read-only	Total Symmetric Crypto Units available in host.
uptime		Read-only	Uptime of device.
cpu_license_type		Read-only	VCPU license 0 = No VCPU License, 1 = VCPU Pool license.
expiry		Read-only	XenServer Expiry.
supplemental_pack		Read-only	Supplemental Pack installed on XenServer.
is_xen_security_supported		Read-only	Flag indicating whether Xen security can be enabled.
iscsi_iqn		Read-only	iSCSI IQN.
scu_free		Read-only	Free Symmetric Crypto Units.
total_crypto_devices		Read-only	Total Crypto Devices.
acu_free		Read-only	Free Asymmetric Crypto Units.
cpu_usage		Read-only	CPU Usage (%) of host.
is_xen_reachable		Read-only	Flag indicating whether Xen is reachable.
memory_total		Read-only	Total memory of host in MB.
status		Read-only	Status of managed device.
build_date		Read-only	XenServer Build Date.
systemname		Read-only	Device System Name.
version_long		Read-only	XenServer Version (full text).
version_short		Read-only	XenServer Version.
kernel_version		Read-only	Kernel Version.
rx		Read-only	In Throughput (Mbps) of host.
ssl_cores_total		Read-only	Total SSL Cores available in host.
memory_usage		Read-only	Memory Usage (%) of host.
number_of_cpu_cores		Read-only	Number of total CPU cores of host.
ssl_cores_free		Read-only	Free SSL Cores.
act_id		Read-only	Activity Id.

Operations

(click to see Properties )

REBOOT
STOP
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

reboot

URL: https://<MGMT-IP>/nitro/v2/config/xen/id_value<String>?action=reboot;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:

{"xen": { }}

<!--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}

<!--NeedCopy-->

stop

URL: https://<MGMT-IP>/nitro/v2/config/xen/id_value<String>?action=stop;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:

{"xen": { }}

<!--NeedCopy-->

Response Payload:

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

<!--NeedCopy-->

get (all)

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

filter https://<MGMT-IP>/nitro/v2/config/xen ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of xen 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/xen ?pagesize=#no;pageno=#no Use this query-parameter to get the xen resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/xen ?count=yes Use this query-parameter to get the count of xen 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, "xen":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"bios_version":<String_value>,
"std_bw_config":<Integer_value>,
"acu_total":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"enabled":<Boolean_value>,
"productcode":<String_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>,
"xen_mgmt_ip_address":<String_value>,
"disk_usage":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"prev_xen_rx":<Double_value>,
"edition":<String_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"platform_version":<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>,
"xen_rx":<Double_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"number_of_cpu":<Integer_value>,
"nexthop_v6":<String_value>,
"memory_free":<Double_value>,
"build_number":<String_value>,
"ipv4_address":<String_value>,
"xen_mgmt_dns":<String_value>,
"prev_xen_tx":<Double_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"internal_ip_address":<String_value>,
"xen_mgmt_netmask":<String_value>,
"sysid":<String_value>,
"uuid":<String_value>,
"ifCount":<Integer_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"xen_mgmt_gateway":<String_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>,
"expiry":<String_value>,
"device_family":<String_value>,
"supplemental_pack":<String_value>,
"license_grace_time":<Integer_value>,
"is_xen_security_supported":<Boolean_value>,
"iscsi_iqn":<String_value>,
"scu_free":<Integer_value>,
"xen_tx":<Double_value>,
"total_crypto_devices":<Integer_value>,
"acu_free":<Integer_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"is_xen_reachable":<Boolean_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"build_date":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"version_long":<String_value>,
"xen_mgmt_ifc":<String_value>,
"ip_address":<String_value>,
"version_short":<String_value>,
"kernel_version":<String_value>,
"prev_poll_time":<Double_value>,
"ping_state":<Integer_value>,
"rx":<Double_value>,
"ssl_cores_total":<Integer_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>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"default_password":<String_value>,
"ssl_cores_free":<Integer_value>,
"ns_ip_arr_to_save":<String_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/xen/id_value<String> 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, "xen":[{
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"bios_version":<String_value>,
"std_bw_config":<Integer_value>,
"acu_total":<Integer_value>,
"gateway_ipv6":<String_value>,
"instance_state":<String_value>,
"enabled":<Boolean_value>,
"productcode":<String_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>,
"xen_mgmt_ip_address":<String_value>,
"disk_usage":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"prev_xen_rx":<Double_value>,
"edition":<String_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"platform_version":<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>,
"xen_rx":<Double_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"number_of_cpu":<Integer_value>,
"nexthop_v6":<String_value>,
"memory_free":<Double_value>,
"build_number":<String_value>,
"ipv4_address":<String_value>,
"xen_mgmt_dns":<String_value>,
"prev_xen_tx":<Double_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"internal_ip_address":<String_value>,
"xen_mgmt_netmask":<String_value>,
"sysid":<String_value>,
"uuid":<String_value>,
"ifCount":<Integer_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"xen_mgmt_gateway":<String_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>,
"expiry":<String_value>,
"device_family":<String_value>,
"supplemental_pack":<String_value>,
"license_grace_time":<Integer_value>,
"is_xen_security_supported":<Boolean_value>,
"iscsi_iqn":<String_value>,
"scu_free":<Integer_value>,
"xen_tx":<Double_value>,
"total_crypto_devices":<Integer_value>,
"acu_free":<Integer_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"is_xen_reachable":<Boolean_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"build_date":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"if_internal_ip_enabled":<Boolean_value>,
"node_id":<String_value>,
"version_long":<String_value>,
"xen_mgmt_ifc":<String_value>,
"ip_address":<String_value>,
"version_short":<String_value>,
"kernel_version":<String_value>,
"prev_poll_time":<Double_value>,
"ping_state":<Integer_value>,
"rx":<Double_value>,
"ssl_cores_total":<Integer_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>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"default_password":<String_value>,
"ssl_cores_free":<Integer_value>,
"ns_ip_arr_to_save":<String_value>,
"act_id":<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

xen

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

xen

Properties

Operations

reboot

stop

get (all)

get

In this article