fortinet.fortimanager.fmgr_casb_useractivity_match_tenantsessionextraction module – CASB user activity tenant session extraction.

Note

This module is part of the fortinet.fortimanager collection (version 2.15.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_match_tenantsessionextraction.

New in fortinet.fortimanager 2.15.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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

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

casb_useractivity_match_tenantsessionextraction

dictionary

The top level parameters set.

filters

list / elements=dictionary

Filters.

body_type

aliases: body-type

string

CASB content extraction filter body type.

Choices:

  • "json"

  • "form"

cookie_name

aliases: cookie-name

string

CASB content extraction filter cookie name.

direction

string

CASB content extraction filter direction.

Choices:

  • "request"

  • "response"

header_name

aliases: header-name

string

CASB content extraction filter header name.

id

integer

CASB content extraction filter ID.

place

string

CASB content extraction filter place type.

Choices:

  • "header"

  • "path"

  • "body"

  • "cookie"

jq

string

CASB user activity session extraction jq script.

session_match

aliases: session-match

string

CASB user activity session match name.

session_source

aliases: session-source

string

Enable/disable CASB session extraction source flag.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable CASB session extraction.

Choices:

  • "disable"

  • "enable"

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

match

string / required

The parameter (match) in requested url.

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.

revision_note

string

The change note that can be specified when an object is created or updated.

user-activity

string

Deprecated, please use “user_activity”

user_activity

string

The parameter (user-activity) in requested url.

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

Examples

- name: Test CASB tenant session extraction
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create the parent CASB user activity
      fortinet.fortimanager.fmgr_casb_useractivity:
        enable_log: true
        adom: root
        state: present
        casb_useractivity:
          name: test_user_activity

    - name: Create the parent CASB user activity match
      fortinet.fortimanager.fmgr_casb_useractivity_match:
        enable_log: true
        adom: root
        user_activity: test_user_activity
        state: present
        casb_useractivity_match:
          id: 1

    - name: Configure CASB tenant session extraction
      fortinet.fortimanager.fmgr_casb_useractivity_match_tenantsessionextraction:
        enable_log: true
        adom: root
        user_activity: test_user_activity
        match: "1"
        casb_useractivity_match_tenantsessionextraction:
          status: disable

- name: Test CASB tenant session extraction filters
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create the parent CASB user activity
      fortinet.fortimanager.fmgr_casb_useractivity:
        enable_log: true
        adom: root
        state: present
        casb_useractivity:
          name: test_user_activity

    - name: Create the parent CASB user activity match
      fortinet.fortimanager.fmgr_casb_useractivity_match:
        enable_log: true
        adom: root
        user_activity: test_user_activity
        state: present
        casb_useractivity_match:
          id: 1

    - name: Configure the parent CASB tenant session extraction
      fortinet.fortimanager.fmgr_casb_useractivity_match_tenantsessionextraction:
        enable_log: true
        adom: root
        user_activity: test_user_activity
        match: "1"
        casb_useractivity_match_tenantsessionextraction:
          status: enable

    - name: Configure a CASB tenant session extraction filter
      fortinet.fortimanager.fmgr_casb_useractivity_match_tenantsessionextraction_filters:
        enable_log: true
        adom: root
        user_activity: test_user_activity
        match: "1"
        state: present
        casb_useractivity_match_tenantsessionextraction_filters:
          id: 1

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)