Class vmm:Ctxt (CONCRETE)

Class ID:2129
Class Label: VMM 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 ]

This object is generated and used only by internal processes.

Naming Rules
RN FORMAT: ctxt

    [1] PREFIX=ctxt


DN FORMAT: 

                


Diagram

Super Mo: comp:Element,


Containers Hierarchies


Contained Hierarchy
[V] vmm:Ctxt This object is generated and used only by internal processes.


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] comp:Entity An abstract based class representing a compute entity.
 
 
 ├
[V] comp:Element An abstract base class representing a physical, virtual or logical compute element.
 
 
 
 ├
[V] vmm:Ctxt This object is generated and used only by internal processes.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vmm:Ctxt
reference:BinRef ctrlrDn  (vmm:Ctxt:ctrlrDn)
           Dn of the Ctrlr
condition:ErrCode
          scalar:Uint32
errCode  (vmm:Ctxt:errCode)
           NO COMMENTS
mo:ReplicaId
          scalar:UByte
replicaId  (vmm:Ctxt:replicaId)
           ReplicaId of the Ctrlr
vmm:RunId
          scalar:Uint32
runId  (vmm:Ctxt:runId)
           An internal ID that identifies the run instance of the task.
mo:ShardId
          scalar:UByte
shardId  (vmm:Ctxt:shardId)
           ShardId of the Ctrlr
reference:BinRef trigDn  (vmm:Ctxt:trigDn)
           Trigger Dn
vmm:TrigId
          scalar:Uint32
trigId  (vmm:Ctxt:trigId)
           null
vmm:TrigT
          scalar:Enum8
trigT  (vmm:Ctxt:trigT)
           Information about the Trigger which started the Stimulus
Defined in: comp:Element
comp:Guid
          string:Basic
guid  (comp:Element:guid)
           Globally Unique Identifier (GUID)
comp:Oid
          string:Basic
oid  (comp:Element:oid)
           OID
comp:Uuid
          string:Basic
uuid  (comp:Element:uuid)
           The endpoint UUID.
Defined in: comp:Entity
naming:Descr
          string:Basic
descr  (comp:Entity:descr)
           Additional descriptive information about the object.
naming:Id
          scalar:Uint64
id  (comp:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           ID
comp:Issues
          scalar:Bitmask64
issues  (comp:Entity:issues)
           General Issues It captures various issues happened to the Entity.
naming:Name
          string:Basic
name  (comp:Entity:name)
           Overrides:naming:NamedObject:name
           Name
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:
Dn of the Ctrlr



descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Additional descriptive information about the object.



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.



errCode

Type: condition:ErrCode
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
none 0u none SUCCESS
ERR-MO-illegal-iterator-state 1100u --- NO COMMENTS
ERR-MO-illegal-object-lifecycle-transition 1101u --- NO COMMENTS
ERR-MO-object-not-found 1102u --- NO COMMENTS
ERR-MO-duplicate-object 1103u --- NO COMMENTS
ERR-MO-naming-rule-violation 1104u --- NO COMMENTS
ERR-MO-illegal-creation 1105u --- NO COMMENTS
ERR-MO-illegal-containment 1106u --- NO COMMENTS
ERR-MO-deletion-rule-violation 1107u --- NO COMMENTS
ERR-MO-PROPERTY-value-out-of-range 1120u --- NO COMMENTS
ERR-MO-PROPERTY-no-such-property 1121u --- NO COMMENTS
ERR-MO-META-no-such-object-class 1122u --- NO COMMENTS
ERR-MO-CONFIG-child-object-cant-be-configured 1130u --- NO COMMENTS
ERR-FILTER-illegal-format 1140u --- NO COMMENTS
ERR-MO-resource-allocation 1150u --- NO COMMENTS
ERR-FSM-no-such-state 1160u --- NO COMMENTS
ERR-MO-access-denied 1170u --- NO COMMENTS
ERR-radius-group-set-error 1501u --- NO COMMENTS
ERR-ldap-group-set-error 1502u --- NO COMMENTS
ERR-tacacs-group-set-error 1503u --- NO COMMENTS
ERR-radius-set-error 1504u --- NO COMMENTS
ERR-radius-global-set-error 1505u --- NO COMMENTS
ERR-tacacs-set-error 1506u --- NO COMMENTS
ERR-tacacs-global-set-error 1507u --- NO COMMENTS
ERR-tacacs-enable-error 1508u --- NO COMMENTS
ERR-ldap-get-error 1509u --- NO COMMENTS
ERR-ldap-delete-error 1510u --- NO COMMENTS
ERR-ldap-set-error 1511u --- NO COMMENTS
ERR-provider-group-set-error 1512u --- NO COMMENTS
ERR-acct-realm-set-error 1513u --- NO COMMENTS
ERR-auth-realm-set-error 1514u --- NO COMMENTS
ERR-role-set-error 1515u --- NO COMMENTS
ERR-user-set-error 1517u --- NO COMMENTS
ERR-ldap-group-modify-error 1518u --- NO COMMENTS
ERR-provider-group-modify-error 1519u --- NO COMMENTS
ERR-aaa-config-modify-error 1520u --- NO COMMENTS
ERR-store-pre-login-banner-msg 1521u --- NO COMMENTS
ERR-admin-passwd-set 1522u --- NO COMMENTS
ERR-delete-user 1523u --- NO COMMENTS
ERR-create-user 1524u --- NO COMMENTS
ERR-modify-user 1525u --- NO COMMENTS
ERR-create-role 1526u --- NO COMMENTS
ERR-modify-role 1527u --- NO COMMENTS
ERR-delete-role 1528u --- NO COMMENTS
ERR-modify-user-role 1532u --- NO COMMENTS
ERR-authentication 1534u --- NO COMMENTS
ERR-authorization-required 1535u --- NO COMMENTS
ERR-user-account-expired 1536u --- NO COMMENTS
ERR-service-not-ready 1539u --- NO COMMENTS
ERR-internal-error 1540u --- NO COMMENTS
ERR-set-password-strength-check 1543u --- NO COMMENTS
ERR-request-timeout 1545u --- NO COMMENTS
ERR-missing-method 1546u --- NO COMMENTS
ERR-xml-parse-error 1547u --- NO COMMENTS
ERR-auth-issue 1548u --- NO COMMENTS
ERR-http-initializing 1549u --- NO COMMENTS
ERR-secondary-node 1550u --- NO COMMENTS
ERR-HTTP-set-error 1551u --- NO COMMENTS
ERR-HTTPS-set-error 1552u --- NO COMMENTS
ERR-create-keyring 1560u --- NO COMMENTS
ERR-domain-set-error 1561u --- NO COMMENTS
ERR-create-domain 1562u --- NO COMMENTS
ERR-modify-domain 1563u --- NO COMMENTS
ERR-delete-domain 1564u --- NO COMMENTS
ERR-modify-user-domain 1565u --- NO COMMENTS
ERR-passwd-set-failure 1566u --- NO COMMENTS
ERR-modify-ctrlr-access 1567u --- NO COMMENTS
ERR-incompat-ctrlr-version 1568u --- NO COMMENTS
ERR-invalid-args 1569u --- NO COMMENTS
ERR-no-buf 1570u --- NO COMMENTS
ERR-api 1571u --- NO COMMENTS
ERR-connect 1572u --- NO COMMENTS
ERR-modify-ctrlr-scope 1573u --- NO COMMENTS
ERR-add-ctrlr 1574u --- NO COMMENTS
ERR-modify-ctrlr-rootcont 1575u --- NO COMMENTS
ERR-modify-ctrlr-dvs-version 1576u --- NO COMMENTS
ERR-modify-ctrlr-trig-inventory 1577u --- NO COMMENTS
ERR-modify-domain-enfpref 1578u --- NO COMMENTS
ERR-modify-domain-mcastpool 1579u --- NO COMMENTS
ERR-modify-domain-mode 1580u --- NO COMMENTS
ERR-modify-domain-encapmode 1581u --- NO COMMENTS
ERR-invalid-domain-name 1582u --- NO COMMENTS
ERR-modify-domain-prefencapmode 1584u --- NO COMMENTS
ERR-rsa-group-set-error 1585u --- NO COMMENTS
ERR-rsa-set-error 1586u --- NO COMMENTS
ERR-rsa-global-set-error 1587u --- NO COMMENTS
ERR-invalid-domain 1588u --- NO COMMENTS
ERR-invalid-delimiter 1589u --- NO COMMENTS
communication-error 1u communication-error FAILED TO DELIVER
DEFAULT 0 --- NO COMMENTS





guid

Type: comp:Guid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Globally Unique Identifier (GUID)



id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
ID



issues

Type: comp: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
tagging-cat-fault 0x10000ull Failed to retrieve all Tag Category information NO COMMENTS
ds-update-fault 0x1000ull Failed to update DS(Data Store) property NO COMMENTS
hv-miss-vmknic-fault 0x100ull ESX Host does not have any vmknic NO COMMENTS
vnic-miss-epg-fault 0x10ull VNIC is attached to an invalid DVS Port Group or unable to communicate with vCenter NO COMMENTS
lnode-property-fault 0x1ull Failed to get DVS property NO COMMENTS
prep-iso-file-fault 0x20000ull Failed to prepare or push iso file for service vm deployment. Please check if correct datastore is selected in policy. NO COMMENTS
rp-update-fault 0x2000ull Failed to update RP(Resource Pool) property NO COMMENTS
mgmtnic-miss-dvs-fault 0x200ull VMK Nic is configured with invalid DVS NO COMMENTS
hpnic-miss-epg-fault 0x20ull HpNIC is attached to an invalid uplink DVS Port Group NO COMMENTS
hv-update-fault 0x2ull Failed to update Hv(ESX Host) property NO COMMENTS
vmfolder-update-fault 0x40000ull Failed to update VM(Virtual Machine) Folder property NO COMMENTS
opflex-channels-down-ave 0x4000ull Both the opflex channels are down for AVE. Please check the connections on the host. NO COMMENTS
hv-miss-pnic-fault 0x400ull ESX Host does not have any pnic NO COMMENTS
hv-miss-dvs-fault 0x40ull ESX Host is configured with invalid DVS NO COMMENTS
vm-update-fault 0x4ull Failed to update VM(Virtual Machine) property NO COMMENTS
tagging-tag-fault 0x8000ull Failed to retrieve all Tag information NO COMMENTS
vm-deploy-task-fault 0x800ull deployVm task failed on vcenter NO COMMENTS
hv-disconnect-fault 0x80ull ESX Host is disconnected or not responding NO COMMENTS
vm-miss-hv-fault 0x8ull VM is attached to an invalid Hv(ESX Host) 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:
Name



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



oid

Type: comp:Oid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
OID



replicaId

Type: mo:ReplicaId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
ReplicaId of the Ctrlr
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: vmm: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:
ShardId of the Ctrlr
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:
Trigger Dn



trigId

Type: vmm:TrigId
Primitive Type: scalar:Uint32

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



trigT

Type: vmm:TrigT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Information about the Trigger which 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





uuid

Type: comp:Uuid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The endpoint UUID.