openconfig-lldp

openconfig-version: 0.2.1

Description

This module defines configuration and operational state data for the LLDP protocol.

Imports

openconfig-lldp-types
openconfig-interfaces
ietf-yang-types
openconfig-extensions

Data elements

/
lldp

description:
Top-level container for LLDP configuration and state data

nodetype: container (rw)

/lldp/
config

description:
Configuration data

nodetype: container (rw)

/lldp/config/
enabled

description:
System level state of the LLDP protocol.

nodetype: leaf (rw)

type: boolean

default: true

/lldp/config/
hello-timer

description:
System level hello timer for the LLDP protocol.

nodetype: leaf (rw)

type: uint64

units: seconds

/lldp/config/
suppress-tlv-advertisement

description:
Indicates whether the local system should suppress the advertisement of particular TLVs with the LLDP PDUs that it transmits. Where a TLV type is specified within this list, it should not be included in any LLDP PDU transmitted by the local agent.

nodetype: leaf-list (rw)

type: identityref

  • base: oc-lldp-types:LLDP_TLV

/lldp/config/
system-name

description:
The system name field shall contain an alpha-numeric string that indicates the system's administratively assigned name. The system name should be the system's fully qualified domain name. If implementations support IETF RFC 3418, the sysName object should be used for this field.

nodetype: leaf (rw)

type: string

/lldp/config/
system-description

description:
The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system's hardware type, software operating system, and networking software. If implementations support IETF RFC 3418, the sysDescr object should be used for this field.

nodetype: leaf (rw)

type: string

/lldp/config/
chassis-id

description:
The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent

nodetype: leaf (rw)

type: string

/lldp/config/
chassis-id-type

description:
This field identifies the format and source of the chassis identifier string. It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.

nodetype: leaf (rw)

type: oc-lldp-types:chassis-id-type

/lldp/
state

description:
Operational state data

nodetype: container (ro)

/lldp/state/
enabled

description:
System level state of the LLDP protocol.

nodetype: leaf (ro)

type: boolean

default: true

/lldp/state/
hello-timer

description:
System level hello timer for the LLDP protocol.

nodetype: leaf (ro)

type: uint64

units: seconds

/lldp/state/
suppress-tlv-advertisement

description:
Indicates whether the local system should suppress the advertisement of particular TLVs with the LLDP PDUs that it transmits. Where a TLV type is specified within this list, it should not be included in any LLDP PDU transmitted by the local agent.

nodetype: leaf-list (ro)

type: identityref

  • base: oc-lldp-types:LLDP_TLV

/lldp/state/
system-name

description:
The system name field shall contain an alpha-numeric string that indicates the system's administratively assigned name. The system name should be the system's fully qualified domain name. If implementations support IETF RFC 3418, the sysName object should be used for this field.

nodetype: leaf (ro)

type: string

/lldp/state/
system-description

description:
The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system's hardware type, software operating system, and networking software. If implementations support IETF RFC 3418, the sysDescr object should be used for this field.

nodetype: leaf (ro)

type: string

/lldp/state/
chassis-id

description:
The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent

nodetype: leaf (ro)

type: string

/lldp/state/
chassis-id-type

description:
This field identifies the format and source of the chassis identifier string. It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.

nodetype: leaf (ro)

type: oc-lldp-types:chassis-id-type

/lldp/state/
counters

description:
Global LLDP counters

nodetype: container (ro)

/lldp/state/counters/
frame-in

description:
The number of lldp frames received.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
frame-out

description:
The number of frames transmitted out.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
frame-error-in

description:
The number of LLDP frames received with errors.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
frame-discard

description:
The number of LLDP frames received and discarded.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
tlv-discard

description:
The number of TLV frames received and discarded.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
tlv-unknown

description:
The number of frames received with unknown TLV.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
last-clear

description:
Indicates the last time the counters were cleared.

nodetype: leaf (ro)

type: yang:date-and-time

/lldp/state/counters/
tlv-accepted

