License Assignment Manager Update Assigned License

License Assignment Manager Update Assigned License

Update the license associated with an entity

Required privileges: Global.Licenses

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/LicenseAssignmentManager/{moId}/UpdateAssignedLicense
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 LicenseAssignmentManager/{moId}.

string
release
Required

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

Request Body
UpdateAssignedLicenseRequestType of type(s) application/json
Required

Show optional properties

{
    "entity": "string",
    "licenseKey": "string"
}
{
    "entity": "string",
    "licenseKey": "string",
    "entityDisplayName": "string"
}
string
entity
Required

ID of the entity. E.g. HostSystem.

string
licenseKey
Required

A license.

string
entityDisplayName
Optional

Display name for the entity

Authentication
This operation uses the following authentication methods.
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

Display name for the license

integer As int32 As int32
total
Required

Total number of units contain in the license

integer As int32 As int32
used
Optional

Number of units used from this license

string
costUnit
Required

The cost unit for this license

array of KeyAnyValue
properties
Optional

Additional properties associated with this license

array of KeyValue
labels
Optional

Key-value lables for this license


500

Failure

Returns LicenseEntityNotFound of type(s) application/json
This response body class contains all of the following: VimFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "entityId": "string"
}
string
entityId
Required

entityId


On This Page
Virtual Infrastructure Operations
POST
License Assignment Manager Query Assigned Licenses
POST
License Assignment Manager Remove Assigned License
POST
License Assignment Manager Update Assigned License