fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy 模块 – 配置 IPv4/IPv6 策略。

注意

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

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

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

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

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_hyperscalepolicy

字典

设置的顶级参数。

action

字符串

策略操作

选项

  • "deny"

  • "accept"

auto_asic_offload

别名：auto-asic-offload

字符串

启用/禁用策略流量 ASIC 卸载。

选项

  • "disable"

  • "enable"

cgn_eif

别名：cgn-eif

字符串

启用/禁用 CGN 端点独立筛选。

选项

  • "disable"

  • "enable"

cgn_eim

别名：cgn-eim

字符串

启用/禁用 CGN 端点独立映射

选项

  • "disable"

  • "enable"

cgn_log_server_grp

别名：cgn-log-server-grp

字符串

NP 日志服务器组名称

cgn_resource_quota

别名：cgn-resource-quota

整数

资源配额

cgn_session_quota

别名：cgn-session-quota

整数

会话配额

comments

字符串

注释。

delay_tcp_npu_session

别名：delay-tcp-npu-session

字符串

启用 TCP NPU 会话延迟以保证三次握手的包顺序。

选项

  • "disable"

  • "enable"

dstaddr

任意

（列表或字符串）目标 IPv4 地址和地址组名称。

dstaddr6

任意

（列表或字符串）目标 IPv6 地址名称和地址组名称。

dstaddr_negate

别名：dstaddr-negate

字符串

启用后，dstaddr/dstaddr6 指定目标地址不能是什么。

选项

  • "disable"

  • "enable"

dstintf

任意

（列表或字符串）传出

firewall_session_dirty

别名：firewall-session-dirty

字符串

如果此防火墙策略的配置发生更改，如何处理会话。

选项

  • "check-all"

  • "check-new"

global_label

别名：global-label

字符串

当 GUI 处于全局视图模式时，显示的策略标签。

ippool

字符串

启用以使用 IP 池进行源 NAT。

选项

  • "disable"

  • "enable"

label

字符串

当 GUI 处于分区视图模式时显示的策略标签。

name

字符串

策略名称。

nat

字符串

启用/禁用源 NAT。

选项

  • "disable"

  • "enable"

policy_offload

别名：policy-offload

字符串

启用/禁用 CGNAT 的硬件会话设置。

选项

  • "disable"

  • "enable"

policyid

整数 / 必填

策略 ID

poolname

任意

（列表或字符串）IP 池名称。

poolname6

任意

（列表或字符串）IPv6 池名称。

send_deny_packet

别名：send-deny-packet

字符串

启用以在会话被防火墙策略拒绝或阻止时发送回复。

选项

  • "disable"

  • "enable"

service

任意

（列表或字符串）服务和服务组名称。

service_negate

别名：service-negate

字符串

启用后，service 指定服务不能是什么。

选项

  • "disable"

  • "enable"

srcaddr

任意

（列表或字符串）源 IPv4 地址和地址组名称。

srcaddr6

任意

（列表或字符串）源 IPv6 地址名称和地址组名称。

srcaddr_negate

别名：srcaddr-negate

字符串

启用后，srcaddr/srcaddr6 指定源地址不能是什么。

选项

  • "disable"

  • "enable"

srcintf

任意

（列表或字符串）传入

status

字符串

启用或禁用此策略。

选项

  • "disable"

  • "enable"

tcp_timeout_pid

别名：tcp-timeout-pid

字符串

TCP 超时配置文件 ID

traffic_shaper

别名：traffic-shaper

字符串

流量整形器。

traffic_shaper_reverse

别名：traffic-shaper-reverse

字符串

反向流量整形器。

udp_timeout_pid

别名：udp-timeout-pid

字符串

UDP 超时配置文件 ID

uuid

字符串

通用唯一标识符

proposed_method

字符串

底层 Json RPC 请求的替代方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素类型=整数

返回码列表，当返回列表中任意一个代码时，模块将被视为失败。

rc_succeeded

列表 / 元素类型=整数

返回码列表，当返回列表中任意一个代码时，模块将被视为成功。

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 中要锁定的 ADOM，值可以是 global 以及其他包括 root 的 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 (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 IPv4/IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy:
        # 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_hyperscalepolicy:
          action: <value in [deny, accept]>
          auto_asic_offload: <value in [disable, enable]>
          cgn_eif: <value in [disable, enable]>
          cgn_eim: <value in [disable, enable]>
          cgn_log_server_grp: <string>
          cgn_resource_quota: <integer>
          cgn_session_quota: <integer>
          comments: <string>
          delay_tcp_npu_session: <value in [disable, enable]>
          dstaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          dstaddr6: <list or string>
          dstintf: <list or string>
          firewall_session_dirty: <value in [check-all, check-new]>
          global_label: <string>
          ippool: <value in [disable, enable]>
          label: <string>
          name: <string>
          nat: <value in [disable, enable]>
          policy_offload: <value in [disable, enable]>
          policyid: <integer>
          poolname: <list or string>
          poolname6: <list or string>
          send_deny_packet: <value in [disable, enable]>
          service: <list or string>
          service_negate: <value in [disable, enable]>
          srcaddr: <list or string>
          srcaddr_negate: <value in [disable, enable]>
          srcaddr6: <list or string>
          srcintf: <list or string>
          status: <value in [disable, enable]>
          tcp_timeout_pid: <string>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          udp_timeout_pid: <string>
          uuid: <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)