| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
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* P | Extension[] |
The list of currently registered extensions.
|
Methods
Methods defined in this Managed Object |
---|
FindExtension, GetPublicKey, QueryExtensionIpAllocationUsage, QueryManagedBy, RegisterExtension, SetExtensionCertificate, SetPublicKey, UnregisterExtension, UpdateExtension |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extensionKey P | xsd:string |
Key to search for.
Since VI API 2.5 |
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. |
Events
Type | |
---|---|
None |
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. |
Events
Type | |
---|---|
None |
Refer to IpPoolManager for details.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extensionKeys* P | xsd:string[] |
List of extensions whose IP allocation is being queried.
If no extension keys are specified then allocation data
for all registered extensions are returned.
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ExtensionManagerIpAllocationUsage[] | List of IP allocation usage. |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extensionKey P | xsd:string |
Key of the extension to find managed entities for.
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ManagedEntity[] | List of entities managed by the extension. |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extension P | Extension |
Extension description to register.
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
None |
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. |
Events
Type | |
---|---|
None |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extensionKey P | xsd:string |
Key of extension to update.
Since vSphere API 4.0 |
certificatePem* P | xsd:string |
PEM encoded certificate. If not specified, the
certificate passed over SSL handshake is used.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NoClientCertificate | Thrown if certificatePem is not specified, and no certificate was passed over SSL handshake. |
NotFound | Thrown if an extension specified by "extensionKey" 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. |
Events
Type | |
---|---|
None |
This method will unset any subject name or certificate associated with the extension.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extensionKey P | xsd:string |
Key of extension to update.
Since VI API 2.5 |
publicKey P | xsd:string |
Public key of extension, encoded
in PEM (privacy-enhanced mail) format.
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
None |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extensionKey P | xsd:string |
Unique name of extension to unregister.
Since VI API 2.5 |
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. |
Events
Type | |
---|---|
None |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
extension P | Extension |
Updated extension description.
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
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. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |