FS-NMS-LLDP-MIB

        
    
Source file
FS-NMS-LLDP-MIB
Last revised
Identity
nmslldpMIB
Base OID
1.3.6.1.4.1.52642.127
Imported Objects
FS-NMS-SMI nms
IANA-ADDRESS-FAMILY-NUMBERS-MIB AddressFamilyNumbers
SNMP-FRAMEWORK-MIB SnmpAdminString
SNMPv2-CONF MODULE-COMPLIANCE (no object page) NOTIFICATION-GROUP (no object page) OBJECT-GROUP (no object page)
SNMPv2-SMI Counter32 Integer32 MODULE-IDENTITY (no object page) NOTIFICATION-TYPE (no object page) OBJECT-TYPE (no object page)
SNMPv2-TC TEXTUAL-CONVENTION (no object page) TimeStamp TruthValue
Net-SNMP examples using the fscom-nms MIB directory Show commands

These commands use the standard Observium installation path and load the selected MIB variant before the RFC and Net-SNMP directories.

Translate the module identity
/usr/bin/snmptranslate -Pud -Ir -On -m 'FS-NMS-LLDP-MIB' -M '/opt/observium/mibs/fscom-nms:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'FS-NMS-LLDP-MIB::nmslldpMIB'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'FS-NMS-LLDP-MIB' -M '/opt/observium/mibs/fscom-nms:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'FS-NMS-LLDP-MIB::nmslldpMIB'
How SNMP, Net-SNMP, MIB paths, and variants work
Objects (96)
.1.3.6.1.4.1.52642.127
.1.3.6.1.4.1.52642.127.0
.1.3.6.1.4.1.52642.127.0.0
.1.3.6.1.4.1.52642.127.1
.1.3.6.1.4.1.52642.127.1.1
secondsInteger32
.1.3.6.1.4.1.52642.127.1.1.1
Integer32
.1.3.6.1.4.1.52642.127.1.1.2
secondsInteger32
.1.3.6.1.4.1.52642.127.1.1.3
secondsInteger32
.1.3.6.1.4.1.52642.127.1.1.4
secondsInteger32
.1.3.6.1.4.1.52642.127.1.1.5
.1.3.6.1.4.1.52642.127.1.1.6
.1.3.6.1.4.1.52642.127.1.1.6.1
.1.3.6.1.4.1.52642.127.1.1.6.1.1
Enumeration
.1.3.6.1.4.1.52642.127.1.1.6.1.2
.1.3.6.1.4.1.52642.127.1.1.6.1.3
Bits
.1.3.6.1.4.1.52642.127.1.1.6.1.4
.1.3.6.1.4.1.52642.127.1.1.7
.1.3.6.1.4.1.52642.127.1.1.7.1
.1.3.6.1.4.1.52642.127.1.1.7.1.1
.1.3.6.1.4.1.52642.127.1.2
.1.3.6.1.4.1.52642.127.1.2.1
table entriesZeroBasedCounter32
.1.3.6.1.4.1.52642.127.1.2.2
table entriesZeroBasedCounter32
.1.3.6.1.4.1.52642.127.1.2.3
table entriesZeroBasedCounter32
.1.3.6.1.4.1.52642.127.1.2.4
.1.3.6.1.4.1.52642.127.1.2.5
.1.3.6.1.4.1.52642.127.1.2.6
.1.3.6.1.4.1.52642.127.1.2.6.1
.1.3.6.1.4.1.52642.127.1.2.6.1.1
.1.3.6.1.4.1.52642.127.1.2.6.1.2
.1.3.6.1.4.1.52642.127.1.2.7
.1.3.6.1.4.1.52642.127.1.2.7.1
.1.3.6.1.4.1.52642.127.1.2.7.1.1
.1.3.6.1.4.1.52642.127.1.2.7.1.2
.1.3.6.1.4.1.52642.127.1.2.7.1.3
.1.3.6.1.4.1.52642.127.1.2.7.1.4
.1.3.6.1.4.1.52642.127.1.2.7.1.5
.1.3.6.1.4.1.52642.127.1.2.7.1.6
.1.3.6.1.4.1.52642.127.1.2.7.1.7
.1.3.6.1.4.1.52642.127.1.3
.1.3.6.1.4.1.52642.127.1.3.1
.1.3.6.1.4.1.52642.127.1.3.2
.1.3.6.1.4.1.52642.127.1.3.3
.1.3.6.1.4.1.52642.127.1.3.4
.1.3.6.1.4.1.52642.127.1.3.5
.1.3.6.1.4.1.52642.127.1.3.6
.1.3.6.1.4.1.52642.127.1.3.7
.1.3.6.1.4.1.52642.127.1.3.7.1
.1.3.6.1.4.1.52642.127.1.3.7.1.1
.1.3.6.1.4.1.52642.127.1.3.7.1.2
.1.3.6.1.4.1.52642.127.1.3.7.1.3
.1.3.6.1.4.1.52642.127.1.3.7.1.4
.1.3.6.1.4.1.52642.127.1.3.8
.1.3.6.1.4.1.52642.127.1.3.8.1
.1.3.6.1.4.1.52642.127.1.3.8.1.1
.1.3.6.1.4.1.52642.127.1.3.8.1.2
.1.3.6.1.4.1.52642.127.1.3.8.1.3
.1.3.6.1.4.1.52642.127.1.3.8.1.4
.1.3.6.1.4.1.52642.127.1.3.8.1.5
ObjectIdentifier
.1.3.6.1.4.1.52642.127.1.3.8.1.6
.1.3.6.1.4.1.52642.127.1.4
.1.3.6.1.4.1.52642.127.1.4.1
.1.3.6.1.4.1.52642.127.1.4.1.1
.1.3.6.1.4.1.52642.127.1.4.1.1.1
.1.3.6.1.4.1.52642.127.1.4.1.1.10
.1.3.6.1.4.1.52642.127.1.4.1.1.11
.1.3.6.1.4.1.52642.127.1.4.1.1.12
.1.3.6.1.4.1.52642.127.1.4.1.1.2
Integer32
.1.3.6.1.4.1.52642.127.1.4.1.1.3
.1.3.6.1.4.1.52642.127.1.4.1.1.4
.1.3.6.1.4.1.52642.127.1.4.1.1.5
.1.3.6.1.4.1.52642.127.1.4.1.1.6
.1.3.6.1.4.1.52642.127.1.4.1.1.7
.1.3.6.1.4.1.52642.127.1.4.1.1.8
.1.3.6.1.4.1.52642.127.1.4.1.1.9
.1.3.6.1.4.1.52642.127.1.4.2
.1.3.6.1.4.1.52642.127.1.4.2.1
.1.3.6.1.4.1.52642.127.1.4.2.1.1
.1.3.6.1.4.1.52642.127.1.4.2.1.2
.1.3.6.1.4.1.52642.127.1.4.2.1.3
.1.3.6.1.4.1.52642.127.1.4.2.1.4
ObjectIdentifier
.1.3.6.1.4.1.52642.127.1.4.2.1.5
.1.3.6.1.4.1.52642.127.1.4.3
.1.3.6.1.4.1.52642.127.1.4.3.1
Integer32
.1.3.6.1.4.1.52642.127.1.4.3.1.1
OctetString
.1.3.6.1.4.1.52642.127.1.4.3.1.2
.1.3.6.1.4.1.52642.127.1.4.4
.1.3.6.1.4.1.52642.127.1.4.4.1
OctetString
.1.3.6.1.4.1.52642.127.1.4.4.1.1
Integer32
.1.3.6.1.4.1.52642.127.1.4.4.1.2
Integer32
.1.3.6.1.4.1.52642.127.1.4.4.1.3
OctetString
.1.3.6.1.4.1.52642.127.1.4.4.1.4
.1.3.6.1.4.1.52642.127.1.5
.1.3.6.1.4.1.52642.127.1.6
.1.3.6.1.4.1.52642.127.2
.1.3.6.1.4.1.52642.127.2.1
.1.3.6.1.4.1.52642.127.2.2
Dependencies (6) 6 direct Show tree and compile order Hide dependency details

Each imported module is resolved in the importing module's source directory first, then through the normal default-variant rules.

Dependency tree
Dependency-first compile order
  1. SNMPv2-SMIrfc
  2. FS-NMS-SMIfscom-nms
  3. SNMPv2-TCrfc
  4. IANA-ADDRESS-FAMILY-NUMBERS-MIBrfc
  5. SNMPv2-CONFrfc
  6. SNMP-FRAMEWORK-MIBrfc
  7. FS-NMS-LLDP-MIBfscom-nmsselected
Type Definitions (11)
OctetString range: 1..255
This TC describes the format of a chassis identifier string.
Objects of this type are always used with an associated
LldpChassisIdSubtype object, which identifies the format of
the particular LldpChassisId object instance.

If the associated LldpChassisIdSubtype object has a value of
'chassisComponent(1)', then the octet string identifies
a particular instance of the entPhysicalAlias object
(defined in IETF RFC 2737) for a chassis component (i.e.,
an entPhysicalClass value of 'chassis(3)').

If the associated LldpChassisIdSubtype object has a value
of 'interfaceAlias(2)', then the octet string identifies
a particular instance of the ifAlias object (defined in
IETF RFC 2863) for an interface on the containing chassis.
If the particular ifAlias object does not contain any values,
another chassis identifier type should be used.

