cisco.meraki.networks_wireless_ssids_hotspot20 模块 – 用于 networks _wireless _ssids _hotspot20 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.networks_wireless_ssids_hotspot20。
cisco.meraki 2.16.0 中的新功能
概要
管理资源 networks _wireless _ssids _hotspot20 的操作更新。
更新 SSID 的 Hotspot 2.0 设置。
注意
此模块具有相应的 操作插件。
要求
在执行此模块的主机上需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
域名数组。 |
|
是否为此 SSID 启用 Hotspot 2.0。 选择
|
|
MCC/MNC 对数组。 |
|
MCC 值。 |
|
MNC 值。 |
|
meraki_action_batch_retry_wait_time (整数), 操作批处理并发错误重试等待时间 默认: |
|
meraki_api_key (字符串)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串)，在所有端点资源之前 默认: |
|
meraki_be_geo_id (字符串)，用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认: |
|
meraki_caller (字符串)，用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认: |
|
meraki_certificate_path (字符串)，如果在本地代理之后，则用于 TLS/SSL 证书验证的路径 默认: |
|
meraki_inherit_logging_config (布尔值)，继承您自己的记录器实例 选择
|
|
meraki_log_file_prefix (字符串)，附加日期和时间戳的日志文件名 默认: |
|
log_path (字符串)，输出日志的路径；如果未指定，则默认为脚本的工作目录 默认: |
|
meraki_maximum_retries (整数)，遇到 429 或其他服务器端错误时最多重试此多次 默认: |
|
meraki_nginx_429_retry_wait_time (整数)，Nginx 429 重试等待时间 默认: |
|
meraki_output_log (布尔值)，创建输出日志文件？ 选择
|
|
meraki_print_console (布尔值)，将日志输出打印到控制台？ 选择
|
|
meraki_requests_proxy (字符串)，如果需要，则用于 HTTPS 的代理服务器和端口 默认: |
|
meraki_retry_4xx_error (布尔值)，如果遇到其他 4XX 错误（除了 429）是否重试？ 选择
|
|
meraki_retry_4xx_error_wait_time (整数)，其他 4XX 错误重试等待时间 默认: |
|
meraki_simulate (布尔值)，模拟 POST/PUT/DELETE 调用以防止更改？ 选择
|
|
meraki_single_request_timeout (整数)，每个 API 调用的最大秒数 默认: |
|
meraki_suppress_logging (布尔值)，禁用所有日志记录？那时您就靠自己了！ 选择
|
|
meraki_use_iterator_for_get_pages (布尔值)，list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选择
|
|
meraki_wait_on_rate_limit (布尔值)，如果遇到 429 速率限制错误是否重试？ 选择
|
|
NAI 领域数组。 |
|
域的格式（“1”或“0”）。 |
|
域的 EAP 方法数组。 |
|
该方法的身份验证类型。这些应格式化为一个对象，其中驼峰式 EAP 方法类别作为键，类型列表作为值（nonEapInnerAuthentication 保留、PAP、CHAP、MSCHAP、MSCHAPV2；eapInnerAuthentication EAP-TLS、EAP-SIM、EAP-AKA、使用 MSCHAPv2 的 EAP-TTLS；凭据 SIM、USIM、NFC 安全元件、硬件令牌、软令牌、证书、用户名/密码、无、保留、供应商特定；tunneledEapMethodCredentials SIM、USIM、NFC 安全元件、硬件令牌、软令牌、证书、用户名/密码、保留、匿名、供应商特定）。 |
|
方法 ID。 |
|
领域的名称。 |
|
此 SSID 的网络类型（“私有网络”、“具有访客访问权限的私有网络”、“收费公共网络”、“免费公共网络”、“个人设备网络”、“仅限紧急服务网络”、“测试或实验”、“通配符”）。 |
|
NetworkId 路径参数。网络 ID。 |
|
Number 路径参数。 |
|
此 SSID 的运营商设置。 |
|
运营商名称。 |
|
漫游联盟 OIs 数组（十六进制数，长度为 3-5 个八位字节）。 |
|
此 SSID 的场所设置。 |
|
场所名称。 |
|
场所类型（“未指定”、“未指定集会”、“竞技场”、“体育场”、“客运站”、“圆形剧场”、“游乐园”、“礼拜场所”、“会议中心”、“图书馆”、“博物馆”、“餐厅”、“剧院”、“酒吧”、“咖啡店”、“动物园或水族馆”、“紧急协调中心”、“未指定商业”、“医生或牙医办公室”、“银行”、“消防站”、“警察局”、“邮局”、“专业办公室”、“研发机构”、“律师事务所”、“未指定教育机构”、“小学”、“中学”、“大学或学院”、“未指定工厂和工业”、“工厂”、“未指定机构”、“医院”、“长期护理机构”、“酒精和药物康复中心”、“集体住宅”、“监狱或看守所”、“未指定商业”、“零售店”、“杂货市场”、“汽车服务站”、“购物中心”、“加油站”、“未指定住宅”、“私人住宅”、“酒店或汽车旅馆”、“宿舍”、“寄宿公寓”、“未指定存储”、“未指定公共设施和杂项”、“未指定车辆”、“汽车或卡车”、“飞机”、“公共汽车”、“渡轮”、“轮船或船只”、“火车”、“摩托车”、“未指定户外”、“市政网状网络”、“城市公园”、“休息区”、“交通控制”、“公共汽车站”、“信息亭”）。 |
备注
注意
使用的 SDK 方法为 wireless.Wireless.update_network_wireless_ssid_hotspot20，
使用的路径为 put /networks/{networkId}/wireless/ssids/{number}/hotspot20，
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 关于 wireless updateNetworkWirelessSsidHotspot20 的文档
updateNetworkWirelessSsidHotspot20 API 的完整参考。
示例
- name: Update all
cisco.meraki.networks_wireless_ssids_hotspot20:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
domains:
- meraki.local
- domain2.com
enabled: true
mccMncs:
- mcc: '123'
mnc: '456'
- mcc: '563'
mnc: '232'
naiRealms:
- format: '1'
methods:
- authenticationTypes:
credentials: []
eapInnerAuthentication:
- EAP-TTLS with MSCHAPv2
nonEapInnerAuthentication:
- MSCHAP
tunneledEapMethodCredentials: []
id: '1'
name: Realm 1
networkAccessType: Private network
networkId: string
number: string
operator:
name: Meraki Product Management
roamConsortOis:
- ABC123
- 456EFG
venue:
name: SF Branch
type: Unspecified Assembly
返回值
常见的返回值记录在这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回：始终 示例： |