faz_cli_system_locallog_disk_setting – Settings for local disk logging.
Added 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.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 and diff 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"
- 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: False
- 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
- cli_system_locallog_disk_setting Settings for local disk logging. type: dict
- diskfull Policy to apply when disk is full. type: str choices: [overwrite, nolog] default: overwrite more...
- log_disk_full_percentage Consider log disk as full at this usage percentage. type: int default: 80 more...
- max_log_file_size Maximum log file size before rolling. type: int default: 100 more...
- roll_day Days of week to roll logs. type: list elements: str choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
- roll_schedule Frequency to check log file for rolling. type: str choices: [none, daily, weekly] default: none more...
- roll_time Time to roll logs (hh:mm). type: str more...
- server_type Server type. type: str choices: [FTP, SFTP, SCP] default: FTP more...
- severity Least severity level to log. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] default: information more...
- status Enable/disable local disk log. type: str choices: [disable, enable] default: enable more...
- upload Upload log file when rolling. type: str choices: [disable, enable] default: disable more...
- upload_delete_files Delete log files after uploading (default = enable). type: str choices: [disable, enable] default: enable more...
- upload_time Time to upload logs (hh:mm). type: str more...
- uploaddir Log file upload remote directory. type: str more...
- uploadip IP address of log uploading server. type: str default: 0.0.0.0 more...
- uploadpass Password of user account in upload server. type: str elements: str more...
- uploadport Server port (0 = default protocol port). type: int default: 0 more...
- uploadsched Scheduled upload (disable = upload when rolling). type: str choices: [disable, enable] default: disable more...
- uploadtype Types of log files that need to be uploaded. type: list elements: str choices: [event] more...
- uploaduser User account in upload server. type: str more...
- uploadzip Compress upload logs. type: str choices: [disable, enable] default: disable more...
- max_log_file_num Maximum number of log files before rolling. type: int default: 10000 more...
- log_disk_quota Quota for controlling local log size. type: int default: 1 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
gather_facts: false
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Settings for local disk logging.
fortinet.fortianalyzer.faz_cli_system_locallog_disk_setting:
cli_system_locallog_disk_setting:
# diskfull: <value in [overwrite, nolog]>
# log_disk_full_percentage: <value of integer>
# max_log_file_size: <value of integer>
roll_day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
# roll_schedule: <value in [none, daily, weekly]>
# roll_time: <value of string>
# server_type: <value in [FTP, SFTP, SCP]>
# severity: <value in [emergency, alert, critical, ...]>
status: disable
upload: disable
upload_delete_files: disable
# upload_time: <value of string>
# uploaddir: <value of string>
# uploadip: <value of string>
# uploadpass: <value of string>
# uploadport: <value of integer>
uploadsched: disable
uploadtype:
- event
# uploaduser: <value of string>
uploadzip: disable
vars:
ansible_network_os: fortinet.fortianalyzer.fortianalyzer
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.