cisco.meraki.meraki_mr_ssid 模块 – 管理 Meraki 云中的无线 SSID

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定：cisco.meraki.meraki_mr_ssid。

已弃用

在以下版本中移除:

版本 3.0.0

原因:

更新后的模块发布，功能增强

替代方案:

cisco.meraki.networks_wireless_ssids

概要

  • 允许管理 Meraki 无线环境中的 SSID。

参数

参数

注释

ap_availability_tags

列表 / 元素=字符串

设置是否将由具有与此列表中任何标签匹配的标签的 AP 广播 SSID。

要求 available_on_all_aps 为 false。

ap_tags_vlan_ids

列表 / 元素=字典

VLAN 标签列表。

要求 ip_assignment_mode 为 桥接模式 或 第 3 层漫游。

要求 use_vlan_tagging 为 True。

tags

列表 / 元素=字符串

AP 标签列表。

vlan_id

整数

分配给 VLAN 的数字标识符。

auth_key

字符串 / 必需

仪表板提供的身份验证密钥。 如果未设置环境变量 MERAKI_KEY，则为必需。

auth_mode

字符串

设置网络的身份验证模式。

选项

  • "open"

  • "psk"

  • "open-with-radius"

  • "8021x-meraki"

  • "8021x-radius"

available_on_all_aps

布尔值

设置是否所有 AP 都应广播 SSID，或者是否应将其限制为与任何可用性标签匹配的 AP。

当设置为 False 时，要求定义 ap_availability_tags。

选项

  • false

  • true

band_selection

字符串

设置频段选择模式。

选项

  • "双频操作"

  • "仅限 5 GHz 频段"

  • "带频段转向的双频操作"

concentrator_network_id

字符串

用于“具有集中器的第 3 层漫游”或“VPN”的集中器。

default_vlan_id

整数

默认 VLAN ID。

要求 ip_assignment_mode 为 桥接模式 或 第 3 层漫游。

enabled

布尔值

启用或禁用 SSID 网络。

选项

  • false

  • true

encryption_mode

字符串

设置网络的加密模式。

选项

  • "wpa"

  • "eap"

  • "wpa-eap"

enterprise_admin_access

字符串

企业管理员是否可以访问 SSID。

选项

  • "禁用访问"

  • "启用访问"

host

字符串

Meraki 仪表板的主机名。

可用于访问区域性 Meraki 环境，例如中国。

默认值： "api.meraki.com"

internal_error_retry_time

整数

如果服务器返回内部服务器错误，则重试的秒数。

默认值： 60

ip_assignment_mode

字符串

SSID 用于分配 IP 地址的方法。

选项

  • "NAT 模式"

  • "桥接模式"

  • "第 3 层漫游"

  • "具有集中器的第 3 层漫游"

  • "VPN"

lan_isolation_enabled

布尔值

启用或禁用第 2 层 LAN 隔离。

要求 ip_assignment_mode 为 桥接模式。

选项

  • false

  • true

min_bitrate

浮点数

SSID 上允许的最小比特率 (Mbps)。

选项

  • 1.0

  • 2.0

  • 5.5

  • 6.0

  • 9.0

  • 11.0

  • 12.0

  • 18.0

  • 24.0

  • 36.0

  • 48.0

  • 54.0

name

字符串

SSID 的名称。

net_id

字符串

网络 ID。

net_name

字符串

网络名称。

number

别名: ssid_number

整数

网络中的 SSID 编号。

org_id

字符串

组织 ID。

org_name

别名: organization

字符串

组织名称。

output_format

字符串

指示模块是否应使用蛇形命名法 (例如 net_id) 或驼峰命名法 (例如 netId) 返回响应键。

选项

  • "snakecase" ← (默认)

  • "camelcase"

output_level

字符串

设置模块执行期间的调试输出量。

选项

  • "debug"

  • "normal" ← (默认)

per_client_bandwidth_limit_down

整数

SSID 上设备可以下载的最大带宽 (Mbps)。

per_client_bandwidth_limit_up

整数

SSID 上设备可以上传的最大带宽 (Mbps)。

psk

字符串

无线网络的密码。

要求将 auth_mode 设置为 psk。

radius_accounting_enabled

布尔值

启用或禁用 RADIUS 记账。

选项

  • false

  • true

radius_accounting_servers

列表 / 元素=字典

RADIUS 记账的 RADIUS 服务器列表。

host

字符串 / 必需

RADIUS 服务器的 IP 地址或主机名。

port

整数

RADIUS 服务器正在侦听的端口号。

secret

字符串

RADIUS 密码。

设置密码不是幂等的。

radius_coa_enabled

布尔值

启用或禁用 SSID 上的 RADIUS CoA（授权更改）。

选项

  • false

  • true

radius_failover_policy

字符串

设置 RADIUS 服务器不可用时客户端的访问策略。

选项

  • "拒绝访问"

  • "允许访问"

radius_load_balancing_policy

字符串

指定多个 RADIUS 服务器时的负载均衡策略。

选项

  • "严格优先级顺序"

  • "轮询"

radius_proxy_enabled

布尔值

启用或禁用 SSID 上的 RADIUS 代理。

选项

  • false

  • true

