Data Object Description

fullFormattedMessage

VmEventArgument

Properties

Name	Type	Description
category	xsd:string	A category of events.
description*	xsd:string	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". *Since* vSphere API 4.0
formatOnComputeResource	xsd:string	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".
formatOnDatacenter	xsd:string	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.
formatOnHost	xsd:string	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"
formatOnVm	xsd:string	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"
fullFormat	xsd:string	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"
key	xsd:string	Type of event being described.
longDescription*	xsd:string	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: The user could not be logged in because of an unknown or invalid user name. The user name was unknown to the system Use a user name known to the system user directory (On Linux) Check if the user directory is correctly configured. Check the health of the domain controller (if you are using Active Directory) The user provided an invalid password Supply the correct password *Since* vSphere API 4.1
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

category

xsd:string

A category of events.

description*

xsd:string

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".

Since vSphere API 4.0

formatOnComputeResource

xsd:string

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".

formatOnDatacenter

xsd:string

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.

formatOnHost

xsd:string

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"

formatOnVm

xsd:string

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"

fullFormat

xsd:string

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"

key

xsd:string

Type of event being described.

longDescription*

xsd:string

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:

The user could not be logged in because of an unknown or invalid user name. The user name was unknown to the system Use a user name known to the system user directory (On Linux) Check if the user directory is correctly configured. Check the health of the domain controller (if you are using Active Directory) The user provided an invalid password Supply the correct password

Since vSphere API 4.1

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="EventDescriptionEventDetail">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="key" type="xsd:string"/>
                     <element name="description" type="xsd:string" minOccurs="0"/>
                     <element name="category" type="xsd:string"/>
                     <element name="formatOnDatacenter" type="xsd:string"/>
                     <element name="formatOnComputeResource" type="xsd:string"/>
                     <element name="formatOnHost" type="xsd:string"/>
                     <element name="formatOnVm" type="xsd:string"/>
                     <element name="fullFormat" type="xsd:string"/>
                     <element name="longDescription" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - EventDescriptionEventDetail

Data Object Description