Developer Documentation

ADC CLI Commands

interface

May 28, 2024

Contributed by:

The following operations can be performed on “interface”:

set interface

Modifies the parameters of an interface.

Synopsis

set interface @ \[-speed ] \[-duplex ] \[-flowControl ] \[-autoneg \( DISABLED | ENABLED )] \[-haMonitor \( ON | OFF )] \[-haHeartbeat \( OFF | ON )] \[-mtu <positive\_integer>] \[-ringsize <positive\_integer>] \[-ringtype \( Elastic | Fixed )] \[-tagall \( ON | OFF )] \[-trunkmode \( ON | OFF )] \[-trunkAllowedVlan <int\[-int]> ...] \[-lacpMode ] \[-lacpKey <positive\_integer>] \[-lagtype \( NODE | CLUSTER )] \[-lacpPriority <positive\_integer>] \[-lacpTimeout \( LONG | SHORT )] \[-ifAlias ] \[-throughput <positive\_integer>] \[-linkRedundancy \( ON | OFF )] \[-bandwidthHigh <positive\_integer> \[-bandwidthNormal <positive\_integer>]] \[-lldpmode ] \[-lrsetPriority <positive\_integer>]

Arguments

id ID of the Interface whose parameters you want to modify. For a Citrix ADC, specify the interface in C/U notation (for example, 1/3). For a cluster configuration, specify the interface in N/C/U notation (for example, 2/1/3). 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. U is a unique integer for representing an interface in a particular port group. N is the ID of the node to which an interface belongs in a cluster configuration. Use spaces to separate multiple entries.

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

Possible values: AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000 Default value: AUTO

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

Possible values: AUTO, HALF, FULL Default value: AUTO

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

Possible values: OFF, RX, TX, RXTX, ON Default value: OFF

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

Possible values: DISABLED, ENABLED Default value: NSA_DVC_AUTONEG_ON

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

Possible values: ON, OFF Default value: ON

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

Possible values: OFF, ON Default value: ON

mtu 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). Default value: 1500 Minimum value: 1500 Maximum value: 9216

ringsize The receive ringsize of the interface. A higher number provides more number of buffers in handling incoming traffic. Default value: 2048 Minimum value: 512 Maximum value: 16384

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

Possible values: Elastic, Fixed Default value: Elastic

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

Possible values: ON, OFF Default value: OFF

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

Possible values: ON, OFF Default value: OFF

trunkAllowedVlan 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 value: 1 Maximum value: 4094

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

Possible values: DISABLED, ACTIVE, PASSIVE Default value: DISABLED

lacpKey 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 Type of entity (Citrix ADC or cluster configuration) for which to create the channel.

Possible values: NODE, CLUSTER Default value: NODE

lacpPriority 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 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 Default value: NSA_LACP_TIMEOUT_LONG

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

throughput 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 Link Redundancy for Cluster LAG.

Possible values: ON, OFF Default value: OFF

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

disable interface

Disables the interface from transmitting and receiving packets. The link remains active and the peer network device is unaware that the interface has been disabled. In a High Availability configuration, an interface that has HA MON enabled and is not bound to any Failover Interface Set (FIS), is a critical interface. Disabling or failure of any critical interface triggers HA failover.

Note: To view the status of an interface, use the show interface command.

Synopsis

disable interface @

Arguments

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

stat interface

Displays the statistics of all interfaces or of the specified interface on the Citrix ADC. To display the statistics of all interfaces, run the command without any parameters. To display the statistics of a particular interface, specify the ID of the interface.

Synopsis

stat interface [@] \[-detail] \[-fullValues] \[-ntimes <positive\_integer>] \[-logFile <input\_filename>] \[-clearstats \( basic | full )]

Arguments

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

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

Output

count devno stateflag

Counters

Interface State (IntfState) Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED .

Link uptime (UpTime) Duration for which the link is UP. This statistic is reset when the state changes to DOWN.

Link downtime (DnTime) Duration for which the link is DOWN. This statistic is reset when the state changes to UP.

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

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

