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

Class lldp:AdjEp (CONCRETE)

Class ID:2728
Class Label: LLDP Adjacency Endpoint
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l1, access-protocol-l2, admin, fabric-protocol-l1, fabric-protocol-l2, tenant-ext-protocol-l2, tenant-protocol-l2]
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: true, HasHealth: true, HasEventRules: true ]

The LLDP neighbors, which contains the information regarding the neighbors.

Naming Rules 
RN FORMAT: adj-{id}

    [1] PREFIX=adj- PROPERTY = id




DN FORMAT: 

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

[1] sys/lldp/inst/if-{[id]}/adj-{id}


Diagram

Super Mo: nw:AdjEp,
Container Mos: lldp:If (deletable:no),
Contained Mos: dcbx:AdjCtx, lldp:AdjStats, lldptlv:Complex, lldptlv:Ip, lldptlv:Mac, lldptlv:Text, lldptlv:UByte, lldptlv:UInt16, lldptlv:UInt32, lldptlv:UInt64,


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] lldp:If The LLDP interface, which holds the operational states.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] lldp:AdjEp The LLDP neighbors, which contains the information regarding the neighbors.
[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.
 
 		 
 		 
 		 ├
 		[V] lldp:If The LLDP interface, which holds the operational states.
 
 		 
 		 
 		 
 		 ├
 		[V] lldp:AdjEp The LLDP neighbors, which contains the information regarding the neighbors.


Contained Hierarchy
[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] 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).


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:Ep A static endpoint.
 
 		 
 		 ├
 		[V] nw:ConnEp A connection endpoint abstraction.
 
 		 
 		 
 		 ├
 		[V] nw:AdjEp The adjacency endpoint. This is the endpoint object that contains information regarding dynamically learned endpoints.
 
 		 
 		 
 		 
 		 ├
 		[V] lldp:AdjEp The LLDP neighbors, which contains the information regarding the neighbors.


Events 
                lldp:AdjEp:lldp_AdjEp_newAdjEp

                lldp:AdjEp:lldp_AdjEp_deleteAdjEp

                lldp:AdjEp:lldp_AdjEp_hostAdjStPortvlanMismatch

                lldp:AdjEp:lldp_AdjEp_hostAdjStPortvlanMissing

                lldp:AdjEp:lldp_AdjEp_adjStPortvlanMismatch

                lldp:AdjEp:lldp_AdjEp_adjStPortvlanMissing


Faults 
                lldp:AdjEp:adjStMultipleNbrs


Fsms


Properties Summary
Defined in: lldp:AdjEp
lldp:Capability
          scalar:Bitmask64 		capability  (lldp:AdjEp:capability)
           LLDP device configured capabilities to receive and send information
lldp:ChassisIdT
          scalar:UByte 		chassisIdT  (lldp:AdjEp:chassisIdT)
           Neighbor chassis id type
lldp:ChassisIdV
          string:Basic 		chassisIdV  (lldp:AdjEp:chassisIdV)
           The LLDP neighbor chassis identifier.
lldp:Capability
          scalar:Bitmask64 		enCap  (lldp:AdjEp:enCap)
           The device enabled capabilities. 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.
lldp:AdjId
          scalar:Uint16 		id  (lldp:AdjEp:id)
           Neighbor ID
scalar:Uint32 mgmtId  (lldp:AdjEp:mgmtId)
          
lldp:MgmtIp
          address:Ip 		mgmtIp  (lldp:AdjEp:mgmtIp)
           The device management IP address.
lldp:MgmtPortMac
          address:MAC 		mgmtPortMac  (lldp:AdjEp:mgmtPortMac)
           The management port MAC address.
reference:BinRef monPolDn  (lldp:AdjEp:monPolDn)
           monitoring policy
naming:Descr
          string:Basic 		portDesc  (lldp:AdjEp:portDesc)
           The LLDP neighbor port description.
lldp:PortIdT
          scalar:UByte 		portIdT  (lldp:AdjEp:portIdT)
           Neighbor port type
lldp:PortIdV
          string:Basic 		portIdV  (lldp:AdjEp:portIdV)
           The LLDP neighbor port identifier.
