:source: faz_report_config_schedule.py
:orphan:
.. _faz_report_config_schedule:
faz_report_config_schedule -- Config schedule.
++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.5.0
.. warning::
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
- Possible variable names before 2.0.0: ``variable-name``, ``variable name``, ``variable.name``
- Corresponding variable names since 2.0.0: ``variable_name``
FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiAnalyzer device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- This module supports check mode and diff mode.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16.0
FortiAnalyzer Version Compatibility
------------------------------------
.. raw:: html
Supported Version Ranges: v6.2.1 -> latest
Parameters
----------
.. raw:: html
access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
enable_log Enable/Disable logging for task type: bool default: False
forticloud_access_token Access token of forticloud analyzer API users. type: str
log_path 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.logtype: str default: "/tmp/fortianalyzer.ansible.log"
proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: True
rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
rc_failed The rc codes list with which the conditions to fail will be overriden type: list
state The directive to create, update or delete an object type: strrequired: true choices: present, absent
adom The parameter in requested url type: strrequired: true
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
Notes
-----
.. note::
- 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
--------
.. code-block:: yaml+jinja
- name: Example playbook
hosts: fortianalyzers
connection: httpapi
gather_facts: false
vars:
ansible_network_os: fortinet.fortianalyzer.fortianalyzer
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
tasks:
- name: Config schedule.
fortinet.fortianalyzer.faz_report_config_schedule:
# bypass_validation: false
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom:
state: present #
report_config_schedule:
name: "your value" # Required variable, string
# description:
# devices:
# - devices_name:
# interfaces:
# - name:
# filter:
# - description:
# name:
# opcode:
# status:
# value:
# report_layout:
# - layout_id:
# is_global:
# status:
# admin_user:
# auto_hcache:
# date_format:
# dev_type:
# device_list_type:
# display_device_by:
# display_table_contents:
# email_report_per_device:
# filter_logic:
# filter_type:
# include_coverpage:
# include_other:
# language:
# ldap_query:
# ldap_server:
# ldap_user_case_change:
# max_reports:
# obfuscate_user:
# orientation:
# output_format:
# output_profile:
# period_end:
# period_last_n:
# period_opt:
# period_start:
# print_report_filters:
# report_per_device:
# resolve_hostname:
# schedule_color:
# schedule_frequency:
# schedule_type:
# schedule_valid_end:
# schedule_valid_start:
# time_period:
# week_start:
# address_filter:
# - id:
# include_option:
# address_type:
# soc_cust_filters:
# - name:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
meta The result of the request. returned: alwaystype: dict
request_url The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code The status of api request. returned: alwaystype: intsample: 0
response_data The data body of the api response. returned: optionaltype: list or dict
response_message The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information The information of the target system. returned: alwaystype: dict
rc The status the request. returned: alwaystype: intsample: 0
version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current versiontype: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Maxx Liu (@MaxxLiu22)
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)