cisco.meraki.networks_wireless_ssids_splash_settings module – Resource module for networks _wireless _ssids _splash _settings
Note
This module is part of the cisco.meraki collection (version 2.17.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.meraki.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.networks_wireless_ssids_splash_settings.
New in cisco.meraki 2.16.0
Synopsis
Manage operation update of the resource networks _wireless _ssids _splash _settings.
Modify the splash page settings for the given SSID.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Whether or not to allow simultaneous logins from different devices. Choices:
|
|
Details associated with billing splash. |
|
Details associated with a free access plan with limits. |
|
How long a device can use a network for free. |
|
Whether or not free access is enabled. Choices:
|
|
Whether or not billing uses the fast login prepaid access option. Choices:
|
|
The email address that receives replies from clients. |
|
How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged. Choices:
|
|
How login attempts should be handled when the controller is unreachable. Can be either ‘open’, ‘restricted’, or ‘default’. |
|
Details associated with guest sponsored splash. |
|
Duration in minutes of sponsored guest authorization. Must be between 1 and 60480 (6 weeks). |
|
Whether or not guests can specify how much time they are requesting. Choices:
|
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices:
|
|
meraki_log_file_prefix (string), log file name appended with date and timestamp Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
meraki_output_log (boolean), create an output log file? Choices:
|
|
meraki_print_console (boolean), print logging output to console? Choices:
|
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices:
|
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices:
|
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: |
|
meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices:
|
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices:
|
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices:
|
|
NetworkId path parameter. Network ID. |
|
Number path parameter. |
|
The custom redirect URL where the users will go after the splash page. |
|
Systems Manager sentry enrollment splash settings. |
|
The system types that the Sentry enforces. Must be included in ‘iOS, ‘Android’, ‘macOS’, and ‘Windows’. |
|
The strength of the enforcement of selected system types. Must be one of ‘focused’, ‘click-through’, and ‘strict’. |
|
Systems Manager network targeted for sentry enrollment. |
|
The network ID of the Systems Manager network. |
|
The image used in the splash page. |
|
The extension of the image file. |
|
Properties for setting a new image. |
|
The file contents (a base 64 encoded string) of your new image. |
|
The format of the encoded contents. Supported formats are ‘png’, ‘gif’, and jpg’. |
|
The MD5 value of the image file. Setting this to null will remove the image from the splash page. |
|
The logo used in the splash page. |
|
The extension of the logo file. |
|
Properties for setting a new image. |
|
The file contents (a base 64 encoded string) of your new logo. |
|
The format of the encoded contents. Supported formats are ‘png’, ‘gif’, and jpg’. |
|
The MD5 value of the logo file. Setting this to null will remove the logo from the splash page. |
|
The prepaid front image used in the splash page. |
|
The extension of the prepaid front image file. |
|
Properties for setting a new image. |
|
The file contents (a base 64 encoded string) of your new prepaid front. |
|
The format of the encoded contents. Supported formats are ‘png’, ‘gif’, and jpg’. |
|
The MD5 value of the prepaid front image file. Setting this to null will remove the prepaid front from the splash page. |
|
Splash timeout in minutes. This will determine how often users will see the splash page. |
|
Optional The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see ‘useSplashUrl’. |
|
The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true. Choices:
|
|
Optional Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID’s access control settings, it may not be possible to use the custom splash URL. Choices:
|
|
The welcome message for the users on the splash page. |
Notes
Note
SDK Method used are wireless.Wireless.update_network_wireless_ssid_splash_settings,
Paths used are put /networks/{networkId}/wireless/ssids/{number}/splash/settings,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for wireless updateNetworkWirelessSsidSplashSettings
Complete reference of the updateNetworkWirelessSsidSplashSettings API.
Examples
- 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
useRedirectUrl: true
useSplashUrl: true
welcomeMessage: Welcome!
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: |