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

Class ip:RouteDef (CONCRETE)

Class ID:4280
Class Label: Abstraction of Match Ip Rule
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity, admin, fabric-connectivity, tenant-connectivity, tenant-ext-connectivity]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The route definitions, which are are used for pushing subnets and static routes to PE. They also push subnets under EpPD to VMMMGR (for configuring external networks in vCD).

Naming Rules 
RN FORMAT: rt-{[ip]}

    [1] PREFIX=rt- PROPERTY = ip




DN FORMAT: 

        Too Many Containers: 329


Containers Hierarchies
Too Many containers: 329


Contained Hierarchy
[V] ip:RouteDef The route definitions, which are are used for pushing subnets and static routes to PE. They also push subnets under EpPD to VMMMGR (for configuring external networks in vCD).
 ├
 		[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.
 ├
 		[V] ip:EpAnycastDef 
 
 		 ├
 		[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.
 ├
 		[V] ip:EpNlbDef 
 
 		 ├
 		[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.
 ├
 		[V] ip:NexthopDef The Nexthops for the static route.
 
 		 ├
 		[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.
 
 		 ├
 		[V] ip:RtNexthopToNexthopDef A target relation to the next hops for the static route.
 ├
 		[V] ip:NexthopEpPDef 
 
 		 ├
 		[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.
 ├
 		[V] ip:RtRouteToRouteDef A target relation to the route definitions.
 ├
 		[V] ip:RtRtDefIpAddr A target relation to the route definitions.
 ├
 		[V] nd:PfxPolDef The neighbor discovery prefix policy definition.
 
 		 ├
 		[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: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:AMatchRule The abstraction for all match rules.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] rtctrl:AMatchIpRule The abstraction for all IP address based on match rules.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ip:ARouteP An abstraction of route definitions.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ip:RouteDef The route definitions, which are are used for pushing subnets and static routes to PE. They also push subnets under EpPD to VMMMGR (for configuring external networks in vCD).


Events


Faults


Fsms


Properties Summary
Defined in: ip:RouteDef
fv:SubnetControl
          scalar:Bitmask8 		ctrl  (ip:RouteDef:ctrl)
           The control state.
address:Ip ip  (ip:RouteDef:ip)
           Overrides:rtctrl:AMatchIpRule:ip
          
actrl:PcTag
          scalar:Uint32 		pcTag  (ip:RouteDef:pcTag)
          
scalar:Bool preferred  (ip:RouteDef:preferred)
           Indicates if the route is preferred (primary) over the available alternatives. Only one preferred route is allowed.
fv:RouteScp
          scalar:Bitmask8 		scope  (ip:RouteDef:scope)
          
reference:BinRef trackListDn  (ip:RouteDef:trackListDn)
           For OTM
scalar:Bool virtual  (ip:RouteDef:virtual)
           Treated as virtual IP address. Used in case of BD extended to multiple sites.
Defined in: ip:ARouteP
rt:Preference
          scalar:UByte 		pref  (ip:ARouteP:pref)
           The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
ip:RtCtrl
          scalar:Bitmask8 		rtCtrl  (ip:ARouteP:rtCtrl)
           NO COMMENTS
rtctrl:MatchType
          scalar:Enum8 		type  (ip:ARouteP:type)
           Overrides:rtctrl:AMatchRule:type
          
Defined in: rtctrl:AMatchIpRule
l3ext:Flag
          scalar:Bool 		aggregate  (rtctrl:AMatchIpRule:aggregate)
           Aggregated Route
l3:IpPfxLen
          scalar:Uint16 		fromPfxLen  (rtctrl:AMatchIpRule:fromPfxLen)
           Prefix list range
l3:IpPfxLen
          scalar:Uint16 		toPfxLen  (rtctrl:AMatchIpRule:toPfxLen)
           NO COMMENTS
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:Resolvable
mo:Owner
          scalar:Enum8 		lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
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.
Properties Detail

aggregate

Type: l3ext:Flag
Primitive Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Aggregated Route
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




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: fv:SubnetControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
unspecified 0 Unspecified Unspecified
querier 1 Querier IP Address will be used as a IGMP querier source IP
nd 2 ND RA Prefix Address will be used as a ND RA Prefix
no-default-gateway 4 No Default SVI Gateway Address will be have default gateway
DEFAULT nd(2) ND RA Prefix Address will be used as a ND RA Prefix




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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.


fromPfxLen

Type: l3:IpPfxLen
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Prefix list range
Constants
defaultValue 0 --- NO COMMENTS




ip

Type: address:Ip

Overrides:rtctrl:AMatchIpRule:ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    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




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


pcTag

Type: actrl:PcTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
any 0u any NO COMMENTS
DEFAULT 0 --- Policy control tag




pref

Type: rt:Preference
Primitive Type: scalar:UByte

Like: ip:Route:pref
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
Constants
defaultValue 1 --- NO COMMENTS




preferred

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Indicates if the route is preferred (primary) over the available alternatives. Only one preferred route is allowed.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.


rtCtrl

Type: ip:RtCtrl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
unspecified 0 Unspecified Unspecified
bfd 1 BFD Bidirectional Forwarding Detection
DEFAULT unspecified(0) Unspecified Unspecified




scope

Type: fv:RouteScp
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
public 1 Advertised Externally Visible outside the fabric
private 2 Private to VRF Visiblity limited to the local Vrf
shared 4 Shared between VRFs Visibility limited to the shared VRF
DEFAULT private(2) Private to VRF Visiblity limited to the local Vrf




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.





toPfxLen

Type: l3:IpPfxLen
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 0 --- NO COMMENTS




trackListDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
For OTM


type

Type: rtctrl:MatchType
Primitive Type: scalar:Enum8

Overrides:rtctrl:AMatchRule:type

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
community 1 Community Community
rt-dst 2 Route Destination Route destinations
rt-nh 3 Route Nexthop Route next hop
rt-src 4 Route Source Route source
rt-type 5 Route Type Route type
rt-tag 6 Route Tag Route tag
rt-static 7 Static Route Static Route
community-regex 8 Community Regex Community
ip-multicast 9 IP Multicast Multicast IP
DEFAULT rt-static(7) Static Route Static Route




virtual

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Treated as virtual IP address. Used in case of BD extended to multiple sites.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS






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