drmofu.fortimanager.fmgr_system_locallog_disk_filter (2.2.2) — module

Filter for disk logging.

| "added in version" 2.0.0 of drmofu.fortimanager"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2


Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager 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.
 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Filter for disk logging.
      fmgr_system_locallog_disk_filter:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         system_locallog_disk_filter:
            devcfg: <value in [disable, enable]>
            devops: <value in [disable, enable]>
            diskquota: <value in [disable, enable]>
            dm: <value in [disable, enable]>
            dvm: <value in [disable, enable]>
            ediscovery: <value in [disable, enable]>
            epmgr: <value in [disable, enable]>
            event: <value in [disable, enable]>
            eventmgmt: <value in [disable, enable]>
            faz: <value in [disable, enable]>
            fazha: <value in [disable, enable]>
            fazsys: <value in [disable, enable]>
            fgd: <value in [disable, enable]>
            fgfm: <value in [disable, enable]>
            fips: <value in [disable, enable]>
            fmgws: <value in [disable, enable]>
            fmlmgr: <value in [disable, enable]>
            fmwmgr: <value in [disable, enable]>
            fortiview: <value in [disable, enable]>
            glbcfg: <value in [disable, enable]>
            ha: <value in [disable, enable]>
            hcache: <value in [disable, enable]>
            iolog: <value in [disable, enable]>
            logd: <value in [disable, enable]>
            logdb: <value in [disable, enable]>
            logdev: <value in [disable, enable]>
            logfile: <value in [enable, disable]>
            logging: <value in [disable, enable]>
            lrmgr: <value in [disable, enable]>
            objcfg: <value in [disable, enable]>
            report: <value in [disable, enable]>
            rev: <value in [disable, enable]>
            rtmon: <value in [disable, enable]>
            scfw: <value in [disable, enable]>
            scply: <value in [disable, enable]>
            scrmgr: <value in [disable, enable]>
            scvpn: <value in [disable, enable]>
            system: <value in [disable, enable]>
            webport: <value in [disable, enable]>
            incident: <value in [disable, enable]>
            aid: <value in [disable, enable]>
            docker: <value in [disable, enable]>

Inputs

    
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:
    - update
    - set
    - 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 FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

system_locallog_disk_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
      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 FortiManager version.
  returned: complex
  type: list