Captive-portal commands

Overview

The Captive Portal profile defines the web address that a user is redirected to for Captive Portal authentication. If the url is blank, a RADIUS VSA will be used.


[NOTE: ]

NOTE: There is a predefined profile called use-radius-vsa that is already configured to use the RADIUS VSA.


Two captive portal profiles are supported:

  • Predefined and read-only

    • Predefined and read-only profile name is use-radius-vsa.

  • Customized

[no] aaa authentication captive-portal profile

Syntax

[no] aaa authentication captive-portal profile <PROFILE-STR> [url <URL-STR>]

Description

Create a captive-portal profile. Profiles are used in user roles to direct the user to a designated captive portal server. When the profile includes a web address, that web address is always used to contact the server. When no web address is specified, it is obtained from the RADIUS VSA.


[NOTE: ]

NOTE: A profile does not have to be pre-existing in the switch for it to be configured to a user role.


Options

profile

Configure a captive portal profile.

<PROFILE-STR>

Configure a captive portal profile string 64 characters long.

url

Configure the captive portal server web address.

<URL-STR>

Configure the captive portal server web address string.

Usage

Switch# aaa authentication captive-portal profile <NAME>
Switch# aaa authentication captive-portal profile <NAME> url <URL>

Validation rules

Validation Error/Message/Prompt

Attempts made to remove a nonexisting profile will return an error:

Switch# no aaa authentication captive-portal profile NON_EXISTING_PROFILE
Captive portal profile NON_EXISTING_PROFILE not found.

When including the configured web address after the web address parameter:[no] aaa authentication captive-portal profile myCaptivePortalProfile url http://myCPPM.local/guest/captive_portal_login.php

Invalid input: http://blablabla.com

A profile name with invalid syntax produces an error: Switch# aaa authentication captive-portal-profile “this is an invalid name”

#aaa authentication captive-portal-profile “this is an invalid name” Invalid character ' ' in name.

When trying to modify a profile that is predefined, Switch# aaa authentication captive-portal-profile name use-radius-vsa

Captive portal profile use-radius-vsa is read only and cannot be modified

A profile name that is too long produces an error: Switch# aaa authentication captive-portal-profiletest342...;ldklsdjflkdsjflk

The name must be fewer than 64 characters.

When attempting to configure more than the number of admin configured profiles,

Switch# aaa authentication captive-portal-profile profileNumber2

No more captive portal profiles may be created.