Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class l3:Dom (ABSTRACT)

Class ID:3770
Class Label: Domain
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: [aaa, access-connectivity, admin, fabric-connectivity, fabric-protocol, tenant-connectivity, tenant-ext-connectivity]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Explicit
Monitoring Policy Source: Explicit
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The Layer 3 Domain (VRF).

Naming Rules 


DN FORMAT:


Diagram

Super Mo: nw:FwDom,
Sub Mos: l3:Ctx, l3:CtxSubstitute, l3:Inst,
Contained Mos: l2:BD, l2:MacCktRef, l3:EncRtdIf, l3:LbRtdIf, l3:RtdIf, mgmt:RtdMgmtIf,
Relations From: fv:EPgDef, aaa:ServiceNodeCluster, telemetry:ServerCtx,
Relations: l3:RtEPgDefToL3Dom, l3:RtToInbL3Dom, l3:RtToL3Dom,


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:FwDom A data plane domain abstraction. This object represents a domain within a forwarding plane instance. For example, a bridge domain.
 
 		 
 		 
 		 ├
 		[V] l3:Dom The Layer 3 Domain (VRF).
 
 		 
 		 
 		 
 		 ├
 		[V] l3:Ctx The tenant context information is equivalent to a virtual routing and forwarding (VRF) instance created for the tenant's L3 network. Similar to a VRF in traditional Cisco routers, the tenant context isolates the IP addresses of the tenant, allowing different tenants to have overlapping IP addresses.
 
 		 
 		 
 		 
 		 ├
 		[V] l3:CtxSubstitute  Tenant context object substitute. Its needed for internal PE purposes but it doesnt instantiate any VRF in the node.
 
 		 
 		 
 		 
 		 ├
 		[V] l3:Inst The infra VRF is created for the iNXOS fabric infrastructure. All communications between fabric elements, such as spine, leaf and vleaf, take place in this VRF.


Events


Faults 
                l3:Dom:l3vmCfgCtrl


Fsms


Properties Summary
Defined in: l3:Dom
l3:VrfAdminState
          scalar:Enum8 		adminState  (l3:Dom:adminState)
           vrf Admin State
l3:BgpRdBytes
          base:Uint8Array8 		bgpRd  (l3:Dom:bgpRd)
           bgp route distinguisher
string:Basic bgpRdDisp  (l3:Dom:bgpRdDisp)
          
scalar:Date createTs  (l3:Dom:createTs)
           vrf creation time
fv:PrimKey
          reference:BinRef 		ctxPKey  (l3:Dom:ctxPKey)
           DN of the fv:Ctx to which the fault will get delegated
base:Encap encap  (l3:Dom:encap)
           Encap for this Context
scalar:Uint32 gsdbCtx  (l3:Dom:gsdbCtx)
           gsdb context
l3:VrfId
          scalar:Uint16 		id  (l3:Dom:id)
           vrf id
scalar:Bitmask64 l3vmCfgFailedBmp  (l3:Dom:l3vmCfgFailedBmp)
          
scalar:Time l3vmCfgFailedTs  (l3:Dom:l3vmCfgFailedTs)
          
scalar:UByte l3vmCfgState  (l3:Dom:l3vmCfgState)
          
scalar:Date lastChgdTs  (l3:Dom:lastChgdTs)
           last state change time
scalar:Uint32 mplsVPNLabelIndex  (l3:Dom:mplsVPNLabelIndex)
           vrf MPLS VPN Label
naming:Name
          string:Basic 		name  (l3:Dom:name)
           Overrides:nw:FwDom:name | nw:Conn:name
           vrf name
l3:VrfOperStateQual
          scalar:Enum8 		oldOperStQual  (l3:Dom:oldOperStQual)
           old oper state reason
l3:VrfOperStateQual
          scalar:Enum8 		operStQual  (l3:Dom:operStQual)
           oper state reason
l3:VrfOperState
          scalar:Enum8 		operState  (l3:Dom:operState)
           The VRF operational state.
scalar:Uint32 oui  (l3:Dom:oui)
           vrf oui
scalar:Bool pending  (l3:Dom:pending)
           pending operation status
scalar:Uint32 prtclBmp  (l3:Dom:prtclBmp)
           protocols in a vrf
l3:VrfId
          scalar:Uint16 		resourceId  (l3:Dom:resourceId)
          
actrl:ScopeId
          scalar:Uint32 		scope  (l3:Dom:scope)
           Scope of the context. It identifies the classId pool and all the epg/bd classIds belonging to this context needs to be allocated from this pool
scalar:Uint32 v4TibId  (l3:Dom:v4TibId)
           ipv4 table id
string:Basic v4TibName  (l3:Dom:v4TibName)
           ipv4 table name
l3:VrfOperStateQual
          scalar:Enum8 		v4TibOldOperStQual  (l3:Dom:v4TibOldOperStQual)
           ipv4 table old oper state reason
l3:VrfOperStateQual
          scalar:Enum8 		v4TibOperStQual  (l3:Dom:v4TibOperStQual)
           ipv4 table oper state reason
l3:VrfOperState
          scalar:Enum8 		v4TibOperState  (l3:Dom:v4TibOperState)
           ipv4 table operational state.
scalar:Bool v4TibPending  (l3:Dom:v4TibPending)
           ipv4 table pending operation status
scalar:Bool v4TibValid  (l3:Dom:v4TibValid)
           ipv4 table valid
scalar:Uint32 v6TibId  (l3:Dom:v6TibId)
           ipv6 table id
string:Basic v6TibName  (l3:Dom:v6TibName)
           ipv6 table name
l3:VrfOperStateQual
          scalar:Enum8 		v6TibOldOperStQual  (l3:Dom:v6TibOldOperStQual)
           ipv6 table old oper state reason
