Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class rtleak:LeakCtrlP (ABSTRACT)

Class ID:3607
Class Label: Route Leak Control Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-connectivity-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The leak control policy, which defines the different knobs to control redistribution of routes.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: pol:Instr,
Sub Mos: isis:LeakCtrlP, ospf:ALeakCtrlP,


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:Instr Represents a policy control instrumentation object.
 
 		 
 		 ├
 		[V] rtleak:LeakCtrlP The leak control policy, which defines the different knobs to control redistribution of routes.
 
 		 
 		 
 		 ├
 		[V] isis:LeakCtrlP The leak controls related to the number of routes leaked.
 
 		 
 		 
 		 ├
 		[V] ospf:ALeakCtrlP An abstraction of the leak controls related to the number of routes leaked.
 
 		 
 		 
 		 
 		 ├
 		[V] ospf:LeakCtrlP The leak controls that determine the number of routes leaked.
 
 		 
 		 
 		 
 		 ├
 		[V] ospfv3:LeakCtrlP The leak controls that determine the number of routes leaked.


Events


Faults


Fsms


Properties Summary
Defined in: rtleak:LeakCtrlP
rtleak:Ctrl
          scalar:Bitmask8 		ctrl  (rtleak:LeakCtrlP:ctrl)
           The control state.
rtleak:Duration
          scalar:Uint16 		duration  (rtleak:LeakCtrlP:duration)
          
rtleak:MaxPfx
          scalar:Uint16 		max  (rtleak:LeakCtrlP:max)
          
rtleak:Retries
          scalar:Uint16 		retries  (rtleak:LeakCtrlP:retries)
           The number of attempts that a provider, method, or route is tried.
rtleak:Thresh
          scalar:UByte 		thresh  (rtleak:LeakCtrlP:thresh)
           The threshold for a maximum number of prefixes before a warning is issued. For example, if the maximum number is 10 and the threshold is set at 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
Defined in: pol:Instr
naming:Descr
          string:Basic 		descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
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




ctrl

Type: rtleak:Ctrl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
warn 1 Warning Warn
withdraw 2 Withdraw Withdraw
DEFAULT warn(1) Warning Warn




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.


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.


duration

Type: rtleak:Duration
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 300 --- NO COMMENTS




max

Type: rtleak:MaxPfx
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 0xffff --- 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


retries

Type: rtleak:Retries
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The number of attempts that a provider, method, or route is tried.
Constants
defaultValue 12 --- 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.





thresh

Type: rtleak:Thresh
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The threshold for a maximum number of prefixes before a warning is issued. For example, if the maximum number is 10 and the threshold is set at 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
Constants
defaultValue 75 --- NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail