Class coop:Inst (CONCRETE)

Class ID:2599
Class Label: COOP Instance
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
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: false, HasHealth: true, HasEventRules: true ]

The per-COOP instance information. There is only one instance of this object present in the system.

Naming Rules
RN FORMAT: inst

    [1] PREFIX=inst


DN FORMAT: 

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

[1] sys/coop/inst

                


Diagram

Super Mo: l3:ProtInst,
Container Mos: coop:Entity (deletable:no),
Contained Mos: coop:AuthP, coop:Dom,


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] 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.


Contained Hierarchy
[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.
 ├
[V] coop:AuthP  This object holds authentication policy information
 
 ├
[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:Dom Per COOP domain (vrf) information.
 
 ├
[V] coop:CitizenAdj The adjacency to the citizen node.
 
 ├
[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:FabMcGrpv4Rec  Fabric IPv4 multicast group records
 
 
 
 ├
[V] coop:RsMcgrp2Leaf A source relation to the COOP leaf records.
 
 
 ├
[V] coop:IpOnlyRec 
 
 
 ├
[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: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: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] 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: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] health:Inst A base class for a health score instance.(Switch only)
 ├
[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] 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:CpInst A control plane instance abstraction. This object represents an instance of the protocol. For example, the protocol instance of OSPF or ISIS.
 
 
 
 ├
[V] nw:ProtInst A protocol instance abstraction.
 
 
 
 
 ├
[V] l3:ProtInst A layer 3 protocol instance abstraction.
 
 
 
 
 
 ├
[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.


Events
                coop:Inst:coop_Inst_operErr
coop:Inst:coop_Inst_adminStChange


Faults
                


Fsms
                


Properties Summary
Defined in: coop:Inst
reference:BinRef monPolDn  (coop:Inst:monPolDn)
           The monitoring policy attached to this observable object.
coop:Role
          scalar:Enum8
role  (coop:Inst:role)
           The COOP instance role. Role (oracle/citizen) Leafs are citizens, Spines are Oracles.
Defined in: nw:CpInst
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpInst:adminSt)
           The administrative state of the object or policy.
nw:InstCtrl
          scalar:Bitmask64
ctrl  (nw:CpInst:ctrl)
           The control state.
naming:Name
          string:Basic
name  (nw:CpInst:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpInst:operErr)
          
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





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: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
stateful-ha 1ull stateful-ha Enable stateful HA
DEFAULT 0 --- Instance 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





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:Conn:name
Units: null Encrypted: false Access: create Category: TopLevelRegular
    Comments:
The name of the object.



operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





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.



role

Type: coop:Role
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The COOP instance role. Role (oracle/citizen) Leafs are citizens, Spines are Oracles.
Constants
citizen 1 Citizen Citizen
oracle 2 Oracle Oracle
DEFAULT citizen(1) Citizen Citizen





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.