# 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 P | LicenseManagerEvaluationInfo | Since vSphere API 4.0
featureInfo* | LicenseFeatureInfo[] |
licenseAssignmentManager* P | ManagedObjectReference to a LicenseAssignmentManager | Since vSphere API 4.0
licensedEdition | xsd:string | Since VI API 2.5
licenses | LicenseManagerLicenseInfo[] | Since vSphere API 4.0
source | LicenseSource |
sourceAvailable | xsd:boolean |

*May not be present P Required 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
licenseKey P | xsd:string | Since vSphere API 4.0
labels* P | KeyValue[] | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
LicenseManagerLicenseInfo |

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

# CheckLicenseFeature

Deprecated.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null
featureKey P | xsd:string | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:boolean |

Faults

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

# ConfigureLicenseSource

Deprecated.

Required Privileges
  Global.Licenses

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null
licenseSource P | LicenseSource | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# DecodeLicense

Required Privileges
  Global.Licenses
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
licenseKey P | xsd:string | Since vSphere API 4.0

P Required privilege: licenseKey

Return Value

Type | Description
--- | ---
LicenseManagerLicenseInfo |

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

# DisableFeature

Deprecated.

Required Privileges
  Global.Licenses

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null
featureKey P | xsd:string | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:boolean |

Faults

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

# EnableFeature

Deprecated.

Required Privileges
  Global.Licenses

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null
featureKey P | xsd:string | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:boolean |

Faults

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

# QueryLicenseSourceAvailability

Deprecated.

Required Privileges
  Global.Licenses

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null

*Need not be set P Required privilege: host

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

# QueryLicenseUsage

Deprecated.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null

*Need not be set P Required privilege: host

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

# QuerySupportedFeatures

Deprecated.

Required Privileges
  Global.Licenses
Since
  VI API 2.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since VI API 2.5

*Need not be set P Required privilege: host

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

# RemoveLicense

Required Privileges
  Global.Licenses
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
licenseKey P | xsd:string | Since vSphere API 4.0

P Required privilege: licenseKey

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

# RemoveLicenseLabel

Required Privileges
  Global.Licenses
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
licenseKey P | xsd:string | Since vSphere API 4.0
labelKey P | xsd:string | Since vSphere API 4.0

P Required privilege - see tooltip for details

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

# SetLicenseEdition

Deprecated.

Required Privileges
  Global.Licenses

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null
featureKey* P | xsd:string | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# UpdateLicense

Required Privileges
  Global.Licenses
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
licenseKey P | xsd:string | Since vSphere API 4.0
labels* P | KeyValue[] | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
LicenseManagerLicenseInfo |

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

# UpdateLicenseLabel

Required Privileges
  Global.Licenses
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the LicenseManager used to make the method call.
licenseKey P | xsd:string | Since vSphere API 4.0
labelKey P | xsd:string | Since vSphere API 4.0
labelValue P | xsd:string | Since vSphere API 4.0

P Required privilege - see tooltip for details

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