License Manager Get Diagnostics

License Manager Get Diagnostics

Deprecated as of vSphere API 4.0, this property is not used by the system.

Return current diagnostic information.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/LicenseManager/{moId}/diagnostics
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property 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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LicenseDiagnostics of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "sourceLastChanged": "string",
    "sourceLost": "string",
    "sourceLatency": "number",
    "licenseRequests": "string",
    "licenseRequestFailures": "string",
    "licenseFeatureUnknowns": "string",
    "opState": "string",
    "lastStatusUpdate": "string",
    "opFailureMessage": "string"
}
string As date-time As date-time
sourceLastChanged
Required

A timestamp of when sourceAvailable last changed state, expressed in UTC.

string
sourceLost
Required

Counter to track number of times connection to source was lost.

This value starts at zero and wraps at 2^32-1 to zero. Discontinuity: sourceLastChanged.

number As float As float
sourceLatency
Required

Exponentially decaying average of the transaction time for license acquisition and routine communications with LicenseSource.

Units: milliseconds.

string
licenseRequests
Required

Counter to track total number of licenses requested.

This value starts at zero and wraps at 2^32-1 to zero. Discontinuity: sourceLastChanged.

string
licenseRequestFailures
Required

Counter to track Total number of licenses requests that were not fulfilled (denied, timeout, or other).

This value starts at zero and wraps at 2^32-1 to zero. Discontinuity: sourceLastChanged.

string
licenseFeatureUnknowns
Required

Counter to track Total number of license features parsed from License source that are not recognized.

This value starts at zero and wraps at 2^32-1 to zero. Discontinuity: sourceLastChanged.

LicenseManagerState_enum
opState
Required

Deprecated as of vSphere API 4.0, this is not used by the system.

State of licensing subsystem.

Possible values:

  • initializing: Setting or resetting configuration in progress.
  • normal: Running within operating parameters.
  • marginal: License source unavailable, using license cache.
  • fault: Initialization has failed or grace period expired.
Possible values are : initializing, normal, marginal, fault,
string As date-time As date-time
lastStatusUpdate
Required

A timestamp of when opState was last updated.

string
opFailureMessage
Required

A human readable reason when optState reports Fault condition.


On This Page
License Manager Operations
POST
License Manager Add License
POST
License Manager Check License Feature
POST
License Manager Configure License Source
POST
License Manager Decode License
POST
License Manager Disable Feature
POST
License Manager Enable Feature
GET
License Manager Get Diagnostics
GET
License Manager Get Evaluation
GET
License Manager Get Feature Info
GET
License Manager Get License Assignment Manager
GET
License Manager Get Licensed Edition
GET
License Manager Get Licenses
GET
License Manager Get Source
GET
License Manager Get Source Available
POST
License Manager Query License Source Availability
POST
License Manager Query License Usage
POST
License Manager Query Supported Features
POST
License Manager Remove License
POST
License Manager Remove License Label
POST
License Manager Set License Edition
POST
License Manager Update License
POST
License Manager Update License Label