fortinet.fortimanager.fmgr_pkg_firewall_centralsnatmap 模块 – 配置中央 SNAT 策略。

注意

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

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

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

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

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_centralsnatmap

字典

设置的顶级参数。

comments

字符串

注释。

dst_addr

别名：dst-addr

任意

(列表或字符串) 可用地址中的目标地址名称。

dst_addr6

别名：dst-addr6

任意

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

dst_port

别名：dst-port

字符串

目标端口或端口范围

dstintf

任意

(列表或字符串) 可用接口中的目标接口名称。

nat

字符串

启用/禁用源 NAT。

选项

  • "disable"

  • "enable"

nat46

字符串

启用/禁用 NAT46。

选项

  • "disable"

  • "enable"

nat64

字符串

启用/禁用 NAT64。

选项

  • "disable"

  • "enable"

nat_ippool

别名：nat-ippool

任意

(列表或字符串) 用于转换地址的 IP 池名称，来自可用 IP 池。

nat_ippool6

别名：nat-ippool6

任意

(列表或字符串) 用于源 NAT 的 IPv6 池。

nat_port

别名：nat-port

字符串

转换后的端口或端口范围

orig_addr

别名：orig-addr

任意

(列表或字符串) 原地址。

orig_addr6

别名：orig-addr6

任意

(列表或字符串) IPv6 原地址。

orig_port

别名：orig-port

任意

(整数或字符串) 原 TCP 端口

policyid

整数 / 必需

策略 ID。

port_preserve

别名：port-preserve

字符串

启用/禁用保留源 NAT 中的原始源端口（如果尚未使用）。

选项

  • "disable"

  • "enable"

protocol

整数

协议类型的整数值

srcintf

任意

(列表或字符串) 可用接口中的源接口名称。

status

字符串

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

选项

  • "disable"

  • "enable"

type

字符串

IPv4/IPv6 源 NAT。

选项

  • "ipv4"

  • "ipv6"

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure central SNAT policies.
      fortinet.fortimanager.fmgr_pkg_firewall_centralsnatmap:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_centralsnatmap:
          dst-addr: "ansible-test1"
          nat: enable
          orig-addr: "ansible-test1"
          policyid: 2
          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 central SNAT policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_centralsnatmap"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            central-snat-map: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

响应代码

整数

API请求的状态。

返回：始终

示例： 0

响应数据

列表 / 元素=字符串

API响应。

返回：始终

响应消息

字符串

API响应的描述性消息。

返回：始终

示例： "OK."

系统信息

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

版本检查警告

列表 / 元素=字符串

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

返回值： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李兴 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈芳 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)