Class udld:If (CONCRETE)

Class ID:9010
Class Label: UDLD Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l2, admin, 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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

This object holds udld information that is operated at a interface level

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

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

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

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

                


Diagram

Super Mo: l2:ProtIf,
Container Mos: udld:Inst (deletable:no),
Contained Mos: udld:AdjEp,
Relations From: nw:PathEp,
Relations To: l1:EthIf,
Relations: l2:RsEthIf, 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] udld:Entity  Holds udld control plane entity information
 
 
 
 
 
 ├
[V] udld:Inst  This objects hold per udld instance information. There is only one instance of udld running in the system today
 
 
 
 
 
 
 ├
[V] udld:If  This object holds udld information that is operated at a interface level
[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] udld:Entity  Holds udld control plane entity information
 
 
 ├
[V] udld:Inst  This objects hold per udld instance information. There is only one instance of udld running in the system today
 
 
 
 ├
[V] udld:If  This object holds udld information that is operated at a interface level


Contained Hierarchy
[V] udld:If  This object holds udld information that is operated at a interface level
 ├
[V] l2:RsEthIf A source relation to an L1 interface. This is an internal object.
 ├
[V] nw:RtPathToIf A target relation to the interface information.
 ├
[V] udld:AdjEp  This object holds udld neighbor 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] udld:If  This object holds udld information that is operated at a interface level


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: udld:If
nw:IfAdminSt
          scalar:Enum8
adminSt  (udld:If:adminSt)
           Overrides:nw:ProtIf:adminSt
           Administrative state
udld:BiDirOperSt
          scalar:Enum8
biDirOperSt  (udld:If:biDirOperSt)
           UDLD Bidirectional state
udld:IfControl
          scalar:Bitmask8
ctrl  (udld:If:ctrl)
           The control state.
nw:IfId
          base:IfIndex
id  (udld:If:id)
           Overrides:nw:If:id
          
udld:PktTime
          string:Basic
lastEchoRecv  (udld:If:lastEchoRecv)
           Last Echo Recv
udld:PktTime
          string:Basic
lastEchoSent  (udld:If:lastEchoSent)
           Last Echo Sent
udld:PktTime
          string:Basic
lastFlushRecv  (udld:If:lastFlushRecv)
           Last Flush Recv
udld:PktTime
          string:Basic
lastFlushSent  (udld:If:lastFlushSent)
           Last Flush Sent
udld:PktTime
          string:Basic
lastPktRecv  (udld:If:lastPktRecv)
           Last Pkt Recv
udld:PktTime
          string:Basic
lastPktSent  (udld:If:lastPktSent)
           Last Pkt Sent
udld:PktTime
          string:Basic
lastProbeRecv  (udld:If:lastProbeRecv)
           Last Probe Recv
udld:PktTime
          string:Basic
lastProbeSent  (udld:If:lastProbeSent)
           Last Probe Sent
udld:LinkOperSt
          scalar:Enum8
linkOperSt  (udld:If:linkOperSt)
           UDLD Link Oper state
udld:MsgIntvl
          scalar:Uint32
msgIntvl  (udld:If:msgIntvl)
           Msg Interval
udld:MsgIntvl
          scalar:Uint32
msgTimeoutIntvl  (udld:If:msgTimeoutIntvl)
           Timeout Interval
udld:DevName
          string:Basic
portId  (udld:If:portId)
           Device ID
udld:PortOperMode
          scalar:Enum8
portOperMode  (udld:If:portOperMode)
           UDLD Operational state
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: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: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:IfAdminSt
Primitive Type: scalar:Enum8

Overrides:nw:ProtIf:adminSt
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
Administrative state
Constants
disabled 0 Disabled Disabled
enabled 1 Enabled Enabled
DEFAULT disabled(0) Disabled Disabled





biDirOperSt

Type: udld:BiDirOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
UDLD Bidirectional state
Constants
unknown 0 Neighbor Status Unknown Unknown
uni-dir 1 Neighbor Status Unidirectional Unidirectional
bi-dir 2 Neighbor Status Bidirectional Bidirectional
tx-rx-loop 3 Neighbor in tx/rx loop TX RX Loop
mismatch 4 Mismatch with Neighbor State Reported Mismatch
echo-empty 5 Neighbor Echo Empty Echo Empty
DEFAULT unknown(0) Neighbor Status Unknown Unknown





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: udld:IfControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
disabled 0 Disabled Disabled
enabled 1 Enabled Enabled
DEFAULT disabled(0) Disabled Disabled





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:



lastEchoRecv

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Echo Recv



lastEchoSent

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Echo Sent



lastFlushRecv

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Flush Recv



lastFlushSent

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Flush Sent



lastPktRecv

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Pkt Recv



lastPktSent

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Pkt Sent



lastProbeRecv

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Probe Recv



lastProbeSent

Type: udld:PktTime
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Probe Sent



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





linkOperSt

Type: udld:LinkOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
UDLD Link Oper state
Constants
up 0 UDLD Link Up Link Up
down 1 UDLD Link Down Link Down
detect 2 UDLD Detection Detection
advertisement 3 UDLD Advertisement Advertisement
port-disabled 4 UDLD Disable Port Port Disable
disabled-linkup 5 UDLD Disabled Link Up Disabled Link Up
disabled-linkdown 6 UDLD Disabled Link Down Disabled Link Down
init 7 UDLD Init Init
ext-detect 8 UDLD Extended Detection Extended Detection
DEFAULT init(7) UDLD Init Init





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





msgIntvl

Type: udld:MsgIntvl
Primitive Type: scalar:Uint32

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



msgTimeoutIntvl

Type: udld:MsgIntvl
Primitive Type: scalar:Uint32

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



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.



portId

Type: udld:DevName
Primitive Type: string:Basic

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



portOperMode

Type: udld:PortOperMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
UDLD Operational state
Constants
enabled 1 UDLD Enabled on port Enabled
disabled 2 UDLD Disabled on port Disabled
enabled-aggresive 3 UDLD Aggresive Mode Enabled on Port Disabled
DEFAULT disabled(2) UDLD Disabled on port Disabled





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.