fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy46 模块 – 配置 IPv4 到 IPv6 策略。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy46。

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_hyperscalepolicy46

字典

设置的顶级参数。

action

字符串

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

选项

  • "deny"

  • "accept"

cgn_log_server_grp

别名：cgn-log-server-grp

字符串

NP 日志服务器组名称

comments

字符串

注释。

dstaddr

any

(列表或字符串) 目标地址对象。

dstintf

字符串

目标接口名称。

name

字符串

策略名称。

policy_offload

别名：policy-offload

字符串

启用/禁用将策略配置卸载到 CP 处理器。

选项

  • "disable"

  • "enable"

policyid

整数 / 必填

策略 ID

service

any

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

srcaddr

any

(列表或字符串) 源地址对象。

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 代码列表。

rc_succeeded

列表 / 元素=整数

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

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: Configure IPv4 to IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy46:
        # 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_hyperscalepolicy46:
          action: <value in [deny, accept]>
          cgn_log_server_grp: <string>
          comments: <string>
          dstaddr: <list or string>
          dstintf: <string>
          name: <string>
          policy_offload: <value in [disable, enable]>
          policyid: <integer>
          service: <list or string>
          srcaddr: <list or string>
          srcintf: <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

列表 / 元素=字符串

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

返回值： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李兴 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑链 (@chillancezen)

  • 沈峰 (@fshen01)

  • 卢宏斌 (@fgtdev-hblu)