fortinet.fortimanager.fmgr_system_report_setting module – Report settings.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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 fortinet.fortimanager 2.0.0
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 |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
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. Choices:
|
|
Deprecated, please rename it to capwap_port. Exclude capwap traffic by port. |
|
Deprecated, please rename it to capwap_service. Exclude capwap traffic by service. |
|
Deprecated, please rename it to exclude_capwap. Exclude capwap traffic. disable - Disable. by-port - By port. by-service - By service. Choices:
|
|
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. Choices:
|
|
Deprecated, please rename it to ldap_cache_timeout. LDAP cache timeout in minutes, default 60, 0 means not use cache. |
|
Deprecated, please rename it to max_rpt_pdf_rows. Maximum number of rows can be generated in a single pdf. |
|
Deprecated, please rename it to max_table_rows. Maximum number of rows can be generated in a single table. |
|
Deprecated, please rename it to report_priority. Priority of sql report. high - High low - Low auto - Auto Choices:
|
|
Deprecated, please rename it to template_auto_install. The language used for new ADOMs default - Default. english - English. Choices:
|
|
Deprecated, please rename it to week_start. Day of the week on which the week starts. sun - Sunday. mon - Monday. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- 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>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |