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 channels

ID of an LA channel or LA channel in cluster configuration whose details you want the Citrix ADC to display.

LA channel name in form LA/x, where x is channel ID, which ranges from 1 to 8 or LR channel name in form LR/x, where x is channel ID, which ranges from 1 to 4

Unit number of the channel. This is an internal reference number that the Citrix ADC uses to identify the channel.

The IEEE standard that the channel is based on.

Flags of this channel.

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 of the channel. This is the maximum frame size that the channel can process.

Native VLAN of the channel.

MAC address of the channel.

Specifies a MAC address for the LA channels configured in Citrix ADC virtual appliances (VPX). This MAC address is persistent after each reboot. If you don't specify this parameter, a MAC address is generated randomly for each LA channel. These MAC addresses change after each reboot.

Duration for which the channel is UP. (Example: 3 hours 1 minute 1 second). This value is reset when the channel state changes to DOWN.

Duration for which the channel is DOWN. (Example: 3 hours 1 minute 1 second). This value is reset when the channel state changes to UP.

Requested media setting for this channel. Since there is no media associated with LA, the displayed values carry no significance.

Requested speed setting for this channel. Since no media are associated with LA, this speed is used to determine the threshold for the slave interfaces. If the speed of the member interface is less than the requested speed, that interface is considered inactive.

Requested duplex setting for this channel. Since no media are associated with LA, the displayed values carry no significance.

Requested flow control setting for this channel. Since no media are associated with LA, the displayed values carry no significance.

Requested media setting for this interface.

Actual speed setting for this channel.

Actualduplex setting for this interface.

Actual flow control setting for this channel.

The type of LA: static LA or dynamic LA (LACP). Possible values: Manual, AUTO. Manual shows the static LA, and AUTO shows the LACP.

The mode(AUTO/MANNUAL) for the LA channel.

HA monitoring enabled or disabled for this channel.

The state of HA HEARTBEAT SEND for the LA channel.

Enable or disable the LA channel.

Requested auto negotiation setting for this channel. Since no media are associated with LA, this setting has no effect.

Actual auto negotiation setting for this channel.

VLAN tags setting on this channel.

The appliance adds a four-byte 802.1q tag to every packet sent on this channel. ON applies tags for all the VLANs that are bound to this channel. OFF, applies the tag for all VLANs other than the native VLAN.

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

Channel setting to accept/drop all tagged packets.

Dynaminc vlan membership on this channel.

Hang detect for this channel.

Hang reset for this channel.

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 bytes received by all the slave interfaces of the channel since the Citrix ADC was started or the interface statistics were cleared.

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

Number of inbound packets dropped by the hardware of the slave interfaces since the Citrix ADC was started or the interface statistics were cleared. Possible causes of dropped packets are CRC, length (undersize or oversize), and alignment errors.

Number of inbound packets dropped by the channel's slave interfaces. 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 slave interfaces of a channel since the Citrix ADC was started or the interface statistics were cleared.

Number of bytes transmitted by slave interfaces of a channel since the Citrix ADC was started or the interface statistics were cleared.

Number of outbound packets dropped by the hardware of a channel's slave interfaces since the Citrix ADC was started or the interface statistics were cleared. Possible causes of dropped packets are length (undersize or oversize) errors and lack of resources.

Number of packets dropped in transmission by a channel's slave interfaces for one of the following reasons: (1) VLAN mismatch. (2) Oversized packets. (3) Interface congestion. (4) Loopback packets sent on non-loopback interface.

Number of error-free inbound packets discarded by a channel's slave interfaces because of a lack of resources (for example, insufficient receive buffers).

Number of error-free outbound packets discarded by a channel's slave interfaces 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 a channel's slave interfaces because of pause frames.

Number of hangs that occurred on the channel's slave interfaces.

Number of status stalls that occurred on the channel's slave interfaces.

Number of Tx stalls happened that occurred on the channel's slave interfaces.

Number of Rx stalls that occurred on the channel's slave interfaces.

Number of times a channel's slave interfaces stopped transmitting and receiving packets because of MAC moves between ports.

Virtual MAC of this channel.

Virtual MAC for IPv6 on this interface.

The alias name for the interface.

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.

Specifies the minimum throughput threshold (in Mbps) to be met by the active subchannel. Setting this parameter automatically divides an LACP channel into logical subchannels, with one subchannel active and the others in standby mode. When the maximum supported throughput of the active channel falls below the lrMinThroughput value, link failover occurs and a standby subchannel becomes active.

Link Redundancy for Cluster LAG.

Actual throughput for the interface.

High threshold value for the bandwidth usage of the LA channel, in Mbps. The Citrix ADC generates an SNMP trap message when the bandwidth usage of the LA channel is greater than or equal to the specified high threshold value.

Normal threshold value for the bandwidth usage of the LA channel, in Mbps. When the bandwidth usage of the LA channel returns to 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 interfaces bound to link aggregate channel.

The cluster backplane status of the LA. If the status is enabled, the LA is part of the cluster backplane. By default, the backplane status is disabled.

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.

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 generally does not transmit LACP messages unless its partner is in the active mode; that is, it does not speak unless spoken to. 3. Disabled: Removes the interface from the LA channel. If this is only interface in the LA channel, the LA channel is also deleted.

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

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.

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.

LR set member interface state(active/inactive).