faz_cli_system_ha – HA configuration.

Added in version 1.0.0.

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

  • Possible variable names before 2.0.0: variable-name, variable name, variable.name

  • Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • This module supports check mode and diff mode.

Requirements

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

  • ansible>=2.16.0

FortiAnalyzer Version Compatibility

Supported Version Ranges: v6.2.1 -> latest

Parameters

  • access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
  • bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
  • enable_log Enable/Disable logging for task type: bool default: False
  • forticloud_access_token Access token of forticloud analyzer API users. type: str
  • log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
  • proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
  • version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
  • rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
  • rc_failed The rc codes list with which the conditions to fail will be overriden type: list
  • 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 Healthchecking options. type: list elements: str choices: [DB, fault-test] more...
    • initial_sync Need to sync data from master before up as an HA member. type: str choices: [false, true, disable, enable] 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, a-a] default: standalone more...
    • password HA group password. type: str elements: str more...
    • peer type: list of dict 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. (needed only when using unicast) type: str more...
      • serial_number Serial number of peer. type: str more...
      • status Peer enabled status. type: str choices: [disable, enable] default: enable more...
      • addr Address of peer for management and data. type: str more...
      • addr_hb Address of peers interface for heartbeat, set if different from ip. (needed only when using unicast) type: str 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 Group password. type: str elements: str more...
    • private_peer type: list of dict 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...
    • private_local_cert set the ha local certificate. type: str more...
    • cfg_sync_hb_interval Config sync heartbeat interval (1 - 80). type: int default: 4 more...
    • local_cert set the ha local certificate. type: str 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

- name: Example playbook
  gather_facts: false
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: HA configuration.
      fortinet.fortianalyzer.faz_cli_system_ha:
        cli_system_ha:
          log_sync: disable
          mode: standalone
  vars:
    ansible_network_os: fortinet.fortianalyzer.fortianalyzer
    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:

  • meta The result of the request. returned: always type: dict
    • 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_data The data body of the api response. returned: optional type: list or dict
    • response_message The descriptive message of the api response. returned: always type: str sample: OK
    • system_information The information of the target system. returned: always type: dict
  • rc The status the request. returned: always type: int sample: 0
  • version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Maxx Liu (@MaxxLiu22)

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)