Packets received (Rx Pkts) Number of packets received by an interface since the Citrix ADC was started or the interface statistics were cleared.

Packets transmitted (Tx Pkts) Number of packets transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared.

Jumbo Packets Received (JumboRcv) Number of Jumbo Packets received on this interface.

Jumbo Packets Transmitted (JumboXmit) Number of Jumbo packets transmitted on this interface by upper layer, with TSO enabled actual trasmission size could be non Jumbo.

Tagged Packets Received on Trunk interface through allowed vlan list (TrunkRcv) Number of Tagged Packets received on this Trunk interface through Allowed VLan List.

Tagged Packets transmitted on Trunk interface through allowed vlan list (TrunkXmit) Number of Tagged Packets transmitted on this Trunk interface through Allowed VLan List.

Multicast packets (McastPkt) Number of multicast packets received by the specified interface since the Citrix ADC was started or the interface statistics were cleared.

NetScaler packets (NSPkt) Number of packets, destined to the Citrix ADC, received by an interface since the Citrix ADC was started or the interface statistics were cleared. The packets destined to Citrix ADC are those that have the same MAC address as that of an interface or a VMAC address owned by the Citrix ADC.

LACPDUs received (RxLacpdu) Number of Link Aggregation Control Protocol Data Units(LACPDUs) received by the specified interface since the Citrix ADC was started or the interface statistics were cleared.

LACPDUs transmitted (TxLacpdu) Number of Link Aggregation Control Protocol Data Units(LACPDUs) transmitted by the specified interface since the Citrix ADC was started or the interface statistics were cleared.

Error packets received (hw) (ErrRx) Number of inbound packets dropped by the hardware on a specified interface once the Citrix ADC starts or the interface statistics are cleared. This happens due to following reasons: 1)The hardware receives packets at a rate higher rate than that at which the software is processing packets. In this case, the hardware FIFO overruns and starts dropping the packets . 2)The specified interface fails to receive inbound packets from the appliance because of insufficient memory. 3)The specified interface receives packets with CRC errors (Alignment or Frame Check Sequence). 4)The specified interface receives overly long packets. 5)The specified interface receives packets with alignment errors. 6)The software does less buffering because it is running out of available memory. When hardware detects that there is no space into which to push newly arrived packets, it starts dropping them. 7)The specified interface receives packets with Frame Check Sequence (FCS) errors. 8)The specified interface receives packets smaller than 64 bytes. 9)The specified interface discards error-free inbound packets because of insufficient resources. For example: NIC buffers. 10)Packets are missed because of collision detection, link lost, physical decoding error, or MAC abort.

Error packets transmitted (hw) (ErrTx) Number of outbound packets dropped by the hardware on a specified interface since the Citrix ADC was started or the interface statistics were cleared. This could happen due to length (undersize or oversize) errors and 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 MPX 15000 and 17000 platforms.

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

Outbound packets discarded(hw) (OutDisc) Number of error-free outbound packets discarded by the specified interface due to 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.

Packets dropped in Rx (sw) (DrpRxPkt) 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. This statistic will increment in most healthy networks at a steady rate regardless of traffic load. If a sharp spike in dropped packets occurs, it generally indicates an issue with connected L2 switches, such as a forwarding database overflow resulting in packets being broadcast on all ports.

Packets dropped in Tx (sw) (DrpTxPkt) Number of packets dropped in transmission by the specified interface due to one of the following reasons. (1) VLAN mismatch. (2) Oversized packets. (3) Interface congestion. (4) Loopback packets sent on non loop back interface.

NIC hangs (Hangs) 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.

Status stalls (StsStall) 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.

Transmit stalls (TxStall) 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.

Receive stalls (RxStall) 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 is received for 16 seconds.

Error-disables (ErrDis) Number of times the specified interface is disabled by the Citrix ADC, due to continuous Receive (Rx) or Transmit (Tx) stalls, since the Citrix ADC was started or the interface statistics were cleared. The Citrix ADC disables an interface when one of the following conditions is met: (1) Three consecutive transmit stalls occurs with at most gap of 10 seconds between any two stalls. (2) Three consecutive receive stalls occurs with at most gap of 120 seconds between any two stalls.

