fortinet.fortios.fortios_casb_attribute_match module – Configure CASB attribute match rule in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.5.1).

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

New in fortinet.fortios 2.0.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify casb feature and attribute_match 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.16

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
casb_attribute_match dictionary	Configure CASB attribute match rule.
application string	CASB attribute application name. Source casb.saas-application.name.
attribute list / elements=dictionary	CASB tenant match rules.
case_sensitive string	CASB attribute match case sensitive. Choices: `"enable"` `"disable"`
match_pattern string	CASB attribute match pattern. Choices: `"simple"` `"substr"` `"regexp"`
match_value string	CASB attribute match value.
name string / required	CASB attribute match name.
negate string	Enable/disable what the matching strategy must not be. Choices: `"enable"` `"disable"`
match list / elements=dictionary	CASB tenant match rules.
id integer / required	CASB attribute match rule ID. see <a href=’#notes’>Notes</a>.
rule list / elements=dictionary	CASB attribute match rule.
attribute string	CASB attribute match name.
case_sensitive string	CASB attribute match case sensitive. Choices: `"enable"` `"disable"`
id integer / required	CASB attribute rule ID. see <a href=’#notes’>Notes</a>.
match_pattern string	CASB attribute match pattern. Choices: `"simple"` `"substr"` `"regexp"`
match_value string	CASB attribute match value.
negate string	Enable/disable what the matching strategy must not be. Choices: `"enable"` `"disable"`
rule_strategy string	CASB attribute match rule strategy. Choices: `"and"` `"or"`
match_strategy string	CASB attribute match strategy. Choices: `"or"` `"and"` `"subset"`
name string / required	CASB attribute match 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

Examples

- name: Configure CASB attribute match rule.
  fortinet.fortios.fortios_casb_attribute_match:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      casb_attribute_match:
          application: "<your_own_value> (source casb.saas-application.name)"
          attribute:
              -
                  case_sensitive: "enable"
                  match_pattern: "simple"
                  match_value: "<your_own_value>"
                  name: "default_name_8"
                  negate: "enable"
          match:
              -
                  id: "11"
                  rule:
                      -
                          attribute: "<your_own_value>"
                          case_sensitive: "enable"
                          id: "15"
                          match_pattern: "simple"
                          match_value: "<your_own_value>"
                          negate: "enable"
                  rule_strategy: "and"
          match_strategy: "or"
          name: "default_name_21"

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)

Collection links

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