W3cubDocs

/Ansible 2.11

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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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
Parameters
Notes
Examples
Return Values

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			Choices/Defaults	Comments
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
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			Choices: present absent	the directive to create, update or delete an object
system_logfetch_clientprofile dictionary				the top level parameters set
	client-adom string			Log-fetch client sides adom name.
	data-range string		Choices: custom ←	Data-range for fetched logs. custom - Specify some other date and time range.
	data-range-value integer		Default: 10	Last n days or hours.
	device-filter list / elements=string			no description
		adom string	Default: "*"	Adom name.
		device string	Default: "*"	Device name or Serial number.
		id integer	Default: 0	Add or edit a device filter.
		vdom string	Default: "*"	Vdom filters.
	end-time string			no description
	id integer		Default: 0	Log-fetch client profile ID.
	index-fetch-logs string		Choices: disable enable ←	Enable/Disable indexing logs automatically after fetching logs. disable - Disable attribute function. enable - Enable attribute function.
	log-filter list / elements=string			no description
		field string		Field name.
		id integer	Default: 0	Log filter ID.
		oper string	Choices: = ← != < > <= >= contain not-contain match	Field filter operator. < - =Less than or equal to > - =Greater than or equal to contain - Contain not-contain - Not contain match - Match (expression)
		value string		Field filter operand or free-text matching expression.
	log-filter-logic string		Choices: and or ←	And/Or logic for log-filters. and - Logic And. or - Logic Or.
	log-filter-status string		Choices: disable ← enable	Enable/Disable log-filter. disable - Disable attribute function. enable - Enable attribute function.
	name string			Name of log-fetch client profile.
	password string			no description
	secure-connection string		Choices: disable enable ←	Enable/Disable protecting log-fetch connection with TLS/SSL. disable - Disable attribute function. enable - Enable attribute function.
	server-adom string			Log-fetch server sides adom name.
	server-ip string		Default: "0.0.0.0"	Log-fetch server IP address.
	start-time string			no description
	sync-adom-config string		Choices: disable ← enable	Enable/Disable sync adom related config. disable - Disable attribute function. enable - Enable attribute function.
	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			Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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 here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_logfetch_clientprofile_module.html