Managed Object - LicenseManager

Property of
HostConfigManager, ServiceContent
See also
HostSystem, KeyValue, LicenseAssignmentManager, LicenseAvailabilityInfo, LicenseDiagnostics, LicenseFeatureInfo, LicenseManagerEvaluationInfo, LicenseManagerLicenseInfo, LicenseSource, LicenseUsageInfo
Since
null


Managed Object Description

Properties

Name Type Description
diagnostics*LicenseDiagnostics

Since VI API 2.5
evaluation PLicenseManagerEvaluationInfo

Since vSphere API 4.0
featureInfo*LicenseFeatureInfo[]


licenseAssignmentManager* PManagedObjectReference
to a LicenseAssignmentManager

Since vSphere API 4.0
licensedEditionxsd:string

Since VI API 2.5
licensesLicenseManagerLicenseInfo[]

Since vSphere API 4.0
sourceLicenseSource


sourceAvailablexsd:boolean


*May not be presentPRequired privilege - see tooltip for details

Methods

Methods defined in this Managed Object
AddLicense, CheckLicenseFeature, ConfigureLicenseSource, DecodeLicense, DisableFeature, EnableFeature, QueryLicenseSourceAvailability, QueryLicenseUsage, QuerySupportedFeatures, RemoveLicense, RemoveLicenseLabel, SetLicenseEdition, UpdateLicense, UpdateLicenseLabel

AddLicense

Required Privileges
Global.Licenses
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
licenseKey Pxsd:string

Since vSphere API 4.0
labels* PKeyValue[]

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
LicenseManagerLicenseInfo

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



CheckLicenseFeature

Deprecated.

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
featureKey Pxsd:string

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

Return Value

Type Description
xsd:boolean

Faults

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



ConfigureLicenseSource

Deprecated.

Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
licenseSource PLicenseSource

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

Return Value

Type Description
None

Faults

Type Description
CannotAccessLocalSource
InvalidLicense
LicenseServerUnavailable
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



DecodeLicense

Required Privileges
Global.Licenses
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
licenseKey Pxsd:string

Since vSphere API 4.0
P Required privilege: licenseKey

Return Value

Type Description
LicenseManagerLicenseInfo

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



DisableFeature

Deprecated.

Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
featureKey Pxsd:string

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

Return Value

Type Description
xsd:boolean

Faults

Type Description
InvalidState
LicenseServerUnavailable
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



EnableFeature

Deprecated.

Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
featureKey Pxsd:string

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

Return Value

Type Description
xsd:boolean

Faults

Type Description
InvalidState
LicenseServerUnavailable
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



QueryLicenseSourceAvailability

Deprecated.

Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
*Need not be set P Required privilege: host

Return Value

Type Description
LicenseAvailabilityInfo[]

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



QueryLicenseUsage

Deprecated.

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
*Need not be set P Required privilege: host

Return Value

Type Description
LicenseUsageInfo

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



QuerySupportedFeatures

Deprecated.

Required Privileges
Global.Licenses
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since VI API 2.5
*Need not be set P Required privilege: host

Return Value

Type Description
LicenseFeatureInfo[]

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



RemoveLicense

Required Privileges
Global.Licenses
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
licenseKey Pxsd:string

Since vSphere API 4.0
P Required privilege: licenseKey

Return Value

Type Description
None

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



RemoveLicenseLabel

Required Privileges
Global.Licenses
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
licenseKey Pxsd:string

Since vSphere API 4.0
labelKey Pxsd:string

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



SetLicenseEdition

Deprecated.

Required Privileges
Global.Licenses

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
featureKey* Pxsd:string

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

Return Value

Type Description
None

Faults

Type Description
InvalidState
LicenseServerUnavailable
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



UpdateLicense

Required Privileges
Global.Licenses
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
licenseKey Pxsd:string

Since vSphere API 4.0
labels* PKeyValue[]

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
LicenseManagerLicenseInfo

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



UpdateLicenseLabel

Required Privileges
Global.Licenses
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the LicenseManager used to make the method call.
licenseKey Pxsd:string

Since vSphere API 4.0
labelKey Pxsd:string

Since vSphere API 4.0
labelValue Pxsd:string

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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