faz_cli_system_ha – HA configuration.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

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

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
cli_system_ha yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • cli_system_ha - HA configuration. type: dict
    • group-id - HA group ID (1 - 255). type: int default: 0 more...
    • group-name - HA group name. type: str more...
    • hb-interface - Interface for heartbeat. type: str more...
    • hb-interval - Heartbeat interval (1 - 20). type: int default: 1 more...
    • healthcheck - No description for the parameter type: array choices: [DB, fault-test] more...
    • initial-sync - Need to sync data from master before up as an HA member. type: str choices: [false, true] default: true more...
    • initial-sync-threads - Number of threads used for initial sync (1-15). type: int default: 4 more...
    • load-balance - Load balance to slaves. type: str choices: [disable, round-robin] default: round-robin more...
    • log-sync - Sync logs to backup FortiAnalyzer. type: str choices: [disable, enable] default: enable more...
    • mode - Standalone or HA (a-p) mode type: str choices: [standalone, a-p] default: standalone more...
    • password - No description for the parameter type: str more...
    • peer - No description for the parameter type: array more...
      • id - Id. type: int default: 0 more...
      • ip - IP address of peer for management and data. type: str more...
      • ip-hb - IP address of peers VIP interface for heartbeat, set if different from ip. type: str more...
      • serial-number - Serial number of peer. type: str more...
      • status - Peer enabled status. type: str choices: [disable, enable] default: enable more...
    • preferred-role - Preferred role, runtime role may be different. type: str choices: [slave, master, secondary, primary] default: slave more...
    • priority - Set the runtime priority between 80 (lowest) - 120 (highest). type: int default: 100 more...
    • private-clusterid - Cluster ID range (1 - 64). type: int default: 1 more...
    • private-file-quota - File quota in MB (2048 - 20480). type: int default: 4096 more...
    • private-hb-interval - Heartbeat interval (1 - 255). type: int default: 5 more...
    • private-hb-lost-threshold - Heartbeat lost threshold (1 - 255). type: int default: 3 more...
    • private-mode - Mode. type: str choices: [standalone, master, slave, primary, secondary] default: standalone more...
    • private-password - No description for the parameter type: str more...
    • private-peer - No description for the parameter type: array more...
      • id - Id. type: int default: 0 more...
      • ip - IP address of peer. type: str more...
      • ip6 - IP address (V6) of peer. type: str default: :: more...
      • serial-number - Serial number of peer. type: str more...
      • status - Peer admin status. type: str choices: [disable, enable] default: enable more...
    • unicast - Use unicast for HA heartbeat. type: str choices: [disable, enable] default: disable more...
    • vip - Virtual IP address for the HA type: str more...
    • vip-interface - Interface for configuring virtual IP address type: str more...
    • cfg-sync-hb-interval - Config sync heartbeat interval (1 - 80). type: int default: 4 more...

Notes

Note

  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_ha:
      cli_system_ha:
        log-sync: disable
        mode: standalone
    name: HA configuration.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.