captive-portal

Displays WLAN captive portal information. Use this command to view a configured captive portal‘s client information.

Supported in the following platforms:

Syntax

show captive-portal sessions {include-ipv6|on <DEVICE-OR-DOMAIN-NAME>|statistics} 
{(filter [captive-portal [<CAPTIVE-PORTAL>|not <CAPTIVE-PORTAL>]|ip [<IPv4>|not <IPv4>]|
ipv6 [<IPv6>|not <IPv6>]|state [pending|success|not [pending|success]|vlan [<VLAN-ID>|
not <VLAN-ID>]|wlan [<WLAN-NAME>|not <WLAN-NAME>]])}

Parameters

show captive-portal sessions {include-ipv6|on <DEVICE-OR-DOMAIN-NAME>|statistics} 
{(filter [captive-portal [<CAPTIVE-PORTAL>|not <CAPTIVE-PORTAL>]|ip [<IPv4>|not <IPv4>]|
ipv6 [<IPv6>|not <IPv6>]|state [pending|success|not [pending|success]|vlan [<VLAN-ID>|
not <VLAN-ID>]|wlan [<WLAN-NAME>|not <WLAN-NAME>]])}
captive-portal sessions Displays active captive portal client session details
include-ipv6 Optional. Includes IPv6 address (if known) of captive portal clients. By default the system only displays IPv4 addresses. The include-ipv6 parameter includes IPv6 address (if known) of each client.
statistics Optional. Displays statistical information regarding client sessions
on <DEVICE-OR-DOMAIN-NAME> Optional. Displays active captive portal session details on a specified device or RF Domain.
  • <DEVICE-OR-DOMAIN-NAME> – Specify the name of the AP, wireless controller, service platform, or RF Domain.
filter This parameter is recursive and can be used with any of the above parameters to define additional filters.

Optional. Defines additional filters. Use one of the following options: captive-portal, ip, ipv6, state, vlan, or wlan.
captive-portal [<CAPTIVE-PORTAL>| not <CAPTIVE-PORTAL>] Optional. Displays captive portal client and client session information, based on the captive portal name passed
  • <CAPTIVE-PORTAL> – Specify the captive portal name. Displays client details for the specified captive portal.
  • not <CAPTIVE-PORTAL> – Inverts the match selection. Displays client details for all captive portals other than the specified captive portal.
ip [<IPv4>|not <IPv4>] Optional. Displays captive portal client/client sessions information, based on the IPv4 address passed
  • <IPv4> – Specify the client‘s IPv4 address. Displays information of the client identified by the <IPv4> parameter.
  • not <IPv4> – Inverts the match selection. Displays client details for all clients other than the one identified by the <IPv4> parameter.
ipv6 [<IPv6>|not <IPv6>] This filter option is available only for the ‘include-ipv6‘ keyword.
Optional. Displays captive portal client/client sessions information, based on the IPv6 address passed
  • <IPv6> – Specify the client‘s IPv6 address. Displays information of the client identified by the <IPv6> parameter
  • not <IPv6> – Inverts the match selection. Displays client details for all clients other than the one identified by the <IPv6> parameter.
state [pending|success| not [pending|success]] Optional. Filters clients/client sessions based on the client‘s authentication state
  • pending – Displays information of clients redirected for authentication
  • success – Displays information of successfully authenticated clients
  • not [pending|success] – Inverts match selection
    • pending – Displays information of successfully authenticated clients (opposite of pending authentication)
    • success – Displays information of clients redirected for authentication (opposite of successful authentication)
vlan [<VLAN-ID>| not <VLAN-ID>] Optional. Displays captive portal client/client sessions information based on the VLAN ID passed
  • <VLAN-ID> – Specify the VLAN ID. Displays client details for the specified VLAN.
  • not <VLAN-ID> – Inverts match selection. Displays client details for all VLANs other than the one identified by the <VLAN-ID> parameter.
wlan [<WLAN-NAME>| not <WLAN-NAME>] Optional. Displays captive portal client/client sessions information based on the WLAN name passed
  • <WLAN-NAME> – Specify the WLAN name. Displays client details for the specified WLAN.
  • not <WLAN-NAME> – Inverts match selection. Displays client details for all WLANs other than the one identified by the <WLAN-NAME> parameter.

Examples

nx9500-6C8809#show captive-portal sessions
=======================================================================================
CLIENT               IPv4     CAPTIVE-PORTAL   WLAN/PORT    VLAN  STATE SESSION  TIME
---------------------------------------------------------------------------------------
00-26-55-F4-5F-79  192.168.3.99 cappo     nx9500-6C8809:ge2    400     Success     23:58:35
=======================================================================================
Total number of captive portal sessions displayed: 1
nx9500-6C8809#
9036514-01 Rev AA