dux_fortinet.fortianalyzer_dev.faz_cli_system_fortiview_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: FortiView settings.
      fortinet.fortianalyzer.faz_cli_system_fortiview_setting:
        cli_system_fortiview_setting:
          not_scanned_apps: exclude
          resolve_ip: disable
  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_fortiview_setting:
    description: The top level parameters set.
    required: false
    suboptions:
      data-source:
        choices:
        - auto
        - cache-only
        - log-and-cache
        description:
        - Data soure of the fortiview query.
        - auto - Data from hcache, and from logs in a flexible way.
        - cache-only - Data from hcache only.
        - log-and-cache - Data from logs and hcache.
        type: str
      not-scanned-apps:
        choices:
        - exclude
        - include
        description:
        - Include/Exclude Not.Scanned applications in FortiView. Set as exclude if you
          want to filter out never scanned applications.
        - exclude - Exclude Not.Scanned applications in FortiView.
        - include - Include Not.Scanned applications in FortiView.
        type: str
      resolve-ip:
        choices:
        - disable
        - enable
        description:
        - Enable or disable resolving IP address to hostname in FortiView.
        - disable - Disable resolving IP address to hostname.
        - enable - Enable resolving IP address to hostname.
        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