Class SsidSplashSettings

Namespace

Meraki.Api.Data

Assembly

Meraki.Api.dll

Splash page settings

[DataContract]
public class SsidSplashSettings

Inheritance

object

SsidSplashSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowSimultaneousLogins

Whether or not to allow simultaneous logins from different devices.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "allowSimultaneousLogins")]
public bool? AllowSimultaneousLogins { get; set; }

Property Value

bool?

Billing

Details associated with billing splash.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "billing")]
public Billing? Billing { get; set; }

Property Value

Billing

BlockAllTrafficBeforeSignOn

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

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "blockAllTrafficBeforeSignOn")]
public bool? BlockAllTrafficBeforeSignOn { get; set; }

Property Value

bool?

ControllerDisconnectBehavior

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

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "controllerDisconnectionBehavior")]
public string? ControllerDisconnectBehavior { get; set; }

Property Value

string

GuestSponsorship

Details associated with guest sponsored splash.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "guestSponsorship")]
public GuestSponsorship? GuestSponsorship { get; set; }

Property Value

GuestSponsorship

RedirectUrl

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

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "redirectUrl")]
public string? RedirectUrl { get; set; }

Property Value

string

SelfRegistration

Self registration settings

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "selfRegistration")]
public SelfRegistration? SelfRegistration { get; set; }

Property Value

SelfRegistration

SplashImage

The image used in the splash page.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashImage")]
public SplashImage? SplashImage { get; set; }

Property Value

SplashImage

SplashLogo

The logo used in the splash page.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashLogo")]
public SplashImage? SplashLogo { get; set; }

Property Value

SplashImage

SplashMethod

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "splashMethod")]
public string? SplashMethod { get; set; }

Property Value

string

SplashPage

Description of the type of splash page.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "splashPage")]
public string? SplashPage { get; set; }

Property Value

string

SplashPrepaidFront

The prepaid front image used in the splash page.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashPrepaidFront")]
public SplashImage? SplashPrepaidFront { get; set; }

Property Value

SplashImage

SplashTimeout

Splash timeout in minutes. This will determine how often users will see the splash page. Permitted values = [30, 60, 120, 240, 480, 720, 1080, 1440, 2880, 5760, 7200, 10080, 20160, 43200, 86400, 129600]

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashTimeout")]
public int? SplashTimeout { get; set; }

Property Value

int?

SplashUrl

[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'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashUrl")]
public string? SplashUrl { get; set; }

Property Value

string

SsidNumber

Ssid Number.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "ssidNumber")]
public int? SsidNumber { get; set; }

Property Value

int?

ThemeId

Theme ID

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "themeId")]
public string? ThemeId { get; set; }

Property Value

string

UseRedirectUrl

The Boolean indicating whether 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.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "useRedirectUrl")]
public bool? UseRedirectUrl { get; set; }

Property Value

bool?

UseSplashUrl

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

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "useSplashUrl")]
public bool? UseSplashUrl { get; set; }

Property Value

bool?

WelcomeMessage

The welcome message for the users on the splash page.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "welcomeMessage")]
public string? WelcomeMessage { get; set; }

Property Value

string

sentryEnrollment

Systems Manager sentry enrollment splash settings.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "sentryEnrollment")]
public SentryEnrollment? sentryEnrollment { get; set; }

Property Value

SentryEnrollment