cisco.meraki.networks_wireless_ssids_splash_settings 模块 – 网络无线SSID登录页面设置资源模块
注意
此模块是 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的登录页面设置。
注意
此模块具有相应的 action 插件。
需求
以下需求是在执行此模块的主机上需要的。
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。 |
|
启动页中使用的图像。 |
|
图像文件的扩展名。 |
|
设置新图像的属性。 |
|
新图像的文件内容（base 64编码字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
图像文件的MD5值。将其设置为null将从启动页中删除图像。 |
|
启动页中使用的徽标。 |
|
徽标文件的扩展名。 |
|
设置新图像的属性。 |
|
新徽标的文件内容（base 64编码字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
徽标文件的MD5值。将其设置为null将从启动页中删除徽标。 |
|
启动页中使用的预付费正面图像。 |
|
预付费正面图像文件的扩展名。 |
|
设置新图像的属性。 |
|
新预付费正面的文件内容（base 64编码字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
预付费正面图像文件的MD5值。将其设置为null将从启动页中删除预付费正面。 |
|
启动页超时时间（分钟）。这将决定用户多久看到一次启动页。 |
|
可选 点击式启动页的自定义启动页URL。请注意，可以配置URL而无需 necessarily 使用它。要启用自定义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用于建立连接。
另请参见
另请参见
- 无线更新NetworkWirelessSsidSplashSettings的思科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返回的响应的字典或列表。 返回：始终 示例： |