vcenter nsx deployment upgrade: get
Gets NSX deployment information, this includes the overall upgrade status, the available release version, the last precheck run time, the current operation details and the list of clusters with their upgrade status. 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/upgrade
Response:
HTTP Status Code: 200
Response Body Structure:
{
"upgrade_status" : "NOT_STARTED",
"last_precheck_run" : "2015-01-01T22:13:05.651Z",
"available_version" : "string",
"current_operation" : {
"start_time" : "2015-01-01T22:13:05.651Z",
"name" : "string",
"end_time" : "2015-01-01T22:13:05.651Z",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"display_name" : {
"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" : {}
}
}
}
}
}
}
},
"tasks" : [
{
"start_time" : "2015-01-01T22:13:05.651Z",
"name" : "string",
"end_time" : "2015-01-01T22:13:05.651Z",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"display_name" : {
"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" : {}
}
}
}
}
}
}
},
"tasks" : [
null,
null
],
"status" : "NOT_STARTED"
},
{
"start_time" : "2015-01-01T22:13:05.651Z",
"name" : "string",
"end_time" : "2015-01-01T22:13:05.651Z",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"display_name" : {
"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" : {}
}
}
}
}
}
}
},
"tasks" : [
null,
null
],
"status" : "NOT_STARTED"
}
],
"status" : "NOT_STARTED"
},
"clusters" : [
{
"number_of_edges_upgraded" : 1,
"number_of_hosts" : 1,
"number_of_hosts_upgraded" : 1,
"number_of_edges" : 1,
"current_version" : "string",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"id" : "obj-103",
"display_name" : "string",
"display_status" : "NOT_STARTED"
},
{
"number_of_edges_upgraded" : 1,
"number_of_hosts" : 1,
"number_of_hosts_upgraded" : 1,
"number_of_edges" : 1,
"current_version" : "string",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"id" : "obj-103",
"display_name" : "string",
"display_status" : "NOT_STARTED"
}
]
}
"upgrade_status" : "NOT_STARTED",
"last_precheck_run" : "2015-01-01T22:13:05.651Z",
"available_version" : "string",
"current_operation" : {
"start_time" : "2015-01-01T22:13:05.651Z",
"name" : "string",
"end_time" : "2015-01-01T22:13:05.651Z",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"display_name" : {
"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" : {}
}
}
}
}
}
}
},
"tasks" : [
{
"start_time" : "2015-01-01T22:13:05.651Z",
"name" : "string",
"end_time" : "2015-01-01T22:13:05.651Z",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"display_name" : {
"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" : {}
}
}
}
}
}
}
},
"tasks" : [
null,
null
],
"status" : "NOT_STARTED"
},
{
"start_time" : "2015-01-01T22:13:05.651Z",
"name" : "string",
"end_time" : "2015-01-01T22:13:05.651Z",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"display_name" : {
"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" : {}
}
}
}
}
}
}
},
"tasks" : [
null,
null
],
"status" : "NOT_STARTED"
}
],
"status" : "NOT_STARTED"
},
"clusters" : [
{
"number_of_edges_upgraded" : 1,
"number_of_hosts" : 1,
"number_of_hosts_upgraded" : 1,
"number_of_edges" : 1,
"current_version" : "string",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"id" : "obj-103",
"display_name" : "string",
"display_status" : "NOT_STARTED"
},
{
"number_of_edges_upgraded" : 1,
"number_of_hosts" : 1,
"number_of_hosts_upgraded" : 1,
"number_of_edges" : 1,
"current_version" : "string",
"progress" : 1.5,
"messages" : [
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
},
{
"unit_name" : "string",
"msg" : {
"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" : {}
}
}
}
}
}
}
},
"msg_type" : "INFO",
"unit_type" : "MANAGER"
}
],
"id" : "obj-103",
"display_name" : "string",
"display_status" : "NOT_STARTED"
}
]
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Info contains the overall upgrade status, the available release version, the last precheck run time, the current operation details and the list of clusters with their upgrade status. |
| -.upgrade_status | string | The overall upgrade status of the NSX deployment. 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. Defines the overall upgrade status of the deployment, including clusters, edges and hosts. 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: NOT_STARTED: The upgrade is not yet started. 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. IN_PROGRESS: The upgrade is in progress. 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. PAUSE_PENDING: A request to pause the upgrade is pending, the upgrade will be paused after the operations on the current clusters are completed. 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. PAUSED: The upgrade is paused, this can happen on a user request or on cluster upgrade failure. 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. COMPLETED: The upgrade is completed. 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. |
| -.available_version | string | The version of the NSX available for upgrade. 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. Only set if any new version is available on vCenter server. |
| -.last_precheck_run | date_time | The time when the last precheck run was completed for the availableVersion. 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. Only set if the last precheck run information is available. |
| -.current_operation | operation | Available current operation. 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. Only set if any operation is in progress or completed. |
| -.current_operation.name | string | The name of the operation. 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. |
| -.current_operation.display_name | localizable_message | The display name of the operation in localizable strucutre. 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. Only set if display name is present. |
| -.current_operation.display_name.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. |
| -.current_operation.display_name.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. |
| -.current_operation.display_name.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. |
| -.current_operation.display_name.params | object | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| -.current_operation.display_name.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| -.current_operation.status | string | The status of the operation. 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. Defines the current status of the operation. 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: NOT_STARTED: The operation is not yet started. 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. IN_PROGRESS: The operation is in progress. 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. PAUSED: The operation is paused. 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. COMPLETED_SUCCESS: The operation completed with success. 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. COMPLETED_ERROR: The operation completed with errors. 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. |
| -.current_operation.start_time | date_time | The time when the operation was started. 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. Only set if the opeation is started and the operation supports start time. |
| -.current_operation.end_time | date_time | The time when the operation ended. 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. Only set if the operation is completed and the operation supports end time. |
| -.current_operation.progress | double | The progress of the operation in percentage. 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. Only set if the operation supports percentage progress. |
| -.current_operation.messages | message[] | The messages corresponding to the operation. 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. Only set if messages are present. |
| -.current_operation.tasks | operation[] | The list of tasks associated with the current operation. 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. Only set if sub tasks are present. |
| -.clusters | cluster_info[] | The list of cluster's information available in the deployment. 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. Only set if any operation has been performed using the availableVersion. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 401 | unauthenticated | if the user can not be authenticated. |
| 400 | not_allowed_in_current_state | if there is no NSX installed with the current vCenter server. |
| 500 | error | if there is some unknown internal error. The accompanying error message will give more details about the error. |