Scripting Object - VcLicenseDataManager

Scripting-object corresponding to
LicenseDataManager
Returned by
queryLicenseDataManager

Scripting Object Description

This managed object type controls License Data associated with host containers (host folders) from the Inventory like clusters, datacenters and datacenter folders. The latter is to support automatic licensing when hosts are added to a particular host conatiner.

Attributes

Name Type Description
entityLicenseDataVcLicenseDataManagerEntityLicenseData []

@since vSphere API 5.0
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
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, applyAssociatedLicenseData, createTrigger, queryAssociatedLicenseData, queryEntityLicenseData, updateAssociatedLicenseData

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

queryEntityLicenseData

This method retrieves all the associated License Data objects. @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcLicenseDataManagerEntityLicenseData []

updateAssociatedLicenseData

This method is used to update/set the License Container associated with a specified Managed Entity. If a licenseContainer is not passed any associated License Container is dissociated and removed from the database. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1VcLicenseDataManagerLicenseData


Return Value

Type Description
None

queryAssociatedLicenseData

This method is used to retrieve the License Data associated with a specified Managed Entity. If the queryParents parameter is true the returned License Data is joined with all the License Data associated with the parents (in terms of vCenter Inventory) of the passed Managed Entity. The join is made in such a way that there is only one License Key for each Asset ID specified in any of the associated License Data where the License Entry closest (in terms of vCenter Inventory) to the passed Managed Entity for a given Asset ID is with the highest priority i.e. if there is License Data associated with the passed Managed Entity all keys from it are directly added to the resulting License Container next if there is a License Container associated with the parent of the passed Managed Entity which contains an Asset ID which is not present in the resulting License Container it is also directly added to the resulting License Container with it's corresponding license key. If an Asset ID which is already present in the resulting License Container is found in one of the "parent" License Containers the license key already existing in the resulting License Container is retained. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1Boolean


Return Value

Type Description
VcLicenseDataManagerLicenseData

applyAssociatedLicenseData

This method is used to apply associated License Data to a Managed Entity. In case of a Host entity, this results in sending any associated 3rd party License Data to this host and invoking corresponding 3rd party-provided script for each of these. The associated vSphere License Data (if any) is set with the standard vCenter licensing mechanisms. In case of a Container entity, this method finds all hosts below specified container (in terms of vCenter Inventory) and applies procedure outlined above for each of these. The License Data associated with each Host is derived using the same rules as in {@link LicenseDataManager#queryAssociatedLicenseData} inheriting from parents. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcManagedEntity


Return Value

Type Description
None