Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

xen_health_interface

March 20, 2024
Contributed by: 
C

Configuration for XenServer Interface Health resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
rx_packets Read-write Received packets.
tx_packets Read-write Transmitted packets.
mapped_port Read-write Mapped Port Name Ex: eth0.

Minimum length = 1

Maximum length = 10
display_name Read-write Display Name Ex: Management Port.

Minimum length = 1

Maximum length = 50
port Read-write Port Name Ex: 10/1.

Minimum length = 1

Maximum length = 10
rx_errors Read-write Receiving errors.
rx_bytes Read-write Received bytes.
tx_bytes Read-write Transmitted bytes.
tx_errors Read-write Transmission errors.
host_ip_address Read-write Host IP Address.

Minimum length = 1

Maximum length = 64
vf_total Read-write Total Virtual Functions.
vf_assigned Read-write Assigned Virtual Functions.
state Read-only State of the Interface - UP/DOWN.

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/xen_health_interface Query-parameters:

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

count https://<MGMT-IP>/nitro/v2/config/xen_health_interface ?count=yes Use this query-parameter to get the count of xen_health_interface 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, "xen_health_interface":[{
"rx_packets":<Double_value>,
"tx_packets":<Double_value>,
"mapped_port":<String_value>,
"display_name":<String_value>,
"port":<String_value>,
"state":<String_value>,
"rx_errors":<Double_value>,
"rx_bytes":<Double_value>,
"tx_bytes":<Double_value>,
"tx_errors":<Double_value>,
"host_ip_address":<String_value>,
"vf_total":<Integer_value>,
"vf_assigned":<Integer_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/xen_health_interface/mapped_port_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, "xen_health_interface":[{
"rx_packets":<Double_value>,
"tx_packets":<Double_value>,
"mapped_port":<String_value>,
"display_name":<String_value>,
"port":<String_value>,
"state":<String_value>,
"rx_errors":<Double_value>,
"rx_bytes":<Double_value>,
"tx_bytes":<Double_value>,
"tx_errors":<Double_value>,
"host_ip_address":<String_value>,
"vf_total":<Integer_value>,
"vf_assigned":<Integer_value>}]}

<!--NeedCopy-->
xen_health_interface
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.