vCenter Storage Monitoring Service API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - ExtensionManager(vim.ExtensionManager)
- Property of
- ServiceContent
- See also
- Extension, ExtensionManagerIpAllocationUsage, ManagedEntity
- 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* P | Extension[] |
The list of currently registered extensions.
|
Methods
| Methods defined in this Managed Object |
|---|
| FindExtension, GetPublicKey, QueryExtensionIpAllocationUsage, QueryManagedBy, RegisterExtension, SetExtensionCertificate, SetPublicKey, SetServiceAccount, UnregisterExtension, UpdateExtension |
FindExtension(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.
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 | |
Show WSDL type definition
GetPublicKey(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
| 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 | |
Show WSDL type definition
QueryExtensionIpAllocationUsage(queryExtensionIpAllocationUsage)
Query statistics about IP allocation usage, either system wide or for specified extensions.Refer to IpPoolManager for details.
- Required Privileges
- System.View
- Since
- vSphere API Release 5.1
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
| extensionKeys* | 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 Release 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 | |
Show WSDL type definition
QueryManagedBy(queryManagedBy)
Find entities managed by an extension. These can be either virtual machines or vApps.- Required Privileges
- System.View
- Since
- vSphere API Release 5.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
| extensionKey | xsd:string |
Key of the extension to find managed entities for.
Since vSphere API Release 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 | |
Show WSDL type definition
RegisterExtension(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.
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 | |
Show WSDL type definition
SetExtensionCertificate(setCertificate)
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 Release 4.0
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.
Since vSphere API Release 4.0 |
| certificatePem* | xsd:string |
PEM encoded certificate. If not specified, the
certificate passed over SSL handshake is used.
Since vSphere API Release 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 | |
Show WSDL type definition
SetPublicKey(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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
| extensionKey | xsd:string |
Key of extension to update.
Since VI API 2.5 |
| publicKey | 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 | |
Show WSDL type definition
SetServiceAccount(setServiceAccount)
Update the stored authentication service account for the specified extension. Updates the registration of the specified extension with the service account passed in the "serviceAccount"parameter. The service account will be used to authenticate the extension by invoking vCenter Server Login APIs and the user session can be used to update an Extension's data.This method will unset the previous service account name associated with the extension.
The account name must be passed in with same case as the created account name. The account name must be suffixed with the vCenter machine id. The account name passed in must be qualified by the SSO domain for the vCenter server using the same format as userName for Login
NOTE: Account lifetime is managed by the extension owning the account.
- Required Privileges
- Extension.Update
- Since
- vSphere API Release 8.0.2.0
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.
Since vSphere API Release 8.0.2.0 |
| serviceAccount | xsd:string |
account name qualified with SSO domain.
Since vSphere API Release 8.0.2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| NotFound | Thrown if an extension specified by "extensionKey" is not registered or the service account is not found. |
| 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 | |
Show WSDL type definition
UnregisterExtension(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.
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 | |
Show WSDL type definition
UpdateExtension(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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ExtensionManager used to make the method call. |
| extension | 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 | |
Show WSDL type definition
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |