Steampunk Ansible Documentation - fortinet.fortianalyzer.faz_cli_system_log_settings_rollinganalyzer (1.4.0) - module - Log rolling policy for Network Analyzer logs.

Install collection

Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortianalyzer
      version: 1.4.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

- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Log rolling policy for Network Analyzer logs.
      fortinet.fortianalyzer.faz_cli_system_log_settings_rollinganalyzer:
        cli_system_log_settings_rollinganalyzer:
          days:
            - sun
            - mon
            - tue
            - wed
            - thu
            - fri
            - sat
          del_files: disable
          gzip_format: disable
          upload: disable
          when: none
  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

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

cli_system_log_settings_rollinganalyzer:
description: The top level parameters set.
required: false
suboptions:
days:
choices:
- sun
- mon
- tue
- wed
- thu
- fri
- sat
description: no description
elements: str
type: list
del-files:
choices:
- disable
- enable
description:
- Enable/disable log file deletion after uploading.
- disable - Disable log file deletion.
- enable - Enable log file deletion.
type: str
directory:
description: Upload server directory, for Unix server, use absolute
type: str
file-size:
description: Roll log files when they reach this size (MB).
type: int
gzip-format:
choices:
- disable
- enable
description:
- Enable/disable compression of uploaded log files.
- disable - Disable compression.
- enable - Enable compression.
type: str
hour:
description: Log files rolling schedule (hour).
type: int
ip:
description: Upload server IP address.
type: str
ip2:
description: Upload server IP2 address.
type: str
ip3:
description: Upload server IP3 address.
type: str
log-format:
choices:
- native
- text
- csv
description:
- Format of uploaded log files.
- native - Native format (text or compact).
- text - Text format (convert if necessary).
- csv - CSV (comma-separated value) format.
type: str
min:
description: Log files rolling schedule (minutes).
type: int
password:
description: no description
type: str
password2:
description: no description
type: str
password3:
description: no description
type: str
port:
description: Upload server IP1 port number.
type: int
port2:
description: Upload server IP2 port number.
type: int
port3:
description: Upload server IP3 port number.
type: int
rolling-upgrade-status:
description: rolling upgrade status (1|0).
type: int
server:
description: Upload server FQDN/IP.
type: str
server-type:
choices:
- ftp
- sftp
- scp
description:
- Upload server type.
- ftp - Upload via FTP.
- sftp - Upload via SFTP.
- scp - Upload via SCP.
type: str
server2:
description: Upload server2 FQDN/IP.
type: str
server3:
description: Upload server3 FQDN/IP.
type: str
upload:
choices:
- disable
- enable
description:
- Enable/disable log file uploads.
- disable - Disable log files uploading.
- enable - Enable log files uploading.
type: str
upload-hour:
description: Log files upload schedule (hour).
type: int
upload-mode:
choices:
- backup
- mirror
description:
- Upload mode with multiple servers.
- backup - Servers are attempted and used one after the other upon failure to
connect.
- mirror - All configured servers are attempted and used.
type: str
upload-trigger:
choices:
- on-roll
- on-schedule
description:
- Event triggering log files upload.
- on-roll - Upload log files after they are rolled.
- on-schedule - Upload log files daily.
type: str
username:
description: Upload server login username.
type: str
username2:
description: Upload server login username2.
type: str
username3:
description: Upload server login username3.
type: str
when:
choices:
- none
- daily
- weekly
description:
- Roll log files periodically.
- none - Do not roll log files periodically.
- daily - Roll log files daily.
- weekly - Roll log files on certain days of week.
type: str
type: dict

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