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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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 - Log-fetch client profile settings. type: dict
- client-adom - Log-fetch client sides adom name. type: str
- data-range - Data-range for fetched logs. type: str choices: [custom] default: custom
- data-range-value - Last n days or hours. type: int default: 10
- device-filter - No description for the parameter type: array
- adom - Adom name. type: str default: *
- device - Device name or Serial number. type: str default: *
- id - Add or edit a device filter. type: int default: 0
- vdom - Vdom filters. type: str default: *
- end-time - No description for the parameter type: str
- id - Log-fetch client profile ID. type: int default: 0
- index-fetch-logs - Enable/Disable indexing logs automatically after fetching logs. type: str choices: [disable, enable] default: enable
- log-filter - No description for the parameter type: array
- field - Field name. type: str
- id - Log filter ID. type: int default: 0
- oper - Field filter operator. type: str choices: [=, !=, <, >, <=, >=, contain, not-contain, match] default: =
- value - Field filter operand or free-text matching expression. type: str
- log-filter-logic - And/Or logic for log-filters. type: str choices: [and, or] default: or
- log-filter-status - Enable/Disable log-filter. type: str choices: [disable, enable] default: disable
- name - Name of log-fetch client profile. type: str
- password - No description for the parameter type: str
- secure-connection - Enable/Disable protecting log-fetch connection with TLS/SSL. type: str choices: [disable, enable] default: enable
- server-adom - Log-fetch server sides adom name. type: str
- server-ip - Log-fetch server IP address. type: str default: 0.0.0.0
- start-time - No description for the parameter type: str
- sync-adom-config - Enable/Disable sync adom related config. type: str choices: [disable, enable] default: disable
- user - Log-fetch server login username. type: str
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¶
- hosts: fortimanager-inventory
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
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_logfetch_clientprofile:
client-adom: <value of string>
data-range: <value in [custom]>
data-range-value: <value of integer>
device-filter:
-
adom: <value of string>
device: <value of string>
id: <value of integer>
vdom: <value of string>
end-time: <value of string>
id: <value of integer>
index-fetch-logs: <value in [disable, enable]>
log-filter:
-
field: <value of string>
id: <value of integer>
oper: <value in [=, !=, <, ...]>
value: <value of string>
log-filter-logic: <value in [and, or]>
log-filter-status: <value in [disable, enable]>
name: <value of string>
password: <value of string>
secure-connection: <value in [disable, enable]>
server-adom: <value of string>
server-ip: <value of string>
start-time: <value of string>
sync-adom-config: <value in [disable, enable]>
user: <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:
- 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