Splash Settings

Location in Dashboard: Wireless >> Configure >> Splash page

Diagram

Classes

ssids (meraki.domains.organizations.networks.wireless)

Name	Type	Constraint	Mandatory	Default Value
splash_settings	Class	[splash_settings]	No

splash_settings (meraki.domains.organizations.networks.wireless.ssids)

Name	Type	Constraint	Mandatory	Default Value
splash_url	String	min: 1, max: 1024	No
use_splash_url	Boolean	true, false	No
splash_timeout	Integer	min: 1, max: 86400	No
redirect_url	String	min: 1, max: 1024	No
use_redirect_url	Boolean	true, false	No
welcome_message	String	min: 1, max: 4096	No
splash_logo	Class	[splash_logo]	No
splash_image	Class	[splash_image]	No
splash_prepaid_front	Class	[splash_prepaid_front]	No
block_all_traffic_before_sign_on	Boolean	true, false	No
controller_disconnection_behavior	Choice	default, open, restricted	No
allow_simultaneous_logins	Boolean	true, false	No
guest_sponsorship	Class	[guest_sponsorship]	No
billing	Class	[billing]	No
sentry_enrollment	Class	[sentry_enrollment]	No
theme_name	String	min: 1, max: 127	No

splash_logo (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Name	Type	Constraint	Mandatory	Default Value
md5	String	min: 1, max: 4096	No
extension	String	min: 1, max: 10	No
image	Class	[image]	No

splash_image (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Name	Type	Constraint	Mandatory	Default Value
md5	String	min: 1, max: 4096	No
extension	String	min: 1, max: 10	No
image	Class	[image]	No

splash_prepaid_front (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Name	Type	Constraint	Mandatory	Default Value
md5	String	min: 1, max: 4096	No
extension	String	min: 1, max: 10	No
image	Class	[image]	No

guest_sponsorship (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Name	Type	Constraint	Mandatory	Default Value
duration_in_minutes	Integer	min: 1, max: 60480	No
guest_can_request_timeframe	Boolean	true, false	No

billing (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Name	Type	Constraint	Mandatory	Default Value
free_access	Class	[free_access]	No
reply_to_email_address	String	min: 1, max: 127	No
prepaid_access_fast_login	Boolean	true, false	No

sentry_enrollment (meraki.domains.organizations.networks.wireless.ssids.splash_settings)

Name	Type	Constraint	Mandatory	Default Value
systems_manager_network	Class	[systems_manager_network]	No
strength	Choice	click-through, focused, strict	No
enforced_systems	List	Choice[iOS, Android, macOS, Windows]	No

image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_logo)

Name	Type	Constraint	Mandatory	Default Value
format	Choice	gif, jpg, png	No
contents	String	min: 1, max: 4096	No

image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_image)

Name	Type	Constraint	Mandatory	Default Value
format	Choice	gif, jpg, png	No
contents	String	min: 1, max: 4096	No

image (meraki.domains.organizations.networks.wireless.ssids.splash_settings.splash_prepaid_front)

Name	Type	Constraint	Mandatory	Default Value
format	Choice	gif, jpg, png	No
contents	String	min: 1, max: 4096	No

free_access (meraki.domains.organizations.networks.wireless.ssids.splash_settings.billing)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
duration_in_minutes	Integer	min: 1, max: 60480	No

systems_manager_network (meraki.domains.organizations.networks.wireless.ssids.splash_settings.sentry_enrollment)

Name	Type	Constraint	Mandatory	Default Value
name	String	min: 1, max: 127	Yes

Config Sample

meraki:
    domains:
      - name: EMEA
        administrator:
            name: Foo Bar
        organizations:
          - name: Dev
            networks:
              - name: Dev-main-cx-provider
                product_types:
                - appliance
                - camera
                - switch
                - wireless
                wireless:
                  ssids:
                    - name: CORP
                      ssid_number: '0'
                      splash_page: None
                      splash_settings:
                          allow_simultaneous_logins: true
                          billing:
                              free_access:
                                  duration_in_minutes: 20
                                  enabled: false
                              reply_to_email_address: digidev.gen@cisco.com
                          block_all_traffic_before_sign_on: true
                          controller_disconnection_behavior: default
                          guest_sponsorship:
                              guest_can_request_timeframe: false
                          splash_timeout: 1440
                          use_redirect_url: false
                          use_splash_url: false