Managed Object - ExtensionManager

Property of
ServiceContent
See also
Extension
Since
VI API 2.5


Managed Object Description

This managed object type provides directory and basic management services for all registered extensions.

Clients use the ExtensionManager, available in ServiceInstance, to access extension objects.

While several authentication methods are available for extension servers to use (see SessionManager), only one authentication method is valid for an extension at any given time.

Properties

Name Type Description
extensionList* PExtension[]

The list of currently registered extensions.
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
FindExtension, GetPublicKey, RegisterExtension, SetExtensionCertificate, SetPublicKey, UnregisterExtension, UpdateExtension

FindExtension

Returns extension with the given key, if any.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.
extensionKeyxsd:string

Key to search for.

Return Value

Type Description
ExtensionExtension that matches given key, if any.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



GetPublicKey

Deprecated. As of VI 4.0, use trusted certificates and LoginExtensionBySubjectName or SetExtensionCertificate and LoginExtensionByCertificate.

Returns VirtualCenter Server public key.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.

Return Value

Type Description
xsd:stringPublic key of VirtualCenter Server, encoded in PEM (privacy-enhanced mail) format.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RegisterExtension

Registers extension.
Required Privileges
Extension.Register

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.
extensionExtension

Extension description to register.

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if the Extension description is incomplete or an extension is already registered with the given unique key.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



SetExtensionCertificate

Update the stored authentication certificate for a specified extension. Updates the registration of the specified extension with the thumbprint of the X.509 client certificate provided over SSL handshake, or by the "certificatePem"argument. The thumbprint will be used to authenticate the extension during invocations of LoginExtensionByCertificate.

NOTE: No verification is performed on the received certificate, such as expiry or revocation.

This method will unset any public key or subject name associated with the extension.

Required Privileges
Extension.Update
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.
extensionKeyxsd:string

Key of extension to update.
certificatePem*xsd:string

PEM encoded certificate. If not specified, the certificate passed over SSL handshake is used.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if the certificate described by "certificatePem" is not in PEM format, or could not be decoded to an X.509 certificate.
NoClientCertificateThrown if certificatePem is not specified, and no certificate was passed over SSL handshake.
NotFoundThrown if an extension specified by "extensionKey" is not registered.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



SetPublicKey

Deprecated. As of VI 4.0, use trusted certificates and LoginExtensionBySubjectName or SetExtensionCertificate and LoginExtensionByCertificate.

Sets extension's public key.

This method will unset any subject name or certificate associated with the extension.

Required Privileges
Extension.Update

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.
extensionKeyxsd:string

Key of extension to update.
publicKeyxsd:string

Public key of extension, encoded in PEM (privacy-enhanced mail) format.

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if the public key is invalid.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UnregisterExtension

Unregisters the specified extension if it exists.
Required Privileges
Extension.Unregister

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.
extensionKeyxsd:string

Unique name of extension to unregister.

Return Value

Type Description
None

Faults

Type Description
NotFoundThrown if the specified extension is not registered.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateExtension

If the key specified in the extension exists, the existing record is updated.

If the "subjectName" property of the Extension object has a value, and it is different from the existing value, this method will unset any public key or certificate associated with the extension.

Required Privileges
Extension.Update

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensionManager used to make the method call.
extensionExtension

Updated extension description.

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if the Extension description is incomplete or invalid.
NotFoundThrown if the specified extension key is not registered.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition