Test Search vSphere Web Services API


Managed Object - LicenseAssignmentManager(vim.LicenseAssignmentManager)

Property of
LicenseManager
See also
LicenseAssignmentManagerLicenseAssignment, LicenseManagerLicenseInfo
Since
vSphere API Release 4.0


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
QueryAssignedLicenses, RemoveAssignedLicense, UpdateAssignedLicense

QueryAssignedLicenses(queryAssignedLicenses)

Get information about all the licenses associated with an entity
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseAssignmentManager used to make the method call.
entityId*xsd:string

ID of the entity. E.g. HostSystem.

Since vSphere API Release 4.0
*Need not be set

Return Value

Type Description
LicenseAssignmentManagerLicenseAssignment[]

Faults

Type Description
RuntimeFaultThrown 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



RemoveAssignedLicense(removeAssignedLicense)

Remove licenses associated with an entity
Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseAssignmentManager used to make the method call.
entityIdxsd:string

ID of the entity. E.g. HostSystem.

Since vSphere API Release 4.0

Return Value

Type Description
None

Faults

Type Description
LicenseEntityNotFound
RuntimeFaultThrown 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



UpdateAssignedLicense(updateAssignedLicense)

Update the license associated with an entity
Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseAssignmentManager used to make the method call.
entityxsd:string

ID of the entity. E.g. HostSystem.

Since vSphere API Release 4.0
licenseKeyxsd:string

A license.

Since vSphere API Release 4.0
entityDisplayName*xsd:string

Display name for the entity

Since vSphere API Release 4.0
*Need not be set

Return Value

Type Description
LicenseManagerLicenseInfoReturns information about the license specified in licenseKey

Faults

Type Description
LicenseEntityNotFound
RuntimeFaultThrown 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