fortinet.fortimanager.fmgr_system_report_setting (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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

Scanned by Steampunk Spotter

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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Report settings.
      fortinet.fortimanager.fmgr_system_report_setting:
        # 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_report_setting:
          aggregate_report: <value in [disable, enable]>
          hcache_lossless: <value in [disable, enable]>
          ldap_cache_timeout: <integer>
          max_table_rows: <integer>
          report_priority: <value in [high, low, auto]>
          template_auto_install: <value in [default, english]>
          week_start: <value in [sun, mon]>
          capwap_port: <integer>
          capwap_service: <string>
          exclude_capwap: <value in [disable, by-port, by-service]>
          max_rpt_pdf_rows: <integer>

Inputs

    
rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    type: bool

system_report_setting:
    description: The top level parameters set.
    required: false
    suboptions:
      aggregate-report:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to aggregate_report.
        - Enable/disable including a group report along with the per-device reports.
        - disable - Exclude a group report along with the per-device reports.
        - enable - Include a group report along with the per-device reports.
        type: str
      capwap-port:
        description: Deprecated, please rename it to capwap_port. Exclude capwap traffic
          by port.
        type: int
      capwap-service:
        description: Deprecated, please rename it to capwap_service. Exclude capwap traffic
          by service.
        type: str
      exclude-capwap:
        choices:
        - disable
        - by-port
        - by-service
        description:
        - Deprecated, please rename it to exclude_capwap.
        - Exclude capwap traffic.
        - disable - Disable.
        - by-port - By port.
        - by-service - By service.
        type: str
      hcache-lossless:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to hcache_lossless.
        - Usableness of ready-with-loss hcaches.
        - disable - Use ready-with-loss hcaches.
        - enable - Do not use ready-with-loss hcaches.
        type: str
      ldap-cache-timeout:
        description: Deprecated, please rename it to ldap_cache_timeout. LDAP cache timeout
          in minutes, default 60, 0 means not use cache.
        type: int
      max-rpt-pdf-rows:
        description: Deprecated, please rename it to max_rpt_pdf_rows. Maximum number
          of rows can be generated in a single pdf.
        type: int
      max-table-rows:
        description: Deprecated, please rename it to max_table_rows. Maximum number of
          rows can be generated in a single table.
        type: int
      report-priority:
        choices:
        - high
        - low
        - auto
        description:
        - Deprecated, please rename it to report_priority.
        - Priority of sql report.
        - high - High
        - low - Low
        - auto - Auto
        type: str
      template-auto-install:
        choices:
        - default
        - english
        description:
        - Deprecated, please rename it to template_auto_install.
        - The language used for new ADOMs
        - default - Default.
        - english - English.
        type: str
      week-start:
        choices:
        - sun
        - mon
        description:
        - Deprecated, please rename it to week_start.
        - Day of the week on which the week starts.
        - sun - Sunday.
        - mon - Monday.
        type: str
    type: dict

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

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

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

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