Class topoctrl:EndpointDebugControlP (CONCRETE)

Class ID:12982
Class Label: Endpoint Debug Control Policy
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: [admin, fabric-connectivity]
Creatable/Deletable: yes (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 ]

Endpoint debug control policy

Naming Rules
RN FORMAT: epdbgcontrolp

    [1] PREFIX=epdbgcontrolp


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/topoctrl/epdbgcontrolp

[1] sys/topoctrl/epdbgcontrolp

                


Diagram

Super Mo: pol:Instr,
Container Mos: topoctrl:Entity (deletable:yes),


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] topoctrl:Entity A container for the topology control policy.
 
 
 
 
 
 ├
[V] topoctrl:EndpointDebugControlP  Endpoint debug control policy
[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] topoctrl:Entity A container for the topology control policy.
 
 
 ├
[V] topoctrl:EndpointDebugControlP  Endpoint debug control policy


Contained Hierarchy
[V] topoctrl:EndpointDebugControlP  Endpoint debug control policy
 ├
[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.


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:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] topoctrl:EndpointDebugControlP  Endpoint debug control policy


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: topoctrl:EndpointDebugControlP
topoctrl:announceFlushType
          scalar:Enum8
announceFlush  (topoctrl:EndpointDebugControlP:announceFlush)
           Enable/disable announce flush mode
topoctrl:batchEpReqTimerType
          scalar:Uint32
batchEpReqTimer  (topoctrl:EndpointDebugControlP:batchEpReqTimer)
           Timer duration in msec to batch EP requests to EPM
topoctrl:coopBatchDurationType
          scalar:Uint32
coopBatchDuration  (topoctrl:EndpointDebugControlP:coopBatchDuration)
           Time duration to wait for batching EPM COOP update
topoctrl:maxBatchEpReqType
          scalar:Uint32
maxBatchEpReq  (topoctrl:EndpointDebugControlP:maxBatchEpReq)
           Maximum number of EP requests to batch
topoctrl:maxIpPerEPType
          scalar:Uint32
maxIPPerEP  (topoctrl:EndpointDebugControlP:maxIPPerEP)
           MAX IPs per MAC
topoctrl:minIPsCoopBatchType
          scalar:Uint32
minIPsCoopBatch  (topoctrl:EndpointDebugControlP:minIPsCoopBatch)
           Minimum number of IPs per EP for batching EPM updates to COOP
topoctrl:minIPsCoopLBType
          scalar:Uint16
minIPsCoopLB  (topoctrl:EndpointDebugControlP:minIPsCoopLB)
           Minimum IPs per vPC EP before COOP requests load balanced
topoctrl:rlDirectAnnounceModeType
          scalar:Enum8
rlDirectAnnounceMode  (topoctrl:EndpointDebugControlP:rlDirectAnnounceMode)
           RL Direct announce mode
topoctrl:rogueModeActionType
          scalar:Enum8
rogueModeAction  (topoctrl:EndpointDebugControlP:rogueModeAction)
           Setup rogue mode
Defined in: pol:Instr
naming:Descr
          string:Basic
descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
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: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

announceFlush

Type: topoctrl:announceFlushType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Enable/disable announce flush mode
Constants
announce-disable 0 Announce Disable Announce Disable
announce-leaf 1 Announce Leaf Announce from leaf
announce-spine 2 Announce Spine Announce from spine
DEFAULT announce-spine(2) Announce Spine Announce from spine





batchEpReqTimer

Type: topoctrl:batchEpReqTimerType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Timer duration in msec to batch EP requests to EPM
Constants
defaultValue 50u --- NO COMMENTS





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





coopBatchDuration

Type: topoctrl:coopBatchDurationType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Time duration to wait for batching EPM COOP update
Constants
defaultValue 100u --- NO COMMENTS





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.



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





maxBatchEpReq

Type: topoctrl:maxBatchEpReqType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Maximum number of EP requests to batch
Constants
defaultValue 25u --- NO COMMENTS





maxIPPerEP

Type: topoctrl:maxIpPerEPType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
MAX IPs per MAC
Constants
max-ip-1k 1024u MAX 1K IPs per MAC NO COMMENTS
max-ip-4k 4096u MAX 4K IPs per MAC 4K IPs per MAC
DEFAULT max-ip-4k(4096u) MAX 4K IPs per MAC 4K IPs per MAC





minIPsCoopBatch

Type: topoctrl:minIPsCoopBatchType
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Minimum number of IPs per EP for batching EPM updates to COOP
Constants
defaultValue 32u --- NO COMMENTS





minIPsCoopLB

Type: topoctrl:minIPsCoopLBType
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Minimum IPs per vPC EP before COOP requests load balanced
Constants
defaultValue 0 --- 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:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



rlDirectAnnounceMode

Type: topoctrl:rlDirectAnnounceModeType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
RL Direct announce mode
Constants
announce-disable 0 Announce Disable Announce Disable
announce-data-path-add 1 Announce Data Path Add Announce Data Path Add
announce-control-path-delete 2 Announce Control Path Delete Announce Control Path Delete
DEFAULT announce-data-path-add(1) Announce Data Path Add Announce Data Path Add





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.



rogueModeAction

Type: topoctrl:rogueModeActionType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Setup rogue mode
Constants
quarantine-and-fault 0 Quarantine and Fault Rogue EP quarantine and fault Rogue EP
quarantine-fault-and-drop 1 Quarantine, fault Rogue EP and drop traffic quarantine, fault Rogue EP and drop traffic
DEFAULT quarantine-and-fault(0) Quarantine and Fault Rogue EP quarantine and fault Rogue EP





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.