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。

要在剧本中使用它，请指定： 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

any

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

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

any

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

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，该值可以是 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 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

列表 / 元素=字符串

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

返回： complex

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈芳 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)