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.2).

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

allowSimultaneousLogins

boolean

Whether or not to allow simultaneous logins from different devices.

Choices:

  • false

  • true

billing

dictionary

Details associated with billing splash.

freeAccess

dictionary

Details associated with a free access plan with limits.

durationInMinutes

integer

How long a device can use a network for free.

enabled

boolean

Whether or not free access is enabled.

Choices:

  • false

  • true

prepaidAccessFastLoginEnabled

boolean

Whether or not billing uses the fast login prepaid access option.

Choices:

  • false

  • true

replyToEmailAddress

string

The email address that receives replies from clients.

blockAllTrafficBeforeSignOn

boolean

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:

  • false

  • true

controllerDisconnectionBehavior

string

How login attempts should be handled when the controller is unreachable. Can be either ‘open’, ‘restricted’, or ‘default’.

guestSponsorship

dictionary

Details associated with guest sponsored splash.

durationInMinutes

integer

Duration in minutes of sponsored guest authorization. Must be between 1 and 60480 (6 weeks).

guestCanRequestTimeframe

boolean

Whether or not guests can specify how much time they are requesting.

Choices:

  • false

  • true

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time

Default: 60

meraki_api_key

string / required

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

meraki_base_url (string), preceding all endpoint resources

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

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

meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), Inherits your own logger instance

Choices:

  • false ← (default)

  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), log file name appended with date and timestamp

Default: "meraki_api_"

meraki_log_path

string

log_path (string), path to output log; by default, working directory of script if not specified

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), create an output log file?

Choices:

  • false

  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), print logging output to console?

Choices:

  • false

  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)?

Choices:

  • false ← (default)

  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?

Choices:

  • false ← (default)

  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), maximum number of seconds for each API call

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), disable all logging? you’re on your own then!

Choices:

  • false ← (default)

  • true

meraki_use_iterator_for_get_pages

boolean

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:

  • false ← (default)

  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?

Choices:

  • false

  • true ← (default)

networkId

string

NetworkId path parameter. Network ID.

number

string

Number path parameter.

redirectUrl

string

The custom redirect URL where the users will go after the splash page.

sentryEnrollment

dictionary

Systems Manager sentry enrollment splash settings.

enforcedSystems

list / elements=string

The system types that the Sentry enforces. Must be included in ‘iOS, ‘Android’, ‘macOS’, and ‘Windows’.

strength

string

The strength of the enforcement of selected system types. Must be one of ‘focused’, ‘click-through’, and ‘strict’.

systemsManagerNetwork

dictionary

Systems Manager network targeted for sentry enrollment.

id

string

The network ID of the Systems Manager network.

splashImage

dictionary

The image used in the splash page.

extension

string

The extension of the image file.

image

dictionary

Properties for setting a new image.

contents

string

The file contents (a base 64 encoded string) of your new image.

format

string

The format of the encoded contents. Supported formats are ‘png’, ‘gif’, and jpg’.

md5

string

The MD5 value of the image file. Setting this to null will remove the image from the splash page.

dictionary

The logo used in the splash page.

extension

string

The extension of the logo file.

image

dictionary

Properties for setting a new image.

contents

string

The file contents (a base 64 encoded string) of your new logo.

format

string

The format of the encoded contents. Supported formats are ‘png’, ‘gif’, and jpg’.

md5

string

The MD5 value of the logo file. Setting this to null will remove the logo from the splash page.

splashPrepaidFront

dictionary

The prepaid front image used in the splash page.

extension

string

The extension of the prepaid front image file.

image

dictionary

Properties for setting a new image.

contents

string

The file contents (a base 64 encoded string) of your new prepaid front.

format

string

The format of the encoded contents. Supported formats are ‘png’, ‘gif’, and jpg’.

md5

string

The MD5 value of the prepaid front image file. Setting this to null will remove the prepaid front from the splash page.

splashTimeout

integer

Splash timeout in minutes. This will determine how often users will see the splash page.

splashUrl

string

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’.

useRedirectUrl

boolean

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:

  • false

  • true

useSplashUrl

boolean

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:

  • false

  • true

welcomeMessage

string

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_mode

  • The 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

meraki_response

dictionary

A dictionary or list with the response returned by the Cisco Meraki Python SDK

Returned: always

Sample: {"allowSimultaneousLogins": true, "billing": {"freeAccess": {"durationInMinutes": 0, "enabled": true}, "prepaidAccessFastLoginEnabled": true, "replyToEmailAddress": "string"}, "blockAllTrafficBeforeSignOn": true, "controllerDisconnectionBehavior": "string", "guestSponsorship": {"durationInMinutes": 0, "guestCanRequestTimeframe": true}, "redirectUrl": "string", "selfRegistration": {"authorizationType": "string", "enabled": true}, "sentryEnrollment": {"enforcedSystems": ["string"], "strength": "string", "systemsManagerNetwork": {"id": "string"}}, "splashImage": {"extension": "string", "md5": "string"}, "splashLogo": {"extension": "string", "md5": "string"}, "splashPage": "string", "splashPrepaidFront": {"extension": "string", "md5": "string"}, "splashTimeout": 0, "splashUrl": "string", "ssidNumber": 0, "useRedirectUrl": true, "useSplashUrl": true, "welcomeMessage": "string"}

Authors

  • Francisco Munoz (@fmunoz)