lldp:PortVlan
          scalar:Uint16 		portVlan  (lldp:AdjEp:portVlan)
           The LLDP neighbor VLAN port identifier.
lldp:AdjStQual
          scalar:Bitmask64 		stQual  (lldp:AdjEp:stQual)
           Neighbor state qualifiers
lldp:NbrSysDesc
          string:Basic 		sysDesc  (lldp:AdjEp:sysDesc)
           Neighbor system description
lldp:SysName
          string:Basic 		sysName  (lldp:AdjEp:sysName)
           The LLDP neighbor system identifier.
lldp:TTL
          scalar:Uint16 		ttl  (lldp:AdjEp:ttl)
           Neighbor TTL
Defined in: nw:Ep
naming:Name
          string:Basic 		name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date 		modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

capability

Type: lldp:Capability
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
LLDP device configured capabilities to receive and send information
Constants
unknown 0ull Unknown unknown
station 128ull Station station
router 16ull Router router
other 1ull Other other
repeater 2ull Repeater repeater
telephone 32ull Telephone telephone
bridge 4ull Bridge bridge
docsis 64ull Docsis cable docsis cable
wlan 8ull Wireless LAN wlan
DEFAULT 0 --- Capability




chassisIdT

Type: lldp:ChassisIdT
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Neighbor chassis id type
Constants
reserved 0 Reserved unknown
chassis-comp 1 Chassis Component chassis component
if-alias 2 Interface alias if alias
port-comp 3 Port component port component
mac 4 Mac address mac address
nw-addr 5 Network address network address
if-name 6 Interface name interface name
local 7 Locally assigned locally assigned
DEFAULT 0 --- Chassis ID type




chassisIdV

Type: lldp:ChassisIdV
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The LLDP neighbor chassis identifier.


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




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.


enCap

Type: lldp:Capability
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The device enabled capabilities. 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.
Constants
unknown 0ull Unknown unknown
station 128ull Station station
router 16ull Router router
other 1ull Other other
repeater 2ull Repeater repeater
telephone 32ull Telephone telephone
bridge 4ull Bridge bridge
docsis 64ull Docsis cable docsis cable
wlan 8ull Wireless LAN wlan
DEFAULT 0 --- Capability




id

Type: lldp:AdjId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Neighbor ID


mgmtId

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:


mgmtIp

Type: lldp:MgmtIp
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The device management IP address.
Constants
unspecified base::Ip(0) Unspecified Unspecified
DEFAULT unspecified(base::Ip(0)) Unspecified Unspecified




mgmtPortMac

Type: lldp:MgmtPortMac
Primitive Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The management port MAC address.
Constants
unspecified 0ull Unspecified Unspecified
DEFAULT unspecified(0ull) Unspecified Unspecified




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: admin
Category: TopLevelRegular
    Comments:
The name of the object.


portDesc

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The LLDP neighbor port description.


portIdT

Type: lldp:PortIdT
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Neighbor port type
Constants
reserved 0 Unknown unknown
if-alias 1 Interface alias if alias
port-comp 2 Port component port component
mac 3 Mac address mac address
nw-addr 4 Network address network address
if-name 5 Interface name interface name
agent-ckt-id 6 Agent circuit id agent circuit id
local 7 Locally assigned locally assigned
DEFAULT 0 --- Port id type




portIdV

Type: lldp:PortIdV
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The LLDP neighbor port identifier.


portVlan

Type: lldp:PortVlan
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The LLDP neighbor VLAN port identifier.
Constants
unspecified 0 Unspecified Unspecified
DEFAULT unspecified(0) Unspecified Unspecified




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.


stQual

Type: lldp:AdjStQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Neighbor state qualifiers
Constants
portvlan-mismatch 1ull Port Vlan Mismatch with Neighbor Portvlan mismatch
DEFAULT 0 --- Adjacency state qualifier




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: lldp:NbrSysDesc
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Neighbor system description


sysName

Type: lldp:SysName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The LLDP neighbor system identifier.


ttl

Type: lldp:TTL
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Neighbor TTL




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