Managed Object - 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

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*	xsd:string	ID of the entity. E.g. HostSystem.

*Need not be set

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.

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" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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	xsd:string	ID of the entity. E.g. HostSystem.

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.

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

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	xsd:string	ID of the entity. E.g. HostSystem.
licenseKey	xsd:string	A license.
entityDisplayName*	xsd:string	Display name for the entity

*Need not be set

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.

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>