fortinet.fortios.fortios_switch_controller_vlan_policy 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中，通过 dynamic-port-policy 配置应用于受管 FortiSwitch 端口的 VLAN 策略。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

switch_controller_vlan_policy

字典

配置 VLAN 策略，通过 dynamic-port-policy 应用于受管 FortiSwitch 端口。

allowed_vlans

列表 / 元素=字典

使用此 VLAN 策略时允许应用的 VLAN。

vlan_name

字符串 / 必填

VLAN 名称。源 system.interface.name。

allowed_vlans_all

字符串

在使用此 VLAN 策略时启用/禁用所有定义的 VLAN。

选项

  • "enable"

  • "disable"

description

字符串

VLAN 策略的描述。

discard_mode

字符串

使用此 VLAN 策略时要应用的丢弃模式。

选项

  • "none"

  • "all-untagged"

  • "all-tagged"

字符串

此 VLAN 策略所属的 FortiLink 接口。源 system.interface.name。

name

字符串 / 必填

VLAN 策略名称。

untagged_vlans

列表 / 元素=字典

使用此 VLAN 策略时要应用的未标记 VLAN。

vlan_name

字符串 / 必填

VLAN 名称。源 system.interface.name。

vlan

字符串

使用此 VLAN 策略时要应用的本机 VLAN。源 system.interface.name。

vdom

字符串

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

默认值： "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy.
  fortinet.fortios.fortios_switch_controller_vlan_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_vlan_policy:
          allowed_vlans:
              -
                  vlan_name: "<your_own_value> (source system.interface.name)"
          allowed_vlans_all: "enable"
          description: "<your_own_value>"
          discard_mode: "none"
          fortilink: "<your_own_value> (source system.interface.name)"
          name: "default_name_9"
          untagged_vlans:
              -
                  vlan_name: "<your_own_value> (source system.interface.name)"
          vlan: "<your_own_value> (source system.interface.name)"

返回值

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

键

描述

build

字符串

fortigate 映像的内部版本号

返回值： 始终

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 的方法

返回值： 始终

示例： "PUT"

http_status

字符串

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

返回值： 始终

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主键 (id)

返回值： 成功

示例： "id"

name

字符串

用于满足请求的表名称

返回值： 始终

示例： "urlfilter"

path

字符串

用于满足请求的表的路径

返回值： 始终

示例： "webfilter"

revision

字符串

内部修订号

返回值： 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回值： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回值： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回值： 始终

示例： "root"

version

字符串

FortiGate 的版本

返回值： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • 米格尔·安吉尔·穆尼奥斯 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)