fortinet.fortimanager.fmgr_system_report_setting – Report settings.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_report_setting.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • 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.

Parameters

Parameter Choices/Defaults Comments
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_report_setting
dictionary
the top level parameters set
aggregate-report
string
    Choices:
  • disable ←
  • enable
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.
capwap-port
integer
Default:
5246
Exclude capwap traffic by port.
capwap-service
string
Exclude capwap traffic by service.
exclude-capwap
string
    Choices:
  • disable
  • by-port ←
  • by-service
Exclude capwap traffic.
disable - Disable.
by-port - By port.
by-service - By service.
hcache-lossless
string
    Choices:
  • disable ←
  • enable
Usableness of ready-with-loss hcaches.
disable - Use ready-with-loss hcaches.
enable - Do not use ready-with-loss hcaches.
ldap-cache-timeout
integer
Default:
60
LDAP cache timeout in minutes, default 60, 0 means not use cache.
max-table-rows
integer
Default:
10000
Maximum number of rows can be generated in a single table.
report-priority
string
    Choices:
  • high
  • low
  • auto ←
Priority of sql report.
high - High
low - Low
auto - Auto
template-auto-install
string
    Choices:
  • default ←
  • english
The language used for new ADOMs (default = default).
default - Default.
english - English.
week-start
string
    Choices:
  • sun ←
  • mon
Day of the week on which the week starts.
sun - Sunday.
mon - Monday.
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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: Report settings.
     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: <value of integer>
           max-table-rows: <value of integer>
           report-priority: <value in [high, low, auto]>
           template-auto-install: <value in [default, english]>
           week-start: <value in [sun, mon]>
           capwap-port: <value of integer>
           capwap-service: <value of string>
           exclude-capwap: <value in [disable, by-port, by-service]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)