UpgradeParams

UpgradeParams
UpgradeParams
JSON Example
{
    "controller_patch_ref": "string",
    "dryrun": false,
    "image_ref": "string",
    "prechecks_only": false,
    "se_group_options": {
        "action_on_error": "string",
        "disruptive": false
    },
    "se_group_refs": [
        "string"
    ],
    "se_patch_ref": "string",
    "skip_warnings": false,
    "system": false
}
string
controller_patch_ref
Optional

Image uuid for identifying Controller patch. 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, Enterprise with Cloud Services edition.

string
image_ref
Optional

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, Enterprise with Cloud Services edition.

se_group_options
Optional

se_group_options

array of string
se_group_refs
Optional

This field identifies the list of SE groups for which the upgrade operations are applicable. This field is ignored if the 'system' is enabled. It is a reference to an object of type ServiceEngineGroup. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
se_patch_ref
Optional

Image uuid for identifying Service Engine patch. 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
skip_warnings
Optional

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

boolean
system
Optional

Apply upgrade operations such as Upgrade/Patch to Controller and ALL SE groups. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of