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

Class ads:Ctxt (CONCRETE)

Class ID:12629
Class Label: ads Context
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]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Context used to carry information from ads Doer to Worker

Naming Rules 
RN FORMAT: ctxt

    [1] PREFIX=ctxt


DN FORMAT:


Diagram

Super Mo: adepg:Entity,


Containers Hierarchies


Contained Hierarchy
[V] ads:Ctxt  Context used to carry information from ads Doer to Worker


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 		 ├
 		[V] adepg:Entity 
 
 		 
 		 ├
 		[V] ads:Ctxt  Context used to carry information from ads Doer to Worker


Events


Faults


Fsms


Properties Summary
Defined in: ads:Ctxt
reference:BinRef ctrlrDn  (ads:Ctxt:ctrlrDn)
           Identifies the dynamic naming string of the controller object.For internal use only.
mo:ReplicaId
          scalar:UByte 		replicaId  (ads:Ctxt:replicaId)
           A replica identifier used internally to identify the replica this controller object belongs to.
ads:RunId
          scalar:Uint32 		runId  (ads:Ctxt:runId)
           An internal ID that identifies the run instance of the task.
mo:ShardId
          scalar:UByte 		shardId  (ads:Ctxt:shardId)
           The shard from which the export job was executed.
reference:BinRef trigDn  (ads:Ctxt:trigDn)
           The distinguished name of the task or a finite state machine object.
ads:TrigId
          scalar:Uint32 		trigId  (ads:Ctxt:trigId)
           An instance ID of the task or finite state machine object
ads:TrigT
          scalar:Enum8 		trigT  (ads:Ctxt:trigT)
           The type of trigger (task or finite state machine) that started the Stimulus.
Defined in: adepg:Entity
naming:Descr
          string:Basic 		descr  (adepg:Entity:descr)
           The description of this configuration item.
naming:Id
          scalar:Uint64 		id  (adepg:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           An object identifier.
adepg:Issues
          scalar:Bitmask64 		issues  (adepg:Entity:issues)
           General Issues It captures various issues happened to the Entity.
naming:Name
          string:Basic 		name  (adepg:Entity:name)
           Overrides:naming:NamedObject:name
           The name of the object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
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

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




ctrlrDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Identifies the dynamic naming string of the controller object.For internal use only.


descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The description of this configuration item.


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.


id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An object identifier.


issues

Type: adepg:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
connection-fault 0x1ull Failed to connect to external Identity server NO COMMENTS
DEFAULT none(0x0ull) None NO 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




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: implicit
Category: TopLevelRegular
    Comments:
The name of the object.


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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


replicaId

Type: mo:ReplicaId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A replica identifier used internally to identify the replica this controller object belongs to.
Constants
undefined 0 Undefined NO COMMENTS
local 127 Local NO COMMENTS
DEFAULT undefined(0) Undefined NO 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.


runId

Type: ads:RunId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An internal ID that identifies the run instance of the task.


shardId

Type: mo:ShardId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The shard from which the export job was executed.
Constants
undefined 0 Undefined NO COMMENTS
local 255 Local NO COMMENTS
DEFAULT undefined(0) Undefined NO COMMENTS




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.





trigDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The distinguished name of the task or a finite state machine object.


trigId

Type: ads:TrigId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An instance ID of the task or finite state machine object


trigT

Type: ads:TrigT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type of trigger (task or finite state machine) that started the Stimulus.
Constants
none 0 none NO COMMENTS
task 1 task NO COMMENTS
fsm 2 fsm NO COMMENTS
DEFAULT none(0) none NO COMMENTS






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