captive-portal-page-upload (user and privi exec modes

Uploads captive portal advanced pages to adopted access points. Use this command to provide access points with specific captive portal configurations, so that they can successfully provision login, welcome, and condition pages to clients attempting to access the wireless network using the captive portal.
Note

Note

Ensure that the captive portal pages to upload are *.tar files.
Note

Note

This command and its syntax is common to both the User Executable and Privilege Executable configuration modes.

Supported in the following platforms:

Syntax

captive-portal-page-upload [<CAPTIVE-PORTAL-NAME>|cancel-upload|delete-file|load-file]

captive-portal-page-upload <CAPTIVE-PORTAL-NAME> [<MAC/HOSTNAME>|all|rf-domain]

captive-portal-page-upload <CAPTIVE-PORTAL-NAME> [<MAC/HOSTNAME>|all] {upload-time <TIME>}

captive-portal-page-upload <CAPTIVE-PORTAL-NAME> rf-domain [<DOMAIN-NAME>|all] 
{from-controller} {(upload-time <TIME>)}

captive-portal-page-upload cancel-upload [<MAC/HOSTNAME>|all|on rf-domain [<DOMAIN-NAME>|all]]

captive-portal-page-upload delete-file <CAPTIVE-PORTAL-NAME> <FILE-NAME>

captive-portal-page-upload load-file <CAPTIVE-PORTAL-NAME> <URL>

Parameters

captive-portal-page-upload <CAPTIVE-PORTAL-NAME> [<MAC/HOSTNAME>|all] {upload-time <TIME>}
captive-portal-page-upload <CAPTIVE-PORTAL-NAME> Uploads advanced pages of the captive portal identified by the <CAPTIVE-PORTAL-NAME> parameter
  • <CAPTIVE-PORTAL-NAME> – Specify captive portal's name (should be existing and configured).
<MAC/HOSTNAME> Uploads to a specified AP
  • <MAC/HOSTNAME> – Specify the AP's MAC address or hostname.
all Uploads to all APs
upload-time <TIME> Schedules an AP upload time
  • <TIME> – Specify upload time in the MM/DD/YYYY-HH:MM or HH:MM format.

The scheduled upload time is your local system‘s time. It is not the access point, controller, service platform, or virtual controller time and it is not synched with the device.

To view a list of uploaded captive portal files, execute the show → captive-portal-page-upload → list-files <CAPTIVE-PORTAL-NAME> command.

 
captive-portal-page-upload <CAPTIVE-PORTAL-NAME> rf-domain [<DOMAIN-NAME>|all] 
{from-controller} {(upload-time <TIME>)}
captive-portal-page-upload <CAPTIVE-PORTAL-NAME> Uploads advanced pages of the captive portal identified by the <CAPTIVE-PORTAL-NAME> parameter
  • <CAPTIVE-PORTAL-NAME> – Specify the captive portal's name (should be existing and configured).
rf-domain [<DOMAIN-NAME>|all] Uploads to all APs within a specified RF Domain or all RF Domains
  • <DOMAIN-NAME> – Uploads to APs within a specified RF Domain. Specify the RF Domain name.
  • all – Uploads to APs across all RF Domains
from-controller Optional. Uploads captive-portal pages to APs via the controller to which the APs are adopted
upload-time <TIME> Optional. Schedules an AP upload time
  • <TIME> – Specify upload time in the MM/DD/YYYY-HH:MM or HH:MM format.

The scheduled upload time is your local system‘s time. It is not the access point, controller, service platform, or virtual controller time and it is not synched with the device.

To view a list of uploaded captive portal files, execute the show → captive-portal-page-upload → list-files <CAPTIVE-PORTAL-NAME> command.

 
captive-portal-page-upload cancel-upload [<MAC/HOSTNAME>|all|on rf-domain [<DOMAIN-NAME>|all]]
captive-portal-page-upload cancel-upload Cancels a scheduled AP upload
cancel-upload [<MAC/HOSTNAME>| all|on rf-domain [<DOMAIN-NAME>| all] Select one of the following options:
  • <MAC/HOSTNAME> – Cancels scheduled upload to a specified AP. Specify the AP's MAC address or hostname.
  • all – Cancels all scheduled AP uploads
  • on rf- domain – Cancels all scheduled uploads within a specified RF Domain or all RF Domains
    • <DOMAIN-NAME> – Cancels scheduled uploads within a specified RF Domain. Specify the RF Domain name.
    • all – Cancels scheduled uploads across all RF Domains
 
captive-portal-page-upload delete-file <CAPTIVE-PORTAL-NAME> <FILE-NAME>
captive-portal-page-upload delete-file Deletes a specified captive portal‘s uploaded captive-portal Web page files
<CAPTIVE-PORTAL-NAME> <FILE-NAME> Identifies the captive-portal and Web pages to delete
  • <CAPTIVE-PORTAL-NAME> – Specify the captive portal name.
  • <FILE-NAME> – Specify the file name. The specified internal captive portal page is deleted.
 
captive-portal-page-upload load-file <CAPTIVE-PORTAL-NAME> <URL>
captive-portal-page-upload load-file Loads captive-portal advanced pages
<CAPTIVE-PORTAL-NAME> <URL> Specify the captive portal's name and location. The captive portal should be existing and configured.

IPv4 URLs:

  • tftp://<hostname|IP>[:port]/path/file
  • ftp://<user>:<passwd>@<hostname|IP>[:port]/path/file
  • sftp://<user>:<passwd>@<hostname|IP>[:port]>/path/file
  • http://<hostname|IP>[:port]/path/file
  • cf:/path/file
  • usb<n>:/path/file

IPv6 URLs:

  • tftp://<hostname|IPv6>[:port]/path/file
  • ftp://<user>:<passwd>@<hostname|IPv6>[:port]/path/file
  • sftp://<user>:<passwd>@<hostname|IPv6>[:port]>/path/file
  • http://<hostname|IPv6>[:port]/path/file
Note: The captive portal pages are downloaded to the controller from the location specified here. After downloading use thecaptive-portal-page-upload → <CAPTIVE-PORTAL-NAME> → <DEVICE-OR-DOMAIN-NAME> command to upload these pages to APs.

Examples

ap8533-B1A214#captive-portal-page-upload load-file captive_portal_test tftp://89.89.89.17/pages_new_only.tar

ap8533-B1A214#show captive-portal-page-upload load-image-status
Download of captive_portal_test advanced page file is complete
ap6562-B1A214#

ap8533-B1A214#captive-portal-page-upload captive_portal_test all
--------------------------------------------------------------------------------
         CONTROLLER             STATUS                   MESSAGE
--------------------------------------------------------------------------------
  FC-0A-81-B1-A2-14         Success         Added 6 APs to upload queue
--------------------------------------------------------------------------------
ap8533-B1A214#

ap8533-B1A214@#show captive-portal-page-upload status
Number of APs currently being uploaded : 1
Number of APs waiting in queue to be uploaded : 0
---------------------------------------------------------------------------------------
        AP           STATE     UPLOAD TIME PROGRESS RETRIES LAST UPLOAD ERROR UPLOADED BY
---------------------------------------------------------------------------------------
  ap8533-B1A738   downloading   immediate   100      0       -                 None
---------------------------------------------------------------------------------------
ap8533-B1A214#

The following example lists captive portal CP-BW uploaded files:

nx7500-7F2C13#show captive-portal-page-upload list-files CP-BW
--------------------------------------------------------------------------------
       NAME                   SIZE                LAST MODIFIED
--------------------------------------------------------------------------------
  CP-BW-1.tar.gz              6133              2019-05-16 10:38:40
  CP-BW.tar.gz                3370              2019-05-16 10:45:44
--------------------------------------------------------------------------------
nx7500-7F2C13#
9036316-02 REV AB