fortinet.fortimanager.fmgr_firewall_casbprofile 模块 – 防火墙 CASB 配置文件

注意

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

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

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

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_firewall_casbprofile。

在 fortinet.fortimanager 2.3.0 中新增

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

firewall_casbprofile

字典

设置的顶层参数。

name

字符串 / 必需

名称。

saas_application

别名：saas-application

列表 / 元素=字典

Saas 应用程序。

access_rule

别名：access-rule

列表 / 元素=字典

访问规则。

action

字符串

操作。

选项

  • "block"

  • "monitor"

  • "bypass"

bypass

列表 / 元素=字符串

旁路。

选项

  • "av"

  • "dlp"

  • "web-filter"

  • "file-filter"

  • "video-filter"

name

字符串

名称。

custom_control

别名：custom-control

列表 / 元素=字典

自定义控制。

name

字符串

名称。

option

列表 / 元素=字典

选项。

name

字符串

名称。

user_input

别名：user-input

列表 / 元素=字符串

用户输入。

domain_control

别名：domain-control

字符串

域控制。

选项

  • "disable"

  • "enable"

domain_control_domains

别名：domain-control-domains

列表 / 元素=字符串

域控制域。

log

字符串

日志。

选项

  • "disable"

  • "enable"

name

字符串

名称。

safe_search

别名：safe-search

字符串

安全搜索。

选项

  • "disable"

  • "enable"

safe_search_control

别名：safe-search-control

列表 / 元素=字符串

安全搜索控制。

tenant_control

别名：tenant-control

字符串

租户控制。

选项

  • "disable"

  • "enable"

tenant_control_tenants

别名：tenant-control-tenants

列表 / 元素=字符串

租户控制租户。

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

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

workspace_locking_timeout

整数

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

默认值： 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: Firewall casb profile
      fortinet.fortimanager.fmgr_firewall_casbprofile:
        # 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>
        state: present # <value in [present, absent]>
        firewall_casbprofile:
          name: <string>
          saas_application:
            -
              access_rule:
                -
                  action: <value in [block, monitor, bypass]>
                  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>

返回值

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

键

描述

meta

字典

请求的结果。

返回： 始终

request_url

字符串

请求的完整 URL。

返回： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回： 始终

response_message

字符串

API 响应的描述性消息。

返回： 始终

示例： "OK."

system_information

字典

目标系统的信息。

返回： 始终

rc

整数

请求的状态。

返回： 始终

示例： 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)