Try SpotterResource module for networks _wireless _ssids _splash _settings
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operation update of the resource networks _wireless _ssids _splash _settings.
Modify the splash page settings for the given SSID.
- 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: user@email.com
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!
number:
description: Number path parameter.
type: str
billing:
description: Details associated with billing splash.
suboptions:
freeAccess:
description: Details associated with a free access plan with limits.
suboptions:
durationInMinutes:
description: How long a device can use a network for free.
type: int
enabled:
description: Whether or not free access is enabled.
type: bool
type: dict
prepaidAccessFastLoginEnabled:
description: Whether or not billing uses the fast login prepaid access option.
type: bool
replyToEmailAddress:
description: The email address that receives replies from clients.
type: str
type: dict
themeId:
description: The id of the selected splash theme.
type: str
networkId:
description: NetworkId path parameter. Network ID.
type: str
splashUrl:
description: 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'.
type: str
splashLogo:
description: The logo used in the splash page.
suboptions:
extension:
description: The extension of the logo file.
type: str
image:
description: Properties for setting a new image.
suboptions:
contents:
description: The file contents (a base 64 encoded string) of your new logo.
type: str
format:
description: The format of the encoded contents. Supported formats are 'png',
'gif', and jpg'.
type: str
type: dict
md5:
description: The MD5 value of the logo file. Setting this to null will remove
the logo from the splash page.
type: str
type: dict
redirectUrl:
description: The custom redirect URL where the users will go after the splash page.
type: str
splashImage:
description: The image used in the splash page.
suboptions:
extension:
description: The extension of the image file.
type: str
image:
description: Properties for setting a new image.
suboptions:
contents:
description: The file contents (a base 64 encoded string) of your new image.
type: str
format:
description: The format of the encoded contents. Supported formats are 'png',
'gif', and jpg'.
type: str
type: dict
md5:
description: The MD5 value of the image file. Setting this to null will remove
the image from the splash page.
type: str
type: dict
useSplashUrl:
description: 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.
type: bool
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
splashTimeout:
description: Splash timeout in minutes. This will determine how often users will see
the splash page.
type: int
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
useRedirectUrl:
description: 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.
type: bool
welcomeMessage:
description: The welcome message for the users on the splash page.
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
guestSponsorship:
description: Details associated with guest sponsored splash.
suboptions:
durationInMinutes:
description: Duration in minutes of sponsored guest authorization. Must be between
1 and 60480 (6 weeks).
type: int
guestCanRequestTimeframe:
description: Whether or not guests can specify how much time they are requesting.
type: bool
type: dict
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
sentryEnrollment:
description: Systems Manager sentry enrollment splash settings.
suboptions:
enforcedSystems:
description: The system types that the Sentry enforces. Must be included in 'iOS,
'Android', 'macOS', and 'Windows'.
elements: str
type: list
strength:
description: The strength of the enforcement of selected system types. Must be
one of 'focused', 'click-through', and 'strict'.
type: str
systemsManagerNetwork:
description: Systems Manager network targeted for sentry enrollment.
suboptions:
id:
description: The network ID of the Systems Manager network.
type: str
type: dict
type: dict
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
splashPrepaidFront:
description: The prepaid front image used in the splash page.
suboptions:
extension:
description: The extension of the prepaid front image file.
type: str
image:
description: Properties for setting a new image.
suboptions:
contents:
description: The file contents (a base 64 encoded string) of your new prepaid
front.
type: str
format:
description: The format of the encoded contents. Supported formats are 'png',
'gif', and jpg'.
type: str
type: dict
md5:
description: The MD5 value of the prepaid front image file. Setting this to null
will remove the prepaid front from the splash page.
type: str
type: dict
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
allowSimultaneousLogins:
description: Whether or not to allow simultaneous logins from different devices.
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
blockAllTrafficBeforeSignOn:
description: 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.
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
controllerDisconnectionBehavior:
description: How login attempts should be handled when the controller is unreachable.
Can be either 'open', 'restricted', or 'default'.
type: str
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"allowSimultaneousLogins\": true,\n \"billing\": {\n \"freeAccess\"\
: {\n \"durationInMinutes\": 0,\n \"enabled\": true\n },\n \"\
prepaidAccessFastLoginEnabled\": true,\n \"replyToEmailAddress\": \"string\"\
\n },\n \"blockAllTrafficBeforeSignOn\": true,\n \"controllerDisconnectionBehavior\"\
: \"string\",\n \"guestSponsorship\": {\n \"durationInMinutes\": 0,\n \"\
guestCanRequestTimeframe\": true\n },\n \"redirectUrl\": \"string\",\n \"selfRegistration\"\
: {\n \"authorizationType\": \"string\",\n \"enabled\": true\n },\n \"\
sentryEnrollment\": {\n \"enforcedSystems\": [\n \"string\"\n ],\n\
\ \"strength\": \"string\",\n \"systemsManagerNetwork\": {\n \"id\"\
: \"string\"\n }\n },\n \"splashImage\": {\n \"extension\": \"string\"\
,\n \"md5\": \"string\"\n },\n \"splashLogo\": {\n \"extension\": \"string\"\
,\n \"md5\": \"string\"\n },\n \"splashPage\": \"string\",\n \"splashPrepaidFront\"\
: {\n \"extension\": \"string\",\n \"md5\": \"string\"\n },\n \"splashTimeout\"\
: 0,\n \"splashUrl\": \"string\",\n \"ssidNumber\": 0,\n \"themeId\": \"string\"\
,\n \"useRedirectUrl\": true,\n \"useSplashUrl\": true,\n \"welcomeMessage\"\
: \"string\"\n}\n"
type: dict