get-upgrade-status¶

Description¶

The current status of the CDE Service upgrade. If all the steps are completed allStepsCompleted would be true. After a particular step triggered by upgrade-service is completed nextStep would point to the next step to take.

Synopsis¶

  get-upgrade-status
--cluster-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

Cluster ID of the service.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

upgradeStatusMessage -> (string)

The status of the upgrade.

nextStep -> (string)

The next step to take in multi-step upgrade process. Currently supported steps are prepare, backup, upgrade and resume.

allStepsCompleted -> (boolean)

Whether all the steps of the multi-step upgrade process completed.

Form Factors¶

public, private