fortinet.fortimanager.fmgr_casb_profile_saasapplication 模块 – CASB 配置文件 SaaS 应用。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_casb_profile_saasapplication。

fortinet.fortimanager 2.3.0 中的新功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有需要在使用前调整为数据源的参数和值。

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必填

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ← (默认)

  • true

casb_profile_saasapplication

字典

顶级参数集。

access_rule

别名: access-rule

列表 / 元素=字典

访问规则。

action

字符串

CASB 访问规则操作。

选择

  • "block"

  • "bypass"

  • "monitor"

bypass

列表 / 元素=字符串

CASB 绕过选项。

选择

  • "av"

  • "dlp"

  • "web-filter"

  • "file-filter"

  • "video-filter"

name

字符串

CASB 访问规则活动名称。

custom_control

别名: custom-control

列表 / 元素=字典

自定义控制。

name

字符串

CASB 自定义控制用户活动名称。

option

列表 / 元素=字典

选项。

name

字符串

CASB 自定义控制选项名称。

user_input

别名: user-input

列表 / 元素=字符串

CASB 自定义控制用户输入。

domain_control

别名: domain-control

字符串

启用/禁用域控制。

选择

  • "disable"

  • "enable"

domain_control_domains

别名: domain-control-domains

列表 / 元素=字符串

CASB 配置文件域控制域。

log

字符串

启用/禁用日志设置。

选择

  • "disable"

  • "enable"

name

字符串 / 必填

CASB 配置文件 SaaS 应用名称。

safe_search

别名: safe-search

字符串

启用/禁用安全搜索。

选择

  • "disable"

  • "enable"

safe_search_control

别名: safe-search-control

列表 / 元素=字符串

CASB 配置文件安全搜索控制。

status

字符串

启用/禁用设置。

选择

  • "disable"

  • "enable"

tenant_control

别名: tenant-control

字符串

启用/禁用租户控制。

选择

  • "disable"

  • "enable"

tenant_control_tenants

别名: tenant-control-tenants

列表 / 元素=字符串

CASB 配置文件租户控制租户。

enable_log

布尔值

启用/禁用任务日志记录。

选择

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

profile

字符串 / 必填

请求的 URL 中的参数 (profile)。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

用于覆盖失败条件的返回码列表。

rc_succeeded

列表 / 元素=整数

用于覆盖成功条件的返回码列表。

state

字符串 / 必填

用于创建、更新或删除对象的指令。

选择

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 需要锁定的 ADOM，该值可以是 global 以及其他（包括 root）。

workspace_locking_timeout

integer

等待其他用户释放工作区锁定的最长时间（秒）。

默认值： 300

说明

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将 “var-name” 等参数更改为 “var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可帮助完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: CASB profile SaaS application.
      fortinet.fortimanager.fmgr_casb_profile_saasapplication:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        profile: <your own value>
        state: present # <value in [present, absent]>
        casb_profile_saasapplication:
          access_rule:
            -
              action: <value in [block, bypass, monitor]>
              bypass:
                - "av"
                - "dlp"
                - "web-filter"
                - "file-filter"
                - "video-filter"
              name: <string>
          custom_control:
            -
              name: <string>
              option:
                -
                  name: <string>
                  user_input: <list or string>
          domain_control: <value in [disable, enable]>
          domain_control_domains: <list or string>
          log: <value in [disable, enable]>
          name: <string>
          safe_search: <value in [disable, enable]>
          safe_search_control: <list or string>
          tenant_control: <value in [disable, enable]>
          tenant_control_tenants: <list or string>
          status: <value in [disable, enable]>

返回值

常见的返回值记录在这里，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回： 始终

request_url

字符串

完整的请求 URL。

返回： 始终

示例： "/sys/login/user"

response_code

integer

API 请求的状态。

返回： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回： 始终

response_message

字符串

API 响应的描述性消息。

返回： 始终

示例： "OK."

system_information

字典

目标系统的信息。

返回： 始终

rc

integer

请求的状态。

返回： 始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)