Class rtctrl:RtCtrlPBase (ABSTRACT)

Class ID:6870
Class Label: Route Control Policy Base
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-protocol-l3, tenant-ext-protocol-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 ]

NO COMMENTS

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: pol:Instr,
Sub Mos: bgp:PfxLeakCtrlP, bgp:RtCtrlMapP, bgp:RtExpP, rtctrl:RtCtrlP,


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] rtctrl:RtCtrlPBase 
 
 
 
 ├
[V] bgp:PfxLeakCtrlP  This object holds route control policy for all networks defined by PfxLeakP in that domain
 
 
 
 ├
[V] bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.
 
 
 
 ├
[V] bgp:RtExpP  Route export policy to control whether to export routes into a different address family. Destination address family is specified in the object. Object may be nested within peer Address family (AF) to subject only those peer's particular AF routes to export. Object can also be under a domain Address family in which case it is applicable to all pe...
 
 
 
 ├
[V] rtctrl:RtCtrlP Route control policy for routes. There are few ways to apply this policy, controlling through route maps or prefix lists. The direction specifies whether to apply this policy in the incoming or outgoing direction
 
 
 
 
 ├
[V] bgp:RtCtrlP The route control policy for routes coming/going to peers. There are few ways to apply this policy.
 
 
 
 
 ├
[V] eigrp:RtCtrlP The route control policy for routes coming/going over interfaces. There are few ways to apply this policy, controlling through route maps or prefix lists. The direction specifies whether to apply this policy in the incoming or outgoing direction
 
 
 
 
 ├
[V] eigrp:RtMetricAlterP  Metric Alteration policy for EIGRP routes. Selection of routes for which metric has to be adjusted, can be done through route maps or prefix lists. The direction specifies whether to apply this policy for incoming or outgoing routes
 
 
 
 
 ├
[V] ipmcsnoop:ACtrlP  Access control policy for multicast snoop. The policy can be applied either through prefix-list or route-map. Either prefix-list or route-map is applied
 
 
 
 
 
 ├
[V] igmpsnoop:ACtrlP  Route control policy for igmp multicast snoop.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: rtctrl:RtCtrlPBase
string:Basic rtMap  (rtctrl:RtCtrlPBase:rtMap)
           The name of the route map. This route map name is used to control distribution.
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





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.



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



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.