LicenseReservationInfo

LicenseReservationInfo
LicenseReservationInfo

Deprecated as of vSphere API 4.0, this is not used by the system.

A reservation describes how many licenses of a particular feature are being used by a particular feature.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "state": "string",
    "required": 0
}
string
key
Required

Key of the License Feature.

See also key.

state
Required

Describes the reservation state of a license.

Possible values:

  • notUsed: This license is currently unused by the system, or the feature does not apply.

    For example, a DRS license appears as NotUsed if the host is not part of a DRS-enabled cluster.

  • noLicense: This indicates that the license has expired or the system attempted to acquire the license but was not successful in reserving it.

  • unlicensedUse: The LicenseManager failed to acquire a license but the implementation policy allows us to use the licensed feature anyway.

    This is possible, for example, when a license server becomes unavailable after a license had been successfully reserved from it.

  • licensed: The required number of licenses have been acquired from the license source.

Possible values are : notUsed, noLicense, unlicensedUse, licensed,
integer As int32 As int32
required
Required

Contains the required number of licenses of the particular type that the product needs in its current configuration.

Licenses are normally allocated at the same time as they are needed, so the value of required is set at the time the license is needed. For example, in the case of the number of licenses based on virtual machines, the required count is set at the time a virtual machine is powered on, just before the license is checked out.