Class ip:ARouteP (ABSTRACT)

Class ID:4278
Class Label: Abstraction of Match Ip Rule
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: []
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstraction of route definitions.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: rtctrl:AMatchIpRule,
Sub Mos: ip:RouteDef, ip:RouteP,


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).
 
 
 
 
 
 
 
 ├
[V] ip:RouteP Configure the IP address and next hop IP address for the routed outside network.


Events
                


Faults
                


Fsms
                


Properties Summary
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
address:Ip ip  (rtctrl:AMatchIpRule:ip)
           IP Address
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

aggregate

Type: l3ext:Flag
Primitive Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    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





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.



ip

Type: address:Ip

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
IP Address



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



pref

Type: rt:Preference
Primitive Type: scalar:UByte

Like: ip:Route:pref
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)1  max: (short)255
    Comments:
The administrative preference value for this route. This value is useful for resolving routes advertised from different protocols.
Constants
defaultValue 1 --- 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
Property Validators:
    Comments:
NO COMMENTS
Constants
unspecified 0 Unspecified Unspecified
bfd 1 BFD Bidirectional Forwarding Detection
DEFAULT unspecified(0) Unspecified Unspecified





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