| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Entitlements are identified by a short string 'key'. Keys can represent either a particular edition (Full, Starter) or a particular feature/function (featureKey) (backup, nas). An edition implies zero one or more functions which are express, denied or optional. For example a 'Full' edition includes 'iscsi' function but a Starter edition might disallow it.
Which edition a given VMware platform uses can be defined at any time. Generally this is done right after first install and boot as installation software may not set it. For editions that are similar in nature, any future changes to edition type will only impact future requests for functionality. Current functionality is left unaffected. The same is true for optional functions enabled/disabled after some period of time. For dissimilar editions, such transitions may require entering maintenance mode first else an exception of InvalidState will be thrown.
To specify the edition type and any optional functions, use updateLicense for ESX Server and addLicense follow by LicenseAssingmentManager.updateAssignedLicense for VirtualCenter.
When an edition is specified for a given host, the cost of that edition (how many licenses are needed) is determined. The cost is computed using the license's CostUnit value multiplied by the number of units activated. For example, when a VMware platform is set to an edition which uses a 'cpuPackage' on a two socket server, two licenses would be needed to successfully install that edition.
Here is a diagram of the unit costs supported by this API and their relationships.
+------------------------------+ +--------+ +-------+ | +-----------+ +-----------+ | | Server | | Host | | | | | | | +--------+ +-------+ | | cpuCore | | cpuCore | | +-------+ | +-----------+ +-----------+ | +--------+ | Host | | cpuPackage | | VM | +-------+ +------------------------------+ +--------+
Properties
Name | Type | Description |
---|---|---|
diagnostics* | LicenseDiagnostics | Deprecated.
As of vSphere API 4.0, this property is not used by the system.
Return current diagnostic information.
Since VI API 2.5 |
evaluation P | LicenseManagerEvaluationInfo |
Since vSphere API 4.0 |
featureInfo* | LicenseFeatureInfo[] | Deprecated.
As of VI API 2.5, use QuerySupportedFeatures
instead.
The list of features that can be licensed.
|
licenseAssignmentManager* P | ManagedObjectReference
to a LicenseAssignmentManager |
License Assignment Manager
Since vSphere API 4.0 |
licensedEdition | xsd:string | Deprecated.
As of vSphere API 4.0, use
QueryAssignedLicenses instead.
The product's license edition. The edition defines which product license
the server requires. This, in turn, determines the core set of functionalities
provided by the product and the additional features that can be licensed. If
no edition is set the property is set to the empty string ("").
To set the edition use SetLicenseEdition.
Since VI API 2.5 |
licenses | LicenseManagerLicenseInfo[] |
Get information about all the licenses available.
Since vSphere API 4.0 |
source | LicenseSource | Deprecated.
As of vSphere API 4.0, use
QueryAssignedLicenses to get evaluation information.
Set or return a data object type of LocalLicense or LicenseServer.
|
sourceAvailable | xsd:boolean | Deprecated.
As of vSphere API 4.0, this property is not used.
Current state of the license source. License sources that are LocalSource
are always available.
|
Methods
Methods defined in this Managed Object |
---|
AddLicense, CheckLicenseFeature, ConfigureLicenseSource, DecodeLicense, DisableFeature, EnableFeature, QueryLicenseSourceAvailability, QueryLicenseUsage, QuerySupportedFeatures, RemoveLicense, RemoveLicenseLabel, SetLicenseEdition, UpdateLicense, UpdateLicenseLabel |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
licenseKey P | xsd:string |
A license. E.g. a serial license.
Since vSphere API 4.0 |
labels* P | KeyValue[] |
array of key-value labels. Ignored by ESX Server.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
LicenseManagerLicenseInfo | Returns information about the license specified in licenseKey. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Host to act on if LicenseManager is not on a host.
Since 2.0 |
featureKey P | xsd:string |
Name of the feature to enable.
Since 2.0 |
Return Value
Type | Description |
---|---|
xsd:boolean | Returns true if the feature is enabled and false if it is not. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it. |
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 |
This changes the licensing source to be either served or local. Before changing the license source location, the API checks the number of licenses available at the new potential source to ensure there are at least as many licenses there as have been issued by the current source. If there are an equal or greater number of licenses at the new source, all licenses on the current source are released and then reacquired from the new source. If there are not enough licenses available on the new source to reissue all licenses, the operation fails.
This is used to configure the license source on an individual host.
PLATFORM Specific Notes: VirtualCenter - only supports a served source. the host parameter is mandatory. ESX Server - the host parameter is optional.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Host for which the license manager should be reconfigured.
Since 2.0 |
licenseSource P | LicenseSource |
ServedSource or LocalSource.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
CannotAccessLocalSource | Thrown if the local source cannot be accessed. |
InvalidLicense | Thrown if the new license source is LocalLicenseSource and the license file is not valid. |
LicenseServerUnavailable | Thrown if the license server is unreachable. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
licenseKey P | xsd:string |
A license. E.g. a serial license.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
LicenseManagerLicenseInfo | Returns information about the license specified in licenseKey. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Host to act on if LicenseManager is not on a host.
Since 2.0 |
featureKey P | xsd:string |
key of the feature to disable.
Since 2.0 |
Return Value
Type | Description |
---|---|
xsd:boolean | Returns true if the feature was disabled and false if not. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the feature is in use. |
LicenseServerUnavailable | Thrown if the license server is unavailable. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Host to act on if LicenseManager is not on a host.
Since 2.0 |
featureKey P | xsd:string |
Name of the feature to enable.
Since 2.0 |
Return Value
Type | Description |
---|---|
xsd:boolean | Returns true if enabling the feature was successful, false otherwise. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it. |
LicenseServerUnavailable | Thrown if the license server is unavailable. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Use the license source of the specified host.
Since 2.0 |
Return Value
Type | Description |
---|---|
LicenseAvailabilityInfo[] |
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 |
PLATFORM Specific Notes: VirtualCenter - Empty string returns the usage of non-host specific features. Must specify managed host to query. ESX Server - Host argument ignored.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Host to query for usage. If missing, query the server the
LicenseManager is on.
Since 2.0 |
Return Value
Type | Description |
---|---|
LicenseUsageInfo |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Use the license source of the specified host.
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
LicenseFeatureInfo[] |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
licenseKey P | xsd:string |
A licenses. E.g. a serial license.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
licenseKey P | xsd:string |
A license.
Since vSphere API 4.0 |
labelKey P | xsd:string |
A label key.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
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 |
To determine what featureKey the current platform will accept, use querySourceAvailablity() at runtime, or consult the documentation for the current platform.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
host* P | ManagedObjectReference
to a HostSystem |
Host to act on if LicenseManager is not on a host.
Since 2.0 |
featureKey* P | xsd:string |
Name of edition feature to select. If featureKey is not
set or set to empty string, the product becomes unlicensed.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it. |
LicenseServerUnavailable | Thrown if the license server is unavailable. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
licenseKey P | xsd:string |
A license. E.g. a serial license.
Since vSphere API 4.0 |
labels* P | KeyValue[] |
array of key-value labels.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
LicenseManagerLicenseInfo | Returns information about the license specified in licenseKey. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call. |
licenseKey P | xsd:string |
A license.
Since vSphere API 4.0 |
labelKey P | xsd:string |
A label key.
Since vSphere API 4.0 |
labelValue P | xsd:string |
Value for the label.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |