Managed Object - LicenseManager

Property of: ServiceContent
See also: HostSystem, LicenseAvailabilityInfo, LicenseFeatureInfo, LicenseSource, LicenseUsageInfo

Managed Object Description

This managed object type provides access to all licensing information and license management. A license key specifies a licensable feature. Edition licenses represent a subset of these features and enable you to configure the licensable features based on the edition of a product.

Feature information includes the state and the cost unit. A feature can be in in one of three states: enabled, disabled, and optional. A feature in the enabled state is implicitly enabled; a feature in the disabled state is implicitly disabled. A feature in the optional state can be enabled or disabled using the appropriate operation below.

The cost unit determines the measurement by which licenses are reserved. For example, "cpuPackage" specifies that one license is reserved per each CPU; "cpuCore" specifies that one license is reserved per each CPU core in each CPU; "server" specifies that one license is reserved per server.

When you enable a feature, one or more licenses are reserved based on the cost unit value. For example, when you enable the DRS feature for 32 CPU packages (cost unit = "cpuPackage"), across multiple ESX Server hosts, if there are not enough licenses based on the cost unit, the feature is not enabled.

Licensing data is acquired from a single source, either a remote license server or a local source. You can configure this using an operation in this managed object.

Properties

Name	Type	Description
featureInfo*	LicenseFeatureInfo[]	The list of features that can be licensed.
source	LicenseSource	The source of this licenseManager. Acceptable values are ServedSource or LocalSource.
sourceAvailable	xsd:boolean	Current state of the license source. License sources that are LocalSource are always available.

*May not be present

Methods

Methods defined in this Managed Object
CheckLicenseFeature, ConfigureLicenseSource, DisableFeature, EnableFeature, QueryLicenseSourceAvailability, QueryLicenseUsage, SetLicenseEdition

CheckLicenseFeature

Returns whether or not a given feature is enabled.

See LicenseManagerLicenseKey

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Host to act on if LicenseManager is not on a host. See LicenseManagerLicenseKey
featureKey	xsd:string	Name of the feature to enable. See LicenseManagerLicenseKey

*Need not be set

Return Value

Type	Description
xsd:boolean	Returns true if the feature is enabled and false if it is not.

Faults

Type	Description
InvalidArgument	Thrown if a feature name is not found. See LicenseManagerLicenseKey
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it. See LicenseManagerLicenseKey
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" name="CheckLicenseFeature">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
                  <element name="featureKey" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="CheckLicenseFeatureResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

ConfigureLicenseSource

Allows for reconfiguration of the License Manager license source.

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. When the API is called directly on a host, the host parameter is optional. When called through VirtualCenter, the host argument must be specified.

Note: This method is supported on the LicenseManager for VirtualCenter, but VirtualCenter only supports a served source.

Required Privileges: Global.Licenses

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Host for which the license manager should be reconfigured.
licenseSource	LicenseSource	ServedSource or LocalSource.

*Need not be set

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.
NotEnoughLicenses	Thrown if the new license source does not have enough licenses.
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" name="ConfigureLicenseSource">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
                  <element name="licenseSource" type="vim2:LicenseSource"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="ConfigureLicenseSourceResponse">
            <complexType/>
         </element>

DisableFeature

Release licenses for an optional feature.

See LicenseManagerLicenseKey

Required Privileges: Global.Licenses

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Host to act on if LicenseManager is not on a host. See LicenseManagerLicenseKey
featureKey	xsd:string	key of the feature to disable. See LicenseManagerLicenseKey

*Need not be set

Return Value

Type	Description
xsd:boolean	Returns true if the feature was disabled and false if not.

Faults

Type	Description
InvalidArgument	Thrown if a feature name is not found or it is not optional. See LicenseManagerLicenseKey
InvalidState	Thrown if the feature is in use. See LicenseManagerLicenseKey
LicenseServerUnavailable	Thrown if the license server is unavailable. See LicenseManagerLicenseKey
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" name="DisableFeature">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
                  <element name="featureKey" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="DisableFeatureResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

EnableFeature

Enable a feature that has an optional state.

See LicenseManagerLicenseKey

Required Privileges: Global.Licenses

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Host to act on if LicenseManager is not on a host. See LicenseManagerLicenseKey
featureKey	xsd:string	Name of the feature to enable. See LicenseManagerLicenseKey

*Need not be set

Return Value

Type	Description
xsd:boolean	Returns true if enabling the feature was successful, false otherwise.

Faults

Type	Description
InvalidArgument	Thrown if a feature name is not found or it is not optional. See LicenseManagerLicenseKey
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it. See LicenseManagerLicenseKey
LicenseServerUnavailable	Thrown if the license server is unavailable. See LicenseManagerLicenseKey
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" name="EnableFeature">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
                  <element name="featureKey" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="EnableFeatureResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

QueryLicenseSourceAvailability

Queries the current license source for total and available licenses available for each feature known to this system.

Required Privileges: Global.Licenses

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Use the license source of the specified host.

*Need not be set

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="QueryLicenseSourceAvailability">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="QueryLicenseSourceAvailabilityResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim2:LicenseAvailabilityInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryLicenseUsage

Returns the license usage. The license usage is a list of supported features and the number of licenses that have been reserved.

The behavior of the API depends on whether or not it is called on VirtualCenter or a stand-alone host. For a stand-alone host, the host argument is ignored. For VirtualCenter, the API allows a query for the license usage on a particular host. If no host is set, the usage of non-host specific features are returned.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Host to query for usage.

*Need not be set

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="QueryLicenseUsage">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="QueryLicenseUsageResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim2:LicenseUsageInfo"/>
               </sequence>
            </complexType>
         </element>

SetLicenseEdition

Defines the product's license edition. The edition defines which product license the server requires. This, in turn, determines the core set of functionality provided by the product and the additional features that can be licensed.

For VirtualCenter, only the "vc" edition is supported.

For ESX 3.0, three editions are supported: "esxFull", "esxVmtn", and "esxExpress".

See LicenseManagerLicenseKey

Required Privileges: Global.Licenses

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the LicenseManager used to make the method call.
host*	ManagedObjectReference to a HostSystem	Host to act on if LicenseManager is not on a host. See LicenseManagerLicenseKey
featureKey*	xsd:string	Name of edition feature to select. If featureKey is not set, no edition is selected and the product becomes unlicensed. See LicenseManagerLicenseKey

*Need not be set

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if a feature key is not an edition feature key. See LicenseManagerLicenseKey
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it. See LicenseManagerLicenseKey
LicenseServerUnavailable	Thrown if the license server is unavailable. See LicenseManagerLicenseKey
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" name="SetLicenseEdition">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="host" type="vim2:ManagedObjectReference" minOccurs="0"/>
                  <element name="featureKey" type="xsd:string" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="SetLicenseEditionResponse">
            <complexType/>
         </element>