Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

Interface

August 17, 2023
Contributed by: 
C

Configuration for interface resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
id Read-write Interface number, in C/U format, where C can take one of the following values:
* 0 - Indicates a management interface.
* 1 - Indicates a 1 Gbps port.
* 10 - Indicates a 10 Gbps port.
* LA - Indicates a link aggregation port.
* LO - Indicates a loop back port.
U is a unique integer for representing an interface in a particular port group.
speed Read-write Ethernet speed of the interface, in Mbps.
Notes:
* If you set the speed as AUTO, the Citrix ADC attempts to auto-negotiate or auto-sense the link speed of the interface when it is UP. You must enable auto negotiation on the interface.
* If you set a speed other than AUTO, you must specify the same speed for the peer network device. Mismatched speed and duplex settings between the peer devices of a link lead to link errors, packet loss, and other errors.
Some interfaces do not support certain speeds. If you specify an unsupported speed, an error message appears.
Default value: AUTO
Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000
duplex Read-write The duplex mode for the interface. Notes:* If you set the duplex mode to AUTO, the Citrix ADC attempts to auto-negotiate the duplex mode of the interface when it is UP. You must enable auto negotiation on the interface. If you set a duplex mode other than AUTO, you must specify the same duplex mode for the peer network device. Mismatched speed and duplex settings between the peer devices of a link lead to link errors, packet loss, and other errors.
Default value: AUTO
Possible values = AUTO, HALF, FULL
flowctl Read-write 802.3x flow control setting for the interface. The 802.3x specification does not define flow control for 10 Mbps and 100 Mbps speeds, but if a Gigabit Ethernet interface operates at those speeds, the flow control settings can be applied. The flow control setting that is finally applied to an interface depends on auto-negotiation. With the ON option, the peer negotiates the flow control, but the appliance then forces two-way flow control for the interface.
Default value: OFF
Possible values = OFF, RX, TX, RXTX, ON
autoneg Read-write Auto-negotiation state of the interface. With the ENABLED setting, the Citrix ADC auto-negotiates the speed and duplex settings with the peer network device on the link. The Citrix ADC appliance auto-negotiates the settings of only those parameters (speed or duplex mode) for which the value is set as AUTO.
Default value: NSA_DVC_AUTONEG_ON
Possible values = DISABLED, ENABLED
hamonitor Read-write In a High Availability (HA) configuration, monitor the interface for failure events. In an HA configuration, an interface that has HA MON enabled and is not bound to any Failover Interface Set (FIS), is a critical interface. Failure or disabling of any critical interface triggers HA failover.
Default value: ON
Possible values = ON, OFF
haheartbeat Read-write In a High Availability (HA) or Cluster configuration, configure the interface for sending heartbeats. In an HA or Cluster configuration, an interface that has HA Heartbeat disabled should not send the heartbeats.
Default value: ON
Possible values = OFF, ON
mtu Read-write The maximum transmission unit (MTU) is the largest packet size, measured in bytes excluding 14 bytes ethernet header and 4 bytes crc, that can be transmitted and received by this interface. Default value of MTU is 1500 on all the interface of Citrix ADC any value configured more than 1500 on the interface will make the interface as jumbo enabled. In case of cluster backplane interface MTU value will be changed to 1514 by default, user has to change the backplane interface value to maximum mtu configured on any of the interface in cluster system plus 14 bytes more for backplane interface if Jumbo is enabled on any of the interface in a cluster system. Changing the backplane will bring back the MTU of backplane interface to default value of 1500. If a channel is configured as backplane then the same holds true for channel as well as member interfaces.
Default value: 1500
Minimum value = 1500
Maximum value = 9216
tagall Read-write Add a four-byte 802.1q tag to every packet sent on this interface. The ON setting applies the tag for this interface’s native VLAN. OFF applies the tag for all VLANs other than the native VLAN.
Default value: OFF
Possible values = ON, OFF
trunk Read-write This argument is deprecated by tagall.
Default value: OFF
Possible values = ON, OFF
trunkmode Read-write Accept and send 802.1q VLAN tagged packets, based on Allowed Vlan List of this interface.
Default value: OFF
Possible values = ON, OFF
trunkallowedvlan <String[]> Read-write VLAN ID or range of VLAN IDs will be allowed on this trunk interface. In the command line interface, separate the range with a hyphen. For example: 40-90.
Minimum length = 1
Maximum length = 4094
lacpmode Read-write Bind the interface to a LA channel created by the Link Aggregation control protocol (LACP).
Available settings function as follows:
* Active - The LA channel port of the Citrix ADC generates LACPDU messages on a regular basis, regardless of any need expressed by its peer device to receive them.
* Passive - The LA channel port of the Citrix ADC does not transmit LACPDU messages unless the peer device port is in the active mode. That is, the port does not speak unless spoken to.
* Disabled - Unbinds the interface from the LA channel. If this is the only interface in the LA channel, the LA channel is removed.
Default value: DISABLED
Possible values = DISABLED, ACTIVE, PASSIVE
lacpkey Read-write Integer identifying the LACP LA channel to which the interface is to be bound.
For an LA channel of the Citrix ADC, this digit specifies the variable x of an LA channel in LA/x notation, where x can range from 1 to 8. For example, if you specify 3 as the LACP key for an LA channel, the interface is bound to the LA channel LA/3.
For an LA channel of a cluster configuration, this digit specifies the variable y of a cluster LA channel in CLA/(y-4) notation, where y can range from 5 to 8. For example, if you specify 6 as the LACP key for a cluster LA channel, the interface is bound to the cluster LA channel CLA/2.
Minimum value = 1
Maximum value = 8
lagtype Read-write Type of entity (Citrix ADC or cluster configuration) for which to create the channel.
Default value: NODE
Possible values = NODE, CLUSTER
lacppriority Read-write LACP port priority, expressed as an integer. The lower the number, the higher the priority. The Citrix ADC limits the number of interfaces in an LA channel to sixteen.
Default value: 32768
Minimum value = 1
Maximum value = 65535
lacptimeout Read-write Interval at which the Citrix ADC sends LACPDU messages to the peer device on the LA channel.
Available settings function as follows:
LONG - 30 seconds.
SHORT - 1 second.
Default value: NSA_LACP_TIMEOUT_LONG
Possible values = LONG, SHORT
ifalias Read-write Alias name for the interface. Used only to enhance readability. To perform any operations, you have to specify the interface ID.
Default value: “ “
Maximum length = 31
throughput Read-write Low threshold value for the throughput of the interface, in Mbps. In an HA configuration, failover is triggered if the interface has HA MON enabled and the throughput is below the specified the threshold.
Minimum value = 0
Maximum value = 160000
linkredundancy Read-write Link Redundancy for Cluster LAG.
Default value: OFF
Possible values = ON, OFF
bandwidthhigh Read-write High threshold value for the bandwidth usage of the interface, in Mbps. The Citrix ADC generates an SNMP trap message when the bandwidth usage of the interface is greater than or equal to the specified high threshold value.
Minimum value = 0
Maximum value = 160000
bandwidthnormal Read-write Normal threshold value for the bandwidth usage of the interface, in Mbps. When the bandwidth usage of the interface becomes less than or equal to the specified normal threshold after exceeding the high threshold, the Citrix ADC generates an SNMP trap message to indicate that the bandwidth usage has returned to normal.
Minimum value = 0
Maximum value = 160000
lldpmode Read-write Link Layer Discovery Protocol (LLDP) mode for an interface. The resultant LLDP mode of an interface depends on the LLDP mode configured at the global and the interface levels.
Possible values = NONE, TRANSMITTER, RECEIVER, TRANSCEIVER
lrsetpriority Read-write LRSET port priority, expressed as an integer ranging from 1 to 1024. The highest priority is 1. The Citrix ADC limits the number of interfaces in an LRSET to 8. Within a LRSET the highest LR Priority Interface is considered as the first candidate for the Active interface, if the interface is UP.
Default value: 1024
Minimum value = 1
Maximum value = 1024
devicename Read-only Name of the interface.
unit Read-only Unit number for this interface, signifying the sequence number in which this interface is discovered on this Citrix ADC.
description Read-only Display the type of interface, the speeds at which this interface can operate, and, if applicable, the type of SFP,.
flags Read-only Flags for this interface. Used for communicating the device states.
actualmtu Read-only MTU for this interface (the largest frame that can transit this interface).
vlan Read-only Native VLAN for this interface.
mac Read-only MAC address for this interface.
uptime Read-only Duration for which the interface has been UP (Example: 3 hours 1 minute 1 second). This value is reset when the interface state changes to DOWN..
downtime Read-only Duration for which the interface has been DOWN. This value is reset when the interface state changes to UP.(Example: 3 hours 1 minute 1 second).
reqmedia Read-only Requested media setting for this interface.
Possible values = AUTO, UTP, FIBER
reqspeed Read-only Requested speed setting for this interface.
Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000
reqduplex Read-only Requested duplex setting for this interface.
Possible values = AUTO, HALF, FULL
reqflowcontrol Read-only Requested flow control setting for this interface.
Possible values = OFF, RX, TX, RXTX, ON
actmedia Read-only Actual media setting for this interface.
Possible values = AUTO, UTP, FIBER
actspeed Read-only Actual speed setting for this interface.
Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000
actduplex Read-only Actual duplex setting for this interface.
Possible values = AUTO, HALF, FULL
actflowctl Read-only Actual flow control setting for this interface.
Possible values = OFF, RX, TX, RXTX, ON
mode Read-only Interface Link Aggregation mode (Auto/Manual) setting.
Possible values = MANUAL, AUTO
state Read-only Link state of the interface (UP/DOWN).
Default value: ENABLED
Possible values = ENABLED, DISABLED
autonegresult Read-only Actual auto-negotiation setting for this interface.
tagged Read-only VLAN tags setting on this channel.
taggedany Read-only Interface setting to accept/drop all tagged packets.
taggedautolearn Read-only Dynamic VLAN membership autolearning enabled or disabled on this interface.
hangdetect Read-only Hang detection enabled or disabled for this interface.
hangreset Read-only Hang reset enabled or disabled for this interface.
linkstate Read-only The current state of the link associated with the interface. For logical interfaces (LA), the state of the link is dependent on the state of the slave interfaces. For the link to be UP at least one of the slave interfaces needs to be UP.
intfstate Read-only Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED.
rxpackets Read-only Number of packets received by an interface since the Citrix ADC was started or the interface statistics were cleared.
rxbytes Read-only Number of bytes received by an interface since the Citrix ADC was started or the interface statistics were cleared.
rxerrors Read-only Number of inbound packets dropped by the hardware on a specified interface since the Citrix ADC was started or the interface statistics were cleared. Packets can be dropped because of CRC, length (undersize or oversize), or alignment errors.
rxdrops Read-only Number of inbound packets dropped by the specified interface. Commonly dropped packets are multicast frames, spanning tree BPDUs, packets destined to a MAC not owned by the Citrix ADC when L2 mode is disabled, or packets tagged for a VLAN that is not bound to the interface. In most healthy networks, this statistic increments at a steady rate regardless of traffic load. A sharp spike in dropped packets generally indicates an issue with connected L2 switches, such as a forwarding database overflow resulting in packets being broadcast on all ports.
txpackets Read-only Number of packets transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared.
txbytes Read-only Number of bytes transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared.
txerrors Read-only Number of outbound packets dropped by the hardware on a specified interface since the Citrix ADC was started or the interface statistics were cleared. Packets can be dropped because of length (undersize or oversize) errors or a lack of resources. This statistic is available only for:
(1) Loop back interface (LO) of all platforms.
(2) All data ports on the Citrix ADC 12000 platform.
(3) Management ports on the Citrix ADC MPX 15000 and 17000 platforms.
.
txdrops Read-only Number of packets dropped in transmission by the specified interface for one of the following reasons.
(1) VLAN mismatch.
(2) Oversized packets.
(3) Interface congestion.
(4) Loopback packets sent on non loop back interface.
.
indisc Read-only Number of error-free inbound packets discarded by the specified interface because of a lack of resources (for example, insufficient receive buffers).
outdisc Read-only Number of error-free outbound packets discarded by the specified interface because of a lack of resources. This statistic is not available on:
(1) 10G ports of Citrix ADC MPX 12500/12500/15500-10G platforms.
(2) 10G data ports on Citrix ADC MPX 17500/19500/21500 platforms.
.
fctls Read-only Number of times flow control is performed on the specified interface because of received pause frames.
hangs Read-only Number of times the specified interface detected hangs in the transmit and receive paths since the Citrix ADC was started or the interface statistics were cleared.
stsstalls Read-only Number of times the status updates for a specified interface were stalled since the Citrix ADC was started or the interface statistics were cleared. A status stall is detected when the status of the interface is not updated by the NIC hardware within 0.8 seconds of the last update.
txstalls Read-only Number of times the interface stalled, when transmitting packets, since the Citrix ADC was started or the interface statistics were cleared. Transmit (Tx) stalls are detected when a packet posted for transmission is not transmitted in 4 seconds.
rxstalls Read-only Number of times the interface stalled, when receiving packets, since the Citrix ADC was started or the interface statistics were cleared. Receive (Rx) stalls are detected when the following conditions are met:
(1)The link is up for more than 10 minutes.
(2)Packets are transmitted, but no packets are received for 16 seconds.
.
bdgmacmoved Read-only Number of MAC moves between ports. A high rate of MAC moves typically indicates a bridge loop between two interfaces.
bdgmuted Read-only Number of times the specified interface stopped transmitting and receiving packets because of MAC moves between ports.
vmac Read-only Virtual MAC of this interface.
vmac6 Read-only Virtual MAC for IPv6 of this interface.
reqthroughput Read-only Minimum required throughput for an interface. Failover is triggered if the operating throughput of a Link Aggregation (LA) channel for which HAMON is ON falls below this value. The possible values are:
1. 1000Mbps for 1G interfaces.
2. 10000Mbps for 10G interfaces.
3. 160000Mbps for Link Aggregation channels.
Minimum value = 0
Maximum value = 160000
actthroughput Read-only Actual throughput for the interface.
backplane Read-only The cluster backplane status of the interface. If the status is enabled, the interface is part of the cluster backplane. By default, the backplane status is disabled.
Possible values = ENABLED, DISABLED
ifnum <String[]> Read-only Contains the LA Master, if the interface is part of LA channel.
cleartime Read-only Time since the interface stats are cleared last time.
slavestate Read-only State of the member interfaces.
slavemedia Read-only Media type of the member interfaces.
slavespeed Read-only Speed of the member interfaces.
slaveduplex Read-only Duplex of the member interfaces.
slaveflowctl Read-only Flowcontrol of the member interfaces.
slavetime Read-only UP time of the member interfaces.
intftype Read-only Interface Type, this field will have the interface type either it is virtual, physical or loopback. .
Possible values = BROADCOM 5700/5701, TIGON1/TIGON2, INTEL 82546, INTEL 8255X(PRO), Link Aggregate, Loopback, Intel 82541/47, Broadcom 5704, Chelsio 1G, Intel 8247X, Intel 82576 VF, Xen Virtual, Intel 10G, Intel 82599 VF, Mellanox 100G, Mellanox 50G, Mellanox 25G, Intel FVL 40G, Intel FVL 25G, Intel FVL 10G, Intel FVL 40G VF, Mellanox VF, Hyper v, Cluster LAG, Intel 8247X SFP, XEN Interface, Chelsio 10G, KVM Virtio, VMXNET3
svmcmd Read-only New attribute added to identify the source of cmd, when SVM fires the nitro cmd, it will set the value of SVMCMD to be 1. .
Default value: 0
lacpactormode Read-only
* Active - The LA channel port of the Citrix ADC generates LACPDU messages on a regular basis, regardless of any need expressed by its peer device to receive them.
* Passive - The LA channel port of the Citrix ADC does not transmit LACPDU messages unless the peer device port is in the active mode. That is, the port does not speak unless spoken to.
* Disabled - Unbinds the interface from the LA channel. If this is the only interface in the LA channel, the LA channel is removed.
Possible values = DISABLED, ACTIVE, PASSIVE
lacpactortimeout Read-only Interval at which the Citrix ADC sends LACPDU messages to the peer device on the LA channel.
Available settings function as follows:
LONG - 30 seconds.
SHORT - 1 second.
Possible values = LONG, SHORT
lacpactorpriority Read-only LACP Actor Priority. A LACP port priority is configured on each port using LACP. LACP uses the port priority with the port number to form the port identifier. The port priority determines which ports should be put in standby mode when there is a hardware limitation that prevents all compatible ports from aggregating.
lacpactorportno Read-only LACP Actor port number. LACP uses the port priority with the port number to form the port identifier.
lacppartnerstate Read-only LACP Partner State. Whether the port is in Active or Passive negotiating state.
Possible values = MANUAL, AUTO
lacppartnertimeout Read-only The timeout value for the information revieved in LACPDUs. It can have values as SHORT or LONG. The SHORT timeout is 3s and the LONG timeout is 90s.
Possible values = LONG, SHORT
lacppartneraggregation Read-only The Aggregation flag indicates that the participant will allow the link to be used as part of an aggregate. Otherwise the link is to be used as an individual link, i.e. not aggregated with any other.
Possible values = NS_EMPTY_STR, AGG
lacppartnerinsync Read-only The Synchronization flag indicates that the transmitting participant.s mux component is in sync with the system id and key information transmitted.
Possible values = NS_EMPTY_STR, SYNC
lacppartnercollecting Read-only The Collecting flag indicates that the participant.s collector, i.e. the reception component of the mux, is definitely on. If set the flag communicates collecting.
Possible values = NS_EMPTY_STR, COLLECTING
lacppartnerdistributing Read-only The Distributing flag indicates that the participant.s distributor is not definitely off. If reset the flag indicates not distributing.
Possible values = NS_EMPTY_STR, DISTRIBUTING
lacppartnerdefaulted Read-only If the timer expires in the Expired state, the Receive Machine enters the Defaulted state.
Possible values = NS_EMPTY_STR, DEFAULTED
lacppartnerexpired Read-only If the LACPDUs are received for timeout period, the Receive Machine enters the Expired state and the timer is restarted with the timeout value of SHORT timeout.
Possible values = NS_EMPTY_STR, EXPIRED
lacppartnerpriority Read-only LACP Partner Priority. A LACP port priority is configured on each port using LACP. LACP uses the port priority with the port number to form the port identifier.
The port priority determines which ports should be put in standby mode when there is a hardware limitation that prevents all compatible ports from aggregating.
lacppartnersystemmac Read-only LACP Partner System MAC.
lacppartnersystempriority Read-only LACP Partner System Priority. The LACP partner’s system priority. The values for the priority range from 0 to 65535. The lower the value, the higher the system priority. The switch with the lower system priority value determines which links between LACP partner are active and which are in the standby for each LACP Channel.
lacppartnerportno Read-only LACP Partner Port number. LACP uses the port priority with the port number to form the port identifier.
lacppartnerkey Read-only LACP Partner Key. The LACP key used by the partner port.
lacpactoraggregation Read-only The Aggregation flag indicates that the participant will allow the link to be used as part of an aggregate. Otherwise the link is to be used as an individual link, i.e. not aggregated with any other.
Possible values = NS_EMPTY_STR, AGG
lacpactorinsync Read-only The Synchronization flag indicates that the transmitting participant.s mux component is in sync with the system id and key information transmitted.
Possible values = NS_EMPTY_STR, SYNC
lacpactorcollecting Read-only The Collecting flag indicates that the participant.s collector, i.e. the reception component of the mux, is definitely on. If set the flag communicates collecting.
Possible values = NS_EMPTY_STR, COLLECTING
lacpactordistributing Read-only The Distributing flag indicates that the participant.s distributor is not definitely off. If reset the flag indicates not distributing.
Possible values = NS_EMPTY_STR, DISTRIBUTING
lacpportmuxstate Read-only LACP Port MUX state. The state of the MUX control machine. The Mux Control Machine attaches the physical port to an aggregate port, using the Selection Logic to choose an appropriate port, and turns the distributor and collector for the physical port on or off as required by protocol information.
Possible values = DETACHED, WAITING, ATTACHED, COLLECTING, DISTRIBUTING
lacpportrxstat Read-only LACP Port RX state. The state of the Receive machine. The Receive Machine maintains partner information, recording protocol information from LACPDUs sent by remote partner(s). Received information is subject to a timeout, and if sufficient time elapses the receive machine will revert to using default partner information.
Possible values = INIT, PORT_DISABLED, LACP_DISABLED, EXPIRED, DEFAULTED, CURRENT
lacpportselectstate Read-only LACP Port SELECT state. The state of the SELECT state machine, It could be SELECTED or UNSELECTED.
Possible values = UNSELECTED, SELECTED, STANDBY
lractiveintf Read-only LR set member interface state(active/inactive).
__count Read-only count parameter