Link re-initializations (LnkReint) Number of times the link has been re-initialized. A re-initialization occurs due to link state change, configuration parameter change, or administrative reset operation.

MAC moves registered (MacMvd) Number of MAC moves between ports. If a high rate of MAC moves is observed, it is likely that there is a bridge loop between two interfaces.

Times NIC became muted (ErrMtd) Number of times the specified interface stopped transmitting and receiving packets due to MAC moves between ports.

Receive CRC errors (ErrRxCRC) Number of packets received with the wrong checksum by the specified interface since the Citrix ADC was started or the interface statistics were cleared. This indicates the number of Jabber frames received instead of CRC errors on the 10G data ports of Citrix ADC 12000-10G platform and the data ports of Citrix ADC MPX 15000 and 17000 platforms.

Interface Alias (IntfAlias) Alias Name for the Interface

Link State (State) 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.

stat MapDomain

enable interface

Enables the interface. If the link is active, it can transmit and receive packets. Note: To view the status of an interface, use the show interface command.

Synopsis

enable interface @

Arguments

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

show interface

Displays the settings of all interfaces or of the specified interface on the Citrix ADC. To display the settings of all interfaces, run the command without any parameters. To display the settings of a particular interface, specify the ID of the interface.

Synopsis

show interface [@] show interface stats - alias for 'stat interface'

Arguments

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

Output

stateflag deviceName Name of the interface.

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

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

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

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

vlan Native VLAN for this interface.

mac MAC address for this interface.

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

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

actualringsize 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

reqMedia Requested media setting for this interface.

reqSpeed Requested speed setting for this interface.

reqDuplex Requested duplex setting for this interface.

reqFlowcontrol Requested flow control setting for this interface.

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

media Actual media setting for this interface.

speed Actual speed setting for this interface.

duplex Actual duplex setting for this interface.

flowControl Actual flow control setting for this interface.

Mode Interface Link Aggregation mode (Auto/Manual) setting.

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

haMonitor HA monitor enabled or disabled for this interface.

haHeartbeat HA Hearbeat send enabled or disabled for this interface.

state Link state of the interface (UP/DOWN).

autoneg Interface autonegotiation enabled or disabled.

autonegResult Actual auto-negotiation setting for this interface.

tagged VLAN tags setting on this channel.

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

trunk This argument is deprecated by tagall.

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

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

taggedAny Interface setting to accept/drop all tagged packets.

taggedAutolearn Dynamic VLAN membership autolearning enabled or disabled on this interface.

hangDetect Hang detection enabled or disabled for this interface.

hangReset Hang reset enabled or disabled for this interface.

linkState 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 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 Number of packets received by an interface since the Citrix ADC was started or the interface statistics were cleared.

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

rxerrors 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 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 Number of packets transmitted by an interface since the Citrix ADC was started or the interface statistics were cleared.

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

txerrors 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 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 Number of error-free inbound packets discarded by the specified interface because of a lack of resources (for example, insufficient receive buffers).

outDisc 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 Number of times flow control is performed on the specified interface because of received pause frames.

hangs 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 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 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 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 Number of MAC moves between ports. A high rate of MAC moves typically indicates a bridge loop between two interfaces.

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

vmac Virtual MAC of this interface.

vmac6 Virtual MAC for IPv6 of this interface.

lacpMode The LACP mode of the specified interface. The possible values are:

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

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

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

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

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

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

reqThroughput 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:

1000Mbps for 1G interfaces.
10000Mbps for 10G interfaces.
160000Mbps for Link Aggregation channels.

throughput Minimum required throughput for the interface.

linkRedundancy Link Redundancy for Cluster LAG.

throughput Actual throughput for the interface.

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

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

clearTime Time since the interface stats are cleared last time.

slavestate State of the member interfaces.

slavemedia Media type of the member interfaces.

slavespeed Speed of the member interfaces.

slaveduplex Duplex of the member interfaces.

slaveflowctl Flowcontrol of the member interfaces.

