REST API - get
  1. Operations
  2. vcenter
  3. nsx
  4. deployment
  5. upgrade status

vcenter nsx deployment upgrade status: get

Gets the information about the current NSX upgrade operation. 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-status

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "upgrade_status" : "NOT_STARTED"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Info which gives the information about th NSX upgrade operation.
-.upgrade_status string The status of upgrade 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 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.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the user can not be authenticated.
500 error if there is some unknown internal error. The accompanying error message will give more details about the error.