Documentation forOrion Platform

Interface variables for Network Atlas tooltips

Variable

Description

${AdminStatus}

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

${AdminStatusLED}

Filename of current interface administrative status icon.

${Caption}

User friendly description of interface combining name with other identifying information.

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

${InBandwidth}

Incoming bandwidth of interface.

${Inbps}

Current incoming traffic, in bps, to interface.

${InDiscardsThisHour}

Number of incoming packets discarded by interface in last hour.

${InDiscardsToday}

Number of incoming packets discarded by interface in current day.

${InErrorsThisHour}

Number of interface receive errors in last hour.

${InErrorsToday}

Number of interface receive errors in current day.

${InMcastPps}

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

${InPercentUtil}

Current percent utilization of interface receive.

${InPktSize}

Average size of incoming packets to interface.

${InPps}

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

${InterfaceIcon}

File name of the icon represent the interface type.

${InterfaceID}

Internal unique identifier of selected interface.

${InterfaceIndex}

Index of selected interface on parent node.

${InterfaceLastChange}

sysUpTime value when the interface entered current operational state.

${InterfaceMTU}

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

${InterfaceName}

User-friendly name.

${InterfaceSpeed}

Interface bandwidth.

${InterfaceType}

IANA type of selected interface.

${InterfaceTypeDescription}

User-friendly description of interface type.

${InterfaceTypeName}

User-friendly name of interface IANA type.

${InUcastPps}

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

${LastSync}

Time and date of last interface database and memory synchronization.

${MaxInBpsTime}

Time when ${MaxInBpsToday} was measured.

${MaxInBpsToday}

Maximum measured traffic, in bps, into interface.

${MaxOutBpsTime}

Time when ${MaxOutBpsToday} was measured.

${MaxOutBpsToday}

Maximum measured traffic, in bps, out from interface.

${NextPoll}

Day, date and time of next scheduled interface polling.

${NextRediscovery}

Next interface rediscovery time.

${NodeID}

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

${ObjectSubType}

States if parent node supports SNMP or is ICMP only.

${OperStatus}

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

${OperStatusLED}

File name of current interface operational status icon.

${OutBandwidth}

Outgoing bandwidth of interface.

${Outbps}

Current outgoing traffic, in bps, from interface.

${OutDiscardsThisHour}

Number of outgoing packets discarded by interface in last hour.

${OutDiscardsToday}

Number of outgoing packets discarded by interface in current day.

${OutErrorsThisHour}

Number of interface transmit errors in last hour.

${OutErrorsToday}

Number of interface transmit errors in current day.

${OutMcastPps}

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

${OutPercentUtil}

Current percent utilization of interface transmit.

${OutPktSize}

Average size of outgoing packets from interface.

${OutPps}

Current outgoing traffic, from interface, in pps.

${OutUcastPps}

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

${PhysicalAddress}

Physical address of interface.

${PollInterval}

Interval, in seconds, between polling attempts for interface.

${RediscoveryInterval}

Interval, in minutes, between rediscovery attempts for interface.

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

${StatCollection}

Interface statistics collection frequency, in minutes.

${Status}

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

${StatusLED}

Filename of current interface status icon.

${UnManaged}

States if interface is currently unmanaged.

${UnPluggable}

States if interface is designated as unpluggable.