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

Class bgp:DampeningCtrl (CONCRETE)

Class ID:7650
Class Label: Dampening Control
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: 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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Route dampening parameters

Naming Rules 
RN FORMAT: dampening

    [1] PREFIX=dampening


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/bgp/inst/dom-{name}/af-{type}/dampening

[1] sys/bgp/inst/dom-{name}/af-{type}/dampening


Diagram

Container Mos: bgp:DomAf (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] bgp:Entity The BGP control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:DomAf The BGP (VRF) address family information.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:DampeningCtrl  Route dampening parameters
[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] bgp:Entity The BGP control plane entity information.
 
 		 
 		 ├
 		[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 		 
 		 
 		 ├
 		[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 		 
 		 
 		 
 		 ├
 		[V] bgp:DomAf The BGP (VRF) address family information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:DampeningCtrl  Route dampening parameters


Contained Hierarchy
[V] bgp:DampeningCtrl  Route dampening parameters


Inheritance
[V] bgp:DampeningCtrl  Route dampening parameters


Events


Faults


Fsms


Properties Summary
Defined in: bgp:DampeningCtrl
rtmap:DampHalfLife
          scalar:Uint16 		halfLife  (bgp:DampeningCtrl:halfLife)
           Below parametes applicable when type is "global" Half Life
rtmap:DampMaxSuppressTime
          scalar:Uint16 		maxSuppressTime  (bgp:DampeningCtrl:maxSuppressTime)
           Max Suppress Time
rtmap:DampReuse
          scalar:Uint16 		reuse  (bgp:DampeningCtrl:reuse)
           Reuse Limit
string:Basic rtMap  (bgp:DampeningCtrl:rtMap)
           The name of the route map. This route map name is used to control distribution.
rtmap:DampSuppress
          scalar:Uint16 		suppress  (bgp:DampeningCtrl:suppress)
           Suppress Limit
bgp:DampConfigType
          scalar:Enum8 		type  (bgp:DampeningCtrl:type)
           The specific type of the object or component.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date 		modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
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




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.


halfLife

Type: rtmap:DampHalfLife
Primitive Type: scalar:Uint16

Units: minutes
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Below parametes applicable when type is "global" Half Life
Constants
defaultValue 15 --- 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




maxSuppressTime

Type: rtmap:DampMaxSuppressTime
Primitive Type: scalar:Uint16

Units: minutes
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Suppress Time
Constants
defaultValue 60 --- 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




reuse

Type: rtmap:DampReuse
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Reuse Limit
Constants
defaultValue 750 --- 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.


rtMap

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the route map. This route map name is used to control distribution.


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.





suppress

Type: rtmap:DampSuppress
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Suppress Limit
Constants
defaultValue 2000 --- NO COMMENTS




type

Type: bgp:DampConfigType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
global 1 Global Config Dampening Global Config
route-map 2 Route map config Dampening Route Map Config
DEFAULT global(1) Global Config Dampening Global Config






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