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

Class bfd:Sess (CONCRETE)

Class ID:5767
Class Label: BFD Session
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (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 ]

This object holds bfd session information

Naming Rules 
RN FORMAT: session-{discr}

    [1] PREFIX=session- PROPERTY = discr




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/bfd/inst/session-{discr}

[1] sys/bfd/inst/session-{discr}


Diagram

Container Mos: bfd:Inst (deletable:yes),
Contained Mos: bfd:PeerV, bfd:SessApp, bfd:SessStats,
Relations: bfd:RsMbrSess, bfd:RtMbrSess,


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] bfd:Entity  Holds bfd control plane entity information
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bfd:Inst  This objects hold per bfd instance information.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bfd:Sess  This object holds bfd session information
[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] bfd:Entity  Holds bfd control plane entity information
 
 		 
 		 ├
 		[V] bfd:Inst  This objects hold per bfd instance information.
 
 		 
 		 
 		 ├
 		[V] bfd:Sess  This object holds bfd session information


Contained Hierarchy
[V] bfd:Sess  This object holds bfd session information
 ├
 		[V] bfd:PeerV  This object holds bfd last packet information. This signifies peer view of the session.
 ├
 		[V] bfd:RsMbrSess  Relation to port-channel member sessions
 ├
 		[V] bfd:RtMbrSess  Relation to port-channel member sessions
 ├
 		[V] bfd:SessApp  This object holds app information per bfd session
 ├
 		[V] bfd:SessStats  This object holds bfd session stats information
 ├
 		[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)


Inheritance
[V] bfd:Sess  This object holds bfd session information


Events 
                bfd:Sess:bfd_Sess_newSess

                bfd:Sess:bfd_Sess_deleteSess

                bfd:Sess:bfd_Sess_sessUp

                bfd:Sess:bfd_Sess_sessActiveParamChange

                bfd:Sess:bfd_Sess_sessLocalParamChange


Faults 
                bfd:Sess:sessDown


Fsms


Properties Summary
Defined in: bfd:Sess
l4:Port
          scalar:Uint16 		asyncPort  (bfd:Sess:asyncPort)
           Async mode source port
bfd:AuthSeqno
          scalar:Uint32 		authSeqno  (bfd:Sess:authSeqno)
           Authentication sequence number
bfd:AuthT
          scalar:Enum8 		authType  (bfd:Sess:authType)
           Active value of auth type
address:Ip destAddr  (bfd:Sess:destAddr)
           Destination ip
bfd:DetectMult
          scalar:UByte 		detectMult  (bfd:Sess:detectMult)
           Active value of detection multiplier
bfd:DiagCode
          scalar:Enum16 		diag  (bfd:Sess:diag)
           Protocol diag code
bfd:Discr
          scalar:Uint32 		discr  (bfd:Sess:discr)
           Local session identifier
l4:Port
          scalar:Uint16 		echoPort  (bfd:Sess:echoPort)
           Echo mode source port
bfd:MinTxIntvl
          scalar:Uint16 		echoTxIntvl  (bfd:Sess:echoTxIntvl)
           Active value of echo tx interval
bfd:PktFlags
          scalar:Bitmask8 		flags  (bfd:Sess:flags)
           Packet flags
nw:IfId
          base:IfIndex 		ifId  (bfd:Sess:ifId)
           Interface id
nw:Iod
          scalar:Uint32 		iod  (bfd:Sess:iod)
           Interface ordinal
bfd:DiagCode
          scalar:Enum16 		lastDiag  (bfd:Sess:lastDiag)
           Last diag code
scalar:Date lastDownTime  (bfd:Sess:lastDownTime)
           Last down time
scalar:Date lastTransTime  (bfd:Sess:lastTransTime)
           Last time when protocol state changed
bfd:DetectMult
          scalar:UByte 		localDetectMult  (bfd:Sess:localDetectMult)
           Local value of detection multiplier
address:MAC localMac  (bfd:Sess:localMac)
           Local mac address
bfd:MinRxIntvl
          scalar:Uint16 		localRxIntvl  (bfd:Sess:localRxIntvl)
           Local value of rx interval
bfd:MinTxIntvl
          scalar:Uint16 		localTxIntvl  (bfd:Sess:localTxIntvl)
           Local value of tx interval
reference:BinRef monPolDn  (bfd:Sess:monPolDn)
           Monitoring policy attached to this observable object
bfd:OperSt
          scalar:Enum8 		operSt  (bfd:Sess:operSt)
           Oper (protocol) state
bfd:Discr
          scalar:Uint32 		remoteDiscr  (bfd:Sess:remoteDiscr)
           Remote session identifier
address:MAC remoteMac  (bfd:Sess:remoteMac)
           Remote mac address
bfd:OperSt
          scalar:Enum8 		remoteOperSt  (bfd:Sess:remoteOperSt)
           Remote oper state
bfd:MinRxIntvl
          scalar:Uint16 		rxIntvl  (bfd:Sess:rxIntvl)
           Active value of rx interval
bfd:SlowIntvl
          scalar:Uint16 		slowIntvl  (bfd:Sess:slowIntvl)
           Active value of slow interval
address:Ip srcAddr  (bfd:Sess:srcAddr)
           Source ip
bfd:MinTxIntvl
          scalar:Uint16 		txIntvl  (bfd:Sess:txIntvl)
           Active value of tx interval
l3:VrfName
          string:Basic 		vrfName  (bfd:Sess:vrfName)
           L3 context name
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

asyncPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Async mode source port
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 ftp-data NO COMMENTS
smtp 25 smtp NO COMMENTS
dns 53 dns NO COMMENTS
http 80 http NO COMMENTS
pop3 110 pop3 NO COMMENTS
https 443 https NO COMMENTS
rtsp 554 rtsp NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS




authSeqno

Type: bfd:AuthSeqno
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Authentication sequence number


authType

Type: bfd:AuthT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active value of auth type
Constants
none 0 No authentication None
sha1 4 Keyed SHA1 Keyed SHA1
DEFAULT none(0) No authentication None




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




destAddr

Type: address:Ip

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


detectMult

Type: bfd:DetectMult
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active value of detection multiplier
Constants
defaultValue 3 --- NO COMMENTS




diag

Type: bfd:DiagCode
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Protocol diag code
Constants
none 0 No Diagnostic NO COMMENTS
detect-timeout 1 Control Detection Time Expired NO COMMENTS
echo-fail 2 Echo Function Failed NO COMMENTS
nbr-signal-down 3 Neighbor Signaled Session Down NO COMMENTS
fwd-plane-reset 4 Forwarding Plane Reset NO COMMENTS
path-down 5 Path Down NO COMMENTS
concat-path-down 6 Concatenated Path Down NO COMMENTS
admin-down 7 Administratively Down NO COMMENTS
rev-concat-path-down 8 Reverse Concatenated Path Down NO COMMENTS
DEFAULT 0 --- Diag Code




discr

Type: bfd:Discr
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Local session identifier


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.


echoPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Echo mode source port
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 ftp-data NO COMMENTS
smtp 25 smtp NO COMMENTS
dns 53 dns NO COMMENTS
http 80 http NO COMMENTS
pop3 110 pop3 NO COMMENTS
https 443 https NO COMMENTS
rtsp 554 rtsp NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS




echoTxIntvl

Type: bfd:MinTxIntvl
Primitive Type: scalar:Uint16

Units: msec
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active value of echo tx interval
Constants
defaultValue 50 --- NO COMMENTS




flags

Type: bfd:PktFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Packet flags
Constants
demand 1 Demand NO COMMENTS
poll 2 Poll NO COMMENTS
final 4 Final NO COMMENTS
authentication 8 Authentication NO COMMENTS
DEFAULT 0 --- Packet flags




ifId

Type: nw:IfId
Primitive Type: base:IfIndex

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


iod

Type: nw:Iod
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Interface ordinal
Constants
defaultValue 1u --- NO COMMENTS




lastDiag

Type: bfd:DiagCode
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last diag code
Constants
none 0 No Diagnostic NO COMMENTS
detect-timeout 1 Control Detection Time Expired NO COMMENTS
echo-fail 2 Echo Function Failed NO COMMENTS
nbr-signal-down 3 Neighbor Signaled Session Down NO COMMENTS
fwd-plane-reset 4 Forwarding Plane Reset NO COMMENTS
path-down 5 Path Down NO COMMENTS
concat-path-down 6 Concatenated Path Down NO COMMENTS
admin-down 7 Administratively Down NO COMMENTS
rev-concat-path-down 8 Reverse Concatenated Path Down NO COMMENTS
DEFAULT 0 --- Diag Code




lastDownTime

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last down time


lastTransTime

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last time when protocol state changed


localDetectMult

Type: bfd:DetectMult
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Local value of detection multiplier
Constants
defaultValue 3 --- NO COMMENTS




localMac

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Local mac address


localRxIntvl

Type: bfd:MinRxIntvl
Primitive Type: scalar:Uint16

Units: msec
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Local value of rx interval
Constants
defaultValue 50 --- NO COMMENTS




localTxIntvl

Type: bfd:MinTxIntvl
Primitive Type: scalar:Uint16

Units: msec
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Local value of tx interval
Constants
defaultValue 50 --- 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 attached to this observable object


operSt

Type: bfd:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Oper (protocol) state
Constants
admin-down 0 AdminDown NO COMMENTS
down 1 Down NO COMMENTS
init 2 Init NO COMMENTS
up 3 Up NO COMMENTS
DEFAULT 0 --- Oper State




remoteDiscr

Type: bfd:Discr
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Remote session identifier


remoteMac

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Remote mac address


remoteOperSt

Type: bfd:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Remote oper state
Constants
admin-down 0 AdminDown NO COMMENTS
down 1 Down NO COMMENTS
init 2 Init NO COMMENTS
up 3 Up NO COMMENTS
DEFAULT 0 --- Oper State




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.


rxIntvl

Type: bfd:MinRxIntvl
Primitive Type: scalar:Uint16

Units: msec
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active value of rx interval
Constants
defaultValue 50 --- NO COMMENTS




slowIntvl

Type: bfd:SlowIntvl
Primitive Type: scalar:Uint16

Units: msec
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active value of slow interval
Constants
defaultValue 2000 --- NO COMMENTS




srcAddr

Type: address:Ip

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


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.





txIntvl

Type: bfd:MinTxIntvl
Primitive Type: scalar:Uint16

Units: msec
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Active value of tx interval
Constants
defaultValue 50 --- NO COMMENTS




vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
L3 context name




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