addBreakHAStatus

The addBreakHAStatus operation handles configuration related to BreakHAStatus model.

Data Parameters

Parameter	Required	Type	Description
statusMessage	False	string	A string that contains all deployment status messages
cliErrorMessage	False	string	An error message returned from the configuration CLI.
state	False	string	The current deployment state.
queuedTime	False	integer	The time in milliseconds (UNIX Epoch Time) when the deployment was scheduled.
startTime	False	integer	The time in millisecond (UNIX Epoch time) when the deployment was started
endTime	False	integer	The time in milliseconds (UNIX Epoch Time) when the deployment completed.
statusMessages	False	[string]	A list of messages that show deployment status.
name	False	string	Field level constraints: length must be between 0 and 128 (inclusive), must match pattern (^[a-zA-Z0-9]$)\|(^[a-zA-Z0-9][ a-zA-Z0-9.()+-]*[a-zA-Z0-9.+-]$). (Note: Additional constraints might exist)
modifiedObjects	False	object	The modified objects in this deployment

Query Parameters

Parameter	Required	Type	Description
clearIntfs	False	boolean	A Boolean value, TRUE or FALSE. On an active device, this parameter is optional. TRUE value indicates that this action will clear interface configuration on both active and standby devices. FALSE (the default) value indicates that this action will only clear interface configuration on standby device. On a non-active device, this parameter is required and the value has to be TRUE as this action will clear interface configuration on the current device.

Example

- name: Execute 'addBreakHAStatus' operation
  ftd_configuration:
    operation: "addBreakHAStatus"
    data:
        statusMessage: "{{ status_message }}"
        cliErrorMessage: "{{ cli_error_message }}"
        state: "{{ state }}"
        queuedTime: "{{ queued_time }}"
        startTime: "{{ start_time }}"
        endTime: "{{ end_time }}"
        statusMessages: "{{ status_messages }}"
        name: "{{ name }}"
        modifiedObjects: "{{ modified_objects }}"
    query_params:
        clearIntfs: "{{ clear_intfs }}"