startUpgrade

Query Parameters

Parameter	Required	Type	Description
cancelOnFailure	False	boolean	A Boolean value, TRUE or FALSE. This parameter is optional and its default value is defined in UpgradeFile API. TRUE value indicates that this action will install the upgrade image and will perform the restoration operation to get to the state before the upgrade if the upgrade fails. FALSE value indicates that this action will install the upgrade image and will stop if the upgrade fails.

Example

yaml

Copy- name: Execute 'startUpgrade' operation
  ftd_configuration:
    operation: "startUpgrade"
    query_params:
        cancelOnFailure: "{{ cancel_on_failure }}"