fortinet.fortios.fortios_system_virtual_wire_pair 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置虚拟线对。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_virtual_wire_pair。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 virtual_wire_pair 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值都需要在使用前调整为数据源。已通过 FOS v6.0.0 测试

要求

以下要求在执行此模块的主机上是必需的。

  • ansible>=2.15

参数

参数

注释

access_token

string

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

boolean

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

member_path

string

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标记为 member_path 的参数对于执行成员操作是合法的。

member_state

string

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

string / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_virtual_wire_pair

dictionary

配置虚拟线对。

member

list / elements=dictionary

属于虚拟线对的接口。

interface_name

string / 必需

接口名称。源 system.interface.name。

name

string / 必需

虚拟线对名称。必须是唯一的接口名称。

outer_vlan_id

list / elements=dictionary

外部 VLAN ID。

vlanid

integer / 必需

VLAN ID (1 - 4094)。请参阅 <a href=’#notes’>注释</a>。

vlan_filter

string

要允许的 VLAN 范围

wildcard_vlan

string

启用/禁用通配符 VLAN。

选项

  • "enable"

  • "disable"

vdom

string

虚拟域，在先前定义的那些之中。vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure virtual wire pairs.
  fortinet.fortios.fortios_system_virtual_wire_pair:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_virtual_wire_pair:
          member:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          name: "default_name_5"
          outer_vlan_id:
              -
                  vlanid: "<you_own_value>"
          vlan_filter: "<your_own_value>"
          wildcard_vlan: "enable"

返回值

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

键

描述

build

string

FortiGate 映像的构建编号

已返回： 始终

示例： "1547"

http_method

string

最后一次用于将内容配置到 FortiGate 中的方法

已返回： 始终

示例： "PUT"

http_status

string

FortiGate 在上次应用的操作中给出的最后结果

已返回： 始终

示例： "200"

mkey

string

上次调用 FortiGate 时使用的主密钥（ID）

已返回： 成功

示例： "id"

name

string

用于满足请求的表名

已返回： 始终

示例： "urlfilter"

path

string

用于满足请求的表路径

已返回： 始终

示例： "webfilter"

revision

string

内部修订号

已返回： 始终

示例： "17.0.2.10658"

serial

string

设备的序列号

已返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

string

操作结果的指示

已返回： 始终

示例： "success"

vdom

string

使用的虚拟域

已返回： 始终

示例： "root"

version

string

FortiGate 的版本

已返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)