fortinet.fortimanager.fmgr_casb_useractivity module – Configure CASB user activity.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_casb_useractivity
.
New in fortinet.fortimanager 2.3.0
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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The top level parameters set. |
|
CASB SaaS application name. |
|
Deprecated, please rename it to casb_name. CASB user activity signature name. |
|
CASB user activity category. Choices:
|
|
Deprecated, please rename it to control_options. Control options. |
|
CASB control option name. |
|
Operations. |
|
CASB operation action. Choices:
|
|
Deprecated, please rename it to case_sensitive. CASB operation search case sensitive. Choices:
|
|
CASB operation direction. Choices:
|
|
Deprecated, please rename it to header_name. CASB operation header name to search. |
|
CASB control option operation name. |
|
Deprecated, please rename it to search_key. CASB operation key to search. |
|
Deprecated, please rename it to search_pattern. CASB operation search pattern. Choices:
|
|
CASB operation target. Choices:
|
|
Deprecated, please rename it to value_from_input. Enable/disable value from user input. Choices:
|
|
CASB operation new values. |
|
CASB control option status. Choices:
|
|
CASB user activity description. |
|
Match. |
|
CASB user activity match rules ID. |
|
Rules. |
|
Deprecated, please rename it to case_sensitive. CASB user activity match case sensitive. Choices:
|
|
CASB user activity domain list. |
|
Deprecated, please rename it to header_name. CASB user activity rule header name. |
|
CASB user activity rule ID. |
|
Deprecated, please rename it to match_pattern. CASB user activity rule match pattern. Choices:
|
|
Deprecated, please rename it to match_value. CASB user activity rule match value. |
|
CASB user activity method list. |
|
Enable/disable what the matching strategy must not be. Choices:
|
|
CASB user activity rule type. Choices:
|
|
CASB user activity rules strategy. Choices:
|
|
Deprecated, please rename it to match_strategy. CASB user activity match strategy. Choices:
|
|
CASB user activity name. |
|
CASB user activity status. Choices:
|
|
CASB user activity type. Choices:
|
|
Universally Unique Identifier |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
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 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: |
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.
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: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure CASB user activity.
fortinet.fortimanager.fmgr_casb_useractivity:
# 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, ...]
adom: <your own value>
state: present # <value in [present, absent]>
casb_useractivity:
application: <string>
casb_name: <string>
category: <value in [activity-control, tenant-control, domain-control, ...]>
control_options:
-
name: <string>
operations:
-
action: <value in [append, prepend, replace, ...]>
case_sensitive: <value in [disable, enable]>
direction: <value in [request]>
header_name: <string>
name: <string>
search_key: <string>
search_pattern: <value in [simple, substr, regexp]>
target: <value in [header, path]>
value_from_input: <value in [disable, enable]>
values: <list or string>
status: <value in [disable, enable]>
description: <string>
match:
-
id: <integer>
rules:
-
case_sensitive: <value in [disable, enable]>
domains: <list or string>
header_name: <string>
id: <integer>
match_pattern: <value in [simple, substr, regexp]>
match_value: <string>
methods: <list or string>
negate: <value in [disable, enable]>
type: <value in [domains, host, path, ...]>
strategy: <value in [or, and]>
match_strategy: <value in [or, and]>
name: <string>
type: <value in [built-in, customized]>
uuid: <string>
status: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |