References > References > Variables and examples > Interface Variables

Interface Variables

The following are valid interface variables.

Interface Variable

Description

${N=SwisEntity;M=AdminStatus}

Numeric administrative status of interface. For more information, see Status Icons and Identifiers.

${N=SwisEntity;M=AdminStatusLED}

Filename of current interface administrative status icon

${N=SwisEntity;M=Caption}

User friendly description of interface combining name with other identifying information

${N=SwisEntity;M=Counter64}

States if interface supports IF-MIB high capacity counters

${CustomBandwidth}

Indicates if transmit and receive bandwidth fields are user‑controlled (1) or controlled by automated detection via ifSpeed MIB (0)

${CustomPollerLastStatisticsPoll}

Day, date, and time that this interface was last polled by the current poller

${N=SwisEntity;M=FullName}

User friendly name combining captions of parent node and interface

${N=SwisEntity;M=Caption}

Internal name discovered for this interface with the ifName OID

${N=SwisEntity;M=InterfaceID}

Internal unique identifier of selected interface

${N=SwisEntity;M=InBandwidth}

Incoming bandwidth of interface

${N=SwisEntity;M=Inbps}

Current incoming traffic, in bps, to interface

${N=SwisEntity;M=InDiscardsThisHour}

Number of incoming packets discarded by interface in last hour

${N=SwisEntity;M=InDiscardsToday}

Number of incoming packets discarded by interface in current day

${N=SwisEntity;M=InErrorsThisHour}

Number of interface receive errors in last hour

${N=SwisEntity;M=InErrorsToday}

Number of interface receive errors in current day

${N=SwisEntity;M=InMcastPps}

Current incoming multicast traffic, in packets per second, to interface

${N=SwisEntity;M=InPercentUtil}

Current percent utilization of interface receive

${N=SwisEntity;M=InPktSize}

Average size of incoming packets to interface

${N=SwisEntity;M=InPps"}

Current incoming traffic, in packets per second, to interface

${N=SwisEntity;M=InterfaceAlias}

Alias or description of interface discovered from parent node

${N=SwisEntity;M=InterfaceIcon}

Filename of the icon used to represent the interface type

${N=SwisEntity;M=InterfaceIndex}

Index of selected interface on parent node

${N=SwisEntity;M=InterfaceLastChange}

sysUpTime value when the interface entered current operational state

${InterfaceMTU}

Interface Maximum Transfer Unit: the largest packet the interface can handle

${N=SwisEntity;M=InterfaceName}

User friendly name

${N=SwisEntity;M=InterfaceSpeed}

Interface bandwidth

${N=SwisEntity;M=InterfaceType"}

IANA type of selected interface

${InterfaceTypeDescription}

User friendly description of interface type

${N=SwisEntity;M=InterfaceTypeName}

User friendly name of interface IANA type

${N=SwisEntity;M=InUcastPps}

Current incoming unicast traffic, in packets per second, to interface

${LastSync}

Time and date of last interface database and memory synchronization

${N=SwisEntity;M=NextPoll}

Day, date and time of next scheduled interface polling

${N=SwisEntity;M=NextRediscovery}

Next interface rediscovery time

${N=SwisEntity;M=NodeID}

Internal unique identifier of node that is parent to the selected interface

${N=Alerting;M=ObjectSubType}

States if parent node supports SNMP or is ICMP only

${N=SwisEntity;M=OperStatusLED}

Filename of current interface operational status icon

${N=SwisEntity;M=OutBandwidth}

Outgoing bandwidth of interface

${N=SwisEntity;M=Outbps}

Current outgoing traffic, in bps, from interface

${N=SwisEntity;M=OutDiscardsThisHour}

Number of outgoing packets discarded by interface in last hour

${N=SwisEntity;M=OutDiscardsToday}

Number of outgoing packets discarded by interface in current day

${N=SwisEntity;M=OutErrorsThisHour}

Number of interface transmit errors in last hour

${N=SwisEntity;M=OutErrorsToday}

Number of interface transmit errors in current day

${N=SwisEntity;M=OutErrorsToday"}

Current outgoing multicast traffic, in packets per second, from interface

${N=SwisEntity;M=OutPercentUtil}

Current percent utilization of interface transmit

${N=SwisEntity;M=OutPktSize}

Average size of outgoing packets from interface

${N=SwisEntity;M=OutPps}

Current outgoing traffic, from interface, in pps

${N=SwisEntity;M=OutUcastPps}

Current outgoing unicast traffic, in packets per second, from interface

${PhysicalAddress}

Physical address of interface

${N=SwisEntity;M=PollInterval}

Interval, in seconds, between polling attempts for interface

${N=SwisEntity;M=RediscoveryInterval}

Interval, in minutes, between rediscovery attempts for interface

${N=SwisEntity;M=Severity}

A network health score providing 1 point for an interface in a warning state, 1000 points for a down interface, and 1 million points for a down node

${N=SwisEntity;M=StatCollection}

Interface statistics collection frequency, in minutes

${N=SwisEntity;M=Status;F=Status" objectType="Interface}

Numeric interface status. For more information, see Status Icons and Identifiers.

${N=SwisEntity;M=StatusLED}

Filename of current interface status icon