Operations

(click to see Properties)

CLEAR UPDATE UNSET ENABLE DISABLE RESET GET (ALL) GET COUNT

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

clear

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?action=clear

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"Interface":{
<b>"id":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"Interface":{
<b>"id":<String_value>,
</b>"speed":<String_value>,
"duplex":<String_value>,
"flowctl":<String_value>,
"autoneg":<String_value>,
"hamonitor":<String_value>,
"haheartbeat":<String_value>,
"mtu":<Double_value>,
"tagall":<String_value>,
"trunk":<String_value>,
"trunkmode":<String_value>,
"trunkallowedvlan":<String[]_value>,
"lacpmode":<String_value>,
"lacpkey":<Double_value>,
"lagtype":<String_value>,
"lacppriority":<Double_value>,
"lacptimeout":<String_value>,
"ifalias":<String_value>,
"throughput":<Double_value>,
"linkredundancy":<String_value>,
"bandwidthhigh":<Double_value>,
"bandwidthnormal":<Double_value>,
"lldpmode":<String_value>,
"lrsetpriority":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"Interface":{
<b>"id":<String_value>,
</b>"speed":true,
"duplex":true,
"flowctl":true,
"autoneg":true,
"hamonitor":true,
"haheartbeat":true,
"mtu":true,
"tagall":true,
"trunk":true,
"trunkmode":true,
"trunkallowedvlan":true,
"lacpmode":true,
"lacppriority":true,
"lacptimeout":true,
"ifalias":true,
"throughput":true,
"linkredundancy":true,
"bandwidthhigh":true,
"bandwidthnormal":true,
"lldpmode":true,
"lrsetpriority":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

enable

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?action=enable

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"Interface":{
<b>"id":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

disable

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?action=disable

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"Interface":{
<b>"id":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

reset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?action=reset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"Interface":{
<b>"id":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of Interface resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?pagesize=#no;pageno=#no

Use this query-parameter to get the Interface resources in chunks.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "Interface": [ {
"id":<String_value>,
"devicename":<String_value>,
"unit":<Double_value>,
"description":<String_value>,
"flags":<Double_value>,
"mtu":<Double_value>,
"actualmtu":<Double_value>,
"vlan":<Double_value>,
"mac":<String_value>,
"uptime":<Double_value>,
"downtime":<Double_value>,
"reqmedia":<String_value>,
"reqspeed":<String_value>,
"reqduplex":<String_value>,
"reqflowcontrol":<String_value>,
"actmedia":<String_value>,
"actspeed":<String_value>,
"actduplex":<String_value>,
"actflowctl":<String_value>,
"mode":<String_value>,
"hamonitor":<String_value>,
"haheartbeat":<String_value>,
"state":<String_value>,
"autoneg":<String_value>,
"autonegresult":<Double_value>,
"tagged":<Double_value>,
"tagall":<String_value>,
"trunk":<String_value>,
"trunkmode":<String_value>,
"trunkallowedvlan":<String[]_value>,
"taggedany":<Double_value>,
"taggedautolearn":<Double_value>,
"hangdetect":<Double_value>,
"hangreset":<Double_value>,
"linkstate":<Double_value>,
"intfstate":<Double_value>,
"rxpackets":<Double_value>,
"rxbytes":<Double_value>,
"rxerrors":<Double_value>,
"rxdrops":<Double_value>,
"txpackets":<Double_value>,
"txbytes":<Double_value>,
"txerrors":<Double_value>,
"txdrops":<Double_value>,
"indisc":<Double_value>,
"outdisc":<Double_value>,
"fctls":<Double_value>,
"hangs":<Double_value>,
"stsstalls":<Double_value>,
"txstalls":<Double_value>,
"rxstalls":<Double_value>,
"bdgmacmoved":<Double_value>,
"bdgmuted":<Double_value>,
"vmac":<String_value>,
"vmac6":<String_value>,
"lacpmode":<String_value>,
"lacpkey":<Double_value>,
"lacppriority":<Double_value>,
"lacptimeout":<String_value>,
"lagtype":<String_value>,
"ifalias":<String_value>,
"reqthroughput":<Double_value>,
"linkredundancy":<String_value>,
"actthroughput":<Double_value>,
"bandwidthhigh":<Double_value>,
"bandwidthnormal":<Double_value>,
"backplane":<String_value>,
"ifnum":<String[]_value>,
"cleartime":<Double_value>,
"slavestate":<Double_value>,
"slavemedia":<Double_value>,
"slavespeed":<Double_value>,
"slaveduplex":<Double_value>,
"slaveflowctl":<Double_value>,
"slavetime":<Double_value>,
"intftype":<String_value>,
"svmcmd":<Double_value>,
"lacpactormode":<String_value>,
"lacpactortimeout":<String_value>,
"lacpactorpriority":<Double_value>,
"lacpactorportno":<Double_value>,
"lacppartnerstate":<String_value>,
"lacppartnertimeout":<String_value>,
"lacppartneraggregation":<String_value>,
"lacppartnerinsync":<String_value>,
"lacppartnercollecting":<String_value>,
"lacppartnerdistributing":<String_value>,
"lacppartnerdefaulted":<String_value>,
"lacppartnerexpired":<String_value>,
"lacppartnerpriority":<Double_value>,
"lacppartnersystemmac":<String_value>,
"lacppartnersystempriority":<Double_value>,
"lacppartnerportno":<Double_value>,
"lacppartnerkey":<Double_value>,
"lacpactoraggregation":<String_value>,
"lacpactorinsync":<String_value>,
"lacpactorcollecting":<String_value>,
"lacpactordistributing":<String_value>,
"lacpportmuxstate":<String_value>,
"lacpportrxstat":<String_value>,
"lacpportselectstate":<String_value>,
"lldpmode":<String_value>,
"lrsetpriority":<Double_value>,
"lractiveintf":<Boolean_value>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface/id_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface/id_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface/id_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "Interface": [ {
"id":<String_value>,
"devicename":<String_value>,
"unit":<Double_value>,
"description":<String_value>,
"flags":<Double_value>,
"mtu":<Double_value>,
"actualmtu":<Double_value>,
"vlan":<Double_value>,
"mac":<String_value>,
"uptime":<Double_value>,
"downtime":<Double_value>,
"reqmedia":<String_value>,
"reqspeed":<String_value>,
"reqduplex":<String_value>,
"reqflowcontrol":<String_value>,
"actmedia":<String_value>,
"actspeed":<String_value>,
"actduplex":<String_value>,
"actflowctl":<String_value>,
"mode":<String_value>,
"hamonitor":<String_value>,
"haheartbeat":<String_value>,
"state":<String_value>,
"autoneg":<String_value>,
"autonegresult":<Double_value>,
"tagged":<Double_value>,
"tagall":<String_value>,
"trunk":<String_value>,
"trunkmode":<String_value>,
"trunkallowedvlan":<String[]_value>,
"taggedany":<Double_value>,
"taggedautolearn":<Double_value>,
"hangdetect":<Double_value>,
"hangreset":<Double_value>,
"linkstate":<Double_value>,
"intfstate":<Double_value>,
"rxpackets":<Double_value>,
"rxbytes":<Double_value>,
"rxerrors":<Double_value>,
"rxdrops":<Double_value>,
"txpackets":<Double_value>,
"txbytes":<Double_value>,
"txerrors":<Double_value>,
"txdrops":<Double_value>,
"indisc":<Double_value>,
"outdisc":<Double_value>,
"fctls":<Double_value>,
"hangs":<Double_value>,
"stsstalls":<Double_value>,
"txstalls":<Double_value>,
"rxstalls":<Double_value>,
"bdgmacmoved":<Double_value>,
"bdgmuted":<Double_value>,
"vmac":<String_value>,
"vmac6":<String_value>,
"lacpmode":<String_value>,
"lacpkey":<Double_value>,
"lacppriority":<Double_value>,
"lacptimeout":<String_value>,
"lagtype":<String_value>,
"ifalias":<String_value>,
"reqthroughput":<Double_value>,
"linkredundancy":<String_value>,
"actthroughput":<Double_value>,
"bandwidthhigh":<Double_value>,
"bandwidthnormal":<Double_value>,
"backplane":<String_value>,
"ifnum":<String[]_value>,
"cleartime":<Double_value>,
"slavestate":<Double_value>,
"slavemedia":<Double_value>,
"slavespeed":<Double_value>,
"slaveduplex":<Double_value>,
"slaveflowctl":<Double_value>,
"slavetime":<Double_value>,
"intftype":<String_value>,
"svmcmd":<Double_value>,
"lacpactormode":<String_value>,
"lacpactortimeout":<String_value>,
"lacpactorpriority":<Double_value>,
"lacpactorportno":<Double_value>,
"lacppartnerstate":<String_value>,
"lacppartnertimeout":<String_value>,
"lacppartneraggregation":<String_value>,
"lacppartnerinsync":<String_value>,
"lacppartnercollecting":<String_value>,
"lacppartnerdistributing":<String_value>,
"lacppartnerdefaulted":<String_value>,
"lacppartnerexpired":<String_value>,
"lacppartnerpriority":<Double_value>,
"lacppartnersystemmac":<String_value>,
"lacppartnersystempriority":<Double_value>,
"lacppartnerportno":<Double_value>,
"lacppartnerkey":<Double_value>,
"lacpactoraggregation":<String_value>,
"lacpactorinsync":<String_value>,
"lacpactorcollecting":<String_value>,
"lacpactordistributing":<String_value>,
"lacpportmuxstate":<String_value>,
"lacpportrxstat":<String_value>,
"lacpportselectstate":<String_value>,
"lldpmode":<String_value>,
"lrsetpriority":<Double_value>,
"lractiveintf":<Boolean_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/Interface?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "Interface": [ { "__count": "#no"} ] }

<!--NeedCopy-->
Interface
August 17, 2023
Contributed by: 
C
August 17, 2023
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.