Class eigrp:RtMetricAlterP (CONCRETE)

Class ID:7882
Class Label: Route Metric Alteration Policy
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-connectivity-l3, fabric-protocol-l3, tenant-connectivity-l3, tenant-ext-connectivity-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 ]

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

Naming Rules
RN FORMAT: rtmetricalter-{direction}

    [1] PREFIX=rtmetricalter- PROPERTY = direction




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/eigrp/inst-{name}/dom-{name}/if-{[id]}/af-{type}/rtmetricalter-{direction}

[1] sys/eigrp/inst-{name}/dom-{name}/if-{[id]}/af-{type}/rtmetricalter-{direction}

                


Diagram

Super Mo: rtctrl:RtCtrlP,
Container Mos: eigrp:IfAf (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] eigrp:Entity The EIGRP control plane entity information.
 
 
 
 
 
 ├
[V] eigrp:Inst The EIGRP instance information.
 
 
 
 
 
 
 ├
[V] eigrp:Dom The EIGRP domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] eigrp:If An EIGRP configured interface combines the benefits of distance vector protocols with the features of link-state protocols.
 
 
 
 
 
 
 
 
 ├
[V] eigrp:IfAf The address family interface.
 
 
 
 
 
 
 
 
 
 ├
[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] 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] eigrp:Entity The EIGRP control plane entity information.
 
 
 ├
[V] eigrp:Inst The EIGRP instance information.
 
 
 
 ├
[V] eigrp:Dom The EIGRP domain (VRF) information.
 
 
 
 
 ├
[V] eigrp:If An EIGRP configured interface combines the benefits of distance vector protocols with the features of link-state protocols.
 
 
 
 
 
 ├
[V] eigrp:IfAf The address family interface.
 
 
 
 
 
 
 ├
[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


Contained Hierarchy
[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] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.


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] 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] 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


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: eigrp:RtMetricAlterP
rtctrl:RtCtrlDir
          scalar:Enum8
direction  (eigrp:RtMetricAlterP:direction)
           Overrides:rtctrl:RtCtrlP:direction
           The connector direction.
eigrp:MetricOffset
          scalar:Uint32
offset  (eigrp:RtMetricAlterP:offset)
           The estimated offset of the peer clock relative to the local clock, in seconds.
Defined in: rtctrl:RtCtrlP
string:Basic pfxList  (rtctrl:RtCtrlP:pfxList)
           The prefix list to control the distribution.
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: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





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.



direction

Type: rtctrl:RtCtrlDir
Primitive Type: scalar:Enum8

Overrides:rtctrl:RtCtrlP:direction
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The connector direction.
Constants
in 1 Incoming Incoming
out 2 Outgoing Outgoing
DEFAULT in(1) Incoming Incoming





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.



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





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





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



offset

Type: eigrp:MetricOffset
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The estimated offset of the peer clock relative to the local clock, in seconds.
Constants
defaultValue 0u --- NO COMMENTS





pfxList

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The prefix list to control the distribution.



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.