Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class rtctrl:ASetRtMetric (ABSTRACT)

Class ID:616
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-connectivity-l3]
Read Access: [admin, tenant-ext-connectivity-l3]
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 ]

Sets action rule based on a metric value.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: rtctrl:ASetRule,
Sub Mos: rtctrl:SetRtMetric, rtctrl:SetRtMetricDef,


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] fabric:ProtoComp A base class for protocol policies.
 
 		 
 		 
 		 ├
 		[V] fabric:L3ProtoComp A base class for layer 3 protocol policies.
 
 		 
 		 
 		 
 		 ├
 		[V] rtctrl:ASetRule The abstraction for all set action rules.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] rtctrl:ASetRtMetric Sets action rule based on a metric value.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] rtctrl:SetRtMetric The set action rule based on metric.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] rtctrl:SetRtMetricDef The set route metric definition.


Events


Faults


Fsms


Properties Summary
Defined in: rtctrl:ASetRtMetric
rtmap:Metric
          scalar:Uint32 		metric  (rtctrl:ASetRtMetric:metric)
           The Metric value
rtctrl:SetType
          scalar:Enum8 		type  (rtctrl:ASetRtMetric:type)
           Overrides:rtctrl:ASetRule:type
           Sets the action rule based on the metric type.
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.
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 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.


metric

Type: rtmap:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)0xffffffffl
    Comments:
The Metric value


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


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.





type

Type: rtctrl:SetType
Primitive Type: scalar:Enum8

Overrides:rtctrl:ASetRule:type

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Sets the action rule based on the metric type.
Constants
community 1 Community Community
rt-tag 2 Route Tag Route tag
rt-weight 3 Route Weight Route weight (implicitly used in BGP only)
local-pref 4 Local Preference Local preference (implicitly used in BGP only)
metric 5 Metric Metric
ospf-nssa 6 OSPF NSSA Area OSPF NSSA
ospf-fwd-addr 7 OSPF Fowarding Address OSPF forwarding address
ip-nh 8 IP Nexthop IP Nexthop
metric-type 9 Metric Type Metric Type
dampening-pol 10 Dampening Type Dampening Type
as-path 11 AS Path AS Path
DEFAULT metric(5) Metric Metric






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail