fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy_identitybasedpolicy 模块 – 基于身份的策略。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新增功能

概要

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

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

explicit-proxy-policy

字符串

已弃用，请使用“explicit_proxy_policy”

explicit_proxy_policy

字符串

请求 URL 中的参数 (explicit-proxy-policy)。

forticloud_access_token

字符串

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

pkg

字符串 / 必需

请求 URL 中的参数 (pkg)。

pkg_firewall_explicitproxypolicy_identitybasedpolicy

字典

顶级参数集。

application_list

别名：application-list

字符串

应用程序列表。

av_profile

别名：av-profile

字符串

防病毒配置文件。

casi_profile

别名：casi-profile

字符串

CASI 配置文件。

免责声明

字符串

Web 代理免责声明设置。

选项

  • "disable"

  • "domain"

  • "policy"

  • "user"

dlp_sensor

别名：dlp-sensor

字符串

DLP 传感器。

groups

字符串

组名称。

icap_profile

别名：icap-profile

字符串

ICAP 配置文件。

id

整数 / 必需

ID。

ips_sensor

别名：ips-sensor

字符串

IPS 传感器。

logtraffic

字符串

启用/禁用策略日志流量。

选项

  • "disable"

  • "all"

  • "utm"

logtraffic_start

别名：logtraffic-start

字符串

启用/禁用策略日志流量启动。

选项

  • "disable"

  • "enable"

mms_profile

别名：mms-profile

字符串

Mms 配置文件

profile_group

别名：profile-group

字符串

配置文件组

profile_protocol_options

别名：profile-protocol-options

字符串

配置文件协议选项。

profile_type

别名：profile-type

字符串

配置文件类型

选项

  • "single"

  • "group"

replacemsg_override_group

别名：replacemsg-override-group

字符串

指定身份验证替换消息覆盖组。

scan_botnet_connections

别名：scan-botnet-connections

字符串

启用/禁用扫描与僵尸网络服务器的连接。

选项

  • "disable"

  • "block"

  • "monitor"

schedule

字符串

计划名称。

spamfilter_profile

别名：spamfilter-profile

字符串

垃圾邮件过滤器配置文件。

ssl_ssh_profile

别名：ssl-ssh-profile

字符串

SSL SSH 配置文件。

users

字符串

用户名。

utm_status

别名：utm-status

字符串

启用 AV/web/IPS 保护配置文件。

选项

  • "disable"

  • "enable"

waf_profile

别名: waf-profile

字符串

Web 应用程序防火墙配置文件。

webfilter_profile

别名: webfilter-profile

字符串

Web 过滤配置文件。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

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: Identity-based policy.
      fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy_identitybasedpolicy:
        # 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>
        pkg: <your own value>
        explicit_proxy_policy: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_explicitproxypolicy_identitybasedpolicy:
          application_list: <string>
          av_profile: <string>
          casi_profile: <string>
          disclaimer: <value in [disable, domain, policy, ...]>
          dlp_sensor: <string>
          groups: <string>
          icap_profile: <string>
          id: <integer>
          ips_sensor: <string>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          mms_profile: <string>
          profile_group: <string>
          profile_protocol_options: <string>
          profile_type: <value in [single, group]>
          replacemsg_override_group: <string>
          scan_botnet_connections: <value in [disable, block, monitor]>
          schedule: <string>
          spamfilter_profile: <string>
          ssl_ssh_profile: <string>
          users: <string>
          utm_status: <value in [disable, enable]>
          waf_profile: <string>
          webfilter_profile: <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

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)