fortinet.fortimanager.fmgr_system_log_deviceselector module – Accept/reject devices matching specified filter types.

Note

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

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_log_deviceselector.

New in fortinet.fortimanager 2.10.0

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	Comments
access_token string	The token to access FortiManager without using username and password.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	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_log_deviceselector dictionary	The top level parameters set.
action string	Include or exclude the matching devices. include - Include devices matching specified filter type. exclude - Exclude devices matching specified filter type. Choices: `"include"` `"exclude"`
comment string	Additional comment for the selector.
devid string	Device ID.
expire string	Expiration time of the selector.
id integer / required	ID of device selector entry.
srcip string	Source IP or IP range.
srcip_mode aliases: srcip-mode string	Apply the selector to UDP/514, TCP/514 or any mode. UDP514 - Clients logging through UDP port 514. TCP514 - Clients logging through TCP port 514. any - Clients logging through any mode. Choices: `"UDP514"` `"TCP514"` `"any"`
type string	Type of the selector. unspecified - Filter type unspecified. devid - Filter devices by DeviceID. srcip - Filter devices by source IP. Choices: `"unspecified"` `"devid"` `"srcip"`
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

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
To create or update an object, use state present directive.
To delete an object, use state absent directive.

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Accept/reject devices matching specified filter types.
      fortinet.fortimanager.fmgr_system_log_deviceselector:
        # workspace_locking_adom: <global or your adom name>
        state: present # <value in [present, absent]>
        system_log_deviceselector:
          id: 0 # Required variable, integer
          # action: <value in [include, exclude]>
          # comment: <string>
          # devid: <string>
          # expire: <string>
          # srcip: <string>
          # srcip_mode: <value in [UDP514, TCP514, any]>
          # type: <value in [unspecified, devid, srcip]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
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_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Collection links

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