License Manager Update License

Updates the available licenses to the one provided in licenseKey.

This is the same as removing all the licenses using RemoveLicense and adding licenseKey using AddLicense If the optional parameter labels is specify this is the same as calling updateLicense without the optioal parameter and calling updateLabel for each pair in the labels array.

Required privileges: Global.Licenses

Request

URI

POST

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

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.3.0 APIs.

Request Body

UpdateLicenseRequestType of type(s) application/json

Required

Show optional properties

{
    "licenseKey": "string"
}

{
    "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.

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