License Manager Check License Feature

Deprecated as of vSphere API 4.0, use QueryAssignedLicenses instead.

Returns whether or not a given feature is enabled.

Required privileges: System.Read

Request

URI

POST

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

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

CheckLicenseFeatureRequestType of type(s) application/json

Required

Show optional properties

{
    "featureKey": "string"
}

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

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

string

featureKey

Required

Name of the feature to enable.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns true if the feature is enabled and false if it is not.

Returns integer of type(s) application/json

Operation doesn't return any data structure

500

InvalidArgument: If a feature name is not found.

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

Returns InvalidState 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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

License Manager Add License