You are here: Home > CLI Commands > Just_CLI_Topics > show aaa authentication captive-portal

show aaa authentication captive-portal

show aaa authentication captive-portal [<profile-name>]

Description

This command shows configuration information for captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. authentication profiles.

Syntax

Parameter

Description

<profile-name>

The name of an existing captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. authentication profile.

Usage Guidelines

Issue this command without the <profile-name> parameter to display the entire Captive PortalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. Authentication profile list, including profile status and the number of references to each profile. Include a profile name to display detailed configuration information for that profile.

If you do not yet have any captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. authentication profiles defined, use the command aaa authentication captive-portal to configure your captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. profiles.

Examples

This first example shows that there are three configured captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. profiles in the Captive Profile Authentication Profile List. The References column lists the number of other profiles with references to a captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. authentication profile, and the Profile Status column indicates whether the profile is predefined. User-defined profiles will not have an entry in the Profile Status column.

 

(host) #show aaa authentication captive-portal

 

Captive Portal Authentication Profile List

------------------------------------------

Name References Profile Status

---- ---------- --------------

c-portal 2

remoteuser 1

portal1 1

 

Total: 4

Include a captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. profile name to display a complete list of configuration settings for that profile. The example below shows settings for the captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. profile portal1.

 

Captive Portal Authentication Profile "portal1"

------------------------------------------------

Parameter Value

--------- -----

Default Role guest

Default Guest Role guest

Server Group default

Redirect Pause 10 sec

User Login Enabled

Guest Login Disabled

Logout popup window Enabled

Use HTTP for authentication Disabled

Logon wait minimum wait 5 sec

Logon wait maximum wait 10 sec

logon wait CPU utilization threshold 60 %

Max Authentication failures 0

Show FQDN Disabled

Authentication Protocol PAP

Login page /auth/index.

Welcome page /auth/welcom

Show Welcome Page Yes

Add switch IP address in the redirection URL Disabled

Adding user vlan in redirection URL Disabled

Add a controller interface in the redirection URL N/A

Allow only one active user session Disabled

White List N/A

Black List N/A

Show the acceptable use policy page Disabled

User idle timeout N/A

Redirect URL N/A

Bypass Apple Captive Network Assistant Disabled

URL Hash Key ********

The output of this command includes the following parameters:

Parameter

Description

Default Role

Role assigned to the captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. user upon login.

Default Guest Role

Guest role assigned to the captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. user upon login.

Server Group

Name of the group of servers used to authenticate captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. users.

Redirect Pause

Time, in seconds, that the system remains in the initial welcome page before redirecting the user to the final web URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet.. If set to 0, the welcome page displays until the user clicks on the indicated link.

User Login

Shows whether the profile has enabled or disabled captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. with authentication of user credentials.

Guest Login

Shows whether the profile has enabled or disabled captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. guest login without authentication.

Logout popup window

Shows whether the profile has enabled or disabled a pop-up window that allows a user to log out. If this is disabled, the user remains logged in until the user timeout period has

elapsed or the station resets.

Use HTTP for authentication

Shows whether the profile has enabled or disabled the ability to use the HTTPHypertext Transfer Protocol. The HTTP is an application protocol to transfer data over the web. The HTTP protocol defines how messages are formatted and transmitted, and the actions that the w servers and browsers should take in response to various commands. protocol to redirect users to the captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. page.

Logon wait minimum wait

Minimum time, in seconds, the user will have to wait for the logon page to pop up if the CPUCentral Processing Unit. A CPU is an electronic circuitry in a computer for processing instructions. load is high.

Logon wait maximum wait

Maximum time, in seconds, the user will have to wait for the logon page to pop up if the CPUCentral Processing Unit. A CPU is an electronic circuitry in a computer for processing instructions. load is high.

logon wait CPU utilization threshold

CPUCentral Processing Unit. A CPU is an electronic circuitry in a computer for processing instructions. utilization percentage above which the logon wait interval is applied when directing a captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. user with the logon page.

Max Authentication failures

Maximum number of authentication failures before the user is blacklisted.

Show FQDN

If enabled, the user can see and select the fully-qualified domain name (FQDNFully Qualified Domain Name. FQDN is a complete domain name that identifies a computer or host on the Internet.) on the captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. login page.

Authentication Protocol This parameter specifies the type of authentication required by this profile, PAPPassword Authentication Protocol. PAP validates users by password. PAP does not encrypt passwords for transmission and is thus considered insecure. is the default authentication type

Login page

URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. of the page that appears for the user logon.

Welcome page

URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. of the page that appears after logon and before the user is redirected to the web URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet..

Add controller IP address in the redirection URL

If enabled, this option sends he controller’s IP address in the redirection URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. when external captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. servers are used. An external captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. server can determine the controller from which a request originated by parsing the ‘switchip’ variable in the URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet..

Adding user vlan in redirection URL

Shows the user’s VLANVirtual Local Area Network. In computer networking, a single Layer 2 network may be partitioned to create multiple distinct broadcast domains, which are mutually isolated so that packets can only pass between them through one or more routers; such a domain is referred to as a Virtual Local Area Network, Virtual LAN, or VLAN. ID sent in the redirection URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet., if enabled

Add a controller interface in the redirection URL

Shows the IP address of a controller interface added to the redirection URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet., if enabled.

Allow only one active user session

If enabled, only one active user session is allowed at any time. This feature is disabled by default.

White List

Shows the configured white list on an IPv4 or IPv6 network destination. The white list contains authenticated websites that a guest can access.

Black List

Shows the configured black list on an IPv4 or IPv6 network destination. The black list contains websites (unauthenticated) that a guest cannot access.

Show the acceptable use policy page

If enabled, the captive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users. page will show the acceptable use policy page before the user logon page. This feature is disabled by default.

User Idle Timeout

The user idle timeout for this profile. The valid range is 30-15300 in multiples of 30 seconds. Enabling this option overrides the global settings configured in the AAAAuthentication, Authorization, and Accounting. AAA is a security framework to authenticate users, authorize the type of access based on user credentials, and record authentication events and information about the network access and network resource consumption. timers. If this is disabled, the global settings are used.

redirect-urlUniform Resource Locator. URL is a global address used for locating web resources on the Internet. <url>Uniform Resource Locator. URL is a global address used for locating web resources on the Internet.

URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. to which an authenticated user will be directed.

URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. hash key

If this value is set, the redirection URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet. is hashed using the defined hash key. The characters in the hash key are hidden in the output of this command

Related Commands

Command

Description

aaa authentication captive-portal

This command is used to configure the parameters displayed in the output of this show command.

Command History

Version

Modification

ArubaOS 8.0.0.0

Command introduced.

Command Information

Platforms

Licensing

Command Mode

All platforms

Base operating system.

Enable mode on Mobility Master.

/*]]>*/