drmofu.fortianalyzer.faz_cli_system_locallog_syslogd_filter (1.3.0) — module

Filter for syslog logging.

| "added in version" 1.0.0 of drmofu.fortianalyzer"

Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

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

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- collections:
    - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer_inventory
  tasks:
    - faz_cli_system_locallog_syslogd_filter:
        cli_system_locallog_syslogd_filter:
          # aid: disable
          devcfg: disable
          devops: disable
          diskquota: disable
          dm: disable
          # docker: disable
          dvm: disable
          ediscovery: disable
          epmgr: disable
          event: disable
          eventmgmt: disable
          faz: disable
          fazha: disable
          fazsys: disable
          fgd: disable
          fgfm: disable
          fips: disable
          fmgws: disable
          fmlmgr: disable
          fmwmgr: disable
          fortiview: disable
          glbcfg: disable
          ha: disable
          hcache: disable
          # incident: disable
          iolog: disable
          logd: disable
          logdb: disable
          logdev: disable
          # logfile: <value in [enable, disable]>
          logging: disable
          lrmgr: disable
          objcfg: disable
          report: disable
          rev: disable
          rtmon: disable
          scfw: disable
          scply: disable
          scrmgr: disable
          scvpn: disable
          system: disable
          webport: disable
      name: Filter for syslog logging.
  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_filter:
    description: the top level parameters set
    required: false
    suboptions:
      aid:
        choices:
        - disable
        - enable
        description:
        - Log aid messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      controller:
        choices:
        - disable
        - enable
        description:
        - Controller application generic messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      devcfg:
        choices:
        - disable
        - enable
        description:
        - Log device configuration message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      devops:
        choices:
        - disable
        - enable
        description:
        - Managered devices operations messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      diskquota:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer disk quota messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      dm:
        choices:
        - disable
        - enable
        description:
        - Log deployment manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      docker:
        choices:
        - disable
        - enable
        description:
        - Docker application generic messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      dvm:
        choices:
        - disable
        - enable
        description:
        - Log device manager messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      ediscovery:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer ediscovery messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      epmgr:
        choices:
        - disable
        - enable
        description:
        - Log endpoint manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      event:
        choices:
        - disable
        - enable
        description:
        - Log event messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      eventmgmt:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer event handler messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      faz:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fazha:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer HA messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fazsys:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer system messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fgd:
        choices:
        - disable
        - enable
        description:
        - Log FortiGuard service message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fgfm:
        choices:
        - disable
        - enable
        description:
        - Log FGFM protocol message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fips:
        choices:
        - disable
        - enable
        description:
        - Whether to log fips messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fmgws:
        choices:
        - disable
        - enable
        description:
        - Log web service messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fmlmgr:
        choices:
        - disable
        - enable
        description:
        - Log FortiMail manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fmwmgr:
        choices:
        - disable
        - enable
        description:
        - Log firmware manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fortiview:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer FortiView messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      glbcfg:
        choices:
        - disable
        - enable
        description:
        - Log global database message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      ha:
        choices:
        - disable
        - enable
        description:
        - Log HA message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      hcache:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer hcache messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      incident:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer incident messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      iolog:
        choices:
        - disable
        - enable
        description:
        - Log debug IO log message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      logd:
        choices:
        - disable
        - enable
        description:
        - Log the status of log daemon.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      logdb:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer log DB messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      logdev:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer log device messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      logfile:
        choices:
        - enable
        - disable
        description:
        - Log Fortianalyzer log file messages.
        - enable - Enable setting.
        - disable - Disable setting.
        type: str
      logging:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer logging messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      lrmgr:
        choices:
        - disable
        - enable
        description:
        - Log log and report manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      objcfg:
        choices:
        - disable
        - enable
        description:
        - Log object configuration change message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      report:
        choices:
        - disable
        - enable
        description:
        - Log Fortianalyzer report messages.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      rev:
        choices:
        - disable
        - enable
        description:
        - Log revision history message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      rtmon:
        choices:
        - disable
        - enable
        description:
        - Log real-time monitor message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      scfw:
        choices:
        - disable
        - enable
        description:
        - Log firewall objects message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      scply:
        choices:
        - disable
        - enable
        description:
        - Log policy console message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      scrmgr:
        choices:
        - disable
        - enable
        description:
        - Log script manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      scvpn:
        choices:
        - disable
        - enable
        description:
        - Log VPN console message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      system:
        choices:
        - disable
        - enable
        description:
        - Log system manager message.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      webport:
        choices:
        - disable
        - enable
        description:
        - Log web portal message.
        - disable - Disable setting.
        - enable - Enable setting.
        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