fortinet.fortimanager.fmgr_pm_config_pblock_firewall_proxypolicy 模块 – 配置代理策略。

注意

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

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

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

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

fortinet.fortimanager 2.7.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

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

pblock

字符串 / 必需

请求 URL 中的参数 (pblock)。

pm_config_pblock_firewall_proxypolicy

字典

设置的顶级参数。

_policy_block

整数

分配的策略块。

access_proxy

别名：access-proxy

列表 / 元素=字符串

IPv4 访问代理。

access_proxy6

别名：access-proxy6

列表 / 元素=字符串

IPv6 访问代理。

action

字符串

接受或拒绝与策略参数匹配的流量。

选项

  • "accept"

  • "deny"

  • "redirect"

application_list

别名：application-list

列表 / 元素=字符串

现有应用程序列表的名称。

av_profile

别名：av-profile

列表 / 元素=字符串

现有反病毒配置文件的名称。

block_notification

别名：block-notification

字符串

启用/禁用阻止通知。

选项

  • "disable"

  • "enable"

casb_profile

别名：casb-profile

列表 / 元素=字符串

现有 CASB 配置文件的名称。

cifs_profile

别名：cifs-profile

列表 / 元素=字符串

现有 CIFS 配置文件的名称。

comments

字符串

可选注释。

decrypted_traffic_mirror

别名：decrypted-traffic-mirror

列表 / 元素=字符串

解密流量镜像。

detect_https_in_http_request

别名：detect-https-in-http-request

字符串

启用/禁用在 HTTP 请求中检测 HTTPS。

选项

  • "disable"

  • "enable"

device_ownership

别名：device-ownership

字符串

启用后，所有权强制将在策略级别执行。

选项

  • "disable"

  • "enable"

diameter_filter_profile

别名：diameter-filter-profile

列表 / 元素=字符串

现有 Diameter 过滤器配置文件的名称。

disclaimer

字符串

Web 代理免责声明设置

选项

  • "disable"

  • "domain"

  • "policy"

  • "user"

dlp_profile

别名：dlp-profile

列表 / 元素=字符串

现有 DLP 配置文件的名称。

dlp_sensor

别名：dlp-sensor

列表 / 元素=字符串

现有 DLP 传感器的名称。

dnsfilter_profile

别名：dnsfilter-profile

列表 / 元素=字符串

现有 DNS 过滤器配置文件的名称。

dstaddr

列表 / 元素=字符串

目标地址对象。

dstaddr6

列表 / 元素=字符串

IPv6 目标地址对象。

dstaddr_negate

别名：dstaddr-negate

字符串

启用后，目标地址将匹配任何地址，**除了**指定的目标地址。

选项

  • "disable"

  • "enable"

dstintf

列表 / 元素=字符串

目标接口名称。

emailfilter_profile

别名：emailfilter-profile

列表 / 元素=字符串

现有邮件过滤配置文件的名称。

file_filter_profile

别名：file-filter-profile

列表 / 元素=字符串

现有文件过滤配置文件的名称。

global_label

别名：global-label

字符串

全局基于 Web 的管理可见标签。

groups

列表 / 元素=字符串

组对象的名称。

http_tunnel_auth

别名：http-tunnel-auth

字符串

启用/禁用 HTTP 隧道认证。

选项

  • "disable"

  • "enable"

icap_profile

别名：icap-profile

列表 / 元素=字符串

现有 ICAP 配置文件的名称。

internet_service

别名：internet-service

字符串

启用/禁用为此策略使用互联网服务。

选项

  • "disable"

  • "enable"

internet_service6

别名：internet-service6

字符串

启用/禁用为此策略使用 IPv6 互联网服务。

选项

  • "disable"

  • "enable"

internet_service6_custom

别名：internet-service6-custom

列表 / 元素=字符串

自定义 IPv6 互联网服务名称。

internet_service6_custom_group

别名：internet-service6-custom-group

列表 / 元素=字符串

自定义 IPv6 互联网服务组名称。

internet_service6_group

别名：internet-service6-group

列表 / 元素=字符串

IPv6 互联网服务组名称。

internet_service6_name

别名：internet-service6-name

列表 / 元素=字符串

IPv6 互联网服务名称。

internet_service6_negate

别名：internet-service6-negate

字符串

启用后，互联网服务将匹配任何 IPv6 互联网服务，**除了**选定的 IPv6 互联网服务。

选项

  • "disable"

  • "enable"

internet_service_custom

别名：internet-service-custom

列表 / 元素=字符串

自定义互联网服务名称。

internet_service_custom_group

别名：internet-service-custom-group

列表 / 元素=字符串

自定义互联网服务组名称。

internet_service_group

别名：internet-service-group

列表 / 元素=字符串

互联网服务组名称。

internet_service_id

别名：internet-service-id

列表 / 元素=字符串

互联网服务 ID。

internet_service_name

别名：internet-service-name

列表 / 元素=字符串

互联网服务名称。

internet_service_negate

别名：internet-service-negate

字符串

启用后，互联网服务将匹配任何互联网服务，**除了**选定的互联网服务。

选项

  • "disable"

  • "enable"

ips_sensor

别名：ips-sensor

列表 / 元素=字符串

现有 IPS 传感器的名称。

ips_voip_filter

别名：ips-voip-filter

列表 / 元素=字符串

现有 VoIP 的名称

label

字符串

VDOM 特定的 GUI 可见标签。

log_http_transaction

别名：log-http-transaction

字符串

启用/禁用 HTTP 事务日志。

选项

  • "disable"

  • "enable"

logtraffic

字符串

启用/禁用通过策略记录流量。

选项

  • "disable"

  • "all"

  • "utm"

logtraffic_start

别名：logtraffic-start

字符串

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

选项

  • "disable"

  • "enable"

mms_profile

别名：mms-profile

列表 / 元素=字符串

现有 MMS 配置文件的名称。

name

字符串

策略名称。

policyid

整数 / 必需

策略 ID。

poolname

列表 / 元素=字符串

IP 池对象的名称。

profile_group

别名：profile-group

列表 / 元素=字符串

配置文件组的名称。

profile_protocol_options

别名：profile-protocol-options

列表 / 元素=字符串

现有协议选项配置文件的名称。

profile_type

别名：profile-type

字符串

确定防火墙策略是否仅允许安全配置文件组或单个配置文件。

选项

  • "single"

  • "group"

proxy

字符串

显式代理的类型。

选项

  • "explicit-web"

  • "transparent-web"

  • "ftp"

  • "wanopt"

  • "ssh"

  • "ssh-tunnel"

  • "access-proxy"

  • "ztna-proxy"

redirect_url

别名：redirect-url

字符串

用于进一步显式 Web 代理处理的重定向 URL。

replacemsg_override_group

别名：replacemsg-override-group

列表 / 元素=字符串

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

schedule

列表 / 元素=字符串

计划对象的名称。

sctp_filter_profile

别名：sctp-filter-profile

列表 / 元素=字符串

现有 SCTP 过滤配置文件的名称。

service

列表 / 元素=字符串

服务对象的名称。

service_negate

别名：service-negate

字符串

启用后，服务将匹配任何服务，**除了**指定的目标服务。

选项

  • "disable"

  • "enable"

session_ttl

别名：session-ttl

字符串

此策略接受的会话的 TTL（秒）。

srcaddr

列表 / 元素=字符串

源地址对象。

srcaddr6

列表 / 元素=字符串

IPv6 源地址对象。

srcaddr_negate

别名：srcaddr-negate

字符串

启用后，源地址将匹配任何地址，**除了**指定的源地址。

选项

  • "disable"

  • "enable"

srcintf

列表 / 元素=字符串

源接口名称。

ssh_filter_profile

别名：ssh-filter-profile

列表 / 元素=字符串

现有 SSH 过滤配置文件的名称。

ssh_policy_redirect

别名：ssh-policy-redirect

字符串

将 SSH 流量重定向到匹配的透明代理策略。

选项

  • "disable"

  • "enable"

ssl_ssh_profile

别名：ssl-ssh-profile

列表 / 元素=字符串

现有 SSL SSH 配置文件的名称。

status

字符串

启用/禁用策略的活动状态。

选项

  • "disable"

  • "enable"

transparent

字符串

启用后，使用客户端的 IP 地址连接到服务器。

选项

  • "disable"

  • "enable"

users

列表 / 元素=字符串

用户对象的名称。

utm_status

别名：utm-status

字符串

启用 UTM 配置文件/传感器/列表的使用。

选项

  • "disable"

  • "enable"

uuid

字符串

通用唯一标识符

videofilter_profile

别名：videofilter-profile

列表 / 元素=字符串

现有 VideoFilter 配置文件的名称。

virtual_patch_profile

别名：virtual-patch-profile

列表 / 元素=字符串

虚拟补丁配置文件。

voip_profile

别名：voip-profile

列表 / 元素=字符串

现有 VoIP 配置文件的名称。

waf_profile

别名：waf-profile

列表 / 元素=字符串

现有 Web 应用防火墙配置文件的名称。

webcache

字符串

