License Manager Set License Edition

Deprecated as of vSphere API 4.0, use QueryAssignedLicenses instead.

Defines the product's license edition.

The edition defines which product license the server requires. This, in turn, determines the core set of functionality provided by the product and the additional features that can be licensed.

To determine what featureKey the current platform will accept, use querySourceAvailablity() at runtime, or consult the documentation for the current platform.

Required privileges: Global.Licenses

Request

URI

POST

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

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

SetLicenseEditionRequestType of type(s) application/json

Required

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

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

string

featureKey

Optional

Name of edition feature to select. If featureKey is not set or set to empty string, the product becomes unlicensed.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidArgument: If a feature key is not an edition feature key.

LicenseServerUnavailable: If the license server is unavailable.

InvalidState: If the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

License Manager Operations

POST

License Manager Add License