failover.upgrade

Upgrades both controllers. Files will be downloaded to the Active Controller and then transferred to the Standby Controller. Upgrade process will start concurrently on both nodes. Once both upgrades are applied, the Standby Controller will reboot. This job will wait for that job to complete before finalizing.

This method is a job.

This job CAN be used with file upload. See Uploading a File.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: failover_upgrade

failover_upgrade

Type: object
Default:
{ "train": null, "version": null, "resume": false, "resume_manual": false }

Failover upgrade configuration options.

 No Additional Properties

Train

Default: null

Update train to use for the upgrade or null for default.

Type: string

Must be at least 1 characters long

Type: null

Version

Default: null

Specific version to upgrade to or null for latest.

Type: string
Type: null

Resume

Type: boolean Default: false

Should be set to true if a previous call to this method returned a CallError with errno=EAGAIN meaning that an upgrade can be performed with a warning and that warning is accepted. In that case, you also have to set resume_manual to true if a previous call to this method was performed using update file upload.

Resume Manual

Type: boolean Default: false

Whether to resume a manual upgrade operation.

Result

Type: boolean

Returns true when the failover upgrade is successfully initiated.


Required roles: FAILOVER_WRITE