cisco.meraki.networks_wireless_ssids_splash_settings 模块 – 用于 networks _wireless _ssids _splash _settings 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.networks_wireless_ssids_splash_settings。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 networks _wireless _ssids _splash _settings 的操作更新。
修改给定 SSID 的欢迎页面设置。
注意
此模块具有相应的 操作插件。
要求
以下要求需要在执行此模块的主机上满足。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
是否允许来自不同设备的并发登录。 选择
|
|
与计费欢迎页面相关的详细信息。 |
|
与有限制的免费访问计划相关的详细信息。 |
|
设备可以免费使用网络的时长（分钟）。 |
|
是否启用免费访问。 选择
|
|
计费是否使用快速登录预付访问选项。 选择
|
|
接收来自客户端的回复的电子邮件地址。 |
|
允许流量的限制程度。如果为 true，则在确认欢迎页面之前阻止所有流量类型。如果为 false，则在确认欢迎页面之前允许所有非 HTTP 流量。 选择
|
|
当控制器无法访问时应如何处理登录尝试。可以是 “open”、“restricted” 或 “default”。 |
|
与访客赞助欢迎页面相关的详细信息。 |
|
赞助访客授权的持续时间（分钟）。必须在 1 到 60480（6 周）之间。 |
|
访客是否可以指定他们请求的时间量。 选择
|
|
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 速率限制错误是否重试？ 选择
|
|
NetworkId 路径参数。网络 ID。 |
|
Number 路径参数。 |
|
用户在闪屏页面之后将跳转到的自定义重定向 URL。 |
|
Systems Manager Sentry 注册闪屏设置。 |
|
Sentry 强制执行的系统类型。必须包含在“iOS”、“Android”、“macOS”和“Windows”中。 |
|
所选系统类型的强制执行强度。必须是“focused”、“click-through”和“strict”之一。 |
|
Sentry 注册的目标 Systems Manager 网络。 |
|
Systems Manager 网络的网络 ID。 |
|
闪屏页面中使用的图像。 |
|
图像文件的扩展名。 |
|
用于设置新图像的属性。 |
|
新图像的文件内容（Base64 编码的字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
图像文件的 MD5 值。将其设置为 null 将从闪屏页面中删除图像。 |
|
闪屏页面中使用的徽标。 |
|
徽标文件的扩展名。 |
|
用于设置新图像的属性。 |
|
新徽标的文件内容（Base64 编码的字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
徽标文件的 MD5 值。将其设置为 null 将从闪屏页面中删除徽标。 |
|
闪屏页面中使用的预付费正面图像。 |
|
预付费正面图像文件的扩展名。 |
|
用于设置新图像的属性。 |
|
新预付费正面的文件内容（Base64 编码的字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
预付费正面图像文件的 MD5 值。将其设置为 null 将从闪屏页面中删除预付费正面。 |
|
闪屏超时时间（分钟）。这将确定用户看到闪屏页面的频率。 |
|
可选的点击式闪屏页面的自定义闪屏 URL。请注意，URL 可以配置，但不一定要使用。要启用自定义 URL，请参阅“useSplashUrl”。 |
|
所选闪屏主题的 ID。 |
|
布尔值，指示用户是否会在闪屏页面后被重定向到自定义重定向 URL。如果为 true，则必须设置自定义重定向 URL。 选择
|
|
可选的布尔值，指示用户是否会被重定向到自定义闪屏 URL。如果为 true，则必须设置自定义闪屏 URL。请注意，根据您的 SSID 的访问控制设置，可能无法使用自定义闪屏 URL。 选择
|
|
闪屏页面上用户的欢迎消息。 |
注释
注意
使用的 SDK 方法是 wireless.Wireless.update_network_wireless_ssid_splash_settings，
使用的路径是 put /networks/{networkId}/wireless/ssids/{number}/splash/settings，
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关 wireless updateNetworkWirelessSsidSplashSettings 的 Cisco Meraki 文档
updateNetworkWirelessSsidSplashSettings API 的完整参考。
示例
- name: Update all
cisco.meraki.networks_wireless_ssids_splash_settings:
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
allowSimultaneousLogins: false
billing:
freeAccess:
durationInMinutes: 120
enabled: true
prepaidAccessFastLoginEnabled: true
replyToEmailAddress: [email protected]
blockAllTrafficBeforeSignOn: false
controllerDisconnectionBehavior: default
guestSponsorship:
durationInMinutes: 30
guestCanRequestTimeframe: false
networkId: string
number: string
redirectUrl: https://example.com
sentryEnrollment:
enforcedSystems:
- iOS
strength: focused
systemsManagerNetwork:
id: N_1234
splashImage:
extension: jpg
image:
contents: Q2lzY28gTWVyYWtp
format: jpg
md5: 542cccac8d7dedee0f185311d154d194
splashLogo:
extension: jpg
image:
contents: Q2lzY28gTWVyYWtp
format: jpg
md5: abcd1234
splashPrepaidFront:
extension: jpg
image:
contents: Q2lzY28gTWVyYWtp
format: jpg
md5: 542cccac8d7dedee0f185311d154d194
splashTimeout: 1440
splashUrl: https://www.custom_splash_url.com
themeId: c3ddcb4f16785ee747ab5ffc10867d6c8ea704be
useRedirectUrl: true
useSplashUrl: true
welcomeMessage: Welcome!
返回值
常见的返回值记录在此处 这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco Meraki Python SDK 返回的响应 返回: 总是 示例: |