faz_cli_system_log_settings_rollinganalyzer – Log rolling policy for Network Analyzer logs.
New in version 1.0.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.
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.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiAnalyzer Version Compatibility
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
||
None | True | True | True | None | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
6.4.14 |
None | True | True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
7.0.11 |
|||
True | True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
||||||||||
True | True | True | True | True | ||||||||||
7.4.0 |
7.4.1 |
7.4.2 |
||||||||||||
True | True | True |
Parameters
- access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
- 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 required: false default: "/tmp/fortianalyzer.ansible.log"
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- cli_system_log_settings_rollinganalyzer - Log rolling policy for Network Analyzer logs. type: dict
- days - No description for the parameter type: array choices: [sun, mon, tue, wed, thu, fri, sat] more...
- del_files - Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
- directory - Upload server directory, for Unix server, use absolute type: str more...
- file_size - Roll log files when they reach this size (MB). type: int default: 200 more...
- gzip_format - Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
- hour - Log files rolling schedule (hour). type: int default: 0 more...
- ip - Upload server IP address. type: str default: 0.0.0.0 more...
- ip2 - Upload server IP2 address. type: str default: 0.0.0.0 more...
- ip3 - Upload server IP3 address. type: str default: 0.0.0.0 more...
- log_format - Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
- min - Log files rolling schedule (minutes). type: int default: 0 more...
- password - No description for the parameter type: str more...
- password2 - No description for the parameter type: str more...
- password3 - No description for the parameter type: str more...
- port - Upload server IP1 port number. type: int default: 0 more...
- port2 - Upload server IP2 port number. type: int default: 0 more...
- port3 - Upload server IP3 port number. type: int default: 0 more...
- server_type - Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
- upload - Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
- upload_hour - Log files upload schedule (hour). type: int default: 0 more...
- upload_mode - Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
- upload_trigger - Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
- username - Upload server login username. type: str more...
- username2 - Upload server login username2. type: str more...
- username3 - Upload server login username3. type: str more...
- when - Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
- rolling_upgrade_status - rolling upgrade status (1|0). type: int default: 0 more...
- server - Upload server FQDN/IP. type: str more...
- server2 - Upload server2 FQDN/IP. type: str more...
- server3 - Upload server3 FQDN/IP. 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
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Log rolling policy for Network Analyzer logs.
fortinet.fortianalyzer.faz_cli_system_log_settings_rollinganalyzer:
cli_system_log_settings_rollinganalyzer:
days:
- sun
- mon
- tue
- wed
- thu
- fri
- sat
del_files: disable
gzip_format: disable
upload: disable
when: none
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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.