If the associated LldpChassisIdSubtype object has a value
of 'portComponent(3)', then the octet string identifies a
particular instance of the entPhysicalAlias object (defined
in IETF RFC 2737) for a port or backplane component within
the containing chassis.

If the associated LldpChassisIdSubtype object has a value of
'macAddress(4)', then this string identifies a particular
unicast source address (encoded in network byte order and
IEEE 802.3 canonical bit order), of a port on the containing
chassis as defined in IEEE Std 802-2001.

If the associated LldpChassisIdSubtype object has a value of
'networkAddress(5)', then this string identifies a particular
network address, encoded in network byte order, associated
with one or more ports on the containing chassis. The first
octet contains the IANA Address Family Numbers enumeration
value for the specific address type, and octets 2 through
N contain the network address value in network byte order.

If the associated LldpChassisIdSubtype object has a value
of 'interfaceName(6)', then the octet string identifies
a particular instance of the ifName object (defined in
IETF RFC 2863) for an interface on the containing chassis.
If the particular ifName object does not contain any values,
another chassis identifier type should be used.

If the associated LldpChassisIdSubtype object has a value of
'local(7)', then this string identifies a locally assigned
Chassis ID.
Enumeration
chassisComponent(1)
interfaceAlias(2)
portComponent(3)
macAddress(4)
networkAddress(5)
interfaceName(6)
local(7)
This TC describes the source of a chassis identifier.

The enumeration 'chassisComponent(1)' represents a chassis
identifier based on the value of entPhysicalAlias object
(defined in IETF RFC 2737) for a chassis component (i.e.,
an entPhysicalClass value of 'chassis(3)').

The enumeration 'interfaceAlias(2)' represents a chassis
identifier based on the value of ifAlias object (defined in
IETF RFC 2863) for an interface on the containing chassis.

The enumeration 'portComponent(3)' represents a chassis
identifier based on the value of entPhysicalAlias object
(defined in IETF RFC 2737) for a port or backplane
component (i.e., entPhysicalClass value of 'port(10)' or
'backplane(4)'), within the containing chassis.

The enumeration 'macAddress(4)' represents a chassis
identifier based on the value of a unicast source address
(encoded in network byte order and IEEE 802.3 canonical bit
order), of a port on the containing chassis as defined in
IEEE Std 802-2001.

The enumeration 'networkAddress(5)' represents a chassis
identifier based on a network address, associated with
a particular chassis. The encoded address is actually
composed of two fields. The first field is a single octet,
representing the IANA AddressFamilyNumbers value for the
specific address type, and the second field is the network
address value.

The enumeration 'interfaceName(6)' represents a chassis
identifier based on the value of ifName object (defined in
IETF RFC 2863) for an interface on the containing chassis.

The enumeration 'local(7)' represents a chassis identifier
based on a locally defined value.
Enumeration
unknown(1)
ifIndex(2)
systemPortNumber(3)
This TC describes the basis of a particular type of
interface associated with the management address.

The enumeration 'unknown(1)' represents the case where the
interface is not known.

The enumeration 'ifIndex(2)' represents interface identifier
based on the ifIndex MIB object.

The enumeration 'systemPortNumber(3)' represents interface
identifier based on the system port numbering convention.
OctetString range: 1..31
The value of a management address associated with the LLDP
agent that may be used to reach higher layer entities to
assist discovery by network management.

It should be noted that appropriate security credentials,
such as SNMP engineId, may be required to access the LLDP
agent using a management address. These necessary credentials
should be known by the network management and the objects
associated with the credentials are not included in the
LLDP agent.
OctetString range: 1..255
This TC describes the format of a port identifier string.
Objects of this type are always used with an associated
LldpPortIdSubtype object, which identifies the format of the
particular LldpPortId object instance.

If the associated LldpPortIdSubtype object has a value of
'interfaceAlias(1)', then the octet string identifies a
particular instance of the ifAlias object (defined in IETF
RFC 2863). If the particular ifAlias object does not contain
any values, another port identifier type should be used.

If the associated LldpPortIdSubtype object has a value of
'portComponent(2)', then the octet string identifies a
particular instance of the entPhysicalAlias object (defined
in IETF RFC 2737) for a port or backplane component.

