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

注意

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

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

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

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

fortinet.fortimanager 2.0.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 客户端。

pkg

字符串 / 必需

请求 URL 中的参数 (pkg)。

pkg_firewall_proxypolicy

字典

设置的顶层参数。

_policy_block

整数

分配的策略块。

access_proxy

别名: access-proxy

任意

(列表或字符串) 访问代理。

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

字符串

启用/禁用此策略使用 Internet 服务。

选项

  • "disable"

  • "enable"

internet_service6

别名: internet-service6

字符串

启用/禁用此策略使用 Internet Services IPv6。

选项

  • "disable"

  • "enable"

internet_service6_custom

别名: internet-service6-custom

任意

(列表) 自定义 Internet Service IPv6 名称。

internet_service6_custom_group

别名: internet-service6-custom-group

任意

(列表) 自定义 Internet Service IPv6 组名称。

internet_service6_group

别名: internet-service6-group

任意

(列表) Internet Service IPv6 组名称。

internet_service6_name

别名: internet-service6-name

任意

(列表) Internet Service IPv6 名称。

internet_service6_negate

别名: internet-service6-negate

字符串

启用后，Internet 服务将匹配除选定的 Internet 服务 IPv6 之外的任何 Internet 服务 IPv6。

选项

  • "disable"

  • "enable"

internet_service_custom

别名: internet-service-custom

任意

(列表或字符串) 自定义 Internet 服务名称。

internet_service_custom_group

别名: internet-service-custom-group

任意

(列表或字符串) 自定义 Internet 服务组名称。

internet_service_group

别名: internet-service-group

任意

(列表或字符串) Internet 服务组名称。

internet_service_id

别名: internet-service-id

任意

(列表或字符串) Internet 服务 ID。

internet_service_name

别名: internet-service-name

任意

(列表或字符串) Internet 服务名称。

internet_service_negate

别名: internet-service-negate

字符串

启用后，Internet 服务将匹配除选定的 Internet 服务之外的任何 Internet 服务。

选项

  • "disable"

  • "enable"

ips_sensor

别名: ips-sensor

字符串

现有 IPS 防护器的名称。

ips_voip_filter

别名: ips-voip-filter

字符串

现有 VoIP 的名称

标签

字符串

VDOM 特定的 GUI 可见标签。

log_http_transaction

别名: log-http-transaction

字符串

启用/禁用 HTTP 事务日志。

选项

  • "disable"

  • "enable"

logtraffic

字符串

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

选项

  • "disable"

  • "全部"

  • "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

字符串

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

scan_botnet_connections

别名: scan-botnet-connections

字符串

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

选项

  • "disable"

  • "block"

  • "monitor"

schedule

字符串

计划对象的名称。

sctp_filter_profile

别名: sctp-filter-profile

字符串

现有 SCTP 筛选器配置文件的名称。

service

任意

(列表或字符串) 服务对象的名称。

service_negate

别名: service-negate

字符串

启用后，服务将匹配除指定的目的地服务之外的任何服务。

选项

  • "disable"

  • "enable"

session_ttl

别名: session-ttl

任意

(整数或字符串) 此策略接受的会话的 TTL（以秒为单位）

spamfilter_profile

别名: spamfilter-profile

字符串

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

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"

tags

字符串

应用于地址的对象标签的名称。

transparent

字符串

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

选项

  • "disable"

  • "enable"

users

任意

(列表或字符串) 用户对象的名称。

utm_status

别名: utm-status

字符串

启用 UTM 配置文件/防护器/列表的使用。

选项

  • "disable"

  • "enable"

uuid

字符串

通用唯一标识符

videofilter_profile

别名: videofilter-profile

字符串

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

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，该值可以是全局的和其他的，包括根。

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
  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_pkg_firewall_proxypolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_proxypolicy:
          action: accept # <value in [accept, deny, redirect]>
          comments: ansible-comment
          dstaddr: all
          dstintf: any
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          srcintf: any
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the proxy policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_proxypolicy"
          params:
            adom: "ansible"
            proxy-policy: "your_value"
            pkg: "ansible" # package name

返回值

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

键

描述

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 版本不支持 playbook 中使用的参数，则会发出警告。

返回: 复杂类型

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)