description:
The number of valid TLVs received.

nodetype: leaf (ro)

type: yang:counter64

/lldp/state/counters/
entries-aged-out

description:
The number of entries aged out due to timeout.

nodetype: leaf (ro)

type: yang:counter64

/lldp/
interfaces

description:
Enclosing container

nodetype: container (rw)

/lldp/interfaces/
interface

description:
List of interfaces on which LLDP is enabled / available

nodetype: list (rw)

list keys: [name]

/lldp/interfaces/interface/
name

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/lldp/interfaces/interface/
config

description:
Configuration data for LLDP on each interface

nodetype: container (rw)

/lldp/interfaces/interface/config/
name

description:
Reference to the LLDP Ethernet interface

nodetype: leaf (rw)

type: oc-if:base-interface-ref

/lldp/interfaces/interface/config/
enabled

description:
Enable or disable the LLDP protocol on the interface.

nodetype: leaf (rw)

type: boolean

default: true

/lldp/interfaces/interface/
state

description:
Operational state data

nodetype: container (ro)

/lldp/interfaces/interface/state/
name

description:
Reference to the LLDP Ethernet interface

nodetype: leaf (ro)

type: oc-if:base-interface-ref

/lldp/interfaces/interface/state/
enabled

description:
Enable or disable the LLDP protocol on the interface.

nodetype: leaf (ro)

type: boolean

default: true

/lldp/interfaces/interface/state/
counters

description:
LLDP counters on each interface

nodetype: container (ro)

/lldp/interfaces/interface/state/counters/
frame-in

description:
The number of lldp frames received.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/state/counters/
frame-out

description:
The number of frames transmitted out.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/state/counters/
frame-error-in

description:
The number of LLDP frames received with errors.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/state/counters/
frame-discard

description:
The number of LLDP frames received and discarded.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/state/counters/
tlv-discard

description:
The number of TLV frames received and discarded.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/state/counters/
tlv-unknown

description:
The number of frames received with unknown TLV.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/state/counters/
last-clear

description:
Indicates the last time the counters were cleared.

nodetype: leaf (ro)

type: yang:date-and-time

/lldp/interfaces/interface/state/counters/
frame-error-out

description:
The number of frame transmit errors on the interface.

nodetype: leaf (ro)

type: yang:counter64

/lldp/interfaces/interface/
neighbors

description:
Enclosing container for list of LLDP neighbors on an interface

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/
neighbor

description:
List of LLDP neighbors

nodetype: list (ro)

list keys: [id]

/lldp/interfaces/interface/neighbors/neighbor/
id

description:

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/id

/lldp/interfaces/interface/neighbors/neighbor/
config

description:
Configuration data

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/
state

description:
Operational state data

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/state/
system-name

description:
The system name field shall contain an alpha-numeric string that indicates the system's administratively assigned name. The system name should be the system's fully qualified domain name. If implementations support IETF RFC 3418, the sysName object should be used for this field.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
system-description

description:
The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system's hardware type, software operating system, and networking software. If implementations support IETF RFC 3418, the sysDescr object should be used for this field.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
chassis-id

description:
The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
chassis-id-type

description:
This field identifies the format and source of the chassis identifier string. It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.

nodetype: leaf (ro)

type: oc-lldp-types:chassis-id-type

/lldp/interfaces/interface/neighbors/neighbor/state/
id

description:
System generated identifier for the neighbor on the interface.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
age

description:
Age since discovery

nodetype: leaf (ro)

type: uint64

units: seconds

/lldp/interfaces/interface/neighbors/neighbor/state/
last-update

description:
Seconds since last update received.

nodetype: leaf (ro)

type: int64

/lldp/interfaces/interface/neighbors/neighbor/state/
ttl

description:
The time-to-live (TTL) is a mandatory TLV which indicates how long information from the neighbor should be considered valid.

nodetype: leaf (ro)

type: uint16

units: seconds

/lldp/interfaces/interface/neighbors/neighbor/state/
port-id

