addJoinHAStatus

The addJoinHAStatus operation handles configuration related to JoinHAStatus model.

Description

This API call is not allowed on the standby unit in an HA pair.

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
type	False	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

Example

- name: Execute 'addJoinHAStatus' operation
  ftd_configuration:
    operation: "addJoinHAStatus"
    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 }}"
        type: "{{ type }}"
        forceRefreshDeploymentData: "{{ force_refresh_deployment_data }}"