fmgr_system_logfetch_clientprofile – Log-fetch client profile settings.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager 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.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| system_logfetch_clientprofile | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- 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 FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- 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
- system_logfetch_clientprofile - no description 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 - Device-Filter. type: array more...
- end-time - End date and time of the data-range
- 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 - Log-Filter. 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 - Log-fetch server login password. 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 - Start date and time of the data-range
- 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
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- 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: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the Log-fetch client profile settings
fmgr_fact:
facts:
selector: 'system_logfetch_clientprofile'
params:
client-profile: 'your_value'
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Log-fetch client profile settings.
fmgr_system_logfetch_clientprofile:
bypass_validation: False
state: present
system_logfetch_clientprofile:
client-adom: ansible
data-range: custom #<value in [custom]>
id: 1
index-fetch-logs: enable
name: ansible-test-clientprofile
password: fortinet
server-ip: '222.222.22.25'
user: ansible
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict