fortios_casb_profile – Configure CASB profile in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v7.4.1 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- casb_profile - Configure CASB profile. type: dict more...
- name - CASB profile name. type: str required: true more...
- saas_application - CASB profile SaaS application. type: list member_path: saas_application:name more...
- access_rule - CASB profile access rule. type: list member_path: saas_application:name/access_rule:name more...
- action - CASB access rule action. type: str choices: bypass, block, monitor more...
- bypass - CASB bypass options. type: list choices: av, dlp, web-filter, file-filter, video-filter more...
- name - CASB access rule activity name. Source casb.user-activity.name. type: str required: true more...
- custom_control - CASB profile custom control. type: list member_path: saas_application:name/custom_control:name more...
- name - CASB custom control user activity name. Source casb.user-activity.name. type: str required: true more...
- option - CASB custom control option. type: list member_path: saas_application:name/custom_control:name/option:name more...
- domain_control - Enable/disable domain control. type: str choices: enable, disable more...
- domain_control_domains - CASB profile domain control domains. type: list member_path: saas_application:name/domain_control_domains:name more...
- name - Domain control domain name. type: str required: true more...
- log - Enable/disable log settings. type: str choices: enable, disable more...
- name - CASB profile SaaS application name. Source casb.saas-application.name. type: str required: true more...
- safe_search - Enable/disable safe search. type: str choices: enable, disable more...
- safe_search_control - CASB profile safe search control. type: list member_path: saas_application:name/safe_search_control:name more...
- name - Safe search control name. type: str required: true more...
- status - Enable/disable setting. type: str choices: enable, disable more...
- tenant_control - Enable/disable tenant control. type: str choices: enable, disable more...
- tenant_control_tenants - CASB profile tenant control tenants. type: list member_path: saas_application:name/tenant_control_tenants:name more...
- name - Tenant control tenants name. type: str required: true more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure CASB profile.
fortinet.fortios.fortios_casb_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
casb_profile:
name: "default_name_3"
saas_application:
-
access_rule:
-
action: "bypass"
bypass: "av"
name: "default_name_8 (source casb.user-activity.name)"
custom_control:
-
name: "default_name_10 (source casb.user-activity.name)"
option:
-
name: "default_name_12"
user_input:
-
value: "<your_own_value>"
domain_control: "enable"
domain_control_domains:
-
name: "default_name_17"
log: "enable"
name: "default_name_19 (source casb.saas-application.name)"
safe_search: "enable"
safe_search_control:
-
name: "default_name_22"
status: "enable"
tenant_control: "enable"
tenant_control_tenants:
-
name: "default_name_26"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.