fortinet.fortios.fortios_casb_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 CASB 配置文件。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求了解详细信息。

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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 casb 功能和配置文件类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。已在 FOS v6.0.0 版本上测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

casb_profile

字典

配置 CASB 配置文件。

comment

字符串

注释。

name

字符串 / 必需

CASB 配置文件名称。

saas_application

列表 / 元素=字典

CASB 配置文件 SaaS 应用程序。

access_rule

列表 / 元素=字典

CASB 配置文件访问规则。

action

字符串

CASB 访问规则操作。

选项

  • "monitor"

  • "bypass"

  • "block"

bypass

列表 / 元素=字符串

CASB 绕过选项。

选项

  • "av"

  • "dlp"

  • "web-filter"

  • "file-filter"

  • "video-filter"

name

字符串 / 必需

CASB 访问规则活动名称。来源 casb.user-activity.name。

custom_control

列表 / 元素=字典

CASB 配置文件自定义控制。

name

字符串 / 必需

CASB 自定义控制用户活动名称。来源 casb.user-activity.name。

option

列表 / 元素=字典

CASB 自定义控制选项。

name

字符串 / 必需

CASB 自定义控制选项名称。

user_input

列表 / 元素=字典

CASB 自定义控制用户输入。

value

字符串 / 必需

用户输入值。

domain_control

字符串

启用/禁用域控制。

选项

  • "enable"

  • "disable"

domain_control_domains

列表 / 元素=字典

CASB 配置文件域控制域。

name

字符串 / 必需

域控制域名。

log

字符串

启用/禁用日志设置。

选项

  • "enable"

  • "disable"

name

字符串 / 必需

CASB 配置文件 SaaS 应用程序名称。来源 casb.saas-application.name。

字符串

启用/禁用安全搜索。

选项

  • "enable"

  • "disable"

safe_search_control

列表 / 元素=字典

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

name

字符串 / 必需

安全搜索控制名称。

status

字符串

启用/禁用设置。

选项

  • "enable"

  • "disable"

tenant_control

字符串

启用/禁用租户控制。

选项

  • "enable"

  • "disable"

tenant_control_tenants

列表 / 元素=字典

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

name

字符串 / 必需

租户控制租户名称。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方法。

示例

- 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"
                          bypass: "av"
                          name: "default_name_9 (source casb.user-activity.name)"
                  custom_control:
                      -
                          name: "default_name_11 (source casb.user-activity.name)"
                          option:
                              -
                                  name: "default_name_13"
                                  user_input:
                                      -
                                          value: "<your_own_value>"
                  domain_control: "enable"
                  domain_control_domains:
                      -
                          name: "default_name_18"
                  log: "enable"
                  name: "default_name_20 (source casb.saas-application.name)"
                  safe_search: "enable"
                  safe_search_control:
                      -
                          name: "default_name_23"
                  status: "enable"
                  tenant_control: "enable"
                  tenant_control_tenants:
                      -
                          name: "default_name_27"

返回值

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

键

描述

build

字符串

FortiGate 镜像的版本号

返回：始终

示例： "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回：始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回：始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回：成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回：始终

示例： "urlfilter"

path

字符串

用于完成请求的表的路径

返回：始终

示例： "webfilter"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

版本

字符串

FortiGate 版本

返回：始终

示例： "v5.6.3"

作者

  • 郑 link (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆宏斌 (@fgtdev-hblu)

  • 沈锋 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)