dux_fortinet.fortianalyzer_dev.faz_cli_system_locallog_syslogd_setting (1.4.0) — module

Install collection

Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0

Add to requirements.yml

  collections:
    - name: dux_fortinet.fortianalyzer_dev
      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

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

- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Settings for remote syslog server.
      fortinet.fortianalyzer.faz_cli_system_locallog_syslogd_setting:
        cli_system_locallog_syslogd_setting:
          csv: disable
          # facility: <value in [kernel, user, ntp, ...]>
          # severity: <value in [emergency, alert, critical, ...]>
          status: disable
          # syslog_name: <value of string>
  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_locallog_syslogd_setting:
    description: The top level parameters set.
    required: false
    suboptions:
      cert:
        description: Select local certificate used for secure connection.
        type: str
      csv:
        choices:
        - disable
        - enable
        description:
        - CSV format.
        - disable - Disable CSV format.
        - enable - Enable CSV format.
        type: str
      facility:
        choices:
        - kernel
        - user
        - ntp
        - audit
        - alert
        - clock
        - mail
        - daemon
        - auth
        - syslog
        - lpr
        - news
        - uucp
        - cron
        - authpriv
        - ftp
        - local0
        - local1
        - local2
        - local3
        - local4
        - local5
        - local6
        - local7
        description:
        - Remote syslog facility.
        - kernel - Kernel messages.
        - user - Random user-level messages.
        - ntp - NTP daemon.
        - audit - Log audit.
        - alert - Log alert.
        - clock - Clock daemon.
        - mail - Mail system.
        - daemon - System daemons.
        - auth - Security/authorization messages.
        - syslog - Messages generated internally by syslog daemon.
        - lpr - Line printer subsystem.
        - news - Network news subsystem.
        - uucp - Network news subsystem.
        - cron - Clock daemon.
        - authpriv - Security/authorization messages (private).
        - ftp - FTP daemon.
        - local0 - Reserved for local use.
        - local1 - Reserved for local use.
        - local2 - Reserved for local use.
        - local3 - Reserved for local use.
        - local4 - Reserved for local use.
        - local5 - Reserved for local use.
        - local6 - Reserved for local use.
        - local7 - Reserved for local use.
        type: str
      reliable:
        choices:
        - disable
        - enable
        description:
        - Enable/disable reliable realtime logging.
        - disable - Disable reliable realtime logging.
        - enable - Enable reliable realtime logging.
        type: str
      secure-connection:
        choices:
        - disable
        - enable
        description:
        - Enable/disable connection secured by TLS/SSL.
        - disable - Disable SSL connection.
        - enable - Enable SSL connection.
        type: str
      severity:
        choices:
        - emergency
        - alert
        - critical
        - error
        - warning
        - notification
        - information
        - debug
        description:
        - Least severity level to log.
        - emergency - Emergency level.
        - alert - Alert level.
        - critical - Critical level.
        - error - Error level.
        - warning - Warning level.
        - notification - Notification level.
        - information - Information level.
        - debug - Debug level.
        type: str
      status:
        choices:
        - disable
        - enable
        description:
        - Remote syslog log.
        - disable - Do not log to remote syslog server.
        - enable - Log to remote syslog server.
        type: str
      syslog-name:
        description: Remote syslog server name.
        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