If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

If the method succeeds, message is NULL else message contains Error/Warning message.

List of interfaces

* 0 - Indicates a management interface.

Name of the interface.

Unit number for this interface, signifying the sequence number in which this interface is discovered on this Citrix ADC.

Display the type of interface, the speeds at which this interface can operate, and, if applicable, the type of SFP,.

Flags for this interface. Used for communicating the device states.

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 an interface. The default value of MTU is 1500 on all the interface of Citrix ADC, some Cloud Platforms will restrict Citrix ADC to use the lesser default value. Any MTU value more than 1500 is called Jumbo MTU and will make the interface as jumbo enabled. The Maximum Jumbo MTU in Citrix ADC is 9216, however, some Virtualized / Cloud Platforms will have lesser Maximum Jumbo MTU Value (9000). In the case of Cluster, the Backplane interface requires an MTU value of 78 bytes more than the Max MTU configured on any other Data-Plane Interface. When the Data plane interfaces are all at default 1500 MTU, Cluster Back Plane will be automatically set to 1578 (1500 + 78) MTU. If a Backplane interface is reset to Data Plane Interface, then the 1578 MTU will be automatically reset to the default MTU of 1500(or whatever lesser default value). If any data plane interface of a Cluster is configured with a Jumbo MTU ( > 1500), then all backplane interfaces require to be configured with a minimum MTU of 'Highest Data Plane MTU in the Cluster + 78'. That makes the maximum Jumbo MTU for any Data-Plane Interface in a Cluster System to be '9138 (9216 - 78)., where 9216 is the maximum Jumbo MTU. On certain Virtualized / Cloud Platforms, the maximum possible MTU is restricted to a lesser value, Similar calculation can be applied, Maximum Data Plane MTU in Cluster = (Maximum possible MTU - 78).

MTU for this interface (the largest frame that can transit this interface).

Native VLAN for this interface.

MAC address for this interface.

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..

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).

The receive ringsize of the interface. A higher number provides more number of buffers in handling incoming traffic.

The receive ringtype of the interface (Fixed or Elastic). A fixed ring type pre-allocates configured number of buffers irrespective of traffic rate. In contrast, an elastic ring, expands and shrinks based on incoming traffic rate.

Actual receive ringsize of the interface. This will be same as configured receive ringsize when ringtype is Fixed whereas it denotes the current number of receive buffers allocated when ringtype is Elastic

Requested media setting for this interface.

Requested speed setting for this interface.

Requested duplex setting for this interface.

Requested flow control setting for this interface.

Actual media setting for this interface.

Actual speed setting for this interface.

Actual duplex setting for this interface.

Actual flow control setting for this interface.

Interface Link Aggregation mode (Auto/Manual) setting.

HA monitor enabled or disabled for this interface.

HA Hearbeat send enabled or disabled for this interface.

Link state of the interface (UP/DOWN).

Interface autonegotiation enabled or disabled.

Actual auto-negotiation setting for this interface.

VLAN tags setting on this channel.

VLAN tagging behavior on this interface. With the ON setting,, packets are tagged with all the VLANs that are bound to this interface. With the OFF setting, packets are tagged with the native VLAN.

This argument is deprecated by tagall.
NOTE: This attribute is deprecated.
The "trunk" argument is confused with LA-trunk, renaming this to "tagall" instead.

Accept and send 802.1q VLAN tagged packets, based on Allowed Vlan List of this interface.

VLAN ID or range of VLAN IDs will be allowed on this trunk interface. In the method line interface, separate the range with a hyphen. For example: 40-90.

Interface setting to accept/drop all tagged packets.

Dynamic VLAN membership autolearning enabled or disabled on this interface.

Hang detection enabled or disabled for this interface.

Hang reset enabled or disabled for this interface.

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.

Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED.

Number of packets received by an interface since the Citrix ADC was started or the interface statistics were cleared.

Number of bytes received by an interface since the Citrix ADC was started or the interface statistics were cleared.

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.

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.

Number of packets transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared.

Number of bytes transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared.

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.

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.

Number of error-free inbound packets discarded by the specified interface because of a lack of resources (for example, insufficient receive buffers).

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.

Number of times flow control is performed on the specified interface because of received pause frames.

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.

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.

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.

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.

Number of MAC moves between ports. A high rate of MAC moves typically indicates a bridge loop between two interfaces.

Number of times the specified interface stopped transmitting and receiving packets because of MAC moves between ports.

Virtual MAC of this interface.

Virtual MAC for IPv6 of this interface.

The LACP mode of the specified interface. The possible values are: 1. Active: A port in active mode generates LACP protocol messages on a regular basis, regardless of any need expressed by its partner to receive them. 2. Passive: A port in passive mode is generally not transmit LACP messages unless its partner is in the active mode; that is, it does not communicate to the other appliance unless other appliance communicates with this appliance.

Identifies the channel to which the interface is bound. The possible values are 1, 2, 3, and 4.

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.

Time to wait for the LACPDU. If an LACPDU is not received within this interval, the Citrix ADC markes the link partner port as DOWN. Possible values; Long, Short. Long lacptimeout is 90 sec and Short LACP timeout is 3 sec.

Type of entity (Citrix ADC or cluster configuration) for which to create the channel.

Alias name for the interface. Used only to enhance readability. To perform any operations, you have to specify the interface ID.

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.

Link Redundancy for Cluster LAG.

Actual throughput for the interface.

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.

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.

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.

Contains the LA Master, if the interface is part of LA channel.

Time since the interface stats are cleared last time.

State of the member interfaces.

Media type of the member interfaces.

Speed of the member interfaces.

Duplex of the member interfaces.

Flowcontrol of the member interfaces.

UP time of the member interfaces.

Interface Type, this field will have the interface type either it is virtual, physical or loopback.

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.

* 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.

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.

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.

LACP Actor port number. LACP uses the port priority with the port number to form the port identifier.

LACP Partner State. Whether the port is in Active or Passive negotiating state.

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.

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.

The Synchronization flag indicates that the transmitting participant.s mux component is in sync with the system id and key information transmitted.

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.

The Distributing flag indicates that the participant.s distributor is not definitely off. If reset the flag indicates not distributing.

If the timer expires in the Expired state, the Receive Machine enters the Defaulted state.

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

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.

LACP Partner System MAC.

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.

LACP Partner Port number. LACP uses the port priority with the port number to form the port identifier.

LACP Partner Key. The LACP key used by the partner port.

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.

The Synchronization flag indicates that the transmitting participant.s mux component is in sync with the system id and key information transmitted.

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.

The Distributing flag indicates that the participant.s distributor is not definitely off. If reset the flag indicates not distributing.

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.

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.

LACP Port SELECT state. The state of the SELECT state machine, It could be SELECTED or UNSELECTED.

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.

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.

LR set member interface state(active/inactive).