fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy 模块 – 配置组播 NAT 策略。

注意

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

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

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

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

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_multicastpolicy

字典

设置的顶级参数。

action

字符串

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

选项

  • "deny"

  • "accept"

auto_asic_offload

别名：auto-asic-offload

字符串

启用/禁用硬件加速的策略流量卸载。

选项

  • "disable"

  • "enable"

comments

字符串

注释。

dnat

字符串

用于组播目标地址的 IPv4 DNAT 地址。

dstaddr

任意

（列表或字符串）目标地址对象。

dstintf

字符串

目标接口名称。

end_port

别名：end-port

整数

范围内 TCP/UDP/SCTP 目标端口的结束整数值

id

整数 / 必需

策略 ID。

ips_sensor

别名：ips-sensor

字符串

现有 IPS 传感器的名称。

logtraffic

字符串

启用/禁用此策略接受的流量的日志记录。

选项

  • "disable"

  • "enable"

  • "all"

  • "utm"

name

字符串

策略名称。

protocol

整数

IANA 定义的协议类型的整数值

snat

字符串

启用/禁用将传出接口 IP 地址替换为原始源 IP 地址

选项

  • "disable"

  • "enable"

snat_ip

别名：snat-ip

字符串

用作 NAT 流量的源地址的 IPv4 地址。

srcaddr

任意

（列表或字符串）源地址对象。

srcintf

字符串

源接口名称。

start_port

别名：start-port

整数

范围内 TCP/UDP/SCTP 目标端口的起始整数值

status

字符串

启用/禁用此策略。

选项

  • "disable"

  • "enable"

traffic_shaper

别名：traffic-shaper

字符串

应用于组播策略转发的流量的流量整形器。

utm_status

别名：utm-status

字符串

启用以将 IPS 安全配置文件添加到策略。

选项

  • "disable"

  • "enable"

uuid

字符串

通用唯一标识符

proposed_method

字符串

覆盖基础 Json RPC 请求的方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure multicast NAT policies.
      fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_multicastpolicy:
          action: accept # <value in [deny, accept]>
          dstaddr: all
          dstintf: any
          id: 2
          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 multicast NAT policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_multicastpolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            multicast-policy: "your_value"

返回值

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

键

描述

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)