fortinet.fortios.fortios_casb_user_activity module – Configure CASB user activity in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_casb_user_activity
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify casb feature and user_activity category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure CASB user activity. |
|
CASB SaaS application name. Source casb.saas-application.name. |
|
CASB user activity signature name. |
|
CASB user activity category. Choices:
|
|
CASB control options. |
|
CASB control option name. |
|
CASB control option operations. |
|
CASB operation action. Choices:
|
|
CASB operation search case sensitive. Choices:
|
|
CASB operation direction. Choices:
|
|
CASB operation header name to search. |
|
CASB control option operation name. |
|
CASB operation key to search. |
|
CASB operation search pattern. Choices:
|
|
CASB operation target. Choices:
|
|
Enable/disable value from user input. Choices:
|
|
CASB operation new values. |
|
Operation value. |
|
CASB control option status. Choices:
|
|
CASB user activity description. |
|
CASB user activity match rules. |
|
CASB user activity match rules ID. see <a href=’#notes’>Notes</a>. |
|
CASB user activity rules. |
|
CASB user activity match case sensitive. Choices:
|
|
CASB user activity domain list. |
|
Domain list separated by space. |
|
CASB user activity rule header name. |
|
CASB user activity rule ID. see <a href=’#notes’>Notes</a>. |
|
CASB user activity rule match pattern. Choices:
|
|
CASB user activity rule match value. |
|
CASB user activity method list. |
|
User activity method. |
|
Enable/disable what the matching strategy must not be. Choices:
|
|
CASB user activity rule type. Choices:
|
|
CASB user activity rules strategy. Choices:
|
|
CASB user activity match strategy. Choices:
|
|
CASB user activity name. |
|
CASB user activity status. Choices:
|
|
CASB user activity type. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure CASB user activity.
fortinet.fortios.fortios_casb_user_activity:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
casb_user_activity:
application: "<your_own_value> (source casb.saas-application.name)"
casb_name: "<your_own_value>"
category: "activity-control"
control_options:
-
name: "default_name_7"
operations:
-
action: "append"
case_sensitive: "enable"
direction: "request"
header_name: "<your_own_value>"
name: "default_name_13"
search_key: "<your_own_value>"
search_pattern: "simple"
target: "header"
value_from_input: "enable"
values:
-
value: "<your_own_value>"
status: "enable"
description: "<your_own_value>"
match:
-
id: "23"
rules:
-
case_sensitive: "enable"
domains:
-
domain: "<your_own_value>"
header_name: "<your_own_value>"
id: "29"
match_pattern: "simple"
match_value: "<your_own_value>"
methods:
-
method: "<your_own_value>"
negate: "enable"
type: "domains"
strategy: "and"
match_strategy: "and"
name: "default_name_38"
status: "enable"
type: "built-in"
uuid: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |