Class fv:DomDef (CONCRETE)

Class ID:1852
Class Label: Domain
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: [admin]
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: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

The domain information.

Naming Rules
RN FORMAT: dom-{[domPKey]}

    [1] PREFIX=dom- PROPERTY = domPKey




DN FORMAT: 

        Too Many Containers: 84
                


Containers Hierarchies
Too Many containers: 84


Contained Hierarchy
[V] fv:DomDef The domain information.
 ├
[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] fv:RsDomDefNs A source relation to the VxLAN namespace policy definition. This is an internal object.
 
 ├
[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] fv:RsDomDefNsLocal A source relation to the VxLAN namespace policy definition. This is an internal object.
 
 ├
[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: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: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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] fv:RtToDomDef A target relation to the domain definition. This is an internal object.
 ├
[V] fv:RtToFvDomDef 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] fv:ACont An abstract base class for containers. This is an abstract class and cannot be instantiated.
 
 ├
[V] fv:DomDef The domain information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: fv:DomDef
fv:ClassPref
          scalar:Enum8
classPref  (fv:DomDef:classPref)
           Classification preference for this EPG within a domain encap: the class-id is dervied based on packet encapsulation (e.g Vlan/VxLAN id) useg: class-id is derived based on other useg/EPGs or dynamically learned mac address in VMM.
fv:PrimKey
          reference:BinRef
domPKey  (fv:DomDef:domPKey)
           A privacy key for encapsulation.
fv:InstrImedcy
          scalar:Enum8
instrImedcy  (fv:DomDef:instrImedcy)
           The deployment immediacy preference.
address:Ip mcastAddr  (fv:DomDef:mcastAddr)
           null
vmm:Mode
          scalar:Enum8
mode  (fv:DomDef:mode)
           The BGP Domain mode.
reference:BinRef monPolDn  (fv:DomDef:monPolDn)
           The monitoring policy attached to this observable object.
fv:ResImedcy
          scalar:Enum8
resImedcy  (fv:DomDef:resImedcy)
           A property to specify whether policies are resolved immediately or when needed.
fv:SwitchingModeT
          scalar:Enum8
switchingMode  (fv:DomDef:switchingMode)
           NO COMMENTS
scalar:Uint64 updateTs  (fv:DomDef:updateTs)
           Update timestamp, the time when this instance is updated
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
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.
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





classPref

Type: fv:ClassPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Classification preference for this EPG within a domain encap: the class-id is dervied based on packet encapsulation (e.g Vlan/VxLAN id) useg: class-id is derived based on other useg/EPGs or dynamically learned mac address in VMM.
Constants
encap 0 Packet Encapsulation NO COMMENTS
useg 1 uSeg NO COMMENTS
DEFAULT encap(0) Packet Encapsulation NO COMMENTS





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.



domPKey

Type: fv:PrimKey
Primitive Type: reference:BinRef

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
A privacy key for encapsulation.



instrImedcy

Type: fv:InstrImedcy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The deployment immediacy preference.
Constants
immediate 1 Immediate NO COMMENTS
lazy 2 On Demand NO COMMENTS
DEFAULT lazy(2) On Demand NO 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





mcastAddr

Type: address:Ip

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



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





mode

Type: vmm:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP Domain mode.
Constants
default 0 Distributed Switch NO COMMENTS
n1kv 1 Cisco AVS NO COMMENTS
unknown 2 Unknown NO COMMENTS
ovs 3 Open vSwitch NO COMMENTS
k8s 4 Kubernetes NO COMMENTS
rhev 5 RHEV NO COMMENTS
cf 6 Cloud Foundry NO COMMENTS
openshift 7 OpenShift NO COMMENTS
DEFAULT default(0) Distributed Switch NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



resImedcy

Type: fv:ResImedcy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property to specify whether policies are resolved immediately or when needed.
Constants
immediate 1 Immediate NO COMMENTS
lazy 2 On Demand NO COMMENTS
pre-provision 3 Pre-provision NO COMMENTS
DEFAULT lazy(2) On Demand 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.






switchingMode

Type: fv:SwitchingModeT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
native 0 native NO COMMENTS
AVE 1 AVE NO COMMENTS
DEFAULT native(0) native NO COMMENTS





updateTs

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Update timestamp, the time when this instance is updated