启用/禁用 Web 缓存。

选项

  • "disable"

  • "enable"

webcache_https

别名：webcache-https

字符串

启用/禁用 HTTPS 的 Web 缓存。

选项

  • "disable"

  • "enable"

webfilter_profile

别名：webfilter-profile

列表 / 元素=字符串

现有 Web 过滤配置文件的名称。

webproxy_forward_server

别名：webproxy-forward-server

列表 / 元素=字符串

Web 代理转发服务器名称。

webproxy_profile

别名：webproxy-profile

列表 / 元素=字符串

Web 代理配置文件的名称。

ztna_ems_tag

别名：ztna-ems-tag

列表 / 元素=字符串

ZTNA EMS 标签名称。

ztna_proxy

别名：ztna-proxy

列表 / 元素=字符串

IPv4 ZTNA 流量转发代理。

ztna_tags_match_logic

别名：ztna-tags-match-logic

字符串

ZTNA 标签匹配逻辑。

选项

  • "or"

  • "and"

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 ADOM，该值可以是全局的和其他值，包括 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: Configure proxy policies.
      fortinet.fortimanager.fmgr_pm_config_pblock_firewall_proxypolicy:
        # 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>
        pblock: <your own value>
        state: present # <value in [present, absent]>
        pm_config_pblock_firewall_proxypolicy:
          _policy_block: <integer>
          access_proxy: <list or string>
          access_proxy6: <list or string>
          action: <value in [accept, deny, redirect]>
          application_list: <list or string>
          av_profile: <list or string>
          block_notification: <value in [disable, enable]>
          casb_profile: <list or string>
          comments: <string>
          decrypted_traffic_mirror: <list or string>
          detect_https_in_http_request: <value in [disable, enable]>
          device_ownership: <value in [disable, enable]>
          disclaimer: <value in [disable, domain, policy, ...]>
          dlp_profile: <list or string>
          dnsfilter_profile: <list or string>
          dstaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          dstaddr6: <list or string>
          dstintf: <list or string>
          emailfilter_profile: <list or string>
          file_filter_profile: <list or string>
          global_label: <string>
          groups: <list or string>
          http_tunnel_auth: <value in [disable, enable]>
          icap_profile: <list or string>
          internet_service: <value in [disable, enable]>
          internet_service_custom: <list or string>
          internet_service_custom_group: <list or string>
          internet_service_group: <list or string>
          internet_service_name: <list or string>
          internet_service_negate: <value in [disable, enable]>
          internet_service6: <value in [disable, enable]>
          internet_service6_custom: <list or string>
          internet_service6_custom_group: <list or string>
          internet_service6_group: <list or string>
          internet_service6_name: <list or string>
          internet_service6_negate: <value in [disable, enable]>
          ips_sensor: <list or string>
          ips_voip_filter: <list or string>
          label: <string>
          log_http_transaction: <value in [disable, enable]>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          name: <string>
          policyid: <integer>
          poolname: <list or string>
          profile_group: <list or string>
          profile_protocol_options: <list or string>
          profile_type: <value in [single, group]>
          proxy: <value in [explicit-web, transparent-web, ftp, ...]>
          redirect_url: <string>
          replacemsg_override_group: <list or string>
          schedule: <list or string>
          sctp_filter_profile: <list or string>
          service: <list or string>
          service_negate: <value in [disable, enable]>
          session_ttl: <string>
          srcaddr: <list or string>
          srcaddr_negate: <value in [disable, enable]>
          srcaddr6: <list or string>
          srcintf: <list or string>
          ssh_filter_profile: <list or string>
          ssh_policy_redirect: <value in [disable, enable]>
          ssl_ssh_profile: <list or string>
          status: <value in [disable, enable]>
          transparent: <value in [disable, enable]>
          users: <list or string>
          utm_status: <value in [disable, enable]>
          uuid: <string>
          videofilter_profile: <list or string>
          waf_profile: <list or string>
          webcache: <value in [disable, enable]>
          webcache_https: <value in [disable, enable]>
          webfilter_profile: <list or string>
          webproxy_forward_server: <list or string>
          webproxy_profile: <list or string>
          ztna_ems_tag: <list or string>
          ztna_proxy: <list or string>
          ztna_tags_match_logic: <value in [or, and]>
          diameter_filter_profile: <list or string>
          virtual_patch_profile: <list or string>
          voip_profile: <list or string>
          dlp_sensor: <list or string>
          cifs_profile: <list or string>
          internet_service_id: <list or string>
          mms_profile: <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

列表 / 元素=字符串

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

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑凌 (@chillancezen)

  • 沈峰 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)