addBreakHAStatus

The addBreakHAStatus operation handles configuration related to BreakHAStatus model.

Data Parameters

Parameter	Required	Type	Description
interfaceOption	False	string	An enum value that specifies how interfaces should be handled after HA break on the active and standby nodes. This attribute is optional when used on the active node, but required when used on a non-active node. If you use this on the active node when the devices are in a healthy active/standby state, this attribute applies to the interfaces on the standby node. In any other state, such as active/active or suspended, the attribute applies to the node on which you initiate the break.
Possible values are:
-DISABLE_INTERFACES (the default). All data interfaces on the standby device (or this device) are disabled.
-ENABLE_WITH_STANDBY_IP. If you configured a standby IP address for an interface, the interface on the standby device (or this device) is reconfigured to use the standby address. Any interface that lacks a standby address is disabled.
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 milliseconds (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
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.
forceRefreshDeploymentData	False	boolean	A flag that makes deployment regenerate all CLI and Snort configurations. Cannot be enabled for this deployment type

Query Parameters

Parameter	Required	Type	Description
clearIntfs	False	boolean	This is a deprecated parameter, please use interfaceOption within the JSON body instead. Whenever interfaceOption is specified, clearIntfs will be ignored. If interafceOption is not specified, setting clearIntfs to TRUE will set interfaceOption to DISABLE_INTERFACES. Setting clearIntfs as FALSE will have no effect.

Example

- name: Execute 'addBreakHAStatus' operation
  ftd_configuration:
    operation: "addBreakHAStatus"
    data:
        interfaceOption: "{{ interface_option }}"
        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 }}"
        type: "{{ type }}"
        forceRefreshDeploymentData: "{{ force_refresh_deployment_data }}"
    query_params:
        clearIntfs: "{{ clear_intfs }}"