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.

Properties

Name	Type	Description
extensionList* P	Extension[]	The list of currently registered extensions.

*May not be presentP Required privilege: System.View

Methods

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

FindExtension

Returns extension with the given key, if any.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ExtensionManager used to make the method call.
extensionKey	xsd:string	Key to search for.

Return Value

Type	Description
Extension	Extension that matches given key, if any.

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FindExtension" type="vim25:FindExtensionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FindExtensionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:Extension" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

GetPublicKey

Returns VirtualCenter Server public key.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ExtensionManager used to make the method call.

Return Value

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

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetPublicKey" type="vim25:GetPublicKeyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetPublicKeyResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

RegisterExtension

Registers extension.

Required Privileges: Extension.Register

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ExtensionManager used to make the method call.
extension	Extension	Extension description to register.

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the Extension description is incomplete or an extension is already registered with the given unique key.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RegisterExtension" type="vim25:RegisterExtensionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RegisterExtensionResponse">
            <complexType/>
         </element>

SetPublicKey

Sets extension's public key.

Required Privileges: Extension.Update

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ExtensionManager used to make the method call.
extensionKey	xsd:string	Key of extension to update.
publicKey	xsd:string	Public key of extension, encoded in PEM (privacy-enhanced mail) format.

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the public key is invalid.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SetPublicKey" type="vim25:SetPublicKeyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SetPublicKeyResponse">
            <complexType/>
         </element>

UnregisterExtension

Unregisters the specified extension if it exists.

Required Privileges: Extension.Unregister

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ExtensionManager used to make the method call.
extensionKey	xsd:string	Unique name of extension to unregister.

Return Value

Type	Description
None

Faults

Type	Description
NotFound	Thrown if the specified extension is not registered.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnregisterExtension" type="vim25:UnregisterExtensionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnregisterExtensionResponse">
            <complexType/>
         </element>

UpdateExtension

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

Required Privileges: Extension.Update

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ExtensionManager used to make the method call.
extension	Extension	Updated extension description.

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the Extension description is incomplete or invalid.
NotFound	Thrown if the specified extension key is not registered.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateExtension" type="vim25:UpdateExtensionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateExtensionResponse">
            <complexType/>
         </element>