Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class lldp:Inst (CONCRETE)

Class ID:2753
Class Label: LLDP Instance
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: true ]

Link Layer Discovery Protocol (LLDP) supports a set of attributes that it uses to discover neighbor devices. These attributes contain type, length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive and send information to their neighbors. Details such as configuration information, device capabilities, and device identity can be advertised using this protocol.

Naming Rules 
RN FORMAT: inst

    [1] PREFIX=inst


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/lldp/inst

[1] sys/lldp/inst


Diagram

Super Mo: l2:ProtInst,
Container Mos: lldp:Entity (deletable:no),
Contained Mos: lldp:If, lldp:InstIfSendTask, lldp:InstSendTask, lldp:InstStats, lldp:MgmtAddr, lldptlvpol:Complex, lldptlvpol:Ip, lldptlvpol:Mac, lldptlvpol:Text, lldptlvpol:UByte, lldptlvpol:UInt16, lldptlvpol:UInt32, lldptlvpol:UInt64,
Relations To: lldp:InstPol,
Relations: lldp:RsLldpInstPolCons,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		[V] fabric:Topology The root for IFC topology.
 
 		 ├
 		[V] fabric:Pod A pod.
 
 		 
 		 ├
 		[V] fabric:Node The root node for the APIC.
 
 		 
 		 
 		 ├
 		[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 		 
 		 
 		 
 		 ├
 		[V] lldp:Entity LLDP allows network devices to advertise information about themselves to other devices on the network. This protocol runs over the data-link layer, which allows two systems running different network layer protocols to learn about each other.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] lldp:Inst Link Layer Discovery Protocol (LLDP) supports a set of attributes that it uses to discover neighbor devices. These attributes contain type, length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive and send information to their neighbors. Details such as configuration information, device capabilities, and device identity can be advertised using this protocol.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 		 ├
 		[V] lldp:Entity LLDP allows network devices to advertise information about themselves to other devices on the network. This protocol runs over the data-link layer, which allows two systems running different network layer protocols to learn about each other.
 
 		 
 		 ├
 		[V] lldp:Inst Link Layer Discovery Protocol (LLDP) supports a set of attributes that it uses to discover neighbor devices. These attributes contain type, length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive and send information to their neighbors. Details such as configuration information, device capabilities, and device identity can be advertised using this protocol.


