UpgradeControllerParams

JSON Example

{
    "controller_patch_ref": "string",
    "dryrun": false,
    "image_ref": "string",
    "prechecks_only": false,
    "skip_warnings": false
}

string

controller_patch_ref

Optional

Image uuid for identifying controller patch image. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

dryrun

Optional

This flag is set to perform the upgrade dry-run operations. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

image_ref

Required

Image uuid for identifying base image. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

prechecks_only

Optional

This flag is set to run the pre-checks without the subsequent upgrade operations. Field introduced in 22.1.6, 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

skip_warnings

Optional

This is flag when set as true skips few optional must checks. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.