l3:VrfOperStateQual
          scalar:Enum8 		v6TibOperStQual  (l3:Dom:v6TibOperStQual)
           ipv6 table oper state reason
l3:VrfOperState
          scalar:Enum8 		v6TibOperState  (l3:Dom:v6TibOperState)
           ipv6 table Oper State
scalar:Bool v6TibPending  (l3:Dom:v6TibPending)
           ipv6 table pending operation status
scalar:Bool v6TibValid  (l3:Dom:v6TibValid)
           ipv6 table valid
scalar:Uint32 vpnId  (l3:Dom:vpnId)
           vrf vpnId
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

adminState

Type: l3:VrfAdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
vrf Admin State
Constants
shutdown 1 shutdown NO COMMENTS
admin-up 2 admin-up NO COMMENTS
DEFAULT admin-up(2) admin-up NO COMMENTS




bgpRd

Type: l3:BgpRdBytes
Primitive Type: base:Uint8Array8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
bgp route distinguisher


bgpRdDisp

Type: string:Basic

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




createTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
vrf creation time


ctxPKey

Type: fv:PrimKey
Primitive Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DN of the fv:Ctx to which the fault will get delegated


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.


encap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Encap for this Context


gsdbCtx

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
gsdb context


id

Type: l3:VrfId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
vrf id


l3vmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:


l3vmCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:


l3vmCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:


lastChgdTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
last state change time


mplsVPNLabelIndex

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
vrf MPLS VPN Label


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:FwDom:name  |  nw:Conn:name

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
vrf name


oldOperStQual

Type: l3:VrfOperStateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
old oper state reason
Constants
admin-down 1 admin-down NO COMMENTS
admin-down-pending 2 admin-down-pending NO COMMENTS
delete-holddown 3 delete-holddown NO COMMENTS
delete-pending 4 delete-pending NO COMMENTS
invalid 5 invalid NO COMMENTS
create-pending 6 create-pending NO COMMENTS
DEFAULT admin-down(1) admin-down NO COMMENTS




operStQual

Type: l3:VrfOperStateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
oper state reason
Constants
admin-down 1 admin-down NO COMMENTS
admin-down-pending 2 admin-down-pending NO COMMENTS
delete-holddown 3 delete-holddown NO COMMENTS
delete-pending 4 delete-pending NO COMMENTS
invalid 5 invalid NO COMMENTS
create-pending 6 create-pending NO COMMENTS
DEFAULT admin-down(1) admin-down NO COMMENTS




operState

Type: l3:VrfOperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The VRF operational state.
Constants
up 1 up NO COMMENTS
down 2 down NO COMMENTS
DEFAULT down(2) down NO COMMENTS




oui

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
vrf oui


pending

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
pending operation status
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




prtclBmp

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
protocols in a vrf


resourceId

Type: l3:VrfId
Primitive Type: scalar:Uint16

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


scope

Type: actrl:ScopeId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Scope of the context. It identifies the classId pool and all the epg/bd classIds belonging to this context needs to be allocated from this pool
Constants
defaultValue 1u --- NO COMMENTS




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.





v4TibId

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table id


v4TibName

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table name


v4TibOldOperStQual

Type: l3:VrfOperStateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table old oper state reason
Constants
admin-down 1 admin-down NO COMMENTS
admin-down-pending 2 admin-down-pending NO COMMENTS
delete-holddown 3 delete-holddown NO COMMENTS
delete-pending 4 delete-pending NO COMMENTS
invalid 5 invalid NO COMMENTS
create-pending 6 create-pending NO COMMENTS
DEFAULT admin-down(1) admin-down NO COMMENTS




v4TibOperStQual

Type: l3:VrfOperStateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table oper state reason
Constants
admin-down 1 admin-down NO COMMENTS
admin-down-pending 2 admin-down-pending NO COMMENTS
delete-holddown 3 delete-holddown NO COMMENTS
delete-pending 4 delete-pending NO COMMENTS
invalid 5 invalid NO COMMENTS
create-pending 6 create-pending NO COMMENTS
DEFAULT admin-down(1) admin-down NO COMMENTS




v4TibOperState

Type: l3:VrfOperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table operational state.
Constants
up 1 up NO COMMENTS
down 2 down NO COMMENTS
DEFAULT down(2) down NO COMMENTS




v4TibPending

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table pending operation status
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




v4TibValid

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv4 table valid
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




v6TibId

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table id


v6TibName

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table name


v6TibOldOperStQual

Type: l3:VrfOperStateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table old oper state reason
Constants
admin-down 1 admin-down NO COMMENTS
admin-down-pending 2 admin-down-pending NO COMMENTS
delete-holddown 3 delete-holddown NO COMMENTS
delete-pending 4 delete-pending NO COMMENTS
invalid 5 invalid NO COMMENTS
create-pending 6 create-pending NO COMMENTS
DEFAULT admin-down(1) admin-down NO COMMENTS




v6TibOperStQual

Type: l3:VrfOperStateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table oper state reason
Constants
admin-down 1 admin-down NO COMMENTS
admin-down-pending 2 admin-down-pending NO COMMENTS
delete-holddown 3 delete-holddown NO COMMENTS
delete-pending 4 delete-pending NO COMMENTS
invalid 5 invalid NO COMMENTS
create-pending 6 create-pending NO COMMENTS
DEFAULT admin-down(1) admin-down NO COMMENTS




v6TibOperState

Type: l3:VrfOperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table Oper State
Constants
up 1 up NO COMMENTS
down 2 down NO COMMENTS
DEFAULT down(2) down NO COMMENTS




v6TibPending

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table pending operation status
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




v6TibValid

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
ipv6 table valid
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




vpnId

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
vrf vpnId




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail