upsertHAConfiguration

The upsertHAConfiguration operation handles configuration related to HAConfiguration 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 True string The name of HA, configured for modeling purpose and cannot be null
nodeRole True string The role of the unit in HA, can be primary or secondary
Field level constraints: cannot be null. (Note: Additional constraints might exist)
failoverInterface True object A dedicated link between two units used for syncing in case of failover. Must be a physical interface
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
failoverName True string A logical name for the failover interface
Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
primaryFailoverIPv4 False object IPv4 address of the primary failover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
secondaryFailoverIPv4 False object IPv4 address of the secondary failover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
primaryFailoverIPv6 False object IPv6 address of the primary failover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
secondaryFailoverIPv6 False object IPv6 address of the secondary failover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
statefulFailoverInterface True object A dedicated interface used to pass the connection state information during a failover
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
statefulFailoverName True string A logical name for the statefulFailover interface
Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
primaryStatefulFailoverIPv4 False object IPv4 address of the primary statefulFailover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
secondaryStatefulFailoverIPv4 False object IPv4 address of the secondary statefulFailover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
primaryStatefulFailoverIPv6 False object IPv6 address of the primary statefulFailover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
secondaryStatefulFailoverIPv6 False object IPv6 address of the secondary statefulFailover interface
Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
sharedKey False string Encrypted shared key used for encryption between the failover interfaces
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 'upsertHAConfiguration' operation
  ftd_configuration:
    operation: "upsertHAConfiguration"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        nodeRole: "{{ node_role }}"
        failoverInterface: "{{ failover_interface }}"
        failoverName: "{{ failover_name }}"
        primaryFailoverIPv4: "{{ primary_failover_i_pv4 }}"
        secondaryFailoverIPv4: "{{ secondary_failover_i_pv4 }}"
        primaryFailoverIPv6: "{{ primary_failover_i_pv6 }}"
        secondaryFailoverIPv6: "{{ secondary_failover_i_pv6 }}"
        statefulFailoverInterface: "{{ stateful_failover_interface }}"
        statefulFailoverName: "{{ stateful_failover_name }}"
        primaryStatefulFailoverIPv4: "{{ primary_stateful_failover_i_pv4 }}"
        secondaryStatefulFailoverIPv4: "{{ secondary_stateful_failover_i_pv4 }}"
        primaryStatefulFailoverIPv6: "{{ primary_stateful_failover_i_pv6 }}"
        secondaryStatefulFailoverIPv6: "{{ secondary_stateful_failover_i_pv6 }}"
        sharedKey: "{{ shared_key }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"