fortinet.fortimanager.fmgr_system_logfetch_clientprofile module – Log-fetch client profile settings.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_logfetch_clientprofile

dictionary

the top level parameters set

client-adom

string

Log-fetch client sides adom name.

data-range

string

Data-range for fetched logs.

custom - Specify some other date and time range.

Choices:

  • custom ← (default)

data-range-value

integer

Last n days or hours.

Default: 10

device-filter

list / elements=string

Device-Filter.

adom

string

Adom name.

Default: “*”

device

string

Device name or Serial number.

Default: “*”

id

integer

Add or edit a device filter.

Default: 0

vdom

string

Vdom filters.

Default: “*”

end-time

string

End date and time of the data-range <hh:mm yyyy/mm/dd>.

id

integer

Log-fetch client profile ID.

Default: 0

index-fetch-logs

string

Enable/Disable indexing logs automatically after fetching logs.

disable - Disable attribute function.

enable - Enable attribute function.

Choices:

  • disable

  • enable ← (default)

log-filter

list / elements=string

Log-Filter.

field

string

Field name.

id

integer

Log filter ID.

Default: 0

oper

string

Field filter operator.

&lt; - =Less than or equal to

&gt; - =Greater than or equal to

contain - Contain

not-contain - Not contain

match - Match (expression)

Choices:

  • = ← (default)

  • !=

  • <

  • >

  • <=

  • >=

  • contain

  • not-contain

  • match

value

string

Field filter operand or free-text matching expression.

log-filter-logic

string

And/Or logic for log-filters.

and - Logic And.

or - Logic Or.

Choices:

  • and

  • or ← (default)

log-filter-status

string

Enable/Disable log-filter.

disable - Disable attribute function.

enable - Enable attribute function.

Choices:

  • disable ← (default)

  • enable

name

string

Name of log-fetch client profile.

password

string

Log-fetch server login password.

secure-connection

string

Enable/Disable protecting log-fetch connection with TLS/SSL.

disable - Disable attribute function.

enable - Enable attribute function.

Choices:

  • disable

  • enable ← (default)

server-adom

string

Log-fetch server sides adom name.

server-ip

string

Log-fetch server IP address.

Default: “0.0.0.0”

start-time

string

Start date and time of the data-range <hh:mm yyyy/mm/dd>.

sync-adom-config

string

Enable/Disable sync adom related config.

disable - Disable attribute function.

enable - Enable attribute function.

Choices:

  • disable ← (default)

  • enable

user

string

Log-fetch server login username.

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

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

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

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)