License Manager Query License Usage

Deprecated as of vSphere API 4.0, use QueryAssignedLicenses instead.

Returns the license usage.

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

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.

Required privileges: System.Read

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/LicenseManager/{moId}/QueryLicenseUsage

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case LicenseManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

QueryLicenseUsageRequestType of type(s) application/json

Required

{
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns LicenseUsageInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "source": {
        "_typeName": "string"
    },
    "sourceAvailable": false,
    "reservationInfo": [
        {
            "_typeName": "string",
            "key": "string",
            "state": "string",
            "required": 0
        }
    ],
    "featureInfo": [
        {
            "_typeName": "string",
            "key": "string",
            "featureName": "string",
            "featureDescription": "string",
            "state": "string",
            "costUnit": "string",
            "sourceRestriction": "string",
            "dependentKey": [
                "string"
            ],
            "edition": false,
            "expiresOn": "string"
        }
    ]
}

LicenseSource

source

Required

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

This data object type is used to communicate configuration about where to find licenses to use for this system.

boolean

sourceAvailable

Required

Returns whether or not the source is currently available.

See also LicenseManager.sourceAvailable.

array of LicenseReservationInfo

reservationInfo