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

vcenter nsx deployment upgrade: start

Applies available NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the get 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

POST https://{server}/api/vcenter/nsx/deployment/upgrade

?action=start
{
    "mode" : "BATCH"
}

Body Parameters:

Name Type Description
bold = required
- upgrade_spec The information required to start the upgrade.
-.mode string The mode 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 clusters upgrade strategy. The property specifies the sequence in which the clusters for which the NSX is enabled will be upgraded. 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:
BATCH: The clusters with NSX enabled will be upgraded in parallel. The system supports upgrading up to 5 clusters in parallel. 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.
SERIAL: The clusters with NSX enabled will be upgraded in sequence one at a time. 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.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code Type Description
401 unauthenticated if the user can not be authenticated.
400 invalid_argument if the input spec is incorrect.
400 not_allowed_in_current_state if there is no available upgrade or if some other lifecycle operation is in progress.
400 already_in_desired_state if the upgrade is already in progress.
404 not_found if target NSX software is not found on the vCenter server.
500 error if there is some unknown internal error. The accompanying error message will give more details about the error.