:source: fmgd_casb_profile_saasapplication.py
:orphan:
.. _fmgd_casb_profile_saasapplication:
fmgd_casb_profile_saasapplication -- CASB profile SaaS application.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- profile - The parameter in requested url type: str required: true
- casb_profile_saasapplication - CASB profile SaaS application. type: dict
- access_rule (Alias name: access-rule) Access rule. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- action Casb access rule action. type: str choices: [block, bypass, monitor]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- bypass Casb bypass options. type: list choices: [av, dlp, web-filter, file-filter, video-filter]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Casb access rule activity name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- attribute_filter (Alias name: attribute-filter) Attribute filter. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- action Casb access rule tenant control action. type: str choices: [block, monitor, bypass]
more...
Supported Version Ranges: v7.6.4 -> latest
- attribute_match (Alias name: attribute-match) Casb access rule tenant match. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- id Casb tenant control id. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- custom_control (Alias name: custom-control) Custom control. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Casb custom control user activity name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- option Option. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Casb custom control option name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- user_input (Alias name: user-input) Casb custom control user input. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- attribute_filter (Alias name: attribute-filter) Attribute filter. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- action Casb access rule tenant control action. type: str choices: [block, monitor, bypass]
more...
Supported Version Ranges: v7.6.4 -> latest
- attribute_match (Alias name: attribute-match) Casb access rule tenant match. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- id Casb tenant control id. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- domain_control (Alias name: domain-control) Enable/disable domain control. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- domain_control_domains (Alias name: domain-control-domains) Casb profile domain control domains. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- log Enable/disable log settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Casb profile saas application name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- safe_search (Alias name: safe-search) Enable/disable safe search. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- safe_search_control (Alias name: safe-search-control) Casb profile safe search control. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status Enable/disable setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tenant_control (Alias name: tenant-control) Enable/disable tenant control. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tenant_control_tenants (Alias name: tenant-control-tenants) Casb profile tenant control tenants. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- advanced_tenant_control (Alias name: advanced-tenant-control) Advanced tenant control. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- attribute Attribute. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- input Casb extend user input value. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- name Casb extend user input name. type: str
more...
Supported Version Ranges: v7.6.4 -> latest
- name Casb advanced tenant control name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
Notes
-----
.. note::
- 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.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- 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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: CASB profile SaaS application.
fortinet.fmgdevice.fmgd_casb_profile_saasapplication:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
profile:
state: present #
casb_profile_saasapplication:
name: [] # Required variable
# access_rule:
# - action:
# bypass:
# - "av"
# - "dlp"
# - "web-filter"
# - "file-filter"
# - "video-filter"
# name:
# attribute_filter:
# - action:
# attribute_match:
# id:
# custom_control:
# - name:
# option:
# - name:
# user_input:
# attribute_filter:
# - action:
# attribute_match:
# id:
# domain_control:
# domain_control_domains:
# log:
# safe_search:
# safe_search_control:
# status:
# tenant_control:
# tenant_control_tenants:
# advanced_tenant_control:
# - attribute:
# - input:
# name:
# name:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)