Class mcp:InstPol (CONCRETE)

Class ID:5718
Class Label: Mis-cabling Protocol Instance Policy
Encrypted: true - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [access-connectivity-l1, admin, fabric-protocol-l1]
Read Access: [access-connectivity-l1, access-protocol-l2, admin, fabric-protocol-l1, fabric-protocol-l2, tenant-ext-protocol-l2, tenant-protocol-l2]
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 ]



Naming Rules
RN FORMAT: mcpInstP-{name}

    [1] PREFIX=mcpInstP- PROPERTY = name




DN FORMAT: 

[1] uni/infra/mcpInstP-{name}

                


Diagram

Super Mo: fabric:L2InstPol,
Container Mos: infra:Infra (deletable:no),
Relations From: mcp:Inst, top:System, infra:SubsDfltPolicy,
Relations: mcp:RtMcpInstPolCons, mcp:RtResMcpInstPol, mcp:RtSysMcpInstPolCons, mcp:RtToMcpInstPol,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] infra:Infra A container for all tenant infra configurations.
 
 
 
 
 
 
 
 ├
[V] mcp:InstPol 
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] infra:Infra A container for all tenant infra configurations.
 
 
 ├
[V] mcp:InstPol 


Contained Hierarchy
[V] mcp:InstPol 
 ├
[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] mcp:RtMcpInstPolCons 
 ├
[V] mcp:RtResMcpInstPol 
 ├
[V] mcp:RtSysMcpInstPolCons  Relationship with the mcp instance policy consumed by this node
 ├
[V] mcp:RtToMcpInstPol 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] fabric:ProtoPol A base class for protocol policies.
 
 
 
 ├
[V] fabric:ProtoInstPol A base class for instance-level protocol policies.
 
 
 
 
 ├
[V] fabric:L2InstPol A base class for layer 2 interface-level policies.
 
 
 
 
 
 ├
[V] mcp:InstPol 


Events
                mcp:InstPol:creation__mcp_InstPol
mcp:InstPol:modification__mcp_InstPol
mcp:InstPol:deletion__mcp_InstPol


Faults
                


Fsms
                


Properties Summary
Defined in: mcp:InstPol
nw:AdminSt
          scalar:Enum8
adminSt  (mcp:InstPol:adminSt)
           The administrative state of the object or policy.
nw:InstCtrl
          scalar:Bitmask64
ctrl  (mcp:InstPol:ctrl)
           The control state.
mcp:InitDelayTime
          scalar:Uint16
initDelayTime  (mcp:InstPol:initDelayTime)
          
string:Password key  (mcp:InstPol:key)
           The key or password used to uniquely identify this configuration object.
mcp:LoopDetectMult
          scalar:UByte
loopDetectMult  (mcp:InstPol:loopDetectMult)
          
mcp:LoopProtectAct
          scalar:Bitmask8
loopProtectAct  (mcp:InstPol:loopProtectAct)
          
naming:Name
          string:Basic
name  (mcp:InstPol:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
mcp:TxFreq
          scalar:Uint16
txFreq  (mcp:InstPol:txFreq)
           Sets the transmission frequency of the instance advertisements.
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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: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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Like: mcp:Inst:adminSt
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The administrative state of the object or policy.
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: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Like: mcp:Inst:ctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The control state.
Constants
stateful-ha 1ull stateful-ha NO COMMENTS
pdu-per-vlan 256ull Enable MCP PDU per VLAN Enable sending of MCP PDU per vlan on a port
DEFAULT 0 --- Instance controls





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



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.



initDelayTime

Type: mcp:InitDelayTime
Primitive Type: scalar:Uint16

Like: mcp:Inst:initDelayTime
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 1800
    Comments:
Constants
defaultValue 180 --- NO COMMENTS





key

Type: string:Password

Like: mcp:Inst:key
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The key or password used to uniquely identify this configuration object.



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





loopDetectMult

Type: mcp:LoopDetectMult
Primitive Type: scalar:UByte

Like: mcp:Inst:loopDetectMult
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)1  max: (short)255
    Comments:
Constants
defaultValue 3 --- NO COMMENTS





loopProtectAct

Type: mcp:LoopProtectAct
Primitive Type: scalar:Bitmask8

Like: mcp:Inst:loopProtectAct
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
port-disable 1 Port Disable Port disable
DEFAULT port-disable(1) Port Disable Port disable





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:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



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.






txFreq

Type: mcp:TxFreq
Primitive Type: scalar:Uint16

Like: mcp:Inst:txFreq
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 2  max: 300
    Comments:
Sets the transmission frequency of the instance advertisements.
Constants
defaultValue 2 --- NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.