Class vmm:EventRecord (CONCRETE)

Class ID:2128
Class Label: VMM Controller Events
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: 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 ]

A config object that is not persisted and is used to send messages from a worker thread to a doer.

Naming Rules
RN FORMAT: evtRec

    [1] PREFIX=evtRec


DN FORMAT: 

                


Diagram

Super Mo: comp:Element,


Containers Hierarchies


Contained Hierarchy
[V] vmm:EventRecord A config object that is not persisted and is used to send messages from a worker thread to a doer.


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:EventRecord A config object that is not persisted and is used to send messages from a worker thread to a doer.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vmm:EventRecord
vmm:EventId
          scalar:Uint32
chainId  (vmm:EventRecord:chainId)
          
reference:BinRef ctrlrDn  (vmm:EventRecord:ctrlrDn)
           Dn of CtrlrMo that is associated with the event
vmm:EventCollectorId
          scalar:Enum8
eventCollectorId  (vmm:EventRecord:eventCollectorId)
           Id of the Event Collector that received this event
string:Basic eventDescr  (vmm:EventRecord:eventDescr)
           Event description String as received from Vcenter/Controller
vmm:EventId
          scalar:Uint32
eventId  (vmm:EventRecord:eventId)
           Event ID reported by external Controller like Vcenter
vmm:EventTs
          scalar:Sint64
eventRcvdTs  (vmm:EventRecord:eventRcvdTs)
           Event Received TimeStamp when processed by IFC
vmm:EventTs
          scalar:Sint64
eventTs  (vmm:EventRecord:eventTs)
           Event TimeStamp reported by external Controller like Vcenter
scalar:Uint32 eventType  (vmm:EventRecord:eventType)
           Event Type as received from Vcenter/Controller
scalar:Bool fromEvent  (vmm:EventRecord:fromEvent)
           Flag to indicate that it is recvd from Event Thread as an External Event
scalar:Bool fromMO  (vmm:EventRecord:fromMO)
           Flag to indicate that it is done being processed as Mo Update via postConfigCb or replExplicitCb
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
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: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

chainId

Type: vmm:EventId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    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





ctrlrDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Dn of CtrlrMo that is associated with the event



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.



eventCollectorId

Type: vmm:EventCollectorId
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Id of the Event Collector that received this event
Constants
datacenter 0 Datacenter Event Collector NO COMMENTS
global 1 Global Event Collector NO COMMENTS
count 2 Number of Event Collectors Always make "count" enum the last
DEFAULT datacenter(0) Datacenter Event Collector NO COMMENTS





eventDescr

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Event description String as received from Vcenter/Controller



eventId

Type: vmm:EventId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Event ID reported by external Controller like Vcenter



eventRcvdTs

Type: vmm:EventTs
Primitive Type: scalar:Sint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Event Received TimeStamp when processed by IFC



eventTs

Type: vmm:EventTs
Primitive Type: scalar:Sint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Event TimeStamp reported by external Controller like Vcenter



eventType

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Event Type as received from Vcenter/Controller



fromEvent

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Flag to indicate that it is recvd from Event Thread as an External Event
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





fromMO

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Flag to indicate that it is done being processed as Mo Update via postConfigCb or replExplicitCb
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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
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 NO COMMENTS
lnode-property-fault 0x1ull Failed to get DVS 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
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
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



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.