15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
3.3 KiB
vim.event.EventDescription.EventDetail
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).
- extends
- Attributes:
-
key (str):
Type of event being described.
description (str, 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 thenameof 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".
category (str):
A category of events.
formatOnDatacenter (str):
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.
formatOnComputeResource (str):
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".
formatOnHost (str):
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 (str):
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 (str):
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"
longDescription (str, 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:The user could not be logged in because of an unknown or invalid user name.The user name was unknown to the systemUse 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 passwordSupply the correct password