If the associated LldpPortIdSubtype object has a value of
'macAddress(3)', then this string identifies a particular
unicast source address (encoded in network byte order
and IEEE 802.3 canonical bit order) associated with the port
(IEEE Std 802-2001).

If the associated LldpPortIdSubtype object has a value of
'networkAddress(4)', then this string identifies a network
address associated with the port. The first octet contains
the IANA AddressFamilyNumbers enumeration value for the
specific address type, and octets 2 through N contain the
networkAddress address value in network byte order.

If the associated LldpPortIdSubtype object has a value of
'interfaceName(5)', then the octet string identifies a
particular instance of the ifName object (defined in IETF
RFC 2863). If the particular ifName object does not contain
any values, another port identifier type should be used.

If the associated LldpPortIdSubtype object has a value of
'agentCircuitId(6)', then this string identifies a agent-local
identifier of the circuit (defined in RFC 3046).

If the associated LldpPortIdSubtype object has a value of
'local(7)', then this string identifies a locally
assigned port ID.
Enumeration
interfaceAlias(1)
portComponent(2)
macAddress(3)
networkAddress(4)
interfaceName(5)
agentCircuitId(6)
local(7)
This TC describes the source of a particular type of port
identifier used in the LLDP MIB.

The enumeration 'interfaceAlias(1)' represents a port
identifier based on the ifAlias MIB object, defined in IETF
RFC 2863.

The enumeration 'portComponent(2)' represents a port
identifier based on the value of entPhysicalAlias (defined in
IETF RFC 2737) for a port component (i.e., entPhysicalClass
value of 'port(10)'), within the containing chassis.

The enumeration 'macAddress(3)' represents a port identifier
based on a unicast source address (encoded in network
byte order and IEEE 802.3 canonical bit order), which has
been detected by the agent and associated with a particular
port (IEEE Std 802-2001).

The enumeration 'networkAddress(4)' represents a port
identifier based on a network address, detected by the agent
and associated with a particular port.

The enumeration 'interfaceName(5)' represents a port
identifier based on the ifName MIB object, defined in IETF
RFC 2863.

The enumeration 'agentCircuitId(6)' represents a port
identifier based on the agent-local identifier of the circuit
(defined in RFC 3046), detected by the agent and associated
with a particular port.

The enumeration 'local(7)' represents a port identifier
based on a value locally assigned.
OctetString range: 0..512
Each octet within this value specifies a set of eight ports,
with the first octet specifying ports 1 through 8, the second
octet specifying ports 9 through 16, etc. Within each octet,
the most significant bit represents the lowest numbered port,
and the least significant bit represents the highest numbered
port. Thus, each port of the system is represented by a
single bit within the value of this object. If that bit has
a value of '1' then that port is included in the set of ports;
the port is not included if its bit has a value of '0'.
Integer32 range: 1..4096
Display format: d
Each port contained in the chassis (that is known to the
LLDP agent) is uniquely identified by a port number.

A port number has no mandatory relationship to an
InterfaceIndex object (of the interfaces MIB, IETF RFC 2863).
If the LLDP agent is a IEEE 802.1D, IEEE 802.1Q bridge, the
LldpPortNumber will have the same value as the dot1dBasePort
object (defined in IETF RFC 1493) associated corresponding
bridge port. If the system hosting LLDP agent is not an
IEEE 802.1D or an IEEE 802.1Q bridge, the LldpPortNumber
will have the same value as the corresponding interface's
InterfaceIndex object.

Port numbers should be in the range of 1 and 4096 since a
particular port is also represented by the corresponding
port number bit in LldpPortList.
Bits
other(0)
repeater(1)
bridge(2)
wlanAccessPoint(3)
router(4)
telephone(5)
docsisCableDevice(6)
stationOnly(7)
This TC describes the system capabilities.

The bit 'other(0)' indicates that the system has capabilities
other than those listed below.

The bit 'repeater(1)' indicates that the system has repeater
capability.

The bit 'bridge(2)' indicates that the system has bridge
capability.

The bit 'wlanAccessPoint(3)' indicates that the system has
WLAN access point capability.

The bit 'router(4)' indicates that the system has router
capability.

The bit 'telephone(5)' indicates that the system has telephone
capability.

The bit 'docsisCableDevice(6)' indicates that the system has
DOCSIS Cable Device capability (IETF RFC 2669 & 2670).

The bit 'stationOnly(7)' indicates that the system has only
station capability and nothing else.
Unsigned32
To be used for the index to a table. Allows an application
to download only those rows changed since a particular time.
A row is considered changed if the value of any object in the
row changes or if the row is created or deleted.

