ifAlias

OBS ✓
IF-MIB · .1.3.6.1.2.1.31.1.1.1.18
Commands MIB view Table view

Object

column r/w SNMPv2-TCDisplayString 
This object is an 'alias' name for the interface as
specified by a network manager, and provides a non-volatile
'handle' for the interface.
              
On the first instantiation of an interface, the value of
ifAlias associated with that interface is the zero-length
string.  As and when a value is written into an instance of
ifAlias through a network management set operation, then the
agent must retain the supplied value in the ifAlias instance
associated with the same interface for as long as that
interface remains instantiated, including across all re-
initializations/reboots of the network management system,
including those which result in a change of the interface's
ifIndex value.
              
An example of the value which a network manager might store
in this object for a WAN interface is the (Telco's) circuit
number/identifier of the interface.
              
Some agents may support write-access only for interfaces
having particular values of ifType.  An agent which supports
write access to this object is required to keep the value in
non-volatile storage, but it may limit the length of new
values depending on how much storage is already occupied by
the current values for other interfaces.
Observium directly uses this object
This object is referenced by an Observium discovery or polling workflow.
Used in: Ports
Explore Observium network monitoring

Context

MIB
IF-MIB
OID
.1.3.6.1.2.1.31.1.1.1.18
Type
column
Access
readwrite
Status
current
Parent
ifXEntry
Groups
1

Net-SNMP examples

How SNMP and these commands work

Walk the column to discover its indexed instances, or supply every index to read one instance.

Walk the column
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'IF-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'IF-MIB::ifAlias'
More examples
Read one indexed instance
/usr/bin/snmpget -v2c -c '<community>' -Pud -Ir -OQUv -m 'IF-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'IF-MIB::ifAlias.<index>'
Translate to a numeric OID
/usr/bin/snmptranslate -Pud -Ir -On -m 'IF-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'IF-MIB::ifAlias'

Syntax

SNMPv2-TCDisplayString
Source
SNMPv2-TCDisplayString
Base type
OctetString
Display format
255a
Type Description
Represents textual information taken from the NVT ASCII
          
character set, as defined in pages 4, 10-11 of RFC 854.
          
To summarize RFC 854, the NVT ASCII repertoire specifies:
          
  - the use of character codes 0-127 (decimal)
          
  - the graphics characters (32-126) are interpreted as
    US ASCII
          
  - NUL, LF, CR, BEL, BS, HT, VT and FF have the special
    meanings specified in RFC 854
          
  - the other 25 codes have no standard interpretation
          
  - the sequence 'CR LF' means newline
          
  - the sequence 'CR NUL' means carriage-return
          
  - an 'LF' not preceded by a 'CR' means moving to the
    same column on the next line.
          
  - the sequence 'CR x' for any x other than LF or NUL is
    illegal.  (Note that this also means that a string may
    end with either 'CR LF' or 'CR NUL', but not with CR.)
          
Any object defined using this syntax may not exceed 255
characters in length.

Values & Constraints

Object Constraints
range: 0-64
Type Constraints
range: 0..255

Conformance

Member of
ifGeneralInformationGroup
Compliance refinements
ifCompliance2 readonly
Write access is not required.
ifCompliance3 readonly
Write access is not required.