This module defines configuration and operational state data for the LLDP protocol.
openconfig-lldp-types
openconfig-interfaces
openconfig-yang-types
openconfig-inet-types
openconfig-extensions
openconfig-types
description:
Top-level container for LLDP configuration and state data
nodetype: container (rw)
description:
Configuration data
nodetype: container (rw)
description:
System level state of the LLDP protocol.
nodetype: leaf (rw)
type: boolean
default: true
description:
System level hello timer for the LLDP protocol.
nodetype: leaf (rw)
type: uint64
units: seconds
description:
Time-to-live value for LLDP PDUs transmitted by this system.
This value is carried in the TTL TLV and indicates the time
interval for which information contained in the LLDP PDU is
valid at the receiving system.
Note: The TTL value is independent from the hello-timer interval.
The hello-timer controls how frequently LLDP PDUs are transmitted,
while the TTL value indicates the validity duration of information
contained in those PDUs at the receiving system.
nodetype: leaf (rw)
type: uint16
units: seconds
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
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
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
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
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
description:
The interface in which to derive the population of Management
Address TLV parameters. If unspecified, the implementation may
choose which interface is utilized.
nodetype: leaf (rw)
type: oc-if:interface-id
description:
Operational state data
nodetype: container (ro)
description:
System level state of the LLDP protocol.
nodetype: leaf (ro)
type: boolean
default: true
description:
System level hello timer for the LLDP protocol.
nodetype: leaf (ro)
type: uint64
units: seconds
description:
Time-to-live value for LLDP PDUs transmitted by this system.
This value is carried in the TTL TLV and indicates the time
interval for which information contained in the LLDP PDU is
valid at the receiving system.
Note: The TTL value is independent from the hello-timer interval.
The hello-timer controls how frequently LLDP PDUs are transmitted,
while the TTL value indicates the validity duration of information
contained in those PDUs at the receiving system.
nodetype: leaf (ro)
type: uint16
units: seconds
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
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
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
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
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
description:
The interface in which to derive the population of Management
Address TLV parameters. If unspecified, the implementation may
choose which interface is utilized.
nodetype: leaf (ro)
type: oc-if:interface-id
description:
Global LLDP counters
nodetype: container (ro)
description:
The number of lldp frames received.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of frames transmitted out.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of LLDP frames received with errors.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of LLDP frames received and discarded.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of TLV frames received and discarded.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of frames received with unknown TLV.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Indicates the last time the counters were
cleared.
nodetype: leaf (ro)
type: oc-yang:date-and-time
description:
The number of valid TLVs received.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of entries aged out due to timeout.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Encapsulating container for management addresses
nodetype: container (ro)
description:
List of management addresses in use by the local/remote
system
nodetype: list (ro)
list keys: [address]
description:
Reference to the management address key
nodetype: leaf (list key) (ro)
type: leafref
description:
Operational state data for management addresses
nodetype: container (ro)
description:
Management address associated with the Management Address
TLV.
nodetype: leaf (ro)
type: union
type: oc-inet:ip-address
type: oc-yang:mac-address
description:
Interface number that identifies the specific interface
associated with this management address.
nodetype: leaf (ro)
type: uint32
description:
The Management address interface numbering subtype field
indicating the numbering method used for defining the
interface-number.
nodetype: leaf (ro)
type: oc-lldp-types:mgmt-interface-number-subtype
description:
Enclosing container
nodetype: container (rw)
description:
List of interfaces on which LLDP is enabled / available
nodetype: list (rw)
list keys: [name]
description:
Reference to the list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for LLDP on each interface
nodetype: container (rw)
description:
Reference to the LLDP Ethernet interface
nodetype: leaf (rw)
type: oc-if:base-interface-ref
description:
Enable or disable the LLDP protocol on the interface.
nodetype: leaf (rw)
type: boolean
default: true
description:
The binary string advertised in the 'Port Description' TLV
(Type 3) of LLDP.
When this leaf is populated, its value must be used as the
advertised port description, overriding any system-generated
strings or the generic interface description found in
/interfaces/interface/config/description.
If this leaf is not populated, the implementation
should default to advertising the value of
/interfaces/interface/state/description.
nodetype: leaf (rw)
type: string
description:
References to global custom TLV names to be advertised on this
interface. If a custom TLV name is present in this list, the
corresponding custom TLV will be advertised in LLDP PDUs transmitted
on this interface. If a custom TLV name is not present in this list,
it will not be advertised on this interface.
nodetype: leaf-list (rw)
type: leafref
description:
Operational state data
nodetype: container (ro)
description:
Reference to the LLDP Ethernet interface
nodetype: leaf (ro)
type: oc-if:base-interface-ref
description:
Enable or disable the LLDP protocol on the interface.
nodetype: leaf (ro)
type: boolean
default: true
description:
The binary string advertised in the 'Port Description' TLV
(Type 3) of LLDP.
When this leaf is populated, its value must be used as the
advertised port description, overriding any system-generated
strings or the generic interface description found in
/interfaces/interface/config/description.
If this leaf is not populated, the implementation
should default to advertising the value of
/interfaces/interface/state/description.
nodetype: leaf (ro)
type: string
description:
References to global custom TLV names to be advertised on this
interface. If a custom TLV name is present in this list, the
corresponding custom TLV will be advertised in LLDP PDUs transmitted
on this interface. If a custom TLV name is not present in this list,
it will not be advertised on this interface.
nodetype: leaf-list (ro)
type: leafref
description:
LLDP counters on each interface
nodetype: container (ro)
description:
The number of lldp frames received.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of frames transmitted out.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of LLDP frames received with errors.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of LLDP frames received and discarded.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of TLV frames received and discarded.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of frames received with unknown TLV.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Indicates the last time the counters were
cleared.
nodetype: leaf (ro)
type: oc-yang:date-and-time
description:
The number of frame transmit errors on the
interface.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Timestamp of the last LLDP packet transmitted on this interface.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Timestamp of the last valid LLDP packet received on this interface.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Enclosing container for list of LLDP neighbors on an
interface
nodetype: container (ro)
description:
List of LLDP neighbors
nodetype: list (ro)
list keys: [id]
description:
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data
nodetype: container (ro)
description:
Operational state data
nodetype: container (ro)
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
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
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
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
description:
The interface in which to derive the population of Management
Address TLV parameters. If unspecified, the implementation may
choose which interface is utilized.
nodetype: leaf (ro)
type: oc-if:interface-id
description:
System generated identifier for the neighbor on the
interface.
nodetype: leaf (ro)
type: string
description:
Age since discovery
nodetype: leaf (ro)
type: uint64
units: seconds
description:
Seconds since last update received.
nodetype: leaf (ro)
type: int64
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
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
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
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
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.
This leaf has been deprecated in favor of the management-address
list structure to accomodate multiple addresses and distinct
typing to pair up with the 802.1AB Management Address TLV
specification.
nodetype: leaf (ro)
type: string
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.
This leaf has been deprecated in favor of the management-address
list structure to accomodate multiple addresses and distinct
typing to pair up with the 802.1AB Management Address TLV
specification.
nodetype: leaf (ro)
type: string
description:
Encapsulating container for management addresses
nodetype: container (ro)
description:
List of management addresses in use by the local/remote
system
nodetype: list (ro)
list keys: [address]
description:
Reference to the management address key
nodetype: leaf (list key) (ro)
type: leafref
description:
Operational state data for management addresses
nodetype: container (ro)
description:
Management address associated with the Management Address
TLV.
nodetype: leaf (ro)
type: union
type: oc-inet:ip-address
type: oc-yang:mac-address
description:
Interface number that identifies the specific interface
associated with this management address.
nodetype: leaf (ro)
type: uint32
description:
The Management address interface numbering subtype field
indicating the numbering method used for defining the
interface-number.
nodetype: leaf (ro)
type: oc-lldp-types:mgmt-interface-number-subtype
description:
Enclosing container for list of custom TLVs from a
neighbor
nodetype: container (ro)
description:
List of custom LLDP TLVs from a neighbor
nodetype: list (ro)
list keys: [type] [oui] [oui-subtype]
description:
Reference to type list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Reference to oui list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Reference to oui-subtype list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data for custom LLDP TLVs
nodetype: container (ro)
description:
Operational state data
nodetype: container (ro)
description:
Administrative name of the custom TLV for human identification
and reference purposes, allowing operators to define a template
once at the global level and then reference it by name elsewhere
rather than by their numeric type, OUI, and subtype values.
nodetype: leaf (ro)
type: string
description:
The integer value identifying the type of information
contained in the value field.
nodetype: leaf (ro)
type: int32
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
description:
The organizationally defined subtype field shall contain a
unique subtype value assigned by the defining organization.
nodetype: leaf (ro)
type: string
description:
A variable-length octet-string containing the
instance-specific information for this TLV.
nodetype: leaf (ro)
type: binary
description:
Enclosing container for list of LLDP capabilities
nodetype: container (ro)
description:
List of LLDP system capabilities advertised by the
neighbor
nodetype: list (ro)
list keys: [name]
description:
Reference to capabilities list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data for LLDP capabilities
nodetype: container (ro)
description:
Operational state data for LLDP capabilities
nodetype: container (ro)
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
description:
Indicates whether the corresponding system capability is
enabled on the neighbor.
nodetype: leaf (ro)
type: boolean
description:
Enclosing container for list of global custom TLVs.
Implementation Note: Custom TLV OUI/subtype combinations
MUST NOT collide with standard LLDP TLVs. Configuration
of conflicting OUI/subtype values is not permitted.
nodetype: container (rw)
description:
List of global custom LLDP TLVs
nodetype: list (rw)
list keys: [name]
description:
Reference to the list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for global custom TLVs
nodetype: container (rw)
description:
Administrative name of the custom TLV for human identification
and reference purposes, allowing operators to define a template
once at the global level and then reference it by name elsewhere
rather than by their numeric type, OUI, and subtype values.
nodetype: leaf (rw)
type: string
description:
The integer value identifying the type of information
contained in the value field.
nodetype: leaf (rw)
type: int32
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 (rw)
type: string
description:
The organizationally defined subtype field shall contain a
unique subtype value assigned by the defining organization.
nodetype: leaf (rw)
type: string
description:
A variable-length octet-string containing the
instance-specific information for this TLV.
nodetype: leaf (rw)
type: binary
description:
Operational state data for global custom TLVs
nodetype: container (ro)
description:
Administrative name of the custom TLV for human identification
and reference purposes, allowing operators to define a template
once at the global level and then reference it by name elsewhere
rather than by their numeric type, OUI, and subtype values.
nodetype: leaf (ro)
type: string
description:
The integer value identifying the type of information
contained in the value field.
nodetype: leaf (ro)
type: int32
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
description:
The organizationally defined subtype field shall contain a
unique subtype value assigned by the defining organization.
nodetype: leaf (ro)
type: string
description:
A variable-length octet-string containing the
instance-specific information for this TLV.
nodetype: leaf (ro)
type: binary
This module defines types related to the LLDP protocol model.
openconfig-extensions
description:
Type definition with enumerations describing the source of
the chassis identifier
type: enumeration
description:
Type definition with enumerations describing the basis of
the port identifier
type: enumeration
description:
The Management address interface numbering subtype field
indicating the numbering method used for defining the interface
number.
type: enumeration
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.
description:
Other capability not specified; bit position 1
base identity: LLDP_SYSTEM_CAPABILITY
description:
Repeater capability; bit position 2
base identity: LLDP_SYSTEM_CAPABILITY
description:
MAC bridge capability; bit position 3
base identity: LLDP_SYSTEM_CAPABILITY
description:
WLAN access point capability; bit position 4
base identity: LLDP_SYSTEM_CAPABILITY
description:
Router; bit position 5
base identity: LLDP_SYSTEM_CAPABILITY
description:
Telephone capability; bit position 6
base identity: LLDP_SYSTEM_CAPABILITY
description:
DOCSIS cable device; bit position 7
base identity: LLDP_SYSTEM_CAPABILITY
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
description:
C-VLAN component of a VLAN Bridge; bit position 9
base identity: LLDP_SYSTEM_CAPABILITY
description:
S-VLAN component of a VLAN Bridge; bit position 10
base identity: LLDP_SYSTEM_CAPABILITY
description:
Two-port MAC Relay (TPMR) capability; bit position 11
base identity: LLDP_SYSTEM_CAPABILITY
description:
A base identity which describes the TLVs in LLDP
description:
The chassis identifier of the device associated with
the transmitting LLDP agent
base identity: LLDP_TLV
description:
The port identifier associated with the interface
on with the LLDP agent is transmitting
base identity: LLDP_TLV
description:
The description of the port that is associated with
the interface on which the LLDP agent is transmitting
base identity: LLDP_TLV
description:
The assigned name (sysName or hostname) of the device
which is transmitting the LLDP PDU
base identity: LLDP_TLV
description:
The description (sysDescr) of the device which is
transmitting the LLDP PDU
base identity: LLDP_TLV
description:
The primary functions of the device transmitting the
LLDP PDU and their administrative status
base identity: LLDP_TLV
description:
The address associated with the device transmitting the
LLDP PDU which can be used for higher-layer network
management
base identity: LLDP_TLV