Class l2:Dom (ABSTRACT)

Class ID:3411
Class Label: Domain
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l2, admin]
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 ]

A generic layer 2 flood domain is independent of such technology as 802.1q.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: l2:ADom,
Sub Mos: l2:BD, l2:CktEp,
Contained Mos: l2:EpScanInfo,
Relations From: fv:AIfConn, fv:EPgDef,
Relations To: nw:PathEp,
Relations: l2:RsPathDomAtt, l2:RtDomIfConn, l2:RtEPgDefToL2Dom,


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] l2:ADom  Layer2 Abstract Domain represents a generic layer 2 flood domain. It independent of technology like 802.1q, vxlan
 
 
 
 
 ├
[V] l2:Dom A generic layer 2 flood domain is independent of such technology as 802.1q.
 
 
 
 
 
 ├
[V] l2:BD The Layer 2 Bridge-domain identifies the boundary of a tenant’s bridged/layer 2 traffic. This is similar to a VLAN in a traditional layer 2 switched network.
 
 
 
 
 
 ├
[V] l2:CktEp The abstraction of a circuit endpoint.
 
 
 
 
 
 
 ├
[V] vlan:CktEp A VLAN object created for an endpoint group with an 802.1q encap.
 
 
 
 
 
 
 ├
[V] vxlan:CktEp A VXLAN circuit.


Events
                


Faults
                l2:Dom:vlanmgrCfgCtrl


Fsms
                


Properties Summary
Defined in: l2:Dom
l2:DomAdminSt
          scalar:Enum8
adminSt  (l2:Dom:adminSt)
           admin state
scalar:Date createTs  (l2:Dom:createTs)
           creation time
l2:DomCtrl
          scalar:Bitmask32
ctrl  (l2:Dom:ctrl)
           The control state.
scalar:Uint64 epUpSeqNum  (l2:Dom:epUpSeqNum)
           EP Update Sequence Number
l2:FwdCtrl
          scalar:Bitmask32
fwdCtrl  (l2:Dom:fwdCtrl)
           Forwarding controls
l2:DomId
          scalar:Uint32
hwId  (l2:Dom:hwId)
           Internal domain id
l2:DomId
          scalar:Uint32
id  (l2:Dom:id)
           domain id
l2:DomMode
          scalar:Enum8
mode  (l2:Dom:mode)
           Vlan mode
l2:DomOperSt
          scalar:Enum8
operSt  (l2:Dom:operSt)
           oper state
l2:DomType
          scalar:Enum8
type  (l2:Dom:type)
           domain type
scalar:Bitmask64 vlanmgrCfgFailedBmp  (l2:Dom:vlanmgrCfgFailedBmp)
           null
scalar:Time vlanmgrCfgFailedTs  (l2:Dom:vlanmgrCfgFailedTs)
          
scalar:UByte vlanmgrCfgState  (l2:Dom:vlanmgrCfgState)
           null
Defined in: nw:FwDom
naming:Name
          string:Basic
name  (nw:FwDom:name)
           Overrides:nw:Conn:name
           The name of the object.
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

adminSt

Type: l2:DomAdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
admin state
Constants
suspend 1 suspend NO COMMENTS
active 2 active NO COMMENTS
DEFAULT active(2) active 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





createTs

Type: scalar:Date

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



ctrl

Type: l2:DomCtrl
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
none 0u None None
qiq 16u QiQ QiQ Dom
untagged 1u Untagged Untagged
policy-enforced 2u Policy Enforced Policy enforced
isolated 4u Intra EPG Deny Enforced Isolated
service-ep 8u Service EP Service
DEFAULT none(0u) None None





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.



epUpSeqNum

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
EP Update Sequence Number



fwdCtrl

Type: l2:FwdCtrl
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Forwarding controls
Constants
mac-flush-on-vpc-delete 128u Delete vPC MAC addressesfrom fabric on EP delete Delete vPC MAC addresses from fabric on EP delete in BD unkUcastMac flood mode
mac-learn-disable 16u Disable MAC Learning MAC Learning, default is on. If disabled, the MAC learning will not be done for the BD
mdst-flood 1u Enable Multi Destination Flooding Multi destination (unknown multicast/broadcast) flood, default is on
arp-flood 2u Enable ARP Flooding ARP flooding, default is off. If disabled it will do unicast routing on the target IP
proxy-arp 32u Enable Proxy ARP on EPG Proxy ARP enabled check, default is off.
ip-learn-subnet-check 4u Enable IP Learn Subnet Check IP learning subnet check, default is off. Every BD has multiple subnets associated with it. All IPs are learned without any restrictions. Enable this knob to suppress learning of IPs that fall outside the BD subnets
copy-service 64u Enable copy service on BD Copy service default is off. If enabled, all copy service functionality will be applied on this BD
ip-learn-disable 8u Disable IP Learning IP Learning, default is on. If disabled, the IP learning will not be done for the BD
DEFAULT mdst-flood(1u) Enable Multi Destination Flooding Multi destination (unknown multicast/broadcast) flood, default is on





hwId

Type: l2:DomId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Internal domain id



id

Type: l2:DomId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
domain id



mode

Type: l2:DomMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Vlan mode
Constants
CE 1 CE NO COMMENTS
FabricPath 2 FabricPath NO COMMENTS
DEFAULT CE(1) CE NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



operSt

Type: l2:DomOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
oper state
Constants
up 1 up NO COMMENTS
down 2 down NO COMMENTS
DEFAULT down(2) down 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.



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: l2:DomType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
domain type
Constants
bd-regular 1 BD regular NO COMMENTS
bd-reserved 2 BD reserved NO COMMENTS
bd-control 3 BD control NO COMMENTS
bd-external 4 BD external NO COMMENTS
ckt-vlan 5 Vlan circuit NO COMMENTS
ckt-vxlan 6 Vxlan circuit NO COMMENTS
bd-fcoe 7 BD fcoe NO COMMENTS
DEFAULT bd-regular(1) BD regular NO COMMENTS





vlanmgrCfgFailedBmp

Type: scalar:Bitmask64

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



vlanmgrCfgFailedTs

Type: scalar:Time

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



vlanmgrCfgState

Type: scalar:UByte

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