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.4).

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

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

casb_user_activity

dictionary

Configure CASB user activity.

application

string

CASB SaaS application name. Source casb.saas-application.name.

casb_name

string

CASB user activity signature name.

category

string

CASB user activity category.

Choices:

  • "activity-control"

  • "tenant-control"

  • "domain-control"

  • "safe-search-control"

  • "other"

control_options

list / elements=dictionary

CASB control options.

name

string / required

CASB control option name.

operations

list / elements=dictionary

CASB control option operations.

action

string

CASB operation action.

Choices:

  • "append"

  • "prepend"

  • "replace"

  • "new"

  • "new-on-not-found"

  • "delete"

case_sensitive

string

CASB operation search case sensitive.

Choices:

  • "enable"

  • "disable"

direction

string

CASB operation direction.

Choices:

  • "request"

header_name

string

CASB operation header name to search.

name

string / required

CASB control option operation name.

search_key

string

CASB operation key to search.

search_pattern

string

CASB operation search pattern.

Choices:

  • "simple"

  • "substr"

  • "regexp"

target

string

CASB operation target.

Choices:

  • "header"

  • "path"

value_from_input

string

Enable/disable value from user input.

Choices:

  • "enable"

  • "disable"

values

list / elements=dictionary

CASB operation new values.

value

string / required

Operation value.

description

string

CASB user activity description.

match

list / elements=dictionary

CASB user activity match rules.

id

integer / required

CASB user activity match rules ID. see <a href=’#notes’>Notes</a>.

rules

list / elements=dictionary

CASB user activity rules.

case_sensitive

string

CASB user activity match case sensitive.

Choices:

  • "enable"

  • "disable"

domains

list / elements=dictionary

CASB user activity domain list.

domain

string / required

Domain list separated by space.

header_name

string

CASB user activity rule header name.

id

integer / required

CASB user activity rule ID. see <a href=’#notes’>Notes</a>.

match_pattern

string

CASB user activity rule match pattern.

Choices:

  • "simple"

  • "substr"

  • "regexp"

match_value

string

CASB user activity rule match value.

methods

list / elements=dictionary

CASB user activity method list.

method

string / required

User activity method.

negate

string

Enable/disable what the matching strategy must not be.

Choices:

  • "enable"

  • "disable"

type

string

CASB user activity rule type.

Choices:

  • "domains"

  • "host"

  • "path"

  • "header"

  • "header-value"

  • "method"

strategy

string

CASB user activity rules strategy.

Choices:

  • "and"

  • "or"

match_strategy

string

CASB user activity match strategy.

Choices:

  • "and"

  • "or"

name

string / required

CASB user activity name.

type

string

CASB user activity type.

Choices:

  • "built-in"

  • "customized"

uuid

string

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

vdom

string

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: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure CASB user activity.
    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>"
        description: "<your_own_value>"
        match:
         -
            id:  "22"
            rules:
             -
                case_sensitive: "enable"
                domains:
                 -
                    domain: "<your_own_value>"
                header_name: "<your_own_value>"
                id:  "28"
                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_37"
        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

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)