host_interface

Last published : Oct 30, 2026
Configuration for XenServer Interface resource.

Properties

(click to see Operations )
Name Data Type Permissions Description
auto_applied <Boolean> Read-write True if AUTO is selected as speed.
range <String> Read-write Range for Base Mac Address.
Minimum length = 1
Maximum length = 50
channel_tag_all_vlans <Boolean> Read-write If true then all the member interfaces of this channel are tagged. Possible values: true and false.
mapped_port <String> Read-write Mapped Port Name Ex: eth0.
Minimum length = 1
Maximum length = 50
lacp_channel_time <String> Read-write LACP time. Possible values: fast and slow.
Minimum length = 4
Maximum length = 10
channel_interface_list <String> Read-write Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4).
Maximum length = 256
channel_alias <String> Read-write Alias name for this channel.
Minimum length = 4
Maximum length = 31
id <String> Read-write Id is system generated key .
add_mac_address <Boolean> Read-write Add Mac Address.
apply_mac_address <Boolean> Read-write Apply Mac Address.
channel_type <String> Read-write Channel type if this interface represents a channel (LACP or Static).
Minimum length = 4
Maximum length = 16
mtu <Integer> Read-write MTU value, should be between 1500-9126.
channel_id <String> Read-write Channel ID if this interface represents a channel (LA/1, LA/2 ...).
Minimum length = 4
Maximum length = 5
display_name <String> Read-write Display Name Ex: Management Port.
Minimum length = 1
Maximum length = 50
port <String> Read-write Port Name Ex: 10/1.
Minimum length = 1
Maximum length = 50
static_channel_state <Boolean> Read-write Static channel state (Enabled/Disabled).
channel_ha_monitoring <Boolean> Read-write HA-monitoring control for the channel. Possible values: true and false.
base_mac_address <String> Read-write Mac Address.
Minimum length = 1
Maximum length = 32
channel_throughput <Integer> Read-write Minimum required throughput in Mbps for this channel.
Maximum value =
channel_bandwidth_high <Integer> Read-write Higher end threshold of the channel bandwidth usage in Mbps.
Maximum value =
channel_bandwidth_normal <Integer> Read-write Lower end threshold of the channel bandwidth usage in Mbps.
Maximum value =
flow_control_tx <Boolean> Read-write TX Pause.
vlan_strippping_state <Integer> Read-write VLAN Stripping State, 0: Disabled 1: Enabled.
speed <String> Read-write Actual speed .
Minimum length = 1
Maximum length = 128
support_auto_neg <Boolean> Read-write true if the port supports auto-negotiation.
flow_control_auto_neg <Boolean> Read-write Auto Negotiation For Flow Control.
duplex <String> Read-write Duplex.
Minimum length = 1
Maximum length = 128
sync_operation <Boolean> Read-write sync operation.
adv_auto_neg <Boolean> Read-write true if the advertised auto-negotiation for the port is true.
flow_control_rx <Boolean> Read-write RX Pause.
admin_state <String> Read-only Admin can enable or disable the interface.
xen_bond_uuid <String> Read-only UUID of the corresponding bond in Xenserver.
is_mgmt_bond <Boolean> Read-only True if this bond is on management interface.
lacp_channel_mac_address <String> Read-only Mac address of the bond on Xenserver.
interface_type <String> Read-only Indicates if this is an interface or a channel or a member interface of a channel.
supported_link_modes <String[]> Read-only Supported Link Modes.
state <String> Read-only State of the port..
device_name <String> Read-only Device Name.
act_id <String> Read-only Activity Id.
port_type <String> Read-only Port Type.
supported_port_types <String[]> Read-only Supported Port Types.
cpu_socket <String> Read-only CPU Socket to which this interface belong to.
adv_link_modes <String[]> Read-only Advertised Link Modes.

Operations

(click to see Properties )
  • ADD
  • RESET
  • DELETE
  • GET (ALL)
  • GET
  • UPDATE
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

add

