Data Object - Extension

Property of
ExtensionManager
Parameter to
RegisterExtension, UpdateExtension
Returned by
FindExtension
Extends
DynamicData
See also
Description, ExtensionClientInfo, ExtensionEventTypeInfo, ExtensionFaultTypeInfo, ExtensionHealthInfo, ExtensionOvfConsumerInfo, ExtensionPrivilegeInfo, ExtensionResourceInfo, ExtensionServerInfo, ExtensionTaskTypeInfo, ExtExtendedProductInfo, ExtManagedEntityInfo, ExtSolutionManagerInfo
Since
VI API 2.5

Data Object Description

This data object type contains all information about an extension. An extension may contain zero or more server interfaces and zero or more clients.

Properties

Name Type Description
client*ExtensionClientInfo[]

Clients for this extension.
company*xsd:string

Company information.

Since vSphere API 4.0
descriptionDescription

Description of extension.
eventList*ExtensionEventTypeInfo[]

Definitions of events defined by this extension.
extendedProductInfo*ExtExtendedProductInfo

Extended product information, such as URLs to vendor, product, etc.

Since vSphere API 5.0
faultList*ExtensionFaultTypeInfo[]

Definitions of faults defined by this extension.
healthInfo*ExtensionHealthInfo

Health specification provided by this extension.

Since vSphere API 4.0
keyxsd:string

Extension key. Should follow java package naming conventions for uniqueness (e.g. "com.example.management").

Extension names can only contain characters belonging to the lower ASCII character set (UTF-7) with the exception of the following characters:

  1. All whitespace characters ("space" - ascii character 0x20 is allowed)
  2. Control characters
  3. Comma (ascii 0x2c), Forward slash (ascii 0x2f), Backward slash (ascii 0x5c), Hash/Pound (ascii 0x23), Plus (ascii 0x2b), Greater (ascii 0x3e), Lesser (ascii 0x3c), Equals (ascii 0x3d), Semi-colon (ascii 0x3b) and Double quote (ascii 0x22).

lastHeartbeatTimexsd:dateTime

Last extension heartbeat time.
managedEntityInfo*ExtManagedEntityInfo[]

Information about entities managed by this extension. An extension can register virtual machines as managed by itself, by setting the managedBy property of the virtual machine.

Since vSphere API 5.0
ovfConsumerInfo*ExtensionOvfConsumerInfo

OVF consumer specification provided by this extension.

Since vSphere API 5.0
privilegeList*ExtensionPrivilegeInfo[]

Definitions privileges defined by this extension.
resourceList*ExtensionResourceInfo[]

Resource data for all locales
server*ExtensionServerInfo[]

Servers for this extension.
shownInSolutionManager*xsd:boolean

Opt-in to the Solution Manager. If set to true, this extension will be shown in the Solution Manager. If not set, or set to false, this extension is not shown in the Solution Manager.

Since vSphere API 5.0
solutionManagerInfo*ExtSolutionManagerInfo

Solution Manager configuration for this extension.

Since vSphere API 5.0
subjectName*xsd:string

Subject name from client certificate.
taskList*ExtensionTaskTypeInfo[]

Definitions of tasks defined by this extension.
type*xsd:string

Type of extension (example may include CP-DVS, NUOVA-DVS, etc.).

Since vSphere API 4.0
versionxsd:string

Extension version number as a dot-separated string. For example, "1.0.0"
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition