EventDescriptionEventDetail

EventDescriptionEventDetail

Each Event object provides an automatic event message string through its fullFormattedMessage property.

However, you can use the EventDetail object's properties to format an event message string that is appropriate when viewed from a specific context. The variable information (vm.name, and so on) is derived from the Event object's event arguments (VmEventArgument, and so on).

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "key": "string",
    "description": "string",
    "category": "string",
    "formatOnDatacenter": "string",
    "formatOnComputeResource": "string",
    "formatOnHost": "string",
    "formatOnVm": "string",
    "fullFormat": "string",
    "longDescription": "string"
}

string

key

Required

Type of event being described.

string

description

Optional

A string that is a short human-parseable description of the event.

This is not the full message string (which may contain details of the arguments, etc.), but merely a more understandable, and localized, description of what the event stands for. It is meant for contexts where the name of the event has to be displayed to end-users, e.g. when creating Event-based Alarms. ` *

E.g., for VmPoweredOnEvent, the eventDescription in English might say "VM Powered On".

string

category

Required

A category of events.

string

formatOnDatacenter

Required

A string that is appropriate in the context of a specific Datacenter.

For example, a renaming event in this context produces the following string:

"Renamed {vm.name} from {oldName} to {newName}"

where oldName and newName are properties of the VmRenamedEvent object.

string

formatOnComputeResource

Required

A string that is appropriate in the context of a specific cluster.

For example, a powering on event in this context produces the following string:

"{vm.name} on {host.name} is powered on".

string

formatOnHost

Required

A string that is appropriate in the context of a specific Host.

For example, a powering on event in this context produces the following string:

"{vm.name} is powered on"

string

formatOnVm

Required

A string that is appropriate for the context of a specific virtual machine.

For example, a powering on event in this context produces the following string:

"Virtual machine on {host.name} is powered on"

string

fullFormat

Required

A string whose context is not entity-specific.

For example, a powering on event produces the following string:

"{vm.name} on {host.name} in {datacenter.name} is powered on"

string

longDescription

Optional

A detailed description of the event.

It includes common causes and actions to remediate them. It may also include links to kb articles and other diagnostic information. For example, the BadUserNameSessionEvent may produce the following string:

     <EventLongDescription id="vim.event.BadUserNameSessionEvent">
        <description>
           The user could not be logged in because of an unknown or invalid
           user name.
        </description>
        <cause>
           <description>The user name was unknown to the system</description>
           <action>Use a user name known to the system user directory</action>
           <action>(On Linux) Check if the user directory is correctly
                   configured.</action>
           <action>Check the health of the domain controller (if you are using
                   Active Directory)</action>
        </cause>
        <cause>
           <description>The user provided an invalid password</description>
           <action>Supply the correct password</action>
        </cause>
     </EventLongDescription>

Property Of

ArrayOfEventDescriptionEventDetail

EventDescription