faz_report_run – Start report requests.
Added in version 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.nameCorresponding 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.
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.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.16.0
FortiAnalyzer Version Compatibility
Supported Version Ranges: v6.2.1 -> latest
Parameters
- 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"
- 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
- adom The parameter in requested url type: str required: true
- report_run Start report requests. type: dict
- schedule Schedule name or id. type: str more...
- schedule_param Schedule parameters. If the schedule name is given, the parameters will override the original report ones; If not, the layout-id, device, and time-period are required parameters to initiate a report. type: dict
more...
- device The list of device names. type: str more...
- display_table_contents Display the table of contents. type: int choices: [0, 1] default: 1 more...
- filter type: list of dict more...
- filter_logic Relationship between filters. type: str choices: [all, any] default: all more...
- include_coverpage Include the cover page. type: int choices: [0, 1] default: 1 more...
- layout_id The report layout ID. type: int more...
- period_end End time of report data (YYYY/MM/DD hh:mm). type: str more...
- period_last_n N for last-n-hours/last-n-days/last-n-weeks. type: int more...
- period_start Start time of report data (YYYY/MM/DD hh:mm). type: str more...
- resolve_hostname Resolve IP to hostname. type: int choices: [0, 1] default: 0 more...
- time_period The type of time period. If other is the type, then period-start and period-end must be specificed; If last-n-hours, last-n-days, or last-n-weeks is selected, then period-last-n field must be filled. type: str choices: [today, yesterday, last-n-hours, this-week, last-week, last-7-days, last-n-days, last-2-weeks, last-14-days, this-month, last-month, last-30-days, last-n-weeks, this-quarter, last-quarter, this-year, other] default: other more...
- week_start Day of week start. type: str choices: [sun, mon] default: sun more...
- timezone The timezone index or name. Time range in request and date/time if any in response will follow this timezone. See Appendix type: str more...
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
- 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: Start report requests.
fortinet.fortianalyzer.faz_report_run:
# bypass_validation: false
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
report_run:
# schedule: <value of string>
# schedule_param:
# device: <value of string>
# display_table_contents: <value in [0, 1]>
# filter:
# - name: <value of string>
# opcode: <value in [0, 1]>
# value: <value of string>
# filter_logic: <value in [all, any]>
# include_coverpage: <value in [0, 1]>
# layout_id: <value of integer>
# period_end: <value of string>
# period_last_n: <value of integer>
# period_start: <value of string>
# resolve_hostname: <value in [0, 1]>
# time_period: <value in [today, yesterday, last-n-hours, ...]>
# week_start: <value in [sun, mon]>
# timezone: <value of string>
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:
- meta The result of the request. returned: always type: dict
- request_url The full url requested. returned: always type: str sample: /sys/login/user
- response_code The status of api request. returned: always type: int sample: 0
- response_data The data body of the api response. returned: optional type: list or dict
- response_message The descriptive message of the api response. returned: always type: str sample: OK
- system_information The information of the target system. returned: always type: dict
- rc The status the request. returned: always type: int sample: 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 version type: list
Status
This module is not guaranteed to have a backwards compatible interface.