description:
The Port ID is a mandatory TLV which identifies the port component of the endpoint identifier associated with the transmitting LLDP agent. If the specified port is an IEEE 802.3 Repeater port, then this TLV is optional.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
port-id-type

description:
This field identifies the format and source of the port identifier string. It is an enumerator defined by the PtopoPortIdType object from RFC2922.

nodetype: leaf (ro)

type: oc-lldp-types:port-id-type

/lldp/interfaces/interface/neighbors/neighbor/state/
port-description

description:
The binary string containing the actual port identifier for the port which this LLDP PDU was transmitted. The source and format of this field is defined by PtopoPortId from RFC2922.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
management-address

description:
The Management Address is a mandatory TLV which identifies a network address associated with the local LLDP agent, which can be used to reach the agent on the port identified in the Port ID TLV.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/state/
management-address-type

description:
The enumerated value for the network address type identified in this TLV. This enumeration is defined in the 'Assigned Numbers' RFC [RFC3232] and the ianaAddressFamilyNumbers object.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/
custom-tlvs

description:
Enclosing container for list of custom TLVs from a neighbor

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/
tlv

description:
List of custom LLDP TLVs from a neighbor

nodetype: list (ro)

list keys: [type] [oui] [oui-subtype]

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/
type

description:
Reference to type list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/type

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/
oui

description:
Reference to oui list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/oui

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/
oui-subtype

description:
Reference to oui-subtype list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/oui-subtype

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/
config

description:
Configuration data

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/
state

description:
Operational state data

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/state/
type

description:
The integer value identifying the type of information contained in the value field.

nodetype: leaf (ro)

type: int32

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/state/
oui

description:
The organizationally unique identifier field shall contain the organization's OUI as defined in Clause 9 of IEEE Std 802. The high-order octet is 0 and the low-order 3 octets are the SMI Network Management Private Enterprise Code of the Vendor in network byte order, as defined in the 'Assigned Numbers' RFC [RFC3232].

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/state/
oui-subtype

description:
The organizationally defined subtype field shall contain a unique subtype value assigned by the defining organization.

nodetype: leaf (ro)

type: string

/lldp/interfaces/interface/neighbors/neighbor/custom-tlvs/tlv/state/
value

description:
A variable-length octet-string containing the instance-specific information for this TLV.

nodetype: leaf (ro)

type: binary

/lldp/interfaces/interface/neighbors/neighbor/
capabilities

description:
Enclosing container for list of LLDP capabilities

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/capabilities/
capability

description:
List of LLDP system capabilities advertised by the neighbor

nodetype: list (ro)

list keys: [name]

/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/
name

description:
Reference to capabilities list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/name

/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/
config

description:
Configuration data for LLDP capabilities

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/
state

description:
Operational state data for LLDP capabilities

nodetype: container (ro)

/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/state/
name

description:
Name of the system capability advertised by the neighbor. Capabilities are represented in a bitmap that defines the primary functions of the system. The capabilities are defined in IEEE 802.1AB.

nodetype: leaf (ro)

type: identityref

  • base: oc-lldp-types:LLDP_SYSTEM_CAPABILITY

/lldp/interfaces/interface/neighbors/neighbor/capabilities/capability/state/
enabled

description:
Indicates whether the corresponding system capability is enabled on the neighbor.

nodetype: leaf (ro)

type: boolean

openconfig-lldp-types

openconfig-version: 0.1.1

Description

This module defines types related to the LLDP protocol model.

Imports

openconfig-extensions

Defined types

chassis-id-type

description:
Type definition with enumerations describing the source of the chassis identifier

type: enumeration

  • CHASSIS_COMPONENT
    Chassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737
  • INTERFACE_ALIAS
    Chassis identifier based on the value of ifAlias object defined in IETF RFC 2863
  • PORT_COMPONENT
    Chassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737 for a port or backplane component
  • MAC_ADDRESS
    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
  • NETWORK_ADDRESS
    Chassis identifier based on a network address, associated with a particular chassis. The encoded address is 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
  • INTERFACE_NAME
    Chassis identifier based on the name of the interface, e.g., the value of ifName object defined in IETF RFC 2863
  • LOCAL
    Chassis identifier based on a locally defined value

port-id-type

description:
Type definition with enumerations describing the basis of the port identifier

type: enumeration

  • INTERFACE_ALIAS
    Chassis identifier based on the value of ifAlias object defined in IETF RFC 2863
  • PORT_COMPONENT
    Port identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737 for a port component
  • MAC_ADDRESS
    Port identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order) associated with a port
  • NETWORK_ADDRESS
    Port identifier based on a network address, associated with a particular port
  • INTERFACE_NAME
    Port identifier based on the name of the interface, e.g., the value of ifName object defined in IETF RFC 2863
  • AGENT_CIRCUIT_ID
    Port identifer based on the circuit id in the DHCP relay agent information option as defined in IETF RFC 3046
  • LOCAL
    Port identifier based on a locally defined alphanumeric string

Identities

base: LLDP_SYSTEM_CAPABILITY

description:
Base identity for standard LLDP system capabilities. The system capabilities field contains a bit-map of the capabilities that define the primary function(s) of the system. A system may advertise more than one capability.

OTHER

description:
Other capability not specified; bit position 1

base identity: LLDP_SYSTEM_CAPABILITY

REPEATER

description:
Repeater capability; bit position 2

base identity: LLDP_SYSTEM_CAPABILITY

MAC_BRIDGE

description:
MAC bridge capability; bit position 3

base identity: LLDP_SYSTEM_CAPABILITY

WLAN_ACCESS_POINT

description:
WLAN access point capability; bit position 4

base identity: LLDP_SYSTEM_CAPABILITY

ROUTER

description:
Router; bit position 5

base identity: LLDP_SYSTEM_CAPABILITY

TELEPHONE

description:
Telephone capability; bit position 6

base identity: LLDP_SYSTEM_CAPABILITY

DOCSIS_CABLE_DEVICE

description:
DOCSIS cable device; bit position 7

base identity: LLDP_SYSTEM_CAPABILITY

STATION_ONLY

description:
Station only capability, for devices that implement only an end station capability, and for which none of the other capabilities apply; bit position 8

base identity: LLDP_SYSTEM_CAPABILITY

C_VLAN

description:
C-VLAN component of a VLAN Bridge; bit position 9

base identity: LLDP_SYSTEM_CAPABILITY

S_VLAN

description:
S-VLAN component of a VLAN Bridge; bit position 10

base identity: LLDP_SYSTEM_CAPABILITY

TWO_PORT_MAC_RELAY

description:
Two-port MAC Relay (TPMR) capability; bit position 11

base identity: LLDP_SYSTEM_CAPABILITY

base: LLDP_TLV

description:
A base identity which describes the TLVs in LLDP

CHASSIS_ID

description:
The chassis identifier of the device associated with the transmitting LLDP agent

base identity: LLDP_TLV

PORT_ID

description:
The port identifier associated with the interface on with the LLDP agent is transmitting

base identity: LLDP_TLV

PORT_DESCRIPTION

description:
The description of the port that is associated with the interface on which the LLDP agent is transmitting

base identity: LLDP_TLV

SYSTEM_NAME

description:
The assigned name (sysName or hostname) of the device which is transmitting the LLDP PDU

base identity: LLDP_TLV

SYSTEM_DESCRIPTION

description:
The description (sysDescr) of the device which is transmitting the LLDP PDU

base identity: LLDP_TLV

SYSTEM_CAPABILITIES

description:
The primary functions of the device transmitting the LLDP PDU and their administrative status

base identity: LLDP_TLV

MANAGEMENT_ADDRESS

description:
The address associated with the device transmitting the LLDP PDU which can be used for higher-layer network management

base identity: LLDP_TLV

Data elements