fortinet.fortimanager.fmgr_system_logfetch_clientprofile – Log-fetch client profile settings.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_logfetch_clientprofile
.
New in version 2.10: of fortinet.fortimanager
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the top level parameters set |
|
Log-fetch client sides adom name. |
|
Data-range for fetched logs. custom - Specify some other date and time range. Choices:
|
|
Last n days or hours. Default: 10 |
|
Device-Filter. |
|
Adom name. Default: “*” |
|
Device name or Serial number. Default: “*” |
|
Add or edit a device filter. Default: 0 |
|
Vdom filters. Default: “*” |
|
End date and time of the data-range <hh:mm yyyy/mm/dd>. |
|
Log-fetch client profile ID. Default: 0 |
|
Enable/Disable indexing logs automatically after fetching logs. disable - Disable attribute function. enable - Enable attribute function. Choices:
|
|
Log-Filter. |
|
Field name. |
|
Log filter ID. Default: 0 |
|
Field filter operator. < - =Less than or equal to > - =Greater than or equal to contain - Contain not-contain - Not contain match - Match (expression) Choices:
|
|
Field filter operand or free-text matching expression. |
|
And/Or logic for log-filters. and - Logic And. or - Logic Or. Choices:
|
|
Enable/Disable log-filter. disable - Disable attribute function. enable - Enable attribute function. Choices:
|
|
Name of log-fetch client profile. |
|
Log-fetch server login password. |
|
Enable/Disable protecting log-fetch connection with TLS/SSL. disable - Disable attribute function. enable - Enable attribute function. Choices:
|
|
Log-fetch server sides adom name. |
|
Log-fetch server IP address. Default: “0.0.0.0” |
|
Start date and time of the data-range <hh:mm yyyy/mm/dd>. |
|
Enable/Disable sync adom related config. disable - Disable attribute function. enable - Enable attribute function. Choices:
|
|
Log-fetch server login username. |
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
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: ''
- 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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)