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

Class vpc:Keepalive (CONCRETE)

Class ID:3436
Class Label: VPC Keepalive Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l2, admin]
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 ]

The vPC keepalive definitions.

Naming Rules 
RN FORMAT: keepalive

    [1] PREFIX=keepalive


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/vpc/inst/dom-{id}/keepalive

[1] sys/vpc/inst/dom-{id}/keepalive


Diagram

Super Mo: naming:NamedObject,
Container Mos: vpc:Dom (deletable:yes),


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] vpc:Entity The vPC control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vpc:Inst The vPC instance information. There is only one instance of vpc running in the system today.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vpc:Dom The vPC domain information. There is only one configurable vPC domain that is in the system.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vpc:Keepalive The vPC keepalive definitions.
[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] vpc:Entity The vPC control plane entity information.
 
 		 
 		 ├
 		[V] vpc:Inst The vPC instance information. There is only one instance of vpc running in the system today.
 
 		 
 		 
 		 ├
 		[V] vpc:Dom The vPC domain information. There is only one configurable vPC domain that is in the system.
 
 		 
 		 
 		 
 		 ├
 		[V] vpc:Keepalive The vPC keepalive definitions.


Contained Hierarchy
[V] vpc:Keepalive The vPC keepalive definitions.
 ├
 		[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] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] vpc:Keepalive The vPC keepalive definitions.


Events 
                vpc:Keepalive:vpc_Keepalive_keepaliveChange

                vpc:Keepalive:vpc_Keepalive_keepaliveSendSuccess

                vpc:Keepalive:vpc_Keepalive_keepaliveRecvSuccess


Faults 
                vpc:Keepalive:keepaliveRecvFail

                vpc:Keepalive:keepaliveSendFail

                vpc:Keepalive:vpcCfgCtrl


Fsms


Properties Summary
Defined in: vpc:Keepalive
scalar:Uint32 avgRecvInterval  (vpc:Keepalive:avgRecvInterval)
           average receive interval
address:Ip destIp  (vpc:Keepalive:destIp)
           destination address
vpc:Time
          scalar:Time 		firstRecvTime  (vpc:Keepalive:firstRecvTime)
           first recv time
vpc:FlushTout
          scalar:Uint32 		flushTout  (vpc:Keepalive:flushTout)
           flush timeout
vpc:KeepaliveInterval
          scalar:Uint32 		interval  (vpc:Keepalive:interval)
           interval
reference:BinRef monPolDn  (vpc:Keepalive:monPolDn)
           The monitoring policy attached to this observable object.
vpc:KeepaliveOperSt
          scalar:Bitmask8 		operSt  (vpc:Keepalive:operSt)
           operational state
scalar:Uint32 peerStateChanges  (vpc:Keepalive:peerStateChanges)
           peer state changes
vpc:PrecType
          scalar:Enum8 		precType  (vpc:Keepalive:precType)
           precedence type
vpc:PrecValue
          scalar:UByte 		precValue  (vpc:Keepalive:precValue)
           precedence value
vpc:Counter
          scalar:Uint32 		rcvdPkts  (vpc:Keepalive:rcvdPkts)
           number of packets received
nw:IfId
          base:IfIndex 		recvIf  (vpc:Keepalive:recvIf)
           recv interface
vpc:Time
          scalar:Time 		recvTime  (vpc:Keepalive:recvTime)
           last recv time
nw:IfId
          base:IfIndex 		sendIf  (vpc:Keepalive:sendIf)
           send interface
vpc:Time
          scalar:Time 		sendTime  (vpc:Keepalive:sendTime)
           last send time
vpc:Counter
          scalar:Uint32 		sentPkts  (vpc:Keepalive:sentPkts)
           number of packets sent
address:Ip srcIp  (vpc:Keepalive:srcIp)
           source address
vpc:KeepaliveTout
          scalar:Uint32 		timeout  (vpc:Keepalive:timeout)
           timeout
vpc:TosByte
          scalar:UByte 		tosByte  (vpc:Keepalive:tosByte)
           tos byte
vpc:TosCfgType
          scalar:Enum8 		tosCfgType  (vpc:Keepalive:tosCfgType)
           tos config type
vpc:TosType
          scalar:Enum8 		tosType  (vpc:Keepalive:tosType)
           tos type
vpc:TosValue
          scalar:UByte 		tosValue  (vpc:Keepalive:tosValue)
           tos value
comm:Port
          scalar:Uint32 		udpPort  (vpc:Keepalive:udpPort)
           port number
scalar:Bitmask64 vpcCfgFailedBmp  (vpc:Keepalive:vpcCfgFailedBmp)
           null
scalar:Time vpcCfgFailedTs  (vpc:Keepalive:vpcCfgFailedTs)
           Timestamp
scalar:UByte vpcCfgState  (vpc:Keepalive:vpcCfgState)
           null
l3:VrfName
          string:Basic 		vrf  (vpc:Keepalive:vrf)
           vrf name
Defined in: naming:NamedObject
naming:Name
          string:Basic 		name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date 		modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

avgRecvInterval

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
average receive interval


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




destIp

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
destination address


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.


firstRecvTime

Type: vpc:Time
Primitive Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
first recv time


flushTout

Type: vpc:FlushTout
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
flush timeout
Constants
defaultValue 3u --- NO COMMENTS




interval

Type: vpc:KeepaliveInterval
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
interval
Constants
defaultValue 1000u --- 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:
The monitoring policy attached to this observable object.


name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS


operSt

Type: vpc:KeepaliveOperSt
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
operational state
Constants
not-applicable 0 Not applicable NO COMMENTS
suspended 1 Suspended NO COMMENTS
vrf-invalid 2 Vrf invalid NO COMMENTS
domain-mismatch 4 Domain Mismatch NO COMMENTS
operational 8 Operational NO COMMENTS
send-failed 16 Send failed NO COMMENTS
recv-failed 32 Recv failed NO COMMENTS
peer-was-alive 64 Peer was alive NO COMMENTS
DEFAULT not-applicable(0) Not applicable NO COMMENTS




peerStateChanges

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
peer state changes


precType

Type: vpc:PrecType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
precedence type
Constants
network 0 Network NO COMMENTS
internet 1 Internet NO COMMENTS
critical 2 Critical NO COMMENTS
flash-override 3 Flash override NO COMMENTS
flash 4 Flash NO COMMENTS
immediate 5 Immediate NO COMMENTS
priority 6 Priority NO COMMENTS
routine 7 Routine NO COMMENTS
DEFAULT routine(7) Routine NO COMMENTS




precValue

Type: vpc:PrecValue
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
precedence value
Constants
defaultValue 6 --- NO COMMENTS




rcvdPkts

Type: vpc:Counter
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
number of packets received


recvIf

Type: nw:IfId
Primitive Type: base:IfIndex

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


recvTime

Type: vpc:Time
Primitive Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
last recv time


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.


sendIf

Type: nw:IfId
Primitive Type: base:IfIndex

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


sendTime

Type: vpc:Time
Primitive Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
last send time


sentPkts

Type: vpc:Counter
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
number of packets sent


srcIp

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
source address


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.





timeout

Type: vpc:KeepaliveTout
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
timeout
Constants
defaultValue 5u --- NO COMMENTS




tosByte

Type: vpc:TosByte
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
tos byte
Constants
defaultValue 0 --- NO COMMENTS




tosCfgType

Type: vpc:TosCfgType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
tos config type
Constants
noCfg 0 No configuration No configuration
tos-byte 1 ToS byte Tos byte
tos-value 2 ToS value Tos value
tos-type 3 ToS type Tos type
precedence-type 4 Precedence Type Precedence type
precedence-value 5 Precedence Value Precedence value
DEFAULT noCfg(0) No configuration No configuration




tosType

Type: vpc:TosType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
tos type
Constants
min-delay 0 Min delay NO COMMENTS
max-throughput 1 Max throughput NO COMMENTS
max-reliability 2 Max Reliability NO COMMENTS
min-monetary-cost 3 Min Monetary Cost NO COMMENTS
normal 4 Normal NO COMMENTS
DEFAULT normal(4) Normal NO COMMENTS




tosValue

Type: vpc:TosValue
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
tos value
Constants
defaultValue 0 --- NO COMMENTS




udpPort

Type: comm:Port
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
port number


vpcCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
null
Constants
vpc:KeepalivelcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
vpc:KeepaliveprecType_failed_flag 1024ull --- NO COMMENTS
vpc:KeepalivetosByte_failed_flag 1048576ull --- NO COMMENTS
vpc:KeepalivemonPolDn_failed_flag 128ull --- NO COMMENTS
vpc:KeepaliveudpPort_failed_flag 16777216ull --- NO COMMENTS
vpc:Keepalivename_failed_flag 1ull --- NO COMMENTS
vpc:KeepaliveprecValue_failed_flag 2048ull --- NO COMMENTS
vpc:KeepalivetosCfgType_failed_flag 2097152ull --- NO COMMENTS
vpc:KeepalivemodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
vpc:KeepalivesrcIp_failed_flag 262144ull --- NO COMMENTS
vpc:Keepalivevrf_failed_flag 268435456ull --- NO COMMENTS
vpc:KeepalivenameAlias_failed_flag 2ull --- NO COMMENTS
vpc:KeepaliveflushTout_failed_flag 32ull --- NO COMMENTS
vpc:KeepalivetosType_failed_flag 4194304ull --- NO COMMENTS
vpc:Keepalivetimeout_failed_flag 524288ull --- NO COMMENTS
vpc:Keepaliveinterval_failed_flag 64ull --- NO COMMENTS
vpc:KeepalivetosValue_failed_flag 8388608ull --- NO COMMENTS
vpc:KeepalivedestIp_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS




vpcCfgFailedTs

Type: scalar:Time

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


vpcCfgState

Type: scalar:UByte

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


vrf

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
vrf name




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