radius_servers

列表 / 元素=字典

RADIUS 服务器列表。

host

字符串 / 必需

RADIUS 服务器的 IP 地址或主机名。

port

整数

RADIUS 服务器正在侦听的端口号。

secret

字符串

RADIUS 密码。

设置密码不是幂等的。

rate_limit_retry_time

整数

如果触发了速率限制器，则重试的秒数。

默认值: 165

splash_guest_sponsor_domains

列表 / 元素=字符串

赞助访客门户的有效赞助商电子邮件域名列表。

splash_page

字符串

设置为启用欢迎页面并指定欢迎页面类型。

选项

  • "无"

  • "点击式欢迎页面"

  • "账单"

  • "使用 Meraki RADIUS 进行密码保护"

  • "使用自定义 RADIUS 进行密码保护"

  • "使用 Active Directory 进行密码保护"

  • "使用 LDAP 进行密码保护"

  • "短信身份验证"

  • "Systems Manager Sentry"

  • "Facebook Wi-Fi"

  • "Google OAuth"

  • "赞助访客"

  • "Cisco ISE"

state

字符串

指定是否应查询或修改 SNMP 信息。

选项

  • "absent"

  • "query"

  • "present" ← (默认)

timeout

整数

HTTP 请求的超时时间。

默认值: 30

use_https

布尔值

如果为 no，它将使用 HTTP。否则，它将使用 HTTPS。

仅对 Meraki 内部开发人员有用。

选项

  • false

  • true ← (默认)

use_proxy

布尔值

如果为 no，即使目标主机上的环境变量中定义了代理，也不会使用代理。

选项

  • false ← (默认)

  • true

use_vlan_tagging

布尔值

设置是否使用 VLAN 标记。

要求设置 default_vlan_id。

选项

  • false

  • true

validate_certs

布尔值

是否验证 HTTP 证书。

选项

  • false

  • true ← (默认)

visible

布尔值

启用或禁用 AP 是否应广播此 SSID。

选项

  • false

  • true

vlan_id

整数

SSID 上 VLAN 的 ID 号。

要求 ip_assignment_mode 设置为 ayer 3 roaming with a concentrator 或 VPN。

walled_garden_enabled

布尔值

启用或禁用围墙花园功能。

选项

  • false

  • true

walled_garden_ranges

列表 / 元素=字符串

围墙花园范围列表。

wpa_encryption_mode

字符串

WPA 规范内的加密模式。

选项

  • "WPA1 和 WPA2"

  • "仅 WPA2"

  • "WPA3 过渡模式"

  • "仅 WPA3"

备注

注意

  • 删除 SSID 不会删除 RADIUS 服务器。

  • 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

  • 某些选项可能仅供 Meraki 内部的开发人员使用。

  • 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

  • Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

  • 检查模式从仪表板下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- name: Enable and name SSID
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    enabled: true
    visible: true
  delegate_to: localhost

- name: Set PSK with invalid encryption mode
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    auth_mode: psk
    psk: abc1234
    encryption_mode: eap
  ignore_errors: yes
  delegate_to: localhost

- name: Configure RADIUS servers
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    auth_mode: open-with-radius
    radius_servers:
      - host: 192.0.1.200
        port: 1234
        secret: abc98765
  delegate_to: localhost

- name: Enable click-through splash page
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    splash_page: Click-through splash page
  delegate_to: localhost

返回值

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

键

描述

data

复杂

无线 SSID 列表。

已返回: 成功

auth_mode

字符串

身份验证方法。

已返回: 成功

示例: "psk"

band_selection

字符串

无线网络将广播的无线 RF 频率。

已返回: 成功

示例: "仅 5 GHz 频段"

enabled

布尔值

无线网络的启用状态。

已返回: 成功

示例: true

encryption_mode

字符串

无线流量加密方法。

已返回: 成功

示例: "wpa"

ip_assignment_mode

字符串

无线客户端 IP 分配方法。

已返回: 成功

示例: "NAT 模式"

min_bitrate

整数

无线客户端可以连接的最低比特率。

已返回: 成功

示例: 11

name

字符串

无线 SSID 的名称。

此值是广播的内容。

已返回: 成功

示例: "CorpWireless"

number

整数

SSID 的从零开始的索引号。

已返回: 成功

示例: 0

per_client_bandwidth_limit_down

整数

客户端可以使用的最大下载带宽。

已返回: 成功

示例: 0

per_client_bandwidth_limit_up

整数

客户端可以使用的最大上传带宽。

已返回: 成功

示例: 1000

psk

字符串

秘密无线密码。

已返回: 成功

示例: "SecretWiFiPass"

splash_page

字符串

用户进行身份验证时显示的欢迎页面。

已返回: 成功

示例: "点击式欢迎页面"

ssid_admin_accessible

布尔值

SSID 是否可由管理员访问。

已返回: 成功

示例: true

wpa_encryption_mode

字符串

已启用的 WPA 版本。

已返回: 成功

示例: "仅 WPA2"

状态

  • 此模块将在 3.0.0 版本中移除。[已弃用]

  • 有关更多信息，请参阅已弃用。

作者

  • Kevin Breit (@kbreit)