License Manager Add License

Adds a license to the inventory of available licenses.

Required privileges: Global.Licenses

Request

URI

POST

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

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

AddLicenseRequestType of type(s) application/json

Required

{
    "licenseKey": "string",
    "labels": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ]
}

string

licenseKey

Required

A license. E.g. a serial license.

array of KeyValue

labels

Optional

array of key-value labels. Ignored by ESX Server.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns information about the license specified in licenseKey.

Returns LicenseManagerLicenseInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "licenseKey": "string",
    "editionKey": "string",
    "name": "string",
    "total": 0,
    "used": 0,
    "costUnit": "string",
    "properties": [
        {
            "_typeName": "string",
            "key": "string",
            "value": {
                "_typeName": "string"
            }
        }
    ],
    "labels": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ]
}

string

licenseKey

Required

Key for the license.

E.g. serial number.

string

editionKey

Required

Edition key.

string

name

Required