Contained Hierarchy
[V] lldp:Inst Link Layer Discovery Protocol (LLDP) supports a set of attributes that it uses to discover neighbor devices. These attributes contain type, length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive and send information to their neighbors. Details such as configuration information, device capabilities, and device identity can be advertised using this protocol.
 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] lldp:If The LLDP interface, which holds the operational states.
 
 		 ├
 		[V] dcbx:IfCtx  This object holds dcbx information that is operated at an interface level
 
 		 
 		 ├
 		[V] dcbx:IfStats  This object holds dcbx intf statistics operational information. This is a singleton within an interface
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 		 
 		 ├
 		[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 ├
 		[V] l2:RsEthIf A source relation to an L1 interface. This is an internal object.
 
 		 ├
 		[V] l2:RsMgmtIf  Association to the corresponding mgmt::MgmtIf
 
 		 ├
 		[V] lldp:AdjEp The LLDP neighbors, which contains the information regarding the neighbors.
 
 		 
 		 ├
 		[V] dcbx:AdjCtx  This object holds lldp neighbor dcbx information
 
 		 
 		 
 		 ├
 		[V] dcbx:Control  Represents DCBX Control TLV
 
 		 
 		 
 		 ├
 		[V] dcbx:Feature  Represents DCBX Feature TLV
 
 		 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 
 		 ├
 		[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 		 
 		 
 		 ├
 		[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 		 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 
 		 ├
 		[V] lldp:AdjStats The LLDP adjacency statistics operational information. This is a singleton within an adjacency.
 
 		 
 		 ├
 		[V] lldptlv:Complex A complex type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:Ip An IP type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:Mac A MAC type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:Text A text type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:UByte An 8-bit unsigned integer (UByte) type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:UInt16 A 16-bit unsigned integer (UInt16) type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:UInt32 A 32-bit unsigned integer (UInt32) type, length, value (TLV).
 
 		 
 		 
 		 ├
 		[V] lldptlv:UInt64 A 64-bit unsigned integer (UInt64) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:Ip An IP type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:Mac A MAC type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:Text A text type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:UByte An 8-bit unsigned integer (UByte) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:UInt16 A 16-bit unsigned integer (UInt16) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:UInt32 A 32-bit unsigned integer (UInt32) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlv:UInt64 A 64-bit unsigned integer (UInt64) type, length, value (TLV).
 
 		 ├
 		[V] lldp:CtrlrAdjEp The controller adjacency EP information, which is used by PE to cache. Controller adjEP information handles adjacency deletes.
 
 		 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 
 		 ├
 		[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 		 
 		 
 		 ├
 		[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 		 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 
 		 ├
 		[V] lldp:RsCtrlrAdjEpToStAdjEp A source relation to the ARP static adjacency endpoint.
 
 		 ├
 		[V] lldp:IfSendTask Information returned by or provided to the task.
 
 		 ├
 		[V] lldp:IfStats Holds LLDP INTF statistics operational information and is a singleton within an interface.
 
 		 ├
 		[V] lldptlvpol:Complex A complex type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:Ip An IP type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:Mac A MAC type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:Text A text type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:UByte An 8-bit unsigned integer (UByte) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:UInt16 A 16-bit unsigned integer (UInt16) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:UInt32 A 32-bit unsigned integer (UInt32) type, length, value (TLV).
 
 		 
 		 ├
 		[V] lldptlvpol:UInt64 A 64-bit unsigned integer (UInt64) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:Ip An IP type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:Mac A MAC type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:Text A text type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UByte An 8-bit unsigned integer (UByte) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UInt16 A 16-bit unsigned integer (UInt16) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UInt32 A 32-bit unsigned integer (UInt32) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UInt64 A 64-bit unsigned integer (UInt64) type, length, value (TLV).
 
 		 ├
 		[V] nw:RtPathToIf A target relation to the interface information.
 ├
 		[V] lldp:InstIfSendTask 
 ├
 		[V] lldp:InstSendTask Information returned by or provided to the instance.
 ├
 		[V] lldp:InstStats The LLDP instance statistics operational information. This is a singleton within LLDP.
 ├
 		[V] lldp:MgmtAddr Local management address.
 ├
 		[V] lldp:RsLldpInstPolCons A source relation to the node level LLDP policy.
 ├
 		[V] lldptlvpol:Complex A complex type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:Ip An IP type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:Mac A MAC type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:Text A text type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UByte An 8-bit unsigned integer (UByte) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UInt16 A 16-bit unsigned integer (UInt16) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UInt32 A 32-bit unsigned integer (UInt32) type, length, value (TLV).
 
 		 ├
 		[V] lldptlvpol:UInt64 A 64-bit unsigned integer (UInt64) type, length, value (TLV).
 ├
 		[V] lldptlvpol:Ip An IP type, length, value (TLV).
 ├
 		[V] lldptlvpol:Mac A MAC type, length, value (TLV).
 ├
 		[V] lldptlvpol:Text A text type, length, value (TLV).
 ├
 		[V] lldptlvpol:UByte An 8-bit unsigned integer (UByte) type, length, value (TLV).
 ├
 		[V] lldptlvpol:UInt16 A 16-bit unsigned integer (UInt16) type, length, value (TLV).
 ├
 		[V] lldptlvpol:UInt32 A 32-bit unsigned integer (UInt32) type, length, value (TLV).
 ├
 		[V] lldptlvpol:UInt64 A 64-bit unsigned integer (UInt64) type, length, value (TLV).


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:CpInst A control plane instance abstraction. This object represents an instance of the protocol. For example, the protocol instance of OSPF or ISIS.
 
 		 
 		 
 		 ├
 		[V] nw:ProtInst A protocol instance abstraction.
 
 		 
 		 
 		 
 		 ├
 		[V] l2:ProtInst A protocol instance abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] lldp:Inst Link Layer Discovery Protocol (LLDP) supports a set of attributes that it uses to discover neighbor devices. These attributes contain type, length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive and send information to their neighbors. Details such as configuration information, device capabilities, and device identity can be advertised using this protocol.


Events 
                lldp:Inst:lldp_Inst_operErr

                lldp:Inst:lldp_Inst_adminStChange


Faults


Fsms


Properties Summary
Defined in: lldp:Inst
lldp:HoldTime
          scalar:Uint16 		holdTime  (lldp:Inst:holdTime)
           The hold time (in seconds) that a receiving device should hold the information sent by your device before discarding it.
lldp:InfraVlan
          scalar:Uint16 		infraVlan  (lldp:Inst:infraVlan)
           ignore, not exposed
lldp:InitDelayTime
          scalar:Uint16 		initDelayTime  (lldp:Inst:initDelayTime)
           The delay time (in seconds) for LLDP to initialize on any interface.
reference:BinRef monPolDn  (lldp:Inst:monPolDn)
           monitoring policy
lldp:OptTlvSel
          scalar:Bitmask16 		optTlvSel  (lldp:Inst:optTlvSel)
           The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.
naming:Descr
          string:Basic 		sysDesc  (lldp:Inst:sysDesc)
           System description.
lldp:TxFreq
          scalar:Uint16 		txFreq  (lldp:Inst:txFreq)
           The transmission frequency of LLDP updates (in seconds).
Defined in: nw:CpInst
nw:AdminSt
          scalar:Enum8 		adminSt  (nw:CpInst:adminSt)
           The administrative state of the object or policy.
nw:InstCtrl
          scalar:Bitmask64 		ctrl  (nw:CpInst:ctrl)
           The control state.
naming:Name
          string:Basic 		name  (nw:CpInst:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64 		operErr  (nw:CpInst:operErr)
          
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8 		lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date 		modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled




childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to




ctrl

Type: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
stateful-ha 1ull stateful-ha Enable stateful HA
DEFAULT 0 --- Instance controls




dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.


holdTime

Type: lldp:HoldTime
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hold time (in seconds) that a receiving device should hold the information sent by your device before discarding it.
Constants
defaultValue 120 --- NO COMMENTS




infraVlan

Type: lldp:InfraVlan
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
ignore, not exposed
Constants
unspecified 0 Unspecified Unspecified
DEFAULT unspecified(0) Unspecified Unspecified




initDelayTime

Type: lldp:InitDelayTime
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The delay time (in seconds) for LLDP to initialize on any interface.
Constants
defaultValue 2 --- NO COMMENTS




lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS




modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS




monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
monitoring policy


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
The name of the object.


operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
feature-unsupported 64ull Feature Unsupported Feature Unsupported
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier




optTlvSel

Type: lldp:OptTlvSel
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.
Constants
unknown 0 Unknown unknown
port-desc 1 Port Description Port description
sys-name 2 System Name System name
sys-desc 4 System Description Sytem description
sys-cap 8 System Capabilities System capabilities
mgmt-addr 16 Management Address Management address
port-vlan 32 Port VLAN org tlv - Port vlan
dcbx 64 DCBX DCBX
defaultValue (1|2|4|8|16|32) --- NO COMMENTS




rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.





sysDesc

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
System description.


txFreq

Type: lldp:TxFreq
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The transmission frequency of LLDP updates (in seconds).
Constants
defaultValue 30 --- NO COMMENTS






Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail