Class ipv4:Route (CONCRETE)

Class ID:3795
Class Label: IPv4 Static Route
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-connectivity, access-protocol, admin, fabric-connectivity, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

The static route definitions.

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

    [1] PREFIX=rt- PROPERTY = prefix




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ipv4/inst/dom-{name}/rt-{[prefix]}

[1] sys/ipv4/inst/dom-{name}/rt-{[prefix]}

                


Diagram

Super Mo: ip:Route,
Container Mos: ipv4:Dom (deletable:yes),
Contained Mos: ipv4:Nexthop, ipv4:NexthopStub, vz:PcTagCons,
Relations To: fv:IfConn, leak:RouteIntPfx, ip:RouteDef,
Relations: ip:RsRouteToIfConn, ip:RsRouteToLeakRouteIntPfx, ip:RsRouteToRouteDef,


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] ipv4:Entity A container for IPV4 control plane entity information.
 
 
 
 
 
 ├
[V] ipv4:Inst A container for IPV4 instance information.
 
 
 
 
 
 
 ├
[V] ipv4:Dom The domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] ipv4:Route The static route definitions.
[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] ipv4:Entity A container for IPV4 control plane entity information.
 
 
 ├
[V] ipv4:Inst A container for IPV4 instance information.
 
 
 
 ├
[V] ipv4:Dom The domain (VRF) information.
 
 
 
 
 ├
[V] ipv4:Route The static route definitions.


Contained Hierarchy
[V] ipv4:Route The static route definitions.
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] ip:RsRouteToIfConn A source relation to the connectivity parameters for an interface.
 
 ├
[V] ip:Cons Used for maintaining consumers of a static route from an IPRoueDef.
 
 
 ├
[V] ip:RsConsRoot 
 ├
[V] ip:RsRouteToLeakRouteIntPfx  Relation to the leakRouteIntPfx, which is used to ensure that a route is reference counted when coming from an explicit route-map for leak services, configured by the user
 ├
[V] ip:RsRouteToRouteDef A source relation to route definitions.
 
 ├
[V] ip:Cons Used for maintaining consumers of a static route from an IPRoueDef.
 
 
 ├
[V] ip:RsConsRoot 
 ├
[V] ipv4:Nexthop The next hops for the static route.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[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] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] ip:RsNexthopToNexthopDef A source relation to the next hops for the static route.
 
 ├
[V] ip:RsNexthopToProtG A source relation to an abstraction of the VPC protection group.
 ├
[V] ipv4:NexthopStub 
 
 ├
[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:RsNexthopToNexthopDef A source relation to the next hops for the static route.
 
 ├
[V] ip:RsNexthopToProtG A source relation to an abstraction of the VPC protection group.
 ├
[V] vz:PcTagCons 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[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] tag:Annotation 
 
 ├
[V] tag:Tag 


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] ip:Route The static route definitions.
 
 
 
 ├
[V] ipv4:Route The static route definitions.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: ipv4:Route
reference:BinRef monPolDn  (ipv4:Route:monPolDn)
          
address:Ip prefix  (ipv4:Route:prefix)
           Overrides:ip:Route:prefix
          
Defined in: ip:Route
ip:RtControl
          scalar:Bitmask8
ctrl  (ip:Route:ctrl)
          
scalar:Uint32 flushCount  (ip:Route:flushCount)
           Counts the number of times end-points under this subnet have been flushed.
actrl:PcTag
          scalar:Uint32
pcTag  (ip:Route:pcTag)
          
rt:Preference
          scalar:UByte
pref  (ip:Route:pref)
          
scalar:Sint32 sharedConsCount  (ip:Route:sharedConsCount)
           Shared Consumer Count
rt:Tag
          scalar:Uint32
tag  (ip:Route:tag)
          
track:TrackId
          scalar:Uint32
trackId  (ip:Route:trackId)
           Object Id to track route by OTM
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: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

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: ip:RtControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unspecified 0 Unspecified Unspecified
pervasive 1 Pervasive route Pervasive
bfd 2 BFD Bidirectional Forwarding Detection
dst-unreachable 4 Destination unreachable Dest-unreachable
track-object 8 Object tracked by IPSLA Object to be tracked
DEFAULT unspecified(0) Unspecified Unspecified





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.



flushCount

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Counts the number of times end-points under this subnet have been flushed.



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





monPolDn

Type: reference:BinRef

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

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 1 --- NO COMMENTS





prefix

Type: address:Ip

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



sharedConsCount

Type: scalar:Sint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Shared Consumer Count



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.






tag

Type: rt:Tag
Primitive Type: scalar:Uint32

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





trackId

Type: track:TrackId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Object Id to track route by OTM