Managed Object - LicenseAssignmentManager(vim.LicenseAssignmentManager)

Property of: LicenseManager
See also: LicenseAssignmentManagerLicenseAssignment, LicenseManagerLicenseInfo
Since: vSphere API 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

Name

Type

Description

_this

ManagedObjectReference

A reference to the LicenseAssignmentManager used to make the method call.

entityId* P

xsd:string

ID of the entity. E.g. HostSystem.

Since vSphere API 4.0

*Need not be set P Required privilege: entityId

Return Value

Type	Description
LicenseAssignmentManagerLicenseAssignment[]

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryAssignedLicenses" type="vim25:QueryAssignedLicensesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryAssignedLicensesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:LicenseAssignmentManagerLicenseAssignment" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

RemoveAssignedLicense(removeAssignedLicense)

Remove licenses associated with an entity

Required Privileges: Global.Licenses

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the LicenseAssignmentManager used to make the method call.

entityId P

xsd:string

ID of the entity. E.g. HostSystem.

Since vSphere API 4.0

P Required privilege: entityId

Return Value

Type	Description
None

Faults

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveAssignedLicense" type="vim25:RemoveAssignedLicenseRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveAssignedLicenseResponse">
                  <complexType/>
               </element>

UpdateAssignedLicense(updateAssignedLicense)

Update the license associated with an entity

Required Privileges: Global.Licenses

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseAssignmentManager used to make the method call.
entity P	xsd:string	ID of the entity. E.g. HostSystem. *Since* vSphere API 4.0
licenseKey P	xsd:string	A license. *Since* vSphere API 4.0
entityDisplayName* P	xsd:string	Display name for the entity *Since* vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
LicenseManagerLicenseInfo	Returns information about the license specified in licenseKey

Faults

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateAssignedLicense" type="vim25:UpdateAssignedLicenseRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateAssignedLicenseResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:LicenseManagerLicenseInfo"/>
                     </sequence>
                  </complexType>
               </element>