drmofu.fortianalyzer.faz_cli_system_ha (1.3.0) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0

Add to requirements.yml

  collections:
    - name: drmofu.fortianalyzer
      version: 1.3.0

Description

This module is able to configure a FortiAnalyzer device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
log_path:
    default: /tmp/fortianalyzer.ansible.log
    description:
    - 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.log
    required: false
    type: str

rc_failed:
    description: the rc codes list with which the conditions to fail will be overriden
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: the rc codes list with which the conditions to succeed will be overriden
    elements: int
    required: false
    type: list

cli_system_ha:
    description: the top level parameters set
    required: false
    suboptions:
      cfg-sync-hb-interval:
        description: Config sync heartbeat interval (1 - 80).
        type: int
      group-id:
        description: HA group ID (1 - 255).
        type: int
      group-name:
        description: HA group name.
        type: str
      hb-interface:
        description: Interface for heartbeat.
        type: str
      hb-interval:
        description: Heartbeat interval (1 - 20).
        type: int
      healthcheck:
        choices:
        - DB
        - fault-test
        description: no description
        elements: str
        type: list
      initial-sync:
        choices:
        - 'false'
        - 'true'
        description:
        - Need to sync data from master before up as an HA member.
        - false - False.
        - true - True.
        type: str
      initial-sync-threads:
        description: Number of threads used for initial sync (1-15).
        type: int
      load-balance:
        choices:
        - disable
        - round-robin
        description:
        - Load balance to slaves.
        - disable - Disable load-balance to slaves.
        - round-robin - Round-Robin mode.
        type: str
      log-sync:
        choices:
        - disable
        - enable
        description:
        - Sync logs to backup FortiAnalyzer.
        - disable - Disable.
        - enable - Enable.
        type: str
      mode:
        choices:
        - standalone
        - a-p
        - a-a
        description:
        - Standalone or HA (a-p) mode
        - standalone - Standalone mode.
        - a-p - Active-Passive mode.
        type: str
      password:
        description: no description
        type: str
      peer:
        description: no description
        elements: dict
        suboptions:
          id:
            description: Id.
            type: int
          ip:
            description: IP address of peer for management and data.
            type: str
          ip-hb:
            description: IP address of peers VIP interface for heartbeat, set if different
              from ip. (needed only when using unicast)
            type: str
          serial-number:
            description: Serial number of peer.
            type: str
          status:
            choices:
            - disable
            - enable
            description:
            - Peer enabled status.
            - disable - Disable.
            - enable - Enable.
            type: str
        type: list
      preferred-role:
        choices:
        - slave
        - master
        - secondary
        - primary
        description:
        - Preferred role, runtime role may be different.
        - slave - Prefer slave mode, FAZ can only become master after data-sync is done.
        - master - Prefer master mode, FAZ can become master if theres no existing master.
        type: str
      priority:
        description: Set the runtime priority between 80 (lowest) - 120 (highest).
        type: int
      private-clusterid:
        description: Cluster ID range (1 - 64).
        type: int
      private-file-quota:
        description: File quota in MB (2048 - 20480).
        type: int
      private-hb-interval:
        description: Heartbeat interval (1 - 255).
        type: int
      private-hb-lost-threshold:
        description: Heartbeat lost threshold (1 - 255).
        type: int
      private-local-cert:
        description: set the ha local certificate.
        type: str
      private-mode:
        choices:
        - standalone
        - master
        - slave
        - primary
        - secondary
        description:
        - Mode.
        - standalone - Standalone.
        - master - Master.
        - slave - Slave.
        type: str
      private-password:
        description: no description
        type: str
      private-peer:
        description: no description
        elements: dict
        suboptions:
          id:
            description: Id.
            type: int
          ip:
            description: IP address of peer.
            type: str
          ip6:
            description: IP address (V6) of peer.
            type: str
          serial-number:
            description: Serial number of peer.
            type: str
          status:
            choices:
            - disable
            - enable
            description:
            - Peer admin status.
            - disable - Disable.
            - enable - Enable.
            type: str
        type: list
      unicast:
        choices:
        - disable
        - enable
        description:
        - Use unicast for HA heartbeat.
        - disable - HA heartbeat through multicast.
        - enable - HA heartbeat through unicast.
        type: str
      vip:
        description: Virtual IP address for the HA
        type: str
      vip-interface:
        description: Interface for configuring virtual IP address
        type: str
    type: dict

proposed_method:
    choices:
    - set
    - update
    - add
    description: The overridden method for the underlying Json RPC request
    required: false
    type: str

bypass_validation:
    default: false
    description: only set to True when module schema diffs with FortiAnalyzer API structure,
      module continues to execute without validating parameters
    required: false
    type: bool

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

Outputs

meta:
  contains:
    request_url:
      description: The full url requested
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current fortianalyzer version.
  returned: complex
  type: list