slavetime UP time of the member interfaces.

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

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

lacpActorMode

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.

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

lacpActorPriority 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 LACP Actor port number. LACP uses the port priority with the port number to form the port identifier.

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

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

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

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

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

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

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

lacpPartnerExpired 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

lacpPartnerPriority 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 LACP Partner System MAC.

lacpPartnerSystemPriority 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 LACP Partner Port number. LACP uses the port priority with the port number to form the port identifier.

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

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

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

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

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

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

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

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

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

lrActiveIntf LR set member interface state(active/inactive).

devno count

Example

The output for the show interface command is as follows:

1) Interface 0/1 (Gig Ethernet 10/100/1000 MBits) #4 flags=0x4021 <ENABLED, UP, UP, autoneg, HAMON, 802.1q> MTU=1500, native vlan=1, MAC=00:30:48:67:9a:9a, uptime 1039h54m28s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0

2) Interface 1/1 (Gig Ethernet, copper SFP) #3 flags=0x4021 <ENABLED, UP, UP, autoneg, HAMON, BACKPLANE, 802.1q> MTU=1500, native vlan=1, MAC=00:e0:ed:12:e8:b7, uptime 1039h54m28s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0

3) Interface 1/2 (Gig Ethernet, copper SFP) #2 flags=0x4001 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MTU=1500, native vlan=1, MAC=00:e0:ed:12:e8:b6, downtime 1039h54m28s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0

4) Interface 1/3 (Gig Ethernet, copper SFP) #1 flags=0x4001 <disabled, DOWN, down, autoneg, HAMON, 802.1q> MTU=1500, native vlan=1, MAC=00:e0:ed:12:e8:b5, downtime 1039h54m33s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0

5) Interface 1/4 (Gig Ethernet, copper SFP) #0 flags=0x4001 <disabled, UP, down, autoneg, HAMON, 802.1q> MTU=1500, native vlan=1, MAC=00:e0:ed:12:e8:b4, downtime 1039h54m28s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0

Done

The output for the show interface 0/1 command is as follows:

    Interface 0/1 (Gig Ethernet 10/100/1000 MBits) #4
    flags=0xc020 <ENABLED, UP, UP, autoneg, HAMON, 802.1q>
    MTU=1500, native vlan=1, MAC=00:30:48:67:9a:9a, uptime 0h00m40s
    Requested: media AUTO, speed AUTO, duplex AUTO, fctl RXTX,
             throughput 0
    Actual: media UTP, speed 1000, duplex FULL, fctl RXTX, throughput 1000

    RX: Pkts(27) Bytes(2034) Errs(0) Drops(27) Stalls(0)
    TX: Pkts(3) Bytes(170) Errs(0) Drops(22) Stalls(0)
    NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0)
    Bandwidth thresholds are not set.

Done

clear interface

Resets the statistical counters of the specified interface.

Synopsis

clear interface @

Arguments

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

unset interface

Use this command to remove interface settings.Refer to the set interface command for meanings of the arguments.

Synopsis

unset interface @ [-speed] [-duplex] [-flowControl] [-autoneg] [-haMonitor] [-haHeartbeat] [-mtu] [-ringsize] [-ringtype] [-tagall] [-trunkmode] [-trunkAllowedVlan] [-lacpMode] [-lacpPriority] [-lacpTimeout] [-ifAlias] [-throughput] [-linkRedundancy] [-bandwidthHigh] [-bandwidthNormal] [-lldpmode] [-lrsetPriority]

reset interface

Restarts the interface but leaves the administrative state ENABLED or DISABLED and configuration unchanged. The link pertaining to the interface is reestablished with the existing settings.

Synopsis

reset interface @

Arguments

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

interface

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

interface

set interface

Synopsis

Arguments

disable interface

Synopsis

Arguments

stat interface

Synopsis

Arguments

Output

Counters

Related Commands

enable interface

Synopsis

Arguments

show interface

Synopsis

Arguments

Output

Example

clear interface

Synopsis

Arguments

unset interface

Synopsis

reset interface

Synopsis

Arguments

In this article