Class vpc:KAPol (CONCRETE)

Class ID:694
Class Label: Keep Alive Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-connectivity-l1]
Creatable/Deletable: yes (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 ]

The keepalive policy.

Naming Rules
RN FORMAT: kapol

    [1] PREFIX=kapol


DN FORMAT: 

[1] uni/fabric/vpcInst-{name}/kapol

                


Diagram

Super Mo: pol:Comp,
Container Mos: vpc:InstPol (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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] vpc:InstPol The node-level vPC domain policy, which is used to specify a vPC domain and is applied to both vPC peer devices, the vPC peer keepalive link, the vPC peer link, and all the PortChannels in the vPC domain connected to the downstream device. You can have only one vPC domain ID on each device.
 
 
 
 
 
 
 
 
 ├
[V] vpc:KAPol The keepalive policy.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] vpc:InstPol The node-level vPC domain policy, which is used to specify a vPC domain and is applied to both vPC peer devices, the vPC peer keepalive link, the vPC peer link, and all the PortChannels in the vPC domain connected to the downstream device. You can have only one vPC domain ID on each device.
 
 
 
 ├
[V] vpc:KAPol The keepalive policy.


Contained Hierarchy
[V] vpc:KAPol The keepalive policy.
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] vpc:KAPol The keepalive policy.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vpc:KAPol
vpc:FlushTout
          scalar:Uint32
flushTout  (vpc:KAPol:flushTout)
           flush timeout
vpc:KeepaliveInterval
          scalar:Uint32
interval  (vpc:KAPol:interval)
           interval
vpc:PrecType
          scalar:Enum8
precType  (vpc:KAPol:precType)
           precedence type
vpc:PrecValue
          scalar:UByte
precValue  (vpc:KAPol:precValue)
           precedence value
vpc:KeepaliveTout
          scalar:Uint32
timeout  (vpc:KAPol:timeout)
           timeout
vpc:TosByte
          scalar:UByte
tosByte  (vpc:KAPol:tosByte)
           tos byte
vpc:TosCfgType
          scalar:Enum8
tosCfgType  (vpc:KAPol:tosCfgType)
           tos config type
vpc:TosType
          scalar:Enum8
tosType  (vpc:KAPol:tosType)
           tos type
vpc:TosValue
          scalar:UByte
tosValue  (vpc:KAPol:tosValue)
           tos value
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
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

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:
Specifies the description of a policy component.



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.



flushTout

Type: vpc:FlushTout
Primitive Type: scalar:Uint32

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





interval

Type: vpc:KeepaliveInterval
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



precType

Type: vpc:PrecType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
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: admin
Category: TopLevelRegular
    Comments:
precedence value
Constants
defaultValue 6 --- NO COMMENTS





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.






timeout

Type: vpc:KeepaliveTout
Primitive Type: scalar:Uint32

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





tosByte

Type: vpc:TosByte
Primitive Type: scalar:UByte

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





tosCfgType

Type: vpc:TosCfgType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
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: admin
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: admin
Category: TopLevelRegular
    Comments:
tos value
Constants
defaultValue 0 --- NO COMMENTS