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

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"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - EventDescriptionEventDetail

Data Object Description