fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy 模块 – 配置显式代理策略。

注意

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

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortimanager

要在剧本中使用它,请指定: fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy

fortinet.fortimanager 2.2.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_explicitproxypolicy

字典

设置的顶层参数。

action

字符串

策略操作。

选项

  • "deny"

  • "accept"

active_auth_method

别名:active-auth-method

字符串

活动身份验证方法。

选项

  • "ntlm"

  • "basic"

  • "digest"

  • "form"

  • "none"

  • "negotiate"

application_list

别名:application-list

字符串

应用程序列表。

av_profile

别名:av-profile

字符串

防病毒配置文件。

casi_profile

别名:casi-profile

字符串

CASI 配置文件。

comments

字符串

评论。

disclaimer

字符串

Web 代理免责声明设置。

选项

  • "disable"

  • "domain"

  • "policy"

  • "user"

dlp_sensor

别名:dlp-sensor

字符串

DLP 传感器。

dstaddr

字符串

目标地址名称。

dstaddr6

字符串

IPv6 目标地址

dstaddr_negate

别名:dstaddr-negate

字符串

启用/禁用取反目标地址匹配。

选项

  • "disable"

  • "enable"

dstintf

字符串

目标接口名称。

global_label

别名:global-label

字符串

全局视图的标签。

icap_profile

别名:icap-profile

字符串

ICAP 配置文件。

identity_based

别名:identity-based

字符串

启用/禁用基于身份的策略。

选项

  • "disable"

  • "enable"

identity_based_policy

别名:identity-based-policy

列表 / elements=dictionary

基于身份的策略。

application_list

别名:application-list

字符串

应用程序列表。

av_profile

别名:av-profile

字符串

防病毒配置文件。

casi_profile

别名:casi-profile

字符串

CASI 配置文件。

disclaimer

字符串

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 过滤器配置文件。

ip_based

别名: ip-based

字符串

启用/禁用基于 IP 的身份验证。

选项

  • "disable"

  • "enable"

ips_sensor

别名: ips-sensor

字符串

IPS传感器。

label

字符串

部分视图的标签。

logtraffic

字符串

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

选项

  • "disable"

  • "all"

  • "utm"

logtraffic_start

别名: logtraffic-start

字符串

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

选项

  • "disable"

  • "enable"

mms_profile

别名: mms-profile

字符串

Mms配置文件

policyid

integer / required

策略 ID。

profile_group

别名: profile-group

字符串

配置文件组

profile_protocol_options

别名: profile-protocol-options

字符串

配置文件协议选项。

profile_type

别名: profile-type

字符串

配置文件类型

选项

  • "single"

  • "group"

proxy

字符串

显式代理类型。

选项

  • "web"

  • "ftp"

  • "wanopt"

replacemsg_override_group

别名: replacemsg-override-group

字符串

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

require_tfa

别名: require-tfa

字符串

启用/禁用双因素身份验证的要求。

选项

  • "disable"

  • "enable"

scan_botnet_connections

别名: scan-botnet-connections

字符串

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

选项

  • "disable"

  • "block"

  • "monitor"

schedule

字符串

计划名称。

service

字符串

服务名称。

service_negate

别名: service-negate

字符串

启用/禁用否定服务匹配。

选项

  • "disable"

  • "enable"

spamfilter_profile

别名: spamfilter-profile

字符串

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

srcaddr

字符串

源地址名称。

srcaddr6

字符串

IPv6 源地址

srcaddr_negate

别名: srcaddr-negate

字符串

启用/禁用否定源地址匹配。

选项

  • "disable"

  • "enable"

ssl_ssh_profile

别名: ssl-ssh-profile

字符串

SSL SSH 配置文件。

sso_auth_method

别名: sso-auth-method

字符串

SSO 身份验证方法。

选项

  • "fsso"

  • "rsso"

  • "none"

status

字符串

启用/禁用策略状态。

选项

  • "disable"

  • "enable"

tags

字符串

应用的对象标签。

transaction_based

别名: transaction-based

字符串

启用/禁用基于事务的身份验证。

选项

  • "disable"

  • "enable"

transparent

字符串

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

选项

  • "disable"

  • "enable"

utm_status

别名: utm-status

字符串

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

选项

  • "disable"

  • "enable"

uuid

字符串

通用唯一标识符。

waf_profile

别名: waf-profile

字符串

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

web_auth_cookie

别名: web-auth-cookie

字符串

启用/禁用 Web 身份验证 Cookie。

选项

  • "disable"

  • "enable"

webcache

字符串

启用/禁用 Web 缓存。

选项

  • "disable"

  • "enable"

webcache_https

别名: webcache-https

字符串

启用/禁用 HTTPS 的 Web 缓存。

选项

  • "disable"

  • "any"

  • "enable"

webfilter_profile

别名: webfilter-profile

字符串

Web 过滤器配置文件。

webproxy_forward_server

别名: webproxy-forward-server

字符串

Web 代理转发服务器。

webproxy_profile

别名: webproxy-profile

字符串

Web 代理配置文件。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

将覆盖成功条件的 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 Explicit proxy policies.
      fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy:
        # 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>
        state: present # <value in [present, absent]>
        pkg_firewall_explicitproxypolicy:
          action: <value in [deny, accept]>
          active_auth_method: <value in [ntlm, basic, digest, ...]>
          application_list: <string>
          av_profile: <string>
          casi_profile: <string>
          comments: <string>
          disclaimer: <value in [disable, domain, policy, ...]>
          dlp_sensor: <string>
          dstaddr: <string>
          dstaddr_negate: <value in [disable, enable]>
          dstaddr6: <string>
          dstintf: <string>
          global_label: <string>
          icap_profile: <string>
          identity_based: <value in [disable, enable]>
          identity_based_policy:
            -
              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>
          ip_based: <value in [disable, enable]>
          ips_sensor: <string>
          label: <string>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          mms_profile: <string>
          policyid: <integer>
          profile_group: <string>
          profile_protocol_options: <string>
          profile_type: <value in [single, group]>
          proxy: <value in [web, ftp, wanopt]>
          replacemsg_override_group: <string>
          require_tfa: <value in [disable, enable]>
          scan_botnet_connections: <value in [disable, block, monitor]>
          schedule: <string>
          service: <string>
          service_negate: <value in [disable, enable]>
          spamfilter_profile: <string>
          srcaddr: <string>
          srcaddr_negate: <value in [disable, enable]>
          srcaddr6: <string>
          ssl_ssh_profile: <string>
          sso_auth_method: <value in [fsso, rsso, none]>
          status: <value in [disable, enable]>
          tags: <string>
          transaction_based: <value in [disable, enable]>
          transparent: <value in [disable, enable]>
          utm_status: <value in [disable, enable]>
          uuid: <string>
          waf_profile: <string>
          web_auth_cookie: <value in [disable, enable]>
          webcache: <value in [disable, enable]>
          webcache_https: <value in [disable, any, enable]>
          webfilter_profile: <string>
          webproxy_forward_server: <string>
          webproxy_profile: <string>

返回值

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

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

list / elements=string

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

list / elements=string

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

返回: complex

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)