fortinet.fortios.fortios_wireless_controller_mpsk_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 MPSK 配置文件。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

vdom

字符串

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

默认值： "root"

wireless_controller_mpsk_profile

字典

配置 MPSK 配置文件。

mpsk_concurrent_clients

整数

使用相同密码短语在多个 PSK 身份验证中连接的最大并发客户端数 (0 - 65535)。

mpsk_external_server

字符串

用于对 MPSK 用户进行身份验证的 RADIUS 服务器。来源 user.radius.name。

mpsk_external_server_auth

字符串

启用/禁用 MPSK 外部服务器身份验证。

选项

  • "enable"

  • "disable"

mpsk_group

列表 / 元素=字典

多个 PSK 组的列表。

mpsk_key

列表 / 元素=字典

多个 PSK 条目的列表。

comment

字符串

注释。

concurrent_client_limit_type

字符串

MPSK 客户端限制类型选项。

选项

  • "default"

  • "unlimited"

  • "specified"

concurrent_clients

整数

可以使用此预共享密钥连接的客户端数量 (1 - 65535)。

key_type

字符串

选择密钥的类型。

选项

  • "wpa2-personal"

  • "wpa3-sae"

mac

字符串

MAC 地址。

mpsk_schedules

列表 / 元素=字典

MPSK 密码短语的防火墙计划。密码短语仅在至少一个计划有效时才有效。

name

字符串 / 必需

计划名称。来源 firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name。

name

字符串 / 必需

预共享密钥名称。

passphrase

字符串

WPA 预共享密钥。

sae_password

字符串

WPA3 SAE 密码。

sae_pk

字符串

启用/禁用 WPA3 SAE-PK。

选项

  • "enable"

  • "disable"

sae_private_key

字符串

用于 WPA3 SAE-PK 身份验证的私钥。

name

字符串 / 必需

MPSK 组名称。

vlan_id

整数

可选 VLAN ID。

vlan_type

字符串

MPSK 组 VLAN 选项。

选项

  • "no-vlan"

  • "fixed-vlan"

mpsk_type

字符串

选择此配置文件的密钥的安全类型。

选项

  • "wpa2-personal"

  • "wpa3-sae"

  • "wpa3-sae-transition"

name

字符串 / 必需

MPSK 配置文件名称。

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure MPSK profile.
  fortinet.fortios.fortios_wireless_controller_mpsk_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_mpsk_profile:
          mpsk_concurrent_clients: "0"
          mpsk_external_server: "<your_own_value> (source user.radius.name)"
          mpsk_external_server_auth: "enable"
          mpsk_group:
              -
                  mpsk_key:
                      -
                          comment: "Comment."
                          concurrent_client_limit_type: "default"
                          concurrent_clients: "256"
                          key_type: "wpa2-personal"
                          mac: "<your_own_value>"
                          mpsk_schedules:
                              -
                                  name: "default_name_14 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
                          name: "default_name_15"
                          passphrase: "<your_own_value>"
                          sae_password: "<your_own_value>"
                          sae_pk: "enable"
                          sae_private_key: "<your_own_value>"
                  name: "default_name_20"
                  vlan_id: "0"
                  vlan_type: "no-vlan"
          mpsk_type: "wpa2-personal"
          name: "default_name_24"

返回值

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

键

描述

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"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪斌 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)