W3cubDocs

/Ansible

fortinet.fortios.fortios_casb_profile module – Configure CASB profile in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.4.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.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_profile.

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 profile 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

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

casb_profile

dictionary

Configure CASB profile.

comment

string

Comment.

name

string / required

CASB profile name.

saas_application

list / elements=dictionary

CASB profile SaaS application.

access_rule

list / elements=dictionary

CASB profile access rule.

action

string

CASB access rule action.

Choices:

  • "monitor"
  • "bypass"
  • "block"

attribute_filter

list / elements=dictionary

CASB profile attribute filter.

action

string

CASB access rule tenant control action.

Choices:

  • "monitor"
  • "bypass"
  • "block"

attribute_match

string

CASB access rule tenant match. Source casb.attribute-match.name.

id

integer / required

CASB tenant control ID. see <a href=’#notes’>Notes</a>.

bypass

list / elements=string

CASB bypass options.

Choices:

  • "av"
  • "dlp"
  • "web-filter"
  • "file-filter"
  • "video-filter"

name

string / required

CASB access rule activity name. Source casb.user-activity.name.

advanced_tenant_control

list / elements=dictionary

CASB profile advanced tenant control.

attribute

list / elements=dictionary

CASB advanced tenant control attribute.

input

list / elements=dictionary

CASB extend user input value.

value

string / required

User input value.

name

string / required

CASB extend user input name.

name

string / required

CASB advanced tenant control name. Source casb.user-activity.name.

custom_control

list / elements=dictionary

CASB profile custom control.

attribute_filter

list / elements=dictionary

CASB attribute filter.

action

string

CASB access rule tenant control action.

Choices:

  • "monitor"
  • "bypass"
  • "block"

attribute_match

string

CASB access rule tenant match. Source casb.attribute-match.name.

id

integer / required

CASB tenant control ID. see <a href=’#notes’>Notes</a>.

name

string / required

CASB custom control user activity name. Source casb.user-activity.name.

option

list / elements=dictionary

CASB custom control option.

name

string / required

CASB custom control option name.

user_input

list / elements=dictionary

CASB custom control user input.

value

string / required

user input value.

domain_control

string

Enable/disable domain control.

Choices:

  • "enable"
  • "disable"

domain_control_domains

list / elements=dictionary

CASB profile domain control domains.

name

string / required

Domain control domain name.

log

string

Enable/disable log settings.

Choices:

  • "enable"
  • "disable"

name

string / required

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

string

Enable/disable safe search.

Choices:

  • "enable"
  • "disable"

safe_search_control

list / elements=dictionary

CASB profile safe search control.

name

string / required

Safe search control name.

status

string

Enable/disable setting.

Choices:

  • "enable"
  • "disable"

tenant_control

string

Enable/disable tenant control.

Choices:

  • "enable"
  • "disable"

tenant_control_tenants

list / elements=dictionary

CASB profile tenant control tenants.

name

string / required

Tenant control tenants name.

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
  • The module supports check_mode.

Examples

- name: Configure CASB profile.
  fortinet.fortios.fortios_casb_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      casb_profile:
          comment: "Comment."
          name: "default_name_4"
          saas_application:
              -
                  access_rule:
                      -
                          action: "monitor"
                          attribute_filter:
                              -
                                  action: "monitor"
                                  attribute_match: "<your_own_value> (source casb.attribute-match.name)"
                                  id: "11"
                          bypass: "av"
                          name: "default_name_13 (source casb.user-activity.name)"
                  advanced_tenant_control:
                      -
                          attribute:
                              -
                                  input:
                                      -
                                          value: "<your_own_value>"
                                  name: "default_name_18"
                          name: "default_name_19 (source casb.user-activity.name)"
                  custom_control:
                      -
                          attribute_filter:
                              -
                                  action: "monitor"
                                  attribute_match: "<your_own_value> (source casb.attribute-match.name)"
                                  id: "24"
                          name: "default_name_25 (source casb.user-activity.name)"
                          option:
                              -
                                  name: "default_name_27"
                                  user_input:
                                      -
                                          value: "<your_own_value>"
                  domain_control: "enable"
                  domain_control_domains:
                      -
                          name: "default_name_32"
                  log: "enable"
                  name: "default_name_34 (source casb.saas-application.name)"
                  safe_search: "enable"
                  safe_search_control:
                      -
                          name: "default_name_37"
                  status: "enable"
                  tenant_control: "enable"
                  tenant_control_tenants:
                      -
                          name: "default_name_41"

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)

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