faz_cli_system_logfetch_clientprofile – Log-fetch client profile settings.
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.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.
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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- cli_system_logfetch_clientprofile - Log-fetch client profile settings. type: dict
- client_adom - Log-fetch client sides adom name. type: str more...
- data_range - Data-range for fetched logs. type: str choices: [custom] default: custom more...
- data_range_value - Last n days or hours. type: int default: 10 more...
- device_filter - No description for the parameter type: array more...
- end_time - No description for the parameter type: str more...
- id - Log-fetch client profile ID. type: int default: 0 more...
- index_fetch_logs - Enable/Disable indexing logs automatically after fetching logs. type: str choices: [disable, enable] default: enable more...
- log_filter - No description for the parameter type: array more...
- log_filter_logic - And/Or logic for log-filters. type: str choices: [and, or] default: or more...
- log_filter_status - Enable/Disable log-filter. type: str choices: [disable, enable] default: disable more...
- name - Name of log-fetch client profile. type: str more...
- password - No description for the parameter type: str more...
- secure_connection - Enable/Disable protecting log-fetch connection with TLS/SSL. type: str choices: [disable, enable] default: enable more...
- server_adom - Log-fetch server sides adom name. type: str more...
- server_ip - Log-fetch server IP address. type: str default: 0.0.0.0 more...
- start_time - No description for the parameter type: str more...
- sync_adom_config - Enable/Disable sync adom related config. type: str choices: [disable, enable] default: disable more...
- user - Log-fetch server login username. type: str more...
- peer_cert_cn - Certificate common name of log-fetch server. 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-fetch client profile settings.
fortinet.fortianalyzer.faz_cli_system_logfetch_clientprofile:
cli_system_logfetch_clientprofile:
id: 1
index_fetch_logs: disable
log_filter_status: disable
secure_connection: disable
sync_adom_config: disable
server_ip: 34.54.65.75
name: fooclientprofile
user: "admin"
password: "password"
state: present
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.