URL: https://<MGMT-IP>/nitro/v2/config/host_interface?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"host_interface": {
<b>"channel_interface_list":<String_value></b>,
<b>"channel_type":<String_value></b>,
<b>"channel_id":<String_value></b>,
"auto_applied":<Boolean_value>,
"flow_control_tx":<Boolean_value>,
"range":<String_value>,
"mapped_port":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_alias":<String_value>,
"speed":<String_value>,
"vlan_strippping_state":<Integer_value>,
"support_auto_neg":<Boolean_value>,
"apply_mac_address":<Boolean_value>,
"id":<String_value>,
"add_mac_address":<Boolean_value>,
"mtu":<Integer_value>,
"flow_control_auto_neg":<Boolean_value>,
"display_name":<String_value>,
"port":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"duplex":<String_value>,
"base_mac_address":<String_value>,
"sync_operation":<Boolean_value>,
"adv_auto_neg":<Boolean_value>,
"channel_throughput":<Integer_value>,
"flow_control_rx":<Boolean_value>,
"channel_bandwidth_normal":<Integer_value>,
"channel_bandwidth_high":<Integer_value>}}
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, "host_interface":[{
"auto_applied":<Boolean_value>,
"range":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"mapped_port":<String_value>,
"admin_state":<String_value>,
"lacp_channel_time":<String_value>,
"xen_bond_uuid":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"is_mgmt_bond":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"add_mac_address":<Boolean_value>,
"apply_mac_address":<Boolean_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"display_name":<String_value>,
"port":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"base_mac_address":<String_value>,
"interface_type":<String_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"flow_control_tx":<Boolean_value>,
"flow_control_changed":<Boolean_value>,
"supported_link_modes":<String_value>,
"state":<String_value>,
"device_name":<String_value>,
"act_id":<String_value>,
"vlan_strippping_state":<Integer_value>,
"master_pif_uuid":<String_value>,
"speed":<String_value>,
"link_speed_changed":<Boolean_value>,
"support_auto_neg":<Boolean_value>,
"port_type":<String_value>,
"supported_port_types":<String_value>,
"primary_slave_uuid":<String_value>,
"flow_control_auto_neg":<Boolean_value>,
"cpu_socket":<String_value>,
"duplex":<String_value>,
"sync_operation":<Boolean_value>,
"adv_auto_neg":<Boolean_value>,
"flow_control_rx":<Boolean_value>,
"adv_link_modes":<String_value>}]}

reset

URL: https://<MGMT-IP>/nitro/v2/config/host_interface/id_value<String>?action=reset;onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"host_interface": { }}
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}

delete

URL: https://<MGMT-IP>/nitro/v2/config/host_interface/id_value<String> HTTPS Method: DELETE
Request Headers: 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 Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/host_interface Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/host_interface ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of host_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/host_interface ?pagesize=#no;pageno=#no Use this query-parameter to get the host_interface resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/host_interface ?count=yes Use this query-parameter to get the count of host_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, "host_interface":[{
"auto_applied":<Boolean_value>,
"range":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"mapped_port":<String_value>,
"admin_state":<String_value>,
"lacp_channel_time":<String_value>,
"xen_bond_uuid":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"is_mgmt_bond":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"add_mac_address":<Boolean_value>,
"apply_mac_address":<Boolean_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"display_name":<String_value>,
"port":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"base_mac_address":<String_value>,
"interface_type":<String_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"flow_control_tx":<Boolean_value>,
"flow_control_changed":<Boolean_value>,
"supported_link_modes":<String_value>,
"state":<String_value>,
"device_name":<String_value>,
"act_id":<String_value>,
"vlan_strippping_state":<Integer_value>,
"master_pif_uuid":<String_value>,
"speed":<String_value>,
"link_speed_changed":<Boolean_value>,
"support_auto_neg":<Boolean_value>,
"port_type":<String_value>,
"supported_port_types":<String_value>,
"primary_slave_uuid":<String_value>,
"flow_control_auto_neg":<Boolean_value>,
"cpu_socket":<String_value>,
"duplex":<String_value>,
"sync_operation":<Boolean_value>,
"adv_auto_neg":<Boolean_value>,
"flow_control_rx":<Boolean_value>,
"adv_link_modes":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/host_interface/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_interface":[{
"auto_applied":<Boolean_value>,
"range":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"mapped_port":<String_value>,
"admin_state":<String_value>,
"lacp_channel_time":<String_value>,
"xen_bond_uuid":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"is_mgmt_bond":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"add_mac_address":<Boolean_value>,
"apply_mac_address":<Boolean_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"display_name":<String_value>,
"port":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"base_mac_address":<String_value>,
"interface_type":<String_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"flow_control_tx":<Boolean_value>,
"flow_control_changed":<Boolean_value>,
"supported_link_modes":<String_value>,
"state":<String_value>,
"device_name":<String_value>,
"act_id":<String_value>,
"vlan_strippping_state":<Integer_value>,
"master_pif_uuid":<String_value>,
"speed":<String_value>,
"link_speed_changed":<Boolean_value>,
"support_auto_neg":<Boolean_value>,
"port_type":<String_value>,
"supported_port_types":<String_value>,
"primary_slave_uuid":<String_value>,
"flow_control_auto_neg":<Boolean_value>,
"cpu_socket":<String_value>,
"duplex":<String_value>,
"sync_operation":<Boolean_value>,
"adv_auto_neg":<Boolean_value>,
"flow_control_rx":<Boolean_value>,
"adv_link_modes":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/host_interface/id_value<String> HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"host_interface":{
<b>"mapped_port":<String_value></b>,
<b>"id":<String_value></b>,
"auto_applied":<Boolean_value>,
"flow_control_tx":<Boolean_value>,
"range":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"lacp_channel_time":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"speed":<String_value>,
"vlan_strippping_state":<Integer_value>,
"support_auto_neg":<Boolean_value>,
"channel_type":<String_value>,
"add_mac_address":<Boolean_value>,
"apply_mac_address":<Boolean_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"flow_control_auto_neg":<Boolean_value>,
"display_name":<String_value>,
"port":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"duplex":<String_value>,
"base_mac_address":<String_value>,
"sync_operation":<Boolean_value>,
"adv_auto_neg":<Boolean_value>,
"channel_throughput":<Integer_value>,
"flow_control_rx":<Boolean_value>,
"channel_bandwidth_normal":<Integer_value>,
"channel_bandwidth_high":<Integer_value>}}
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, "host_interface":[{
"auto_applied":<Boolean_value>,
"range":<String_value>,
"channel_tag_all_vlans":<Boolean_value>,
"mapped_port":<String_value>,
"admin_state":<String_value>,
"lacp_channel_time":<String_value>,
"xen_bond_uuid":<String_value>,
"host_type":<String_value>,
"channel_interface_list":<String_value>,
"channel_alias":<String_value>,
"is_mgmt_bond":<Boolean_value>,
"host_ip_address":<String_value>,
"lacp_channel_mac_address":<String_value>,
"id":<String_value>,
"add_mac_address":<Boolean_value>,
"apply_mac_address":<Boolean_value>,
"channel_type":<String_value>,
"mtu":<Integer_value>,
"channel_id":<String_value>,
"display_name":<String_value>,
"port":<String_value>,
"static_channel_state":<Boolean_value>,
"channel_ha_monitoring":<Boolean_value>,
"base_mac_address":<String_value>,
"interface_type":<String_value>,
"channel_throughput":<Integer_value>,
"channel_bandwidth_high":<Integer_value>,
"channel_bandwidth_normal":<Integer_value>,
"flow_control_tx":<Boolean_value>,
"flow_control_changed":<Boolean_value>,
"supported_link_modes":<String_value>,
"state":<String_value>,
"device_name":<String_value>,
"act_id":<String_value>,
"vlan_strippping_state":<Integer_value>,
"master_pif_uuid":<String_value>,
"speed":<String_value>,
"link_speed_changed":<Boolean_value>,
"support_auto_neg":<Boolean_value>,
"port_type":<String_value>,
"supported_port_types":<String_value>,
"primary_slave_uuid":<String_value>,
"flow_control_auto_neg":<Boolean_value>,
"cpu_socket":<String_value>,
"duplex":<String_value>,
"sync_operation":<Boolean_value>,
"adv_auto_neg":<Boolean_value>,
"flow_control_rx":<Boolean_value>,
"adv_link_modes":<String_value>}]}