Collect_NetScaler_Interface

Prev Next

The Collect_NetScaler_Interface collection extension collects the Network Interface status data from a Citrix NetScaler.

  • Type: Collection

  • Source of data: Citrix NetScaler NitroAPI: /nitro/v1/stat/interface

  • Tables created: CitrixNetScalerInterface

  • Log files created: Collect_NetScaler_Interface.log

Columns

The following table explains the columns created by Collect_NetScaler_Interface:

Name

Type

Display Name

Description

name

String

name

This is the NetScaler device.

id

String

id

Interface number, in C/U format.

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: A unique integer for representing an interface in a particular port group.

curintfstate

String

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.

curlinkuptime

String

curlinkuptime

Duration for which the link is UP.

This statistic is reset when the state changes to DOWN.

curlinkdowntime

String

curlinkdowntime

Duration for which the link is DOWN.

This statistic is reset when the state changes to UP.

totrxbytes

Double

totrxbytes

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

rxbytesrate

Double

rxbytesrate

Rate (/s) counter for totrxbytes.

tottxbytes

Double

tottxbytes

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

txbytesrate

Double

txbytesrate

Rate (/s) counter for tottxbytes.

totrxpkts

Double

totrxpkts

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

rxpktsrate

Double

rxpktsrate

Rate (/s) counter for totrxpkts.

tottxpkts

Double

tottxpkts

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

txpktsrate

Double

txpktsrate

Rate (/s) counter for tottxpkts.

trunkpktsreceived

Double

trunkpktsreceived

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

trunkpktsreceivedrate

Double

trunkpktsreceivedrate

Rate (/s) counter for trunkpktsreceived.

trunkpktstransmitted

Double

trunkpktstransmitted

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

trunkpktstransmittedrate

Double

trunkpktstransmittedrate

Rate (/s) counter for trunkpktstransmitted.

nictotmulticastpkts

Double

nictotmulticastpkts

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

nicmulticastpktsrate

Double

nicmulticastpktsrate

Rate (/s) counter for nictotmulticastpkts.

totnetscalerpkts

Double

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

Double

netscalerpktsrate

Rate (/s) counter for totnetscalerpkts.

linkreinits

Double

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.

curlinkstate

String

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.

Files

The following files are created for Collect_NetScaler_Interface:

  • Collect_NetScaler_Interface.bat: Calls the PowerShell script that is doing the actual collection.

  • Collect_NetScaler_Interface.metadata: Collection extension instructions used by SysTrack.

  • Collect_NetScaler_Interface.ps1: PowerShell script that does the collections.