statinterfaceResult Structure Definition

The statinterfaceResult structure defines the return type for statinterface API.

Syntax



Members

rc

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

message

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

interfaceList

Pointer to the interface List.


interfacestats Structure Definition

The interfacestats structure defines the actual return type values for statinterface API.

Syntax



Members

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.

clearstats

Clear the statsistics / counters

_nextgenapiresource


curintfstate

Current state of the specified interface. The interface state set to UP only if the link state is UP and administrative state is ENABLED .
Possible Values : DOWN, UP, PARTIAL-UP, UNKNOWN.

curlinkuptime

Duration for which the link is UP. This statistic is reset when the state changes to DOWN.

curlinkdowntime

Duration for which the link is DOWN. This statistic is reset when the state changes to UP.

totrxbytes

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

rxbytesrate

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

tottxbytes

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

txbytesrate

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

totrxpkts

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

rxpktsrate

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

tottxpkts

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

txpktsrate

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

jumbopktsreceived

Number of Jumbo Packets received on this interface.

jumbopktsreceivedrate

Rate of Jumbo Packets received on this interface.

jumbopktstransmitted

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

jumbopktstransmittedrate

Rate of Jumbo packets transmitted on this interface by upper layer, with TSO enabled actual trasmission size could be non Jumbo.

trunkpktsreceived

Number of Tagged Packets received on this Trunk interface through Allowed VLan List.

trunkpktsreceivedrate

Rate of Tagged Packets received on this Trunk interface through Allowed VLan List.

trunkpktstransmitted

Number of Tagged Packets transmitted on this Trunk interface through Allowed VLan List.

trunkpktstransmittedrate

Rate of Tagged Packets transmitted on this Trunk interface through Allowed VLan List.

nictotmulticastpkts

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

nicmulticastpktsrate

Rate of multicast packets received by the specified interface since the Citrix ADC was started or the interface statistics were cleared.

totnetscalerpkts

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.

netscalerpktsrate

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

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.

rxlacpdurate

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

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.

txlacpdurate

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

errpktrx

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.

errpktrxrate

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

errpkttx

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.

errpkttxrate

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

errifindiscards

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

errifindiscardsrate

Rate of error-free inbound packets discarded by the specified interface due to a lack of resources, for example, insufficient receive buffers.

nicerrifoutdiscards

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.

nicerrifoutdiscardsrate

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

errdroppedrxpkts

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.

errdroppedrxpktsrate

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

errdroppedtxpkts

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.

errdroppedtxpktsrate

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

errlinkhangs

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.

nicstsstalls

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.

nictxstalls

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.

nicrxstalls

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.

nicerrdisables

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.

linkreinits

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.

totmacmoved

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.

macmovedrate

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

errnicmuted

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

rxcrcerrors

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.

rxcrcerrorsrate

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

interfacealias

Alias Name for the Interface

curlinkstate

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.
Possible Values : DOWN, UP, PARTIAL-UP, UNKNOWN.

See Also