fortinet.fortios.fortios_switch_controller_vlan 模块 – 配置 Fortinet 的 FortiOS 和 FortiGate 中交换机控制器的 VLAN。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortios.fortios_switch_controller_vlan。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 switch_controller 功能和 vlan 类别来配置 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

字典

配置交换机控制器的 VLAN。

auth

字符串

身份验证。

选项

  • "radius"

  • "usergroup"

color

整数

GUI 上图标的颜色。

comments

字符串

注释。

name

字符串 / 必需

交换机 VLAN 名称。

portal_message_override_group

字符串

指定受限门户替换消息覆盖组。

portal_message_overrides

字典

单个消息覆盖。

auth_disclaimer_page

字符串

使用 portal-message-overrides 组中的消息覆盖 auth-disclaimer-page 消息。

auth_login_failed_page

字符串

使用 portal-message-overrides 组中的消息覆盖 auth-login-failed-page 消息。

auth_login_page

字符串

使用 portal-message-overrides 组中的消息覆盖 auth-login-page 消息。

auth_reject_page

字符串

使用 portal-message-overrides 组中的消息覆盖 auth-reject-page 消息。

radius_server

字符串

身份验证 radius 服务器。源 user.radius.name。

security

字符串

安全。

选项

  • "open"

  • "captive-portal"

  • "8021x"

selected_usergroups

列表 / 元素=字典

选定的用户组。

name

字符串 / 必需

用户组名称。源 user.group.name。

usergroup

字符串

身份验证用户组。源 user.group.name。

vdom

字符串

虚拟域，

vlanid

整数

VLAN ID。

vdom

字符串

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

默认： "root"

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure VLANs for switch controller.
  fortinet.fortios.fortios_switch_controller_vlan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_vlan:
          auth: "radius"
          color: "16"
          comments: "<your_own_value>"
          name: "default_name_6"
          portal_message_override_group: "<your_own_value>"
          portal_message_overrides:
              auth_disclaimer_page: "<your_own_value>"
              auth_login_failed_page: "<your_own_value>"
              auth_login_page: "<your_own_value>"
              auth_reject_page: "<your_own_value>"
          radius_server: "<your_own_value> (source user.radius.name)"
          security: "open"
          selected_usergroups:
              -
                  name: "default_name_16 (source user.group.name)"
          usergroup: "<your_own_value> (source user.group.name)"
          vdom: "<your_own_value>"
          vlanid: "2047"

返回值

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

键

描述

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 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪滨 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)