Class bgp:ACtxPol (ABSTRACT)

Class ID:642
Class Label: Abstraction of BGP Context Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-ext-protocol]
Read Access: [admin, tenant-ext-protocol]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The context-level BGP policy.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: fabric:L3CtxPol,
Sub Mos: bgp:CtxDef, bgp:CtxPol, bgp:NodeCtxDef,


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:Def Represents self-contained policy document.
 
 
 ├
[V] fabric:ProtoPol A base class for protocol policies.
 
 
 
 ├
[V] fabric:ProtoDomPol A base class for context-level protocol policies.
 
 
 
 
 ├
[V] fabric:L3DomPol A base class for layer 3 context-level policies.
 
 
 
 
 
 ├
[V] fabric:L3CtxPol A base class for layer 3 context-level policies.
 
 
 
 
 
 
 ├
[V] bgp:ACtxPol The context-level BGP policy.
 
 
 
 
 
 
 
 ├
[V] bgp:CtxDef An internal object for the BGP context-level policy definition.
 
 
 
 
 
 
 
 ├
[V] bgp:CtxPol The BGP timers policy uses timers to control periodic activities such as the frequency keepalive messages that are sent to its peer, the amount of time the system waits to declare a peer dead after keepalive messages stop being received, and the amount of time before restarting a dead peer. The BGP timer policy enables you to specify the intervals for the periodic activities and supplies two options for graceful restart control: the graceful rest...
 
 
 
 
 
 
 
 ├
[V] bgp:NodeCtxDef  Node-level bgp definition


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: bgp:ACtxPol
bgp:GRControls
          scalar:Bitmask8
grCtrl  (bgp:ACtxPol:grCtrl)
           A property to determine whether the entity functions only as a graceful restart helper, forwarding prefixes pointing to a restarting peer, or whether graceful restart is enabled completely.
bgp:HoldIntvl
          scalar:Uint16
holdIntvl  (bgp:ACtxPol:holdIntvl)
           The time period to wait before declaring the neighbor device down.
bgp:KaIntvl
          scalar:Uint16
kaIntvl  (bgp:ACtxPol:kaIntvl)
           The interval time between sending keepalive messages.
bgp:MaxAsLimit
          scalar:Uint16
maxAsLimit  (bgp:ACtxPol:maxAsLimit)
           Maximum AS limit, to discard routes that have excessive AS numbers
bgp:GrStaleIntvl
          scalar:Uint16
staleIntvl  (bgp:ACtxPol:staleIntvl)
           Maximum time that BGP keeps stale routes from the restarting BGP peer.
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
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.
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
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



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.



grCtrl

Type: bgp:GRControls
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A property to determine whether the entity functions only as a graceful restart helper, forwarding prefixes pointing to a restarting peer, or whether graceful restart is enabled completely.
Constants
helper 1 Graceful Restart Helper Helper mode enabled
DEFAULT helper(1) Graceful Restart Helper Helper mode enabled





holdIntvl

Type: bgp:HoldIntvl
Primitive Type: scalar:Uint16

Like: bgp:Dom:holdIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 0
    Range:  min: 3  max: 3600
    Comments:
The time period to wait before declaring the neighbor device down.
Constants
defaultValue 180 --- NO COMMENTS





kaIntvl

Type: bgp:KaIntvl
Primitive Type: scalar:Uint16

Like: bgp:Dom:kaIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 3600
    Comments:
The interval time between sending keepalive messages.
Constants
defaultValue 60 --- NO COMMENTS





maxAsLimit

Type: bgp:MaxAsLimit
Primitive Type: scalar:Uint16

Like: bgp:Dom:maxAsLimit
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 2000
    Comments:
Maximum AS limit, to discard routes that have excessive AS numbers
Constants
defaultValue 0 --- NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



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.



staleIntvl

Type: bgp:GrStaleIntvl
Primitive Type: scalar:Uint16

Like: bgp:Gr:staleIntvl
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 3600
    Comments:
Maximum time that BGP keeps stale routes from the restarting BGP peer.
Constants
default 300 Default NO COMMENTS
DEFAULT default(300) Default NO COMMENTS





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.