Scripting Object - VcExtensionManager

Scripting-object corresponding to
ExtensionManager
Attribute of
VcSdkConnection, VcServiceContent

Scripting Object Description

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

Clients use the ExtensionManager, available in {@link vim.ServiceInstance ServiceInstance}, to access extension objects.

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

Attributes

Name Type Description
extensionListVcExtension []

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
publicKeyStringDeprecated.

Returns VirtualCenter Server public key. @since VI API 2.5
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, clearExtensionData, createTrigger, findExtension, queryExtensionData, queryExtensionDataKeys, queryExtensionDataUsage, queryExtensionIpAllocationUsage, queryManagedBy, registerExtension, setExtensionCertificate, setPublicKey, unregisterExtension, updateExtension, updateExtensionData

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

unregisterExtension

Unregisters the specified extension if it exists. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcExtension


Return Value

Type Description
None

queryExtensionDataUsage

Query statistics about the amount of data being stored by extensions registered with vCenter Server. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcExtensionManagerExtensionDataUsage []

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 {@link vim.SessionManager#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. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

registerExtension

Registers extension. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcExtension


Return Value

Type Description
None

updateExtensionData

Update extension specific data associated with an extension. An extension can only update its own data. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcKeyValue []


Return Value

Type Description
None

queryExtensionDataKeys

Query extension specific data keys associated with an extension. An extension can only query its own data keys. @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
String []

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

setPublicKey

Sets extension's public key.

This method will unset any subject name or certificate associated with the extension. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

queryManagedBy

Find entities managed by an extension. These can be either virtual machines or vApps. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcManagedEntity []

queryExtensionData

Query extension specific data associated with an extension. An extension can only query its own data. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcKeyValue []

queryExtensionIpAllocationUsage

Query statistics about IP allocation usage, either system wide or for specified extensions.

Refer to {@link IpPoolManager} for details. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcExtensionManagerIpAllocationUsage []

findExtension

Returns extension with the given key, if any. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcExtension

clearExtensionData

Clear extension specific data associated with an extension. An extension can only clear its own data. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
None