fadcos_system_ha – HA configuration in Fortinet’s FortiADC

New in version 1.0.2.

Synopsis

  • Configure FortiADC HA

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.8

FortiADC Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.1.0 v7.1.4 v7.2.0 v7.2.2 v7.4.0
fadcos_system_ha yes yes yes yes yes yes yes yes

Parameters

  • mgmt_interface - Management interface. type: str required: false
  • local_node_id - local node id (0-7). type: str required: false
  • peer_address - Fort unicast peer ip address. type: str required: false
  • group_name - group name. type: str required: false
  • sync_l4_persistent - sync l4 persistent. type: str required: false
  • monitor_enable - interface list to track. type: str required: false
  • hbdev - heartbeat port. type: str required: false
  • mgmt_ip_allowaccess - Allow access with the management ip address. type: str required: false
  • config_priority - ha config priority. type: str required: false
  • hb_lost_threshold - lost heartbeat threshold (1-60). type: str required: false
  • override - override on resurge. type: str required: false
  • groupid - group id (0-31). type: str required: false
  • node_list - node id. type: str required: false
  • local_address - For unicast local listening ip address. type: str required: false
  • mgmt_ip - IP address of management interface. type: str required: false
  • sync_l4_connection - sync l4 connection. type: str required: false
  • datadev - data port. type: str required: false
  • arp_num - num for sending (1-60). type: str required: false
  • failover_hold_time - failover hold time for remote ip (60-86400 sec). type: str required: false
  • interval - heartbeat interval. type: str required: false
  • arp_interval - interval for sending arp (1-20 sec). type: str required: false
  • mode - high availability mode. type: str required: false
  • mgmt_status - Management status enable/disable. type: str required: false
  • interface_list - interface list to track. type: str required: false
  • sync_l7_persistent - sync http persistent. type: str required: false
  • hbtype - heartbeat type. type: str required: false
  • failover_threshold - failover threshold for remote ip (1-64). type: str required: false
  • priority - ha priority (0-9). type: str required: false

Examples

- name:
  hosts: all
  vars:
  connection: httpapi
  gather_facts: false
  tasks:
    - name: edit
      vars:
       ansible_command_timeout: 60
       #ha setting need more time so set timeout to 60s
      fadcos_system_ha:
       mgmt_interface:
       local_node_id: 0
       peer_address: 0.0.0.0
       group_name: 1
       sync_l4_persistent: disable
       monitor_enable: disable
       hbdev: port5
       mgmt_ip_allowaccess:
       config_priority: 100
       hb_lost_threshold: 6
       isSystemAdmin: True
       override: disable
       groupid: 0
       node_list: 0
       local_address: 0.0.0.0
       isSystemWritable: True
       mgmt_ip: 0.0.0.0/0
       sync_l4_connection: disable
       datadev: port2
       arp_num: 5
       failover_hold_time: 120
       interval: 2
       arp_interval: 6
       mode: active-passive
       mgmt_status: disable
       interface_list: port2
       sync_l7_persistent: disable
       hbtype: multicast
       failover_threshold: 5
       priority: 1

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • 200 - OK: Request returns successful.
  • 400 - Bad Request: Request cannot be processed by the API.
  • 401 - Not Authorized: Request without successful login session.
  • 403 - Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
  • 404 - Resource Not Found: Unable to find the specified resource.
  • 405 - Method Not Allowed: Specified HTTP method is not allowed for this resource.
  • 413 - Request Entity Too Large: Request cannot be processed due to large entity.
  • 424 - Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, or invalid attribute value.
  • 429 - Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
  • 500 - Internal Server Error: Internal error when processing the request.

For errorcode please check FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Jie Li
  • Aravindh Sri

Hint

If you notice any issues in this documentation, you can create a pull request to improve it at: https://github.com/fortinet-ansible-dev/ansible-galaxy-fortiadc-sphinxdoc/pulls