vcenter nsx deployment license: get
Gets the NSX licensing details applied to the NSX Manager Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
GET https://{server}/api/vcenter/nsx/deployment/license
Response:
HTTP Status Code: 200
Response Body Structure:
{
"messages" : [
{
"severity" : "INFO",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"license_key" : "string"
}
"messages" : [
{
"severity" : "INFO",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"severity" : "INFO",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"license_key" : "string"
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Info about the NSX Manager Appliance license. |
| -.license_key | string | License key to be applied or already applied to NSX Manager Appliance. In case multiple license is applied the higest license which is WCP compatible is returned. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.messages | validation_message[] | Validation messages on the license already applied or being validated. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, no messages available to show. |
| -.messages[].severity | string | Severity of the message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Represents the severity of the message. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: INFO: Informational message about the license, e.g., the type of the license.. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. WARNING: Warning message about the license, e.g., the license is going to expire soon. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. ERROR: Error message about the license, e.g., the license is not valid or has expired. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.messages[].message | localizable_message | The message details. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.messages[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.messages[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.messages[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if any other error occurs. |
| 404 | not_found | if no WCP license was applied to the NSX Manager Appliance. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user is not a member of the Administrators group. |