License Manager Configure License Source

Deprecated as of vSphere API 4.0, use UpdateLicense instead.

Allows for reconfiguration of the License Manager license source.

This changes the licensing source to be either served or local. Before changing the license source location, the API checks the number of licenses available at the new potential source to ensure there are at least as many licenses there as have been issued by the current source. If there are an equal or greater number of licenses at the new source, all licenses on the current source are released and then reacquired from the new source. If there are not enough licenses available on the new source to reissue all licenses, the operation fails.

This is used to configure the license source on an individual host.

PLATFORM Specific Notes: VirtualCenter - only supports a served source. the host parameter is mandatory. ESX Server - the host parameter is optional.

Required privileges: Global.Licenses

Request

URI

POST

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

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

ConfigureLicenseSourceRequestType of type(s) application/json

Required

Show optional properties

{
    "licenseSource": {}
}

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

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

LicenseSource

licenseSource

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.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

LicenseServerUnavailable: if the license server is unreachable.

CannotAccessLocalSource: if the local source cannot be accessed.

InvalidLicense: if the new license source is LocalLicenseSource and the license file is not valid.

NotEnoughLicenses: if the new license source does not have enough licenses.

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

Virtual Infrastructure Operations

POST

License Manager Add License