When sysUpTime is equal to zero, this table shall be empty.

One entry exists for each past value of sysUpTime, except that
the whole table is purged should sysUpTime wrap.

As this basic row is updated new conceptual rows are created
(which still share the now updated object values with all
other instances). The number of instances which are created
is determined by the value of sysUpTime at which the basic row
was last updated. One instance will exist for each value of
sysUpTime at the last update time for the row. A new
timeMark instance is created for each new sysUpTime value.
Each new conceptual row will be associated with the timeMark
instance which was created at the value of sysUpTime with
which the conceptual row is to be associated.

By definition all conceptual rows were updated at or after
time zero and so at least one conceptual row (associated with
timeMark.0) must exist for each underlying (basic) row.

See the appendix for further discussion of this variable.

Consider the following fooTable:

fooTable ...
INDEX { fooTimeMark, fooIndex }

FooEntry {
fooTimeMark TimeFilter
fooIndex INTEGER,
fooCounts Counter
}

Should there be two basic rows in this table (fooIndex == 1,
fooIndex == 2) and row 1 was updated most recently at time 6,
while row 2 was updated most recently at time 8, and both rows
had been updated on several earlier occasions such that the
current values were 5 and 9 respectively then the following
fooCounts instances would exist.

fooCounts.0.1 5
fooCounts.0.2 9
fooCounts.1.1 5

fooCounts.1.2 9
fooCounts.2.1 5
fooCounts.2.2 9
fooCounts.3.1 5
fooCounts.3.2 9
fooCounts.4.1 5
fooCounts.4.2 9
fooCounts.5.1 5
fooCounts.5.2 9
fooCounts.6.1 5
fooCounts.6.2 9
fooCounts.7.2 9 -- note that row 1 doesn't exist for
fooCounts.8.2 9 -- times 7 and 8
Unsigned32
This TC describes an object which counts events with the
following semantics: objects of this type will be set to
zero(0) on creation and will thereafter count appropriate
events, wrapping back to zero(0) when the value 2^32 is
reached.

Provided that an application discovers the new object within
the minimum time to wrap it can use the initial value as a
delta since it last polled the table of which this object is
part. It is important for a management station to be aware of
this minimum time and the actual time between polls, and to
discard data if the actual time is too long or there is no
defined minimum time.

Typically this TC is used in tables where the INDEX space is
constantly changing and/or the TimeFilter mechanism is in use.
Conformance Groups (8)
The collection of objects which are used to configure the
LLDP implementation behavior.

This group is mandatory for agents which implement the LLDP.
.1.3.6.1.4.1.52642.127.2.2.1
The collection of objects which are used to configure the
LLDP implementation behavior.

This group is mandatory for agents which implement the LLDP
and have the capability of receiving LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.2
The collection of objects which are used to configure the
LLDP implementation behavior.

This group is mandatory for agents which implement the LLDP
and have the capability of transmitting LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.3
The collection of objects which are used to represent LLDP
reception statistics.

This group is mandatory for agents which implement the LLDP
and have the capability of receiving LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.4
The collection of objects which are used to represent LLDP
transmission statistics.

This group is mandatory for agents which implement the LLDP
and have the capability of transmitting LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.5
The collection of objects which are used to represent LLDP
Local System Information.

This group is mandatory for agents which implement the LLDP
and have the capability of transmitting LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.6
The collection of objects which are used to represent
LLDP Remote Systems Information. The objects represent the
information associated with the basic TLV set. Please note
that even the agent doesn't implement some of the optional
TLVs, it shall recognize all the optional TLV information
that the remote system may advertise.

This group is mandatory for agents which implement the LLDP
and have the capability of receiving LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.7
The collection of notifications used to indicate LLDP MIB
data consistency and general status information.

This group is mandatory for agents which implement the LLDP
and have the capability of receiving LLDP frames.
.1.3.6.1.4.1.52642.127.2.2.8
Compliance Statements (1)

OID .1.3.6.1.4.1.52642.127.2.1.1
The compliance statement for SNMP entities which implement
the LLDP MIB.
Required groups
Notifications / Traps (1)
NameOIDDescription
.1.3.6.1.4.1.52642.127.0.0.1
A lldpRemTablesChange notification is sent when the value
of lldpStatsRemTableLastChangeTime changes. It can be
utilized by an NMS to trigger LLDP remote systems table
maintenance polls.

Note that transmission of lldpRemTablesChange
notifications are throttled by the agent, as specified by the
'lldpNotificationInterval' object.