Class coop:Dom (CONCRETE)

Class ID:2575
Class Label: COOP 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: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

Per COOP domain (vrf) information.

Naming Rules
RN FORMAT: dom-{name}

    [1] PREFIX=dom- PROPERTY = name




DN FORMAT: 

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

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

                


Diagram

Super Mo: l3:ProtDom,
Container Mos: coop:Inst (deletable:no),
Contained Mos: coop:CitizenAdj, coop:ConCitizenAdj, coop:Db, coop:DomAf, coop:OracleAdj, coop:RepP, coop:RibLeakP, coop:ShardSt, coop:TepDb,
Relations From: coop:BD,
Relations: coop:RtBD2Dom,


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] coop:Entity The COOP control plane entity information.
 
 
 
 
 
 ├
[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.
 
 
 
 
 
 
 ├
[V] coop:Dom Per COOP domain (vrf) 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] coop:Entity The COOP control plane entity information.
 
 
 ├
[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.
 
 
 
 ├
[V] coop:Dom Per COOP domain (vrf) information.


Contained Hierarchy
[V] coop:Dom Per COOP domain (vrf) information.
 ├
[V] coop:CitizenAdj The adjacency to the citizen node.
 ├
[V] coop:ConCitizenAdj  Adjacency to the citizen node(s) connected to this Oracle
 ├
[V] coop:Db An abstraction of the COOP database (repository).
 
 ├
[V] coop:CtxRec The context record.
 
 
 ├
[V] coop:RsCtx2Leaf A source relation to the COOP leaf records.
 
 ├
[V] coop:EpRec The endpoint records.
 
 
 ├
[V] coop:EpVpcRec The Endpoint Virtual Port Channel (VPC) citizen record.
 
 
 ├
[V] coop:Ipv4Rec The IPv4 entries in an endpoint record.
 
 
 ├
[V] coop:Ipv6Rec The IPv6 entries in the COOP endpoint record.
 
 
 ├
[V] coop:RtHBucket2EpRec  List of EP record collided onto this bucket
 
 ├
[V] coop:FabMcGrpv4Rec  Fabric IPv4 multicast group records
 
 
 ├
[V] coop:RsFabMcgrp2Leaf  List of interested leafs
 
 ├
[V] coop:IpOnlyRec 
 
 
 ├
[V] coop:RtHBucket2IpOnlyRec  List of IP only record collided onto this bucket
 
 ├
[V] coop:LeafRec The COOP leaf records.
 
 
 ├
[V] coop:RtCtx2Leaf A target relation to the COOP leaf records.
 
 
 ├
[V] coop:RtDTEp2Leaf  List of leafs publishing this DTEP
 
 
 ├
[V] coop:RtFabMcgrp2Leaf  List of interested leafs
 
 
 ├
[V] coop:RtMcgrp2Leaf A target relation to the COOP leaf records.
 
 
 ├
[V] coop:RtMrtr2Leaf A target relation to the COOP leaf records.
 
 ├
[V] coop:McGrpv4Rec The IPv4 multicast group records.
 
 
 ├
[V] coop:RsMcgrp2Leaf A source relation to the COOP leaf records.
 
 ├
[V] coop:McGrpv6Rec The IPv6 multicast group records.
 
 
 ├
[V] coop:RsMcgrp2Leaf A source relation to the COOP leaf records.
 
 ├
[V] coop:MrtrRec The Mrouter records.
 
 
 ├
[V] coop:RsMrtr2Leaf A source relation to the COOP leaf records.
 
 ├
[V] coop:VpcRec The Virtual Port Channel (VPC) records.
 
 
 ├
[V] coop:VpcNodeRec Per-node in the Virtual Port Channel (VPC) configuration record.
 ├
[V] coop:DomAf  This object holds per address family COOP information
 
 ├
[V] coop:ProxyAddr 
 
 ├
[V] coop:RibLeakP 
 ├
[V] coop:OracleAdj The adjacency to the Oracle node information.
 
 ├
[V] coop:ShardSt The COOP shard state.
 
 ├
[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] coop:RepP All the repository policies information.
 
 ├
[V] coop:Ep The COOP static endpoint.
 
 
 ├
[V] coop:IpAddr The IP entries in the static endpoint.
 
 ├
[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] coop:RibLeakP 
 ├
[V] coop:RtBD2Dom  List of VRFs for Host-Route to be leaked
 ├
[V] coop:ShardSt The COOP shard state.
 ├
[V] coop:TepDb  Abstraction of cooptep database (repository)
 
 ├
[V] coop:DTEp  Tunnel endpoints discovered through coop
 
 
 ├
[V] coop:RsDTEp2Leaf  List of leafs publishing this DTEP
 ├
[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)


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] coop:Dom Per COOP domain (vrf) information.


Events
                coop:Dom:coop_Dom_coopDomOperStChange


Faults
                coop:Dom:coopDomCitizenVersionLower
coop:Dom:coopDomInconsistentCfg
coop:Dom:coopDomOracleVersionLower
coop:Dom:coopDomVersionLower
coop:Dom:coopEpDampFreeze


Fsms
                


Properties Summary
Defined in: coop:Dom
address:Ip addr  (coop:Dom:addr)
           My address
coop:Version
          scalar:Enum8
councilMinMaxVersion  (coop:Dom:councilMinMaxVersion)
          
coop:Version
          scalar:Enum8
curVersion  (coop:Dom:curVersion)
          
coop:EPDampStatus
          scalar:Enum8
epDamp  (coop:Dom:epDamp)
           EP Dampening
coop:DomFlags
          scalar:Bitmask32
flags  (coop:Dom:flags)
           The IP address flags.
coop:DomHaveDampenedEps
          scalar:Enum8
haveDampenedEPs  (coop:Dom:haveDampenedEPs)
           Current Dampened EPs
coop:Timestamp
          scalar:Date
lastLowerTs  (coop:Dom:lastLowerTs)
          
coop:AdjAddr
          address:IPv4
lastLowerVersionAddr  (coop:Dom:lastLowerVersionAddr)
          
coop:Version
          scalar:Enum8
maxVersion  (coop:Dom:maxVersion)
          
coop:Version
          scalar:Enum8
minVersion  (coop:Dom:minVersion)
          
reference:BinRef monPolDn  (coop:Dom:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (coop:Dom:name)
           Overrides:nw:CpDom:name | nw:Conn:name
           null
coop:DomNoOfDampenedEps
          scalar:Uint32
noOfDampenedEPs  (coop:Dom:noOfDampenedEPs)
           Number of dampened EPs
coop:DomOperFlags
          scalar:Bitmask32
operFlags  (coop:Dom:operFlags)
           Operational state
coop:DomOperSt
          scalar:Enum8
operSt  (coop:Dom:operSt)
          
coop:DomOperStQual
          scalar:Enum8
operStQual  (coop:Dom:operStQual)
          
rtmap:RouteTag
          scalar:Uint32
routeTag  (coop:Dom:routeTag)
           Route Tag for Host Routes
coop:Vnid
          scalar:Uint32
vnid  (coop:Dom:vnid)
           The virtual network ID of the object (VRF, bridge domain, or layer 3 context).
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

addr

Type: address:Ip

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



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





councilMinMaxVersion

Type: coop:Version
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unknown 0 unknown NO COMMENTS
v1 1 v1 NO COMMENTS
v2 2 v2 NO COMMENTS
DEFAULT unknown(0) unknown NO COMMENTS





curVersion

Type: coop:Version
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unknown 0 unknown NO COMMENTS
v1 1 v1 NO COMMENTS
v2 2 v2 NO COMMENTS
DEFAULT unknown(0) unknown 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.



epDamp

Type: coop:EPDampStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
EP Dampening
Constants
disabled 0 Disabled Disabled
enabled 1 Enabled Enabled
DEFAULT enabled(1) Enabled Enabled





flags

Type: coop:DomFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
host-route 1u host-route IP Generated
DEFAULT 0 --- DomFlags





haveDampenedEPs

Type: coop:DomHaveDampenedEps
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Current Dampened EPs
Constants
no 0 No No
yes 1 Yes Yes
DEFAULT no(0) No No





lastLowerTs

Type: coop:Timestamp
Primitive Type: scalar:Date

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



lastLowerVersionAddr

Type: coop:AdjAddr
Primitive Type: address:IPv4

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





maxVersion

Type: coop:Version
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unknown 0 unknown NO COMMENTS
v1 1 v1 NO COMMENTS
v2 2 v2 NO COMMENTS
DEFAULT unknown(0) unknown NO COMMENTS





minVersion

Type: coop:Version
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unknown 0 unknown NO COMMENTS
v1 1 v1 NO COMMENTS
v2 2 v2 NO COMMENTS
DEFAULT unknown(0) unknown 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:
The monitoring policy attached to this observable object.



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:
null



noOfDampenedEPs

Type: coop:DomNoOfDampenedEps
Primitive Type: scalar:Uint32

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





operFlags

Type: coop:DomOperFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state
Constants
sync-done 1u Is initial sync done NO COMMENTS
DEFAULT 0 --- DomFlags





operSt

Type: coop:DomOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
down 0 Down Down
init 1 Initializing Initializing
up 2 Up Up
DEFAULT down(0) Down Down





operStQual

Type: coop:DomOperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unspecified 0 Unspecified Unspecified
config-unresolved 1 Configuration not resolved config unresolved
time-not-synced 2 Time not synced time not synced
infra-dom-down 3 Infra domain down Infra domain is down
council-pending 4 Council pending council pending
inconsistent-config 5 Inconsistent configuration Inconsitent configuration in the council
admin-down 6 Admin down Administratively down
up 7 Up Up
DEFAULT unspecified(0) Unspecified Unspecified





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.



routeTag

Type: rtmap:RouteTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Route Tag for Host Routes



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.






vnid

Type: coop:Vnid
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The virtual network ID of the object (VRF, bridge domain, or layer 3 context).
Constants
defaultValue 1u --- NO COMMENTS