Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class fabrgm:Dom (CONCRETE)

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

This objects hold per fabrgm domain information

Naming Rules 
RN FORMAT: dom-{name}

    [1] PREFIX=dom- PROPERTY = name




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/fabrgm/inst/dom-{name}

[1] sys/fabrgm/inst/dom-{name}


Diagram

Super Mo: l3:ProtDom,
Container Mos: fabrgm:Inst (deletable:no),
Contained Mos: fabrgm:Db, fabrgm:DomInfo,


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] fabrgm:Entity  Holds fabric routed multicast group manager entity information
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fabrgm:Inst  This objects hold per fabrgm instance information. There is only one instance of fabrgm running in the system today
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fabrgm:Dom  This objects hold per fabrgm domain information
[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] fabrgm:Entity  Holds fabric routed multicast group manager entity information
 
 		 
 		 ├
 		[V] fabrgm:Inst  This objects hold per fabrgm instance information. There is only one instance of fabrgm running in the system today
 
 		 
 		 
 		 ├
 		[V] fabrgm:Dom  This objects hold per fabrgm domain information


Contained Hierarchy
[V] fabrgm:Dom  This objects hold per fabrgm domain information
 ├
 		[V] fabrgm:Db  fabrgm databases
 
 		 ├
 		[V] fabrgm:Route 
 ├
 		[V] fabrgm:DomInfo 


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.
 
 		 
 		 
 		 ├
 		[V] nw:ProtDom A protocol domain abstraction.
 
 		 
 		 
 		 
 		 ├
 		[V] l3:ProtDom A layer 3 protocol domain abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] fabrgm:Dom  This objects hold per fabrgm domain information


Events


Faults


Fsms


Properties Summary
Defined in: fabrgm:Dom
nw:AdminSt
          scalar:Enum8 		adminSt  (fabrgm:Dom:adminSt)
           Admin State
fabrgm:DomCtrl
          scalar:Bitmask16 		ctrl  (fabrgm:Dom:ctrl)
           Per-Dom Controls
naming:Name
          string:Basic 		name  (fabrgm:Dom:name)
           Overrides:nw:CpDom:name | nw:Conn:name
          
fabrgm:DomCtrl
          scalar:Bitmask16 		v6Ctrl  (fabrgm:Dom:v6Ctrl)
           Per-Dom Controls for ipv6
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

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Admin State
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT disabled(2) Disabled Disabled




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: fabrgm:DomCtrl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Per-Dom Controls
Constants
fab-import 1 Import Fabric Groups Import fabric groups Enabled when this is a border leaf configured with PIM
fast-conv 2 Fast Convergence Fast Convergence Attract external traffic to border leaf, but do not forward to the fabric. In case of border leaf reboots, traffic can be quickly put onto the fabric to reduce multicast traffic loss duration
active 4 Address family active Active address family Since we support both ipv4 and ipv6 address families on the same Dom, this type will be used to differentiate which address family is active in the backend
DEFAULT 0 --- Domain Controls




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.


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




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:CpDom:name  |  nw:Conn:name

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.


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.





v6Ctrl

Type: fabrgm:DomCtrl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Per-Dom Controls for ipv6
Constants
fab-import 1 Import Fabric Groups Import fabric groups Enabled when this is a border leaf configured with PIM
fast-conv 2 Fast Convergence Fast Convergence Attract external traffic to border leaf, but do not forward to the fabric. In case of border leaf reboots, traffic can be quickly put onto the fabric to reduce multicast traffic loss duration
active 4 Address family active Active address family Since we support both ipv4 and ipv6 address families on the same Dom, this type will be used to differentiate which address family is active in the backend
DEFAULT 0 --- Domain Controls






Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail