Class lldp:If (CONCRETE)

Class ID:2741
Class Label: LLDP Interface
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-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: false ]

The LLDP interface, which holds the operational states.

Naming Rules
RN FORMAT: if-{[id]}

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

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

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

                


Diagram

Super Mo: l2:ProtIf,
Container Mos: lldp:Inst (deletable:no),
Contained Mos: dcbx:IfCtx, lldp:AdjEp, lldp:CtrlrAdjEp, lldp:IfSendTask, lldp:IfStats, lldptlvpol:Complex, lldptlvpol:Ip, lldptlvpol:Mac, lldptlvpol:Text, lldptlvpol:UByte, lldptlvpol:UInt16, lldptlvpol:UInt32, lldptlvpol:UInt64,
Relations From: nw:PathEp,
Relations To: l1:EthIf, mgmt:MgmtIf,
Relations: l2:RsEthIf, l2:RsMgmtIf, nw:RtPathToIf,


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] 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.


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


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:If The interface information.
 
 
 
 
 ├
[V] nw:LogicalIf A logical interface abstraction.
 
 
 
 
 
 ├
[V] nw:ProtIf A protocol interface abstraction.
 
 
 
 
 
 
 ├
[V] l2:ProtIf A protocol interface abstraction.
 
 
 
 
 
 
 
 ├
[V] lldp:If The LLDP interface, which holds the operational states.


Events
                


Faults
                lldp:If:portOutofService


Fsms
                


Properties Summary
Defined in: lldp:If
lldp:AdminSt
          scalar:Enum8
adminRxSt  (lldp:If:adminRxSt)
           Receive admin state
lldp:AdminSt
          scalar:Enum8
adminTxSt  (lldp:If:adminTxSt)
           Transmit admin state
nw:IfId
          base:IfIndex
id  (lldp:If:id)
           Overrides:nw:If:id
           null
address:MAC mac  (lldp:If:mac)
           Port mac
reference:BinRef monPolDn  (lldp:If:monPolDn)
           monitoring policy
lldp:OperSt
          scalar:Enum8
operRxSt  (lldp:If:operRxSt)
           Operational state of receive enable
lldp:OperSt
          scalar:Enum8
operTxSt  (lldp:If:operTxSt)
           Operational state of transmit enable
naming:Descr
          string:Basic
portDesc  (lldp:If:portDesc)
           Port description
lldp:PortMode
          scalar:Uint16
portMode  (lldp:If:portMode)
           Port mode
lldp:PortVlan
          scalar:Uint16
portVlan  (lldp:If:portVlan)
           Port vlan
naming:Descr
          string:Basic
sysDesc  (lldp:If:sysDesc)
           System description
lldp:WiringIssues
          scalar:Bitmask32
wiringIssues  (lldp:If:wiringIssues)
          
Defined in: nw:ProtIf
nw:IfAdminSt
          scalar:Enum8
adminSt  (nw:ProtIf:adminSt)
           The administrative state of the object or policy.
Defined in: nw:If
naming:Descr
          string:Basic
descr  (nw:If:descr)
          
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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.
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.
Properties Detail

adminRxSt

Type: lldp:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Receive admin state
Constants
enabled 1 Enabled Administrative state is enabled
disabled 2 Disabled Administrative state is disabled
DEFAULT enabled(1) Enabled Administrative state is enabled





adminSt

Type: nw:IfAdminSt
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





adminTxSt

Type: lldp:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Transmit admin state
Constants
enabled 1 Enabled Administrative state is enabled
disabled 2 Disabled Administrative state is disabled
DEFAULT enabled(1) Enabled Administrative state is 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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:



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.



id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:If:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
null



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





mac

Type: address:MAC

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



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.



operRxSt

Type: lldp:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state of receive enable
Constants
disabled 1 Disabled Operational state is disabled
enabled 2 Enabled Operational state is enabled
DEFAULT disabled(1) Disabled Operational state is disabled





operTxSt

Type: lldp:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state of transmit enable
Constants
disabled 1 Disabled Operational state is disabled
enabled 2 Enabled Operational state is enabled
DEFAULT disabled(1) Disabled Operational state is disabled





portDesc

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Port description



portMode

Type: lldp:PortMode
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Port mode
Constants
normal 0 Normal Normal Port Mode
recovery 1 Recovery Recovery Port Mode
DEFAULT normal(0) Normal Normal Port Mode





portVlan

Type: lldp:PortVlan
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Port vlan
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.



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



wiringIssues

Type: lldp:WiringIssues
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
pod-id-mismatch 0x0100u POD ID mismatch NO COMMENTS
fabric-domain-mismatch 0x01u Fabric domain name mismatch NO COMMENTS
unapproved-serialnumber 0x0200u Wired to a node with unregistered serial number NO COMMENTS
ctrlr-uuid-mismatch 0x02u Controller UUID mismatch NO COMMENTS
fabric-id-mismatch 0x0400u Wired to a controller with a different Fabric Id NO COMMENTS
wiring-mismatch 0x04u Wired to an invalid neighbor NO COMMENTS
unknown-neighbor 0x08u Wired to an unknown neighbor NO COMMENTS
none 0x0u None NO COMMENTS
adjacency-not-detected 0x10u Adjacency is not detected yet NO COMMENTS
infra-vlan-mismatch 0x20u Infra vlan mismatch NO COMMENTS
infra-ip-mismatch 0x40u Infra subnet mismatch NO COMMENTS
unapproved-ctrlr 0x80u Unapproved controller in strict fabric mode NO COMMENTS
DEFAULT none(0x0u) None NO COMMENTS