upsertHAFailoverConfiguration

The upsertHAFailoverConfiguration operation handles configuration related to HAFailoverConfiguration model.

Description

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

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	False	string	A string that represents the name of the object
peerPollTime	True	object	The peer poll time, which is how often to send hello packets across the failover link. Peer poll time is between 200 and 999 milliseconds, or 1000 and 15000 in multiples of 1000. The timeUnit can be only MILLISECONDS or SECONDS Field level constraints: cannot be null. (Note: Additional constraints might exist)
peerHoldTime	True	object	The peer hold time, which is how long to wait before making a failover assessment after not receiving a reply to a peer poll packet. Peer hold time is between 800 and 999 milliseconds, or 1000 and 45000 in multiples of 1000. You must enter a value that is at least 3 times the peerPollTimeInMsecs value. The timeUnit can be only MILLISECONDS or SECONDS Field level constraints: cannot be null. (Note: Additional constraints might exist)
interfacePollTime	True	object	The interface poll time, which is how often the hello packets are sent across interfaces. Interface poll time can be between 500 and 999 milliseconds. If higher should be in multiples of 1000 up to 15000 (1 second to 15 seconds). The timeUnit can be only MILLISECONDS or SECONDS Field level constraints: cannot be null. (Note: Additional constraints might exist)
interfaceHoldTime	True	object	The interface hold time, which is how long to wait before failure assessment when a hello packet is not replied back. Interface hold time can be between 25000 and 75000 milliseconds in multiples of 1000. (5 to 75 seconds). Interface HoldTime should minimum five times the unit Interface PollTime. The timeUnit can be only MILLISECONDS or SECONDS Field level constraints: cannot be null. (Note: Additional constraints might exist)
interfaceFailureThreshold	True	integer	Field level constraints: cannot be null. (Note: Additional constraints might exist)
interfaceFailureUnit	True	string	Field level constraints: cannot be null. (Note: Additional constraints might exist)
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Query Parameters

Parameter	Required	Type	Description
filter	False	string	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertHAFailoverConfiguration' operation
  ftd_configuration:
    operation: "upsertHAFailoverConfiguration"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        peerPollTime: "{{ peer_poll_time }}"
        peerHoldTime: "{{ peer_hold_time }}"
        interfacePollTime: "{{ interface_poll_time }}"
        interfaceHoldTime: "{{ interface_hold_time }}"
        interfaceFailureThreshold: "{{ interface_failure_threshold }}"
        interfaceFailureUnit: "{{ interface_failure_unit }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"