webpage

Use this command to define the appearance and flow of Web pages requesting clients encounter when accessing a controller, service platform, or access point managed captive portal. Define whether the Web pages are maintained locally or externally to the managing device as well as messages displayed requesting clients.

Configures Web pages displayed when interacting with a captive portal. There are six (6) different pages.

These Web pages, which interact with captive portal users, can be located either on the controller or an external location.

Supported on the following devices:

Syntax

webpage [external|internal]
webpage external [acknowledgment|agreement|fail|login {post}|no-service|
registration|welcome] <URL>
webpage internal [acknowledgment|agreement|fail|login|no-service|org-name|org-signature|
registration|welcome]
webpage internal [acknowledgment|agreement|fail|login|no-service|registration|welcome] 
[description|footer|header|title] <CONTENT>
webpage internal [acknowledgment|agreement|fail|login|no-service|registration|welcome] 
[body-background-color|body-font-color|org-background-color|org-font-color] <WORD>
webpage internal [acknowledgment|agreement|fail|login|no-service|registration|welcome] 
[main-logo use-as-banner|small-logo] <URL>
webpage internal registration field [age-range|city|country|custom|disclaimer|dob|
   email|gender|member|mobile|name|optout|street|via-email|via-sms|zip] type [checkbox|date|
dropdown-menu|e-address|number|radio-button|text] enable 
{label <LINE>|mandatory|title <LINE>|placeholder <LINE>}
webpage internal welcome use-external-success-url
webpage internal [org-name|org-signature] <LINE>

Parameters

webpage external [acknowledgment|agreement|fail|login {post}|no-service|
registration|welcome] <URL>

external

Indicates Web pages being served are hosted on an external (to the captive portal) server resource

acknowledgment

Indicates the page is displayed for user acknowledgment of details. Users are redirected to this page to acknowledge information provided.

agreement

Indicates the page is displayed for “Terms & Conditions”

The agreement page provides conditions that must be agreed to before captive portal access is permitted.

fail

Indicates the page is displayed for login failure

The fail page asserts authentication attempt has failed, the user is not allowed to access the Internet (using this captive portal) and must provide the correct login information again to access the Internet.

login {post}

Indicates the page is displayed for getting user credentials. This page is displayed by default.

  • post – Optional. Redirects users to post externally when they during authentication

The login page prompts the user for a username and password to access the captive portal and proceed to either the agreement page (if used) or the welcome page.

no-service

Indicates the page is displayed when certain critical services are unavailable and the user fails to access the captive portal. The no-service page asserts the captive portal service is temporarily unavailable due to technical reasons. Once the services become available, the captive portal user is automatically connected back to the services available through the captive portal. The possible scenarios are:

  • The RADIUS server (on-board or external) is not reachable and the user cannot be authenticated

  • The external captive portal server is not reachable

  • The connectivity between the adopted AP and controller is lost

  • The external DHCP server is not reachable

To provide this service, enable the following:

  • External captive portal server monitoring.

  • AAA server monitoring. This enables detection of RADIUS server failure.

  • External DHCP server monitoring.

  • AP to controller connectivity monitoring.

For more information on enabling these critical resource monitoring, see service.
registration Indicates the page is displayed when users are redirected to a Web page where they have to register in the captive portal‘s database.

Guest users are redirected to an internally (or) externally hosted registration page (registration.html) upon association to a captive portal SSID, where previously, not-registered guest users can register.

welcome

Indicates the page is displayed after a user has been successfully authenticated

The welcome page asserts a user has logged in successfully and can access the captive portal.

<URL>

Indicates the URL to the Web page displayed. Query String: URL can include query tags.

Supported Query Tags are:

'WING_TAG_CLIENT_IP' - Captive portal client IPv4 address

'WING_TAG_CLIENT_MAC' - Captive portal client MAC address

'WING_TAG_WLAN_SSID ' - Captive portal client WLAN ssid

'WING_TAG_AP_MAC' - Captive portal client AP MAC address

'WING_TAG_AP_NAME' - Captive portal client AP Name

'WING_TAG_RF_DOMAIN' - Captive portal client RF Domain

'WING_TAG_CP_SERVER' - Captive portal server address

'WING_TAG_USERNAME' - Captive portal authentication username

Example:

http://cportal.com/policy/login.html?client_ip=WING_TAG_CLIENT_IP&ap_m c=WING_TAG_AP_MAC.

Use '&' or '?' character to separate field-value pair.

Enter 'ctrl-v' followed by '?' to configure query string

 
webpage internal [acknowledgment|agreement|fail|login|no-service|registration|welcome] 
[description|footer|header|title] <CONTENT>

internal

Indicates the Web pages are hosted on an internal server resource. This is the default setting.

acknowledgment

Indicates the Web page is displayed for users to acknowledge the information provided

agreement

Indicates the page is displayed for “Terms & Conditions”

fail

Indicates the page is displayed for login failure

login

Indicates the page is displayed for entering user credentials

no-service

Indicates the page is displayed when certain critical services are unavailable and the user fails to access the captive portal. The possible scenarios are:

  • The RADIUS server (on-board or external) is not reachable and the user cannot be authenticated

  • The external captive portal server is not reachable

  • The connectivity between the adopted AP and controller is lost

  • The external DHCP server is not reachable

To provide this service, enable the following:

  • External captive portal server monitoring.

  • AAA server monitoring. This enables detection of RADIUS server failure.

  • External DHCP server monitoring.

  • AP to controller connectivity monitoring.

For more information on enabling these critical resource monitoring, see service.
registration Indicates the page is displayed when users are redirected to a Web page where they have to register in the captive portal‘s database

Guest users are redirected to an internally (or) externally hosted registration page (registration.html) upon association to a captive portal SSID, where previously, not-registered guest users can register.

welcome

 Indicates the page is displayed after a user has been successfully authenticated

description

 Indicates the content is the description portion of each of the following internal Web pages: acknowledgment, agreement, fail, login, no-service, and welcome

footer

 Indicates the content is the footer portion of each of the following internal Web pages: acknowledgment, agreement, fail, no-service, registration, and welcome page. The footer portion contains the signature of the organization that hosts the captive portal.

header

 Indicates the content is the header portion of each of the following internal Web pages: acknowledgment, agreement, fail, no-service, and welcome page. The header portion contains the heading information for each of these pages.

title

 Indicates the content is the title of each of the following internal Web pages: acknowledgment, agreement, fail, no-service, and welcome page. The title for each of these pages is configured here.

<CONTENT>

The following keyword is common to all of the above internal Web page options:

  • <CONTENT> – Specify the content displayed for each of the different components of the internal Web page. Enter up to 900 characters for the description and 256 characters each for header, footer, and title.

 
webpage internal [acknowledgment|agreement|fail|login|no-service|registration|welcome] 
[main-logo use-as-banner|small-logo] <URL>

internal

 Indicates the Web pages are hosted on an internal server resource

acknowledgment

 Indicates the Web page is displayed for users to acknowledge the information provided

agreement

 Indicates the page is displayed for “Terms & Conditions”

fail

 Indicates the page is displayed for login failure

login

 Indicates the page is displayed for user credentials

no-service

Indicates the page is displayed when certain critical services are unavailable and the user fails to access the captive portal. The possible scenarios are:

  • The RADIUS server (on-board or external) is not reachable and the user cannot be authenticated

  • The external captive portal server is not reachable

  • The connectivity between the adopted AP and controller is lost

  • The external DHCP server is not reachable

To provide this service, enable the following:

  • External captive portal server monitoring.

  • AAA server monitoring. This enables detection of RADIUS server failure.

  • External DHCP server monitoring.

  • AP to controller connectivity monitoring.

For more information on enabling these critical resource monitoring, see service.
registration Indicates the page displayed is the registration page to which users are redirected in order to register in the captive portal‘s database

Guest users are redirected to an internally (or) externally hosted registration page (registration.html) upon association to a captive portal SSID, where previously, not-registered guest users can register.

welcome

Indicates the page is displayed after a user has been successfully authenticated

main-logo use-as-banner

The following keyword is common to all of the above internal Web page options:

  • main-logo – Indicates the main logo displayed in the header of each Web page

    • use-as-banner – Uses the image, specified here, as the Web page banner, in place of the logo and organization name

small-logo

The following keyword is common to all of the above internal Web page options:

  • small-logo – Indicates the logo image displayed in the footer portion of each Web page, and constitutes the organization's signature

<URL>

 This parameter is common to the ‘main-logo‘ and ‘small-logo‘ keywords and provides the complete URL from where the main-logo and small-logo files are loaded and subsequently cached on the system.
  • <URL> – Specify the location and name of the main-logo and the small-logo image files.
 
webpage internal registration field [age-range|city|country|custom|disclaimer|
dob|email|gender|member|mobile|name|optout|street|via-email|via-sms|zip] 
type [checkbox|date|dropdown-menu|e-address|number|radio-button|text] enable 
{label <LINE>|mandatory|title <LINE>|placeholder <LINE>}

internal

 Indicates the Web pages are hosted on an internal server resource
registration Allows you to customize the user registration page. Select this option if the captive-portal‘s access-type is set to registration. Use the field and type options to define the input fields (for example, age-range, city, email, etc.) and the field type (for example, text, checkbox, dropdown-menu, radio-button, etc.)

Guest users are redirected to an internally (or) externally hosted registration page (registration.html) upon association to a captive portal SSID, where previously, not-registered guest users can register.

If the registration Web page is not customized, the built-in, default registration page is displayed to the client.
field [age-range| city|country|custom| disclaimer| dob|email|gender|member| mobile|name|optout| street|via-email|via-sms| zip] Configures the captive portal‘s registration page fields
Following are the available fields and the field type for each:
  • age-range – Creates the age-range input field (enabled by default and included in the built-in registration page)
    • dropdown-menu – Configures the age-range field as a drop-down menu
    • radio-button – Configures the age-range field as a radio button menu
  • city – Creates the postal address: city name input field (enabled by default and included in the built-in registration page)
    • text – Configures the city field as only alpha-numeric and special characters input field
  • country – Creates the postal address: country name input field (disabled by default)
    • text – Configures the country field as only alpha-numeric and special characters input field
  • custom <WORD> – Creates a customized field (as per your requirement). Use the ‘custom‘ option to create a field not included in the built-in list.
    • <WORD> – Provide a name for the field. On the registration page, the field is displayed under the name specified here.
  • disclaimer – Creates client‘s disclaimer-confirmation input field (disabled by default)
  • checkbox – Configures the disclaimer field as a check box
  • dob – Creates the client‘s date of birth (DoB) input field (disabled by default)
    • date – Configures the DoB field as only date-format input field
    • dropdown-menu – Configures the DoB field as a drop-down menu
    • text – Configures the DoB field as only alpha-numeric and special characters input field
  • email – Creates the e-mail address input field (enabled by default and included in the built-in registration page)
    • e-address – Configures the e-mail field as only e-mail address format input field
  • gender – Creates client‘s gender input field (disabled by default)
    • dropdown-menu – Configures the gender field as a drop-down menu
    • radio-button – Configures the gender field as a radio button menu
  • member – Creates client‘s loyalty or captive-portal membership card number input field (disabled by default)
    • number – Configures the member field as only-numeric characters input field
    • text – Configures the member field as only alpha-numeric and special characters input field
  • mobile – Creates the mobile number input field (enabled by default and included in the built-in registration page)
    • number – Configures the mobile field as only-numeric characters input field
    • text – Configures the mobile field as only alpha-numeric and special characters input field
  • name – Creates the client name input field (enabled by default and included in the built-in registration page)
    • text – Configures the name field as only alpha-numeric and special characters input field
  • optout – Creates an input field that enables clients to opt out from registering
    • checkbox – Configures the optout field as a check box
  • street – Creates the postal address: street name/number input field (enabled by default and included in the built-in registration page)
    • text – Configures the street field as only alpha-numeric and special characters input field
  • via-email – Creates the client‘s preferred mode of communication as e-mail input field (enabled by default and included in the built-in registration page)
    • checkbox – Configures the via-email field as a check box
  • via-sms – Creates the client‘s preferred mode of communication as SMS input field (enabled by default and included in the built-in registration page)
    • checkbox – Configures the via-sms field as a check box
  • zip – Creates the postal address: zip input field (enabled by default and included in the built-in registration page)
    • number – Configures the zip field as only-numeric characters input field
    • text – Configures the zip field as only alpha-numeric and special characters input field
type [checkbox|date| dropdown-menu|e-address|number| radio-button|text] After specifying the field, configure the field type. The options displayed depend on the field selected in the previous step. These options are: checkbox, date, dropdown-menu, e-address, number, radio-button, and text.
  • checkbox – Configures the field as a check box
  • date – Configures the field as only date-format input field
  • dropdown-menu – Configures the field as a drop-down menu
  • e-address – Configures the field as an e-mail address input field
  • number – Configures the field as only-numeric characters input field
  • radio-button – Configures the field as a radio button
  • text – Configures the field as only alpha-numeric and special characters input field

Some of the fields can have more than one field type options. For example, the field ‘zip‘ can either be a numerical field or a text. Select the one best suited for your captive-portal.
enable {label <LINE>| mandatory| title <LINE>| placeholder <LINE>} Enables the field. When enabled, the field is displayed on the registration page. After enabling the field, optionally configure the following parameters:
  • label <LINE> – Optional. Configures the field‘s label
  • mandatory – Optional. Makes the field mandatory
  • title – Optional. Configures the comma-separated list of items to include in the drop-down menu.
  • placeholder <LINE> – Optional. Configures a string, not exceeding 300 characters, that is displayed within the field. If not configured, the field remains blank.
 
webpage internal welcome use-external-success-url

internal

 Indicates the Web pages are hosted on an internal server resource

welcome

 Indicates the page is displayed after a user has been successfully authenticated
use-external-success-url When configured, redirects the user, on successful authentication, to an externally hosted success URL from the locally-hosted landing page.

Use the webpage > external > welcome > <URL> command to specify the location of the Welcome page.

 
webpage internal [org-name|org-signature] <LINE>

internal

 Indicates the Web pages are hosted on an internal server resource

org-name

 Specifies the company‘s name, included on Web pages along with the main image

org-signature

 Specifies the company‘s signature information, included in the bottom of Web pages along with a small image

<LINE>

 Specify the company‘s name or signature depending on the option selected.

Examples

nx9500-6C8809(config-captive-portal-guest)#webpage external welcome http://192.168.9.46/welcome.html
nx9500-6C8809(config-captive-portal-guest)#show context
captive-portal guest
webpage external welcome http://192.168.9.46/welcome.html
nx9500-6C8809(config-captive-portal-guest)#
nx9500-6C8809(config-captive-portal-register)#webpage internal registration field age-range type dropdown-menu enable mandatory title 10-20,20-30,30-40,50-60,60-70
nx9500-6C8809(config-captive-portal-register)#show context include-factory | include age-range
 webpage internal registration field age-range type dropdown-menu enable mandatory label "Age Range" title "10-20,20-30,30-40,50-60,60-70"
nx9500-6C8809(config-captive-portal-register)#

In the following examples, the background and font colors have been customized for the captive portal‘s login page. Similar customizations can be applied to the acknowledgement, agreement, fail, welcome, no-service, and registration captive portal pages.

nx9500-6C88099(config-captive-portal-cap-enhanced-policy)#webpage internal login 
body-background-color #E7F0EB
nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#webpage internal login 
body-font-color #EF68A7
nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#webpage internal login 
org-background-color #EFE4E9
nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#webpage internal login 
org-font-color #BA4A21
nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#show context
captive-portal cap-enhanced-policy
 webpage internal login org-background-color #EFE4E9
 webpage internal login org-font-color #BA4A21
 webpage internal login body-background-color #E7F0EB
 webpage internal login body-font-color #EF68A7
nx9500-6C8809(config-captive-portal-ca-enhanced-policy)#

The following examples configure a scenario where a successfully authenticated user is redirected to an externally hosted Welcome page from the internal landing page.

nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#webpage external welcome http://192.168.13.10/WelcomePage.html
nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#webpage internal welcome use-external-success-url
nx9500-6C8809(config-captive-portal-cap-enhanced-policy)#show context
captive-portal cap-enhanced-policy
 webpage external welcome http://192.168.13.10/WelcomePage.html
 webpage internal acknowledgement org-background-color #33ff88
 webpage internal acknowledgement org-font-color #bb6622
 webpage internal acknowledgement body-background-color #22aa11
 webpage internal acknowledgement body-font-color #bb6622
 webpage internal welcome use-external-success-url
nx9500-6C8809(config-captive-portal-ca-enhanced-policy)#

Related Commands

no

Resets or disables captive portal configurations
9037762-04 Rev AB