High Availability

Location in GUI: Devices » Device Management » High Availability

Diagram

Classes

devices (fmc.domains)

Name	Type	Constraint	Mandatory	Default Value
ha_pairs	List	`[ha_pairs]`	No

ha_pairs (fmc.domains.devices)

Name	Type	Constraint	Mandatory	Default Value
name	String		No
primary_device	String		No
secondary_device	String		No
ha_link_logical_name	String		No
ha_link_interface_name	String		No
ha_link_primary_ip	IP		No
ha_link_secondary_ip	IP		No
ha_link_netmask	IP		No
state_link_use_same_as_ha	Boolean	`true`, `false`	No
action	Choice	`SWITCH`	No
encryption_enabled	Boolean	`true`, `false`	No
encryption_key	String		No
encryption_key_generation_scheme	Choice	`AUTO`, `CUSTOM`	No
failed_interfaces_limit	Integer	min: `1`, max: `211`	No	`1`
failed_interfaces_percent	Integer	min: `1`, max: `100`	No
ha_link_use_ipv6	Boolean	`true`, `false`	No
interface_hold_time	Integer	min: `25`, max: `75`	No
interface_poll_time	Integer	min: `1`, max: `999`	No
interface_poll_time_unit	Choice	`SEC`, `MSEC`	No
peer_hold_time	Integer	min: `3`, max: `999`	No
peer_hold_time_unit	Choice	`SEC`, `MSEC`	No
peer_poll_time	Integer	min: `1`, max: `999`	No
peer_poll_time_unit	Choice	`SEC`, `MSEC`	No
state_link_interface	String		No
state_link_logical_name	String		No
state_link_netmask	String		No
state_link_primary_ip	IP		No
state_link_secondary_ip	IP		No
state_link_use_ipv6	Boolean	`true`, `false`	No
interfaces	List	`[interfaces]`	No

interfaces (fmc.domains.devices.ha_pairs)

Name	Type	Constraint	Mandatory
interface_logical_name	String		No
ipv4_standby_address	IP		No
monitor_interface	Boolean	`true`, `false`	No

Examples

Prerequisites:

fmc:
  domains:
    - name: Global
      policies:
        access_policies:
          - name: MyAccessPolicyName1
            default_action: BLOCK
      devices:
        devices:
          - name: MyDeviceName1
            host: 10.62.158.201
            registration_key: cisco123
            access_policy: MyAccessPolicyName1
            deploy: true
            licenses:
            - ESSENTIALS
            performance_tier: FTDv5
            vrfs:
              - name: Global
                physical_interfaces:
                  - name: "GigabitEthernet0/2"
          - name: MyDeviceName2
            host: 10.62.158.204
            registration_key: cisco123
            access_policy: MyAccessPolicyName1
            deploy: true
            licenses:
            - ESSENTIALS
            performance_tier: FTDv5

High Availability:

fmc:
  domains:
    - name: Global
      devices:
        ha_pairs:
          - name: MyHAName1
            primary_device: MyDeviceName1
            secondary_device: MyDeviceName2
            ha_link_logical_name: failover
            ha_link_interface_name: GigabitEthernet0/2
            ha_link_primary_ip: 10.10.4.1
            ha_link_secondary_ip: 10.10.4.2
            ha_link_netmask: 255.255.255.248
            state_link_use_same_as_ha: true