set hotspot

Description

Configures hotspot settings.

Syntax

set hotspot [ require-auth <require-auth> ] [ auth-mode <auth-mode> ] [ allowed-group <allowed-group> ] [ timeout <timeout> ] [ portal-title <portal-title> ] [ portal-msg <portal-msg> ] [ show-terms-of-use <show-terms-of-use> ] [ terms-of-use <terms-of-use> ] [ redirect-after-auth <redirect-after-auth> ] [ redirect-after-auth-url <redirect-after-auth-url> ]

Parameters

Parameter

Description

allowed-group

Indicates the specific user group that can authenticate through the hotspot when auth-mode is set to allow-specific-group

A string of alphanumeric characters without space between them:

  • a-z (lower-case letters)

  • A-Z (upper-case letters)

  • 0-9 (digits)

auth-mode

Allow access to a specific user group only or all users

Options: allow-all, allow-specific-group

portal-msg

The message shown in hotspot portal

A string that contains only printable characters.

portal-title

The title of the hotspot portal

A string that contains only printable characters.

redirect-after-auth

Indicates if after the user accepts terms or authenticate in the hotspot portal the user will be redirected to a configured external URL instead of the originally requested URL

Options: on, off

redirect-after-auth-url

Redirect the user to the following URL after the user accepts terms or authenticate in the hotspot portal

Type: urlWithHttp

require-auth

Indicates if user authentication is required

Type: Boolean (true/false)

show-terms-of-use

Indicates if a terms and conditions link will be shown in the hotspot portal

Options: on, off

terms-of-use

Indicates the When users will click the terms and conditions text shown in the hotspot portal

A string that contains only printable characters.

timeout

Time, in minutes, untill the hotspot session expires

A number with no fractional part (integer)

Example

set hotspot require-auth true auth-mode allow-all allowed-group MyUserGroup timeout 15 portal-title My Network portal-msg My Network show-terms-of-use on terms-of-use My Network redirect-after-auth on redirect-after-auth-url urlWithHttp