Ruckus SCG™200,vSZ H™ And SZ™ 300 Hotspot WISPr Reference Guide For SmartZone 3.5 Smart Zone (GA) Portal Integration (SZ300/SCG200/v SZ H) Scg200Vszh Sz300 35 Rev B 20170628

2017-06-28

User Manual: Ruckus SmartZone 3.5 (GA) Hotspot Portal Integration Reference Guide (SZ300/SCG200/vSZ-H)

Open the PDF directly: View PDF .
Page Count: 48

Ruckus Wireless™ SmartCell

Gateway 200, Virtual SmartZone

High-Scale and SmartZone 300

Hotspot WISPr Reference Guide for

SmartZone 3.5

Part Number: 800-71299-001 Rev B

Published: 28 June 2017

www.ruckuswireless.com

Contents

Copyright Notice and Proprietary Information.............................................................................4

About this Guide.........................................................................................................................5

Document Conventions.........................................................................................................5

Terminology..........................................................................................................................6

Related Documentation.........................................................................................................7

Online Training Resources.....................................................................................................7

Documentation Feedback.....................................................................................................7

1 Web Interface Configuration Overview

Request Format..................................................................................................................10

Controller Web Interface Configuration................................................................................11

2 JSON Commands - User Online Control

Request Authentication - Asynchronous Login....................................................................12

Using Asynchronous API.....................................................................................................14

Request Authentication Synchronous Login........................................................................14

Querying Enrichment Information........................................................................................16

Terminating a User Session.................................................................................................17

Disconnect Command........................................................................................................17

3 JSON Responses - GetConfig

JSON Responses...............................................................................................................22

JSON Response Examples.................................................................................................24

A WISPr Support for ZoneDirector Login

B Captive Portal Attributes

C The Smart Client

D User Defined Interface - NBI and UDI

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

E Northbound Portal Interface Support

F WISPr Portal Details

G Certificate Warning

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Information

No part of this documentation may be used, reproduced, transmitted, or translated, in

any form or by any means, electronic, mechanical, manual, optical, or otherwise, without

prior written permission of Ruckus Wireless, Inc. (“Ruckus”), or as expressly provided

by under license from Ruckus.

Destination Control Statement

Technical data contained in this publication may be subject to the export control laws

of the United States of America. Disclosure to nationals of other countries contrary to

United States law is prohibited. It is the reader’s responsibility to determine the applicable

regulations and to comply with them.

Disclaimer

THIS DOCUMENTATION AND ALL INFORMATION CONTAINED HEREIN (“MATERIAL”)

IS PROVIDED FOR GENERAL INFORMATION PURPOSES ONLY. RUCKUS AND ITS

LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH

REGARD TO THE MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A

PARTICULAR PURPOSE, OR THAT THE MATERIAL IS ERROR-FREE, ACCURATE OR

RELIABLE. RUCKUS RESERVES THE RIGHT TO MAKE CHANGES OR UPDATES TO

THE MATERIAL AT ANY TIME.

Limitation of Liability

IN NO EVENT SHALL RUCKUS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

SPECIAL OR CONSEQUENTIAL DAMAGES, OR DAMAGES FOR LOSS OF PROFITS,

REVENUE, DATA OR USE, INCURRED BY YOU OR ANY THIRD PARTY, WHETHER

IN AN ACTION IN CONTRACT OR TORT, ARISING FROM YOUR ACCESS TO, OR USE

OF, THE MATERIAL.

Trademarks

Ruckus Wireless, Ruckus, the bark logo, BeamFlex, ChannelFly, Dynamic PSK,

FlexMaster, Simply Better Wireless, SmartCell, SmartMesh, SmartZone, Unleashed,

ZoneDirector and ZoneFlex are trademarks of Ruckus Wireless, Inc. in the United States

and other countries. All other product or company names may be trademarks of their

respective owners.

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

About this Guide

This Hotspot WISPr Reference Guide describes the SmartCell Gateway™ (SCG) 200,

Virtual SmartZone™ High-Scale (vSZ-H) and SmartZone™ (SZ) 300 (collectively referred

to as “the controller” throughout this guide) RESTful-like/JSON interfaces for external

web portal servers.

This guide is written for service operators and system administrators who are responsible

for managing, configuring, and troubleshooting Ruckus Wireless devices. Consequently,

it assumes a basic working knowledge of local area networks, wireless networking, and

wireless devices.

NOTE If release notes are shipped with your product and the information there differs

from the information in this guide, follow the instructions in the release notes.

Most user guides and release notes are available in Adobe Acrobat Reader Portable

Document Format (PDF) or HTML on the Ruckus Wireless Support Web site at

https://support.ruckuswireless.com/contact-us.

Document Conventions

Table 1: Text conventions on page 5 and Table 2: Notice conventions on page 5 list

the text and notice conventions that are used throughout this guide.

Table 1: Text conventions

ExampleDescriptionConvention

[Device Name] >Represents information as it

appears on screen

message phrase

[Device Name] >

set ipaddr 10.0.0.12

Represents information that

you enter

user input

Click Start > All ProgramsKeyboard keys, software

buttons, and field names

user interface controls

Click Advanced Settings.

The Advanced Settings

page appears.

screen or page names

Table 2: Notice conventions

DescriptionNotice type

Information that describes important

features or instructions

NOTE

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

DescriptionNotice type

Information that alerts you to potential loss

of data or potential damage to an

application, system, or device

CAUTION!

Information that alerts you to potential

personal injury

WARNING!

Terminology

The table lists the terms used in this guide.

Table 3: Terms used in this guide

DescriptionTerminology

Access PointAP

Captive PortalCP

Northbound InterfaceNBI

Remote Access Dial In User ServiceRADIUS

Smart Cell GatewaySCG

Secure Socket LayerSSL

Transmission Control ProtocolTCP

User Define InterfaceUDI

User EquipmentUE

User Equipment - IP AddressUE-IP

User Equipment - MAC AddressUE-MAC

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

About this Guide

Terminology

Related Documentation

For a complete list of documents that accompany this release, refer to the Release

Notes.

Online Training Resources

To access a variety of online Ruckus Wireless training modules, including free introductory

courses to wireless networking essentials, site surveys, and Ruckus Wireless products,

visit the Ruckus Wireless Training Portal at:

https://training.ruckuswireless.com.

Documentation Feedback

Ruckus Wireless is interested in improving its documentation and welcomes your

comments and suggestions.

You can email your comments to Ruckus Wireless at: docs@ruckuswireless.com

When contacting us, please include the following information:

•Document title

•Document part number (on the cover page)

•Page number (if appropriate)

Web Interface Configuration Overview 1

The controller provides Wi-Fi hotspot services in conjunction with external web portal

servers. In most cases, an external web portal server provides the landing web pages

with Wi-Fi hotspot usage instructions, terms and conditions, etc., while the end user

submits his login ID and password directly to the AP for authentication.

There are, however, some cases when an external web portal server requires total control

of a user session by requesting authentication on the user’s behalf as well as terminating

user sessions. JSON interface defined in this reference guide provides a standard way

for an external web portal server to communicate with the controller for this kind of

usage.

The following are the hotspot components and their roles in the hotspot portal as seen

in the Figure

•Northbound: Listens on the control and management interface. It is responsible for

handling requests from external subscriber portal and authenticates with the AAA

server.

•Captive portal: Listens on the control interface or UDI. It is responsible for providing

a wall garden for web-proxy UE. It blocks UEs, which uses user agents that are listed

in the configured black-list and mainly handles high scalable redirecting UEs to the

external subscriber portal.

•External subscriber portal: Is a Web service. The user sends his/her login credentials

(username and password) through this portal. The authentication is performed through

the northbound by user input credential. The external subscriber portal can reach

the northbound depending on the type of interface it can reach such as control

interface, management interface or both.

•AAA server: Is responsible for authenticating the UE through the UE’s login credentials

(username and password).

NOTE Refer to appendix WISPr Portal Details on page 43 for IPv4 and IPv6 protocol

support for GRE tunnels.

Figure 1: Hotspot portal components

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

This reference guide describes the controller RESTful-like/JSON interfaces for external

web portal servers.

NOTE Refer to About This Guide chapter for conventions used in this guide.

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Web Interface Configuration Overview

Request Format

As defined in JSON commands, each request issued from an external web portal server

is in JSON format.

NBI is only accessible via the management, control and user defined interfaces. The

following are the request formats.

HTTP Request

http://scg_management_ip:9080/portalintf

HTTPS Request

https://scg_management_ip:9443/portalintf

NOTE You can download the log for northbound portal interface from the controller

web interface by navigating to Diagnostics > Application Logs as all other applications.

The table lists the ports that must be opened on the network firewall to ensure that the

controller and NBI can communicate with each other successfully.

Table 4: Portal details

PurposeConfigurable

from Web

Interface?

DestinationSourceLayer 4

Protocol

Port

Number

Northbound Portal

Interface for Hotspot

NoControllerAnyHTTP9080

Northbound Portal

Interface for Hotspot

NoControllerAnyHTTPS9443

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Web Interface Configuration Overview

Request Format

Controller Web Interface Configuration

Each JSON request must be accompanied by a request password that is preconfigured

on the controller, as well as on the external web portal server.

This helps ensure that only authorized web portal servers can access the northbound

portal interface.

The northbound portal interface request password can be configured in the controller

web interface by navigating to System > General System Settings > Northbound

Interface. See Figure 2: Setting the password on page 11.

The password in the figure is a token to ensure that a portal has the permission to get

the services from the northbound portal interface. It must be included in all JSON request

as RequestPassword sent to NBI.

A web portal server must use the POST command to issue JSON requests. The controller

will not accept a request with the GET request command.

Figure 2: Setting the password

NOTE Refer to Northbound Portal Interface Support on page 42 for details on MSP

support.

JSON Commands - User Online

Control 2

The Northbound Portal interface supports the following JSON commands:

•Login

•Login Async

•Logout

•Status

•Disconnect

•Enrichment Info

These commands are used for user authentication, user status query, terminating user

sessions and verifying that the enrichment information has the same content. For each

command (JSON POST), both the UE-IP and UE-MAC may be included. Where both

are present, the UE-MAC will be preferred.

The NBI decrypts the strings and returns the decrypted version within the response

message. This is because the Captive Portal (CP) encrypts the IP and MAC address

parameters in each redirection (See the Table for the full list of these parameters) to the

subscriber portal. The controller decrypts the UE-IP and UE-MAC address before returning

the response, by using the Encrypt and Decrypt API described in GetConfig section.

NOTE Northbound Interface (NBI) expects to receive encrypted UE-IP and UE-MAC

address (For example, ENC12bc24c4777703327f2e0aabbf6b9f9e) when the request

category is UserOnlineControl. In the GetConfig request category you do not need to

encrypt UE-IP and UE-MAC address (For example: 172.21.134.87)

Request Authentication - Asynchronous Login

In the Hotspot (WISPr) WLAN use case, an unauthorized user is redirected to an external

web portal server by the controller. Using the asynchronous login command

(RequestType=LoginAsync), the external web portal server sends a request to the

controller to authenticate the user using the RADIUS server.

The external Web portal server receives the response - 202 Authentication pending,

while the controller performs the authentication in the background. It is the responsibility

of the Web portal to poll the controller and fetch the authentication result. This action is

performed using the status command (RequestType=Status).

NOTE To use asynchronous APIs refer to Using Asynchronous API

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

The following is an example of the asynchronous login request:

{

Vendor: “ruckus”

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “UserOnlineControl”,

RequestType: “LoginAsync”,

UE-IP: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,

UE-MAC: “ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157”,

UE-Proxy: “0”,

UE-Username: “test”,

UE-Password: “test”

}

The table lists the controller responses to these authentication requests.

NOTE The user account test (UE username) mentioned in the above example, has

been created as an external user in the RADIUS server. The hotspot portal does not

provide an interface for manipulating user account information.

Table 5: Controller responses to authentication (asynchronous login) requests

Possible ResponsesResponse Type

•101, Client authorized: Response if the user is already authorized.

•202, Authentication pending: Authentication is in progress, portal

server needs to check the result later.

Normal response

•300, Not found: Response if the lookup fails with given UE-MAC

or UE-IP address.

•400, Internal server error: Response when the controller internal

error occurs.

Service error

•302, Bad request: Response if the JSON request is not

well-formed.

•303, Version not supported: Response if there is a version

mismatch.

•304, Command not supported: Response if the request type is

not supported.

•305, Category not supported: Response if the request category

not supported.

•306, Wrong request password: Response if the request

password is mismatched.

General error

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Request Authentication - Asynchronous Login

Using Asynchronous API

When using the asynchronous API (RequestType = LoginAsync), NBI will always return

a response as pending authentication.

The client must send a status request (each X seconds/milliseconds) to check for the

authentication result. This is useful when using a smart device. The App in a smart device

can query the login status periodically. It stores the user credentials in the background

thereby reducing the user driven actions.

Request Authentication Synchronous Login

The controller also provides a synchronous login blocking command

(RequestType=Login).

In synchronous login command the external Web portal must wait for the authentication

process to complete, which is usually processed by the RADIUS server. This could result

in a delayed response if the controller is unable to get a response from the RADIUS

server. The following is an example of this command.

{

Vendor: “ruckus”

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “UserOnlineControl”,

RequestType: “Login”,

UE-IP: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,

UE-MAC: “ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157”,

UE-Proxy: “0”,

UE-Username: “test”,

UE-Password: “test”

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Using Asynchronous API

The table lists the controller responses to the synchronous login command.

Table 6: Controller responses to a synchronous login command

Possible ResponsesResponse Type

•101, Client authorized: Response if the user is already authorized.

•201, Login succeeded: Response if the login is accepted.

Normal response

•300, Not found: Response if the lookup fails with given UE-MAC

or UE-IP address.

•301, Login failed: It will be replaced if the RADIUS reply message

is returned.

•400, Internal server error: Response when an controller internal

error occurs.

•401, Radius server error: Response when a RADIUS connection

error occurs or the connection request times out.

Service error

•302, Bad request: Response if the JSON request is not

well-formed.

•303, Version not supported: Response if there is a version

mismatch.

•304, Command not supported: Response if the request type is

not supported.

•305, Category not supported: Response if the request category

not supported.

•306, Wrong request password: Response if the request password

is mismatched.

General error

NOTE If an authentication process has a result (not pending), the controller responds

to it only once. For example, if the controller replies 301, Login failed to the web portal

server, and the web portal server sends the same query, the response will be 100,

unauthorized. If the controller replies 201, Login succeeded, and the web portal server

queries again, the response will be 101, Authorized.

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Request Authentication Synchronous Login

Querying Enrichment Information

The Northbound Portal Interface provides the JSON command EnrichmentInfo for verifying

that the enrichment information has the same content as HTML header enrichment info

sent from the AP.

This allows the captive portal to obtain the enriched parameters in an SSL (Secure

Sockets Layer) scenario or in other cases wherein the AP enrichment info is not available.

NOTE The EnrichmentInfo command is only applicable for UEs connected to Ruckus

APs and not for 3rd party APs.

The following is an example of the EnrichmentInfo request:

{

Vendor: “ruckus”

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “UserOnlineControl”,

RequestType: “EnrichmentInfo”,

UE-IP: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,

}

The table lists the responses for enrichment information.

Table 7: Query enrichment

Possible ResponsesResponse

Type

•102, Enrichment Information.

Normal

response

•300, Not found: Response if the lookup fails with given UE- MAC

or UE-IP address.

•400, Internal server error: Response when an controller internal

error occurs.

Service error

•302, Bad request: Response if the JSON request is not well-formed.

•303, Version not supported: Response if there is a version

mismatch.

•304, Command not supported: Response if the request type is not

supported.

•305, Category not supported: Response if the request category

not supported.

•306, Wrong request password: Response if the request password

is mismatched.

General error

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Querying Enrichment Information

NOTE If an authentication process has a result (not pending), the controller responds

to it only once. For example, if the controller replies 301, Login failed to the web portal

server, and the web portal server sends the same query, the response will be 100,

unauthorized. If the controller replies 201, Login succeeded, and the web portal server

queries again, the response will be 101, Authorized.

Terminating a User Session

After a user session is authorized, the external web portal server can terminate the user

session by sending a JSON request to the controller.

In this case, the Web portal changes the status of the client from authenticated, to

unauthenticated, forcing the user to login again. When un-authenticating a user, existing

TCP sessions are not terminated and the UE is not disassociated from the AP. It only

changes the status of the UE from authorized to unauthorized. The following is an example

of the terminating a user session command:

{

Vendor: “ruckus”

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “UserOnlineControl”,

RequestType: “Logout”,

UE-IP: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,

UE-MAC: “ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157”

}

Disconnect Command

The controller also provides a command for terminating user TCP (Transmission Control

Protocol) connections from the AP (Access Point).

In other words, the disconnect command (RequestType=Disconnect) changes the status

of the UE from authorized to unauthorized and also disassociates the UE from the AP.

{

Vendor: “ruckus”

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “UserOnlineControl”,

RequestType: “Disconnect”,

UE-IP: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,

UE-MAC: “ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157”

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Terminating a User Session

The table lists the controller response.

Table 8: Controller responses to a disconnect command

Possible ResponsesResponse

Type

•200, OK

•100, Client unauthorized: Response if the user is already

unauthorized

Normal

response

•300, Not found: Response if the lookup fails with given UE- MAC

or the UE-IP address.

•400, Internal server error: Response when an controller internal error

occurs.

Service Error

•302, Bad request: Response if the JSON request is not well-formed.

•303, Version not supported: Response if there is a version mismatch.

•304, Command not supported: Response if the request type is not

supported.

•305, Category not supported: Response if the request category not

supported.

•306, Wrong request password: Response if the request password

is mismatched.

General error

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Disconnect Command

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Commands - User Online Control

Disconnect Command

JSON Responses - GetConfig 3

The northbound interface supports the following JSON commands in the request category

- GetConfig:

•Encrypt

•Decrypt

NOTE It is recommended for new users to implement and use the new APIs - Encrypt

and Decrypt. Existing users can continue using the legacy APIs - EncryptIP and DecryptIP

provided; you have not made any changes to it during implementation on your portal

server.

The following is an example of an Encrypt IP address command, which returns an

encrypted IP address for direct access to the subscriber portal. By default the encryption

is enabled. To disable the encryption, use the CLI command:

ruckus(config)# [no] encrypt-mac-ip

NOTE Refer to the CLI examples given below for enabling disabling the IP and MAC

address encryption.

{

Vendor: “ruckus”,

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “GetConfig”,

RequestType: “Encrypt”,

Data: “172.21.134.87”

}

The following is an example of the success response:

{

Vendor: “ruckus”,

ReplyMessage:”OK",

ResponseCode:200,

APIVersion:”1.0”

Data: “ENC1234bfdbe5y5hbfdgh45y54ryt5y5th5”

}

Another example is the decrypt command, which returns a decrypted value of IP address.

{

Vendor: "ruckus",

RequestPassword: "myPassword", APIVersion: "1.0",

RequestCategory: "GetConfig", RequestType: "Decrypt",

Data: "ENC1234bfdbe5y5hbfdgh45y54ryt5y5th5"

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

The success response:

{

Vendor:"ruckus", ReplyMessage:"OK", ResponseCode:200,

APIVersion:"1.0"

Data: "172.21.134.87"

}

The following are examples of using the CLI command for enabling and disabling the IP

address and MAC address encryptions.

Enabling the IP address and MAC address encryption:

# show running-config encrypt-mac-ip

Disabling the IP address and MAC address encryption:

# config

(config)# no encrypt-mac-ip

Do you want to continue to disable (or input 'no' to cancel)?

[yes/no] yes

Successful operation

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

Confirming that the IP address and MAC address encryption is disabled:

(config)# do show running-config encrypt-mac-ip

Encryption MAC and IP: Disabled

JSON Responses

The table lists the definitions of JSON responses from the northbound portal interface.

The following are the expansions for the abbreviations mentioned in the Used In column.

•UA: User Authenticate (includes LoginSync and LoginAsync)

•SQ: Status Query

•TU: Terminating User (Logout and Disconnect)

•EI: Enrichment Information

•GC: Get Config (Encrypt and Decrypt)

NOTE Refer to JSON Commands for commands related to the responses mentioned

above.

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Responses

Table 9: JSON response definitions

Used InDefinitionCodeCategory

GCEITUSQUA

••Client unauthorized100Informational

••Client authorized101

•Enrichment Info102

••OK200Success

•Login succeeded201

••Authentication

pending

202

••••Not found300Client Error

••Login failed301

•••••Bad request302

•••••Version not

supported

303

Command not

supported

304

Category not

supported

305

•••••Wrong request

password

306

•••••Internal server error400Server Error

••Radius server error401

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Responses

JSON Response Examples

This section provides the following examples of JSON responses defined in the table

(JSON Response Definitions)

Example: Client unauthorized

{

Vendor:"Ruckus",

APIVersion:"1.0",

ResponseCode:100,

ReplyMessage:"Client unauthorized",

UE-IP:"ENC323e79bf1bbd5ac4",

UE-MAC:"ENCf6b7f49da92a45f8978c35966b95eeafc6451102af391592",

AP-MAC:"00:11:22:AA:BB:CC",

SSID:" hotspot-01",

SmartClientInfo:"",

GuestUser:"0",

SmartClientMode:"none"

}

Example: Client authorized

{

Vendor: "Ruckus",

APIVersion: "1.0",

ResponseCode: "101",

ReplyMessage: "Client authorized",

UE-IP: "ENC12bc24c4777703327f2e0aabbf6b9f9e",

UE-MAC: "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",

UE-Username: "user001",

AP-MAC: "04:4f:aa:32:25:f0",

SSID: "hotspot-01"

SmartClientMode: "none",

SmartClientInfo: "",

GuestUser: "0",

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Response Examples

Example: Enrichment information

{

Vendor: "Ruckus",

APIVersion: "1.0",

ResponseCode: "102",

ReplyMessage: "Enrichment Information",

UE-IP: "ENC12bc24c4777703327f2e0aabbf6b9f9e",

UE-MAC: "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",

AP-MAC: "04:4f:aa:32:25:f0",

SSID: "hotspot-01",

WLAN-ID: "1",

Location: "a location",

VLAN-ID: 1

}

Example: Success information

{

Vendor: "Ruckus",

Version: "1.0",

ResponseCode: "200",

ReplyMessage: "OK"

UE-IP: "ENC12bc24c4777703327f2e0aabbf6b9f9e",

UE-MAC: "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",

SmartClientMode: "none",

SmartClientInfo: "",

GuestUser: "0",

}

Example: Login succeeded

{

Vendor: "Ruckus",

APIVersion: "1.0",

ResponseCode: "201",

ReplyMessage: "Login succeeded",

UE-IP: "ENC12bc24c4777703327f2e0aabbf6b9f9e",

UE-MAC: "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",

UE-Username: "user001",

AP-MAC: "04:4f:aa:32:25:f0",

SSID: "hotspot-01",

SmartClientMode: "none",

SmartClientInfo: "",

GuestUser: "0",

UE-Proxy: "0"

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Response Examples

Example: Authentication pending

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "202",

ReplyMessage: "Authentication pending",

UE-IP: "ENC12bc24c4777703327f2e0aabbf6b9f9e",

UE-MAC: "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",

UE-Username: "user001",

AP-MAC: "04:4f:aa:32:25:f0",

SSID: "hotspot-01",

SmartClientMode: "none",

SmartClientInfo: "",

GuestUser: "0",

}

Example: Not found

{

Vendor: "Ruckus",

APIVersion: "1.0",

ResponseCode: "300",

ReplyMessage: "Not found",

}

Example: Login failed

{

Vendor: "Ruckus",

APIVersion: "1.0",

ResponseCode: "301",

ReplyMessage: "Login failed",

UE-IP: "ENC12bc24c4777703327f2e0aabbf6b9f9e",

UE-MAC: "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",

AP-MAC: "04:4f:aa:32:25:f0",

SSID: "hotspot-01",

SmartClientMode: "none",

SmartClientInfo: "",

GuestUser: "0",

}

Example: Bad request

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "302",

ReplyMessage: "Bad request",

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Response Examples

Example: Version not supported

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "303",

ReplyMessage: "Version not supported"

}

Example: Command not supported

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "304",

ReplyMessage: "Command not supported",

}

Example: Category not supported

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "305",

ReplyMessage: "Category not supported",

}

Example: Wrong request password

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "306",

ReplyMessage: "Wrong request password",

}

Example: Internal server error

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "400",

ReplyMessage: "Internal server error",

}

Example: RADIUS server error

{

Vendor: "ruckus",

APIVersion: "1.0",

ResponseCode: "401",

ReplyMessage: "Radius server error",

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Response Examples

Example: Encrypt for MAC address

{

Vendor: “ruckus”,

RequestPassword: “myPassword”,

APIVersion: “1.0”,

RequestCategory: “GetConfig”,

RequestType: “Encrypt”,

Data: “04:4f:aa:32:25:f0”

}

The success response:

{

Vendor: “ruckus”,

ReplyMessage:”OK",

ResponseCode:200,

APIVersion:”1.0”,

Data: "ENC4782689566f8eac8aa30e276aa907f332d0bf93f9f60a7d8"

}

Example: Decrypt for MAC address

{

Vendor: "ruckus",

RequestPassword: “myPassword”,

APIVersion: "1.0",

RequestCategory: "GetConfig",

RequestType: "Decrypt",

Data: "ENC4782689566f8eac8aa30e276aa907f332d0bf93f9f60a7d8"

}

The success response:

{

Vendor:"ruckus", ReplyMessage:"OK",

ResponseCode:200,

APIVersion:"1.0"

Data: "04:4f:aa:32:25:f0"

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Response Examples

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

JSON Responses - GetConfig

JSON Response Examples

WISPr Support for ZoneDirector Login A

The WISPr hotspot portal logon API supports existing customer’s external logon page

(working with Zone Director (ZD). Customers, who already have a ZD deployment and

have implemented their own external logon page for hotspot WLAN, can use ZD's API

(provided by Ruckus) for UE authentication. The controller provides the same API as

that of ZD for customers to use their existing logon page.

NOTE This new API is provided since controller's official portal integration using JSON

requests does not support ZD login API. It is our recommendation that the customer

works with the JSON API as documented in this guide - Hotspot Portal Integration

Interface.

Customer Login

Customers who already have ZD deployment with their own external portal will be required

to make a change to their login/logout URLs to match the new supported API.

The external portal sends the login/logout request to the controller. The requests should

include the parameters provided by controller's captive portal redirection

NOTE See Captive Portal Attributes on page 32 for details.

From:

https://sip:9998/login

To:

https://sip:9998/SubscriberPortal/hotspotlogin

NOTE The login request also supports HTTP with port number 9997.

NOTE This login request should include the customer login credentials such as the

username and password parameters. It is expected that the customer's portal also

sends the following parameters from Captive Portal's redirection -

•url - the original URL which the user tried to browse

•proxy - if the UE browser is set to Web proxy

•uip - UE IP address

•client-mac - UE MAC IP address

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Customer Logout

The logout request path in the external portal to the controller should be changed:

From:

https://sip:9998/logout

To:

https://sip:9998/SubscriberPortal/hotspotlogout?uip=10.20.30.40

Captive Portal Attributes B

The UE-IP and UE-MAC address parameters are decrypted at the beginning of each

user online control request. This is because the Captive Portal (CP) encrypts the IP and

MAC address parameters in each redirection to the subscriber portal.

The controller decrypts the UE-IP and UE-MAC address before returning the response,

by using the Encrypt and Decrypt API described in the GetConfig section.

NOTE In case the external portal is in HTTPS, Apple CNA will not work. It works only

for HTTP redirect.

Redirection Attributes

The table lists these parameters provided by controller's captive portal redirection.

NOTE See WISPr Support for ZoneDirector Login for login and logout details.

Table 10: Redirection attributes

DescriptionAttributes

Encrypted UE Mac address.

NOTE The format of the MAC Address is defined at the Hotspot (WISPr)

Portal configuration.

client_mac

The domain name.dn

AP location.loc

AP Mac address.mac

The UE browser if it is set to the Web proxy.proxy

Reason for redirecting the WLAN. The value could either be:

•Un-Auth-Captive – Regular unauthenticated UE redirected to Login

Portal

•Un-Auth-SSL-Captive – In case of HTTPS, Captive Portal is performing

a “double redirect”. Adding this value to identify this flow

reason

The IP of SCG/SZ’s Northbound Interface. nbilp

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

DescriptionAttributes

The value could either be the:

•FQDN of the uploaded controller (SCG/SZ/vSZ) user interface certificate

if the uploaded certificate’s common name is FQDN.

•Concatenation of the controller cluster name with the common name

value after the wild card, if the uploaded certificate’s common name is

not FQDN (meaning if it includes wild card). For example, if the common

name is “*.ruckuswireless.com” and the cluster name is

“Cluster_Node1”, then the sip is

“cluster_node1.ruckuswireless.com.”

• “scg.ruckuswireless.com”, which is the FQDN of the self-signed

certificate with which controller is packaged, if the certificate is not

uploaded at all.

sip

The broadcasted SSID name.ssid

The URL as per the hotspot configuration, which is to be redirected after

successful login.

startUrl

Encrypted UE IP address.uip

Original URL which the customer tries browsing.url

VLAN which the customer is set to.vlan

WLAN ID of the UE's associated the WLAN.wlan

SSIDs configured WLAN Name.wlanName

In case of 3rd party AP, this attribute will be included instead of WLAN

and will include the zone ID where the SSID is configured to in the

controller.

zoneId

AP zone name of the UE's associated to the WLAN. The zone name is

configured using the WLANs. The zone name is used for Kumo. The value

is encrypted based on a special key.

zoneName

The Smart Client C

The Smart Client is a software solution which resides on the user’s access device that

facilitates the user’s connection to Public Access Networks, whether via a browser,

signaling protocol or other proprietary method of access.

The XML is embedded in the HTML source code as a comment block as the following:

<html>

< head>

< meta http-equiv="content-type" content="text/html;

charset=UTF-8">

< /head>

< body></body>

<!--<?xml version="1.0" encoding="utf-8"?>

{{{ The Embedded XML }}}

-->

</html>

Figure 3: Smart Client Example

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

The Smart Client

Extract the embedded XML as the following.

<?xml version="1.0" encoding="utf-8"?>

<WISPAccessGatewayParam xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance"xsi:

noNamespaceSchemaLocation=

"http://www.acmewisp.com/WISPAccessGatewayParam.xsd">

<LoginURL>https://scg.ruckuswireless.com:

9998/SubscriberPortal/

WisprLogin?nbiIP=172.17.18.173&client_mac=

ENCd67be23390a743c6095b6635a31e93c19e248

7fa83931d98&sip=scg.ruckuswireless.com&wlan=1&reason=

Un-Auth-Captive&proxy=0&

wlanName=RADIUS_TEST&ssid=RADIUS_TEST&mac=

8c:0c:90:2b:8b:90&dn=scg.ruckuswireless.com&

uip=ENCec4cc1fd0c146d5348cd4f1ba20ef459&zoneName=

%5BB%40453f2dba_1439953901413&url=

http%3A%2F%2Fwww.google.com%2F</LoginURL>

<AbortLoginURL>https://scg.ruckuswireless.com:

9998/SubscriberPortal/AbortWisprLogin?

nbiIP=172.17.18.173&client_mac=

ENCd67be23390a743c6095b6635a31e93c19e2487fa83931d98&

sip=scg.ruckuswireless.com&wlan=1&

reason=Un-Auth-Captive&proxy

=0&wlanName=RADIUS_TEST&

ssid=RADIUS_TEST&mac=8c:0c:90:2b:8b:90&dn=

scg.ruckuswireless.com&uip=

ENCec4cc1fd0c146d5348cd4f1ba20ef459&zoneName=

%5BB%40453f2dba_1439953901413&url=

http%3A%2F%2Fwww.google.com%2F</AbortLoginURL>

</Redirect>

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

The Smart Client

Example: Information on the redirection page

<?xml version="1.0" encoding="utf-8"?>

<WISPAccessGatewayParam xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation=

"http://www.acmewisp.com/WISPAccessGatewayParam.xsd">

<LoginURL>https://sip:9998/SubscriberPortal/

WisprLogin?nbiIP=<nbiIP>{& ... other

Redirection attributes in Table 11}</LoginURL>

<AbortLoginURL>https://sip:9998/SubscriberPortal

/AbortWisprLogin?nbiIP=<nbiIP></AbortLoginURL>

</Redirect>

</WISPAccessGatewayParam>

NOTE To do authentication. An HTTP POST request must be sent to the <LoginURL>

with the `UserName` and `Password` fields.

NOTE The content type of request must be "application/x-www-form-urlencoded".

Example: Authentication Request (HTTP)

POST /SubscriberPortal/WisprLogin?nbiIP=<nbiIP>

HTTP/1.1

Host: sip:9998

Content-Type: application/x-www-form-urlencoded

UserName=<UserName>&Password=<Password>

Example: Authentication Reply

<?xml version="1.0" encoding="UTF-8"?>

<WISPAccessGatewayParam xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation=

"http://www.acmewisp.com/WISPAccessGatewayParam.xsd">

<ReplyMessage>Authentication pending</ReplyMessage>

<LoginResultsURL>https://sip:9998/SubscriberPortal

/WisprStatus?nbiIP=<nbiIP>&UserName=

<UserName>&Password=<Password></LoginResultsURL>

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

The Smart Client

</AuthenticationReply>

</WISPAccessGatewayParam>

Example: Authentication Result (Login succeeded)

<?xml version="1.0"encoding="UTF-8"?>

<WISPAccessGatewayParam xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation=

"http://www.acmewisp.com/WISPAccessGatewayParam.xsd">

<ReplyMessage>Login succeeded</ReplyMessage>

<LogoffURL>https://sip:9998/SubscriberPortal

/WisprLogout?nbiIP=<nbiIP> &UserName=

<UserName>&Password=<Password></LogoffURL>

</AuthenticationPollReply>

</WISPAccessGatewayParam>

Example: Authentication Result (Login failed)

<?xml version="1.0" encoding="UTF-8"?>

<WISPAccessGatewayParam xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation=

"http://www.acmewisp.com/WISPAccessGatewayParam.xsd">

<ReplyMessage>Login failed</ReplyMessage>

</AuthenticationPollReply>

</WISPAccessGatewayParam>

Example: Logoff Reply

<?xml version="1.0" encoding="UTF-8"?>

<WISPAccessGatewayParam xmlns:xsi=

"http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation=

"http://www.acmewisp.com/WISPAccessGatewayParam.xsd">

</LogoffReply>

</WISPAccessGatewayParam>

User Defined Interface - NBI and UDI D

AP uses the control interface to communicate with the controller regarding its

configuration. To have a logical separation of UE traffic from the AP control traffic the

administrator can create an UDI (User Define Interface).

In case the UDI (using control interface, physical interface and hotspot service as shown

in the figure) is configured the AP uses it to DNAT unauthorized UE's requests to the

controller's captive portal (otherwise the AP uses the control interface).

NOTE UDI option is not available for vSZ-H.

The controller's captive portal redirects the UE to the configured portal login page URL.

When the UE triggers this portal URL request, the AP will let it go through (it will not

DNAT to the controller's captive portal), as it is configured as ACL in AP, directly to the

external portal server.

The external portal communicates with the controller's NBI for status/login/logout

requests. The interfaces external portal can communicate are the interfaces NBI listens

to. NBI is bound by default to the controller's control and management interfaces.

In addition, the administrator can configure UDI interface, which NBI will bind as well.

This UDI for NBI can be the same UDI which AP DNAT to the controller's captive portal,

or others using control or management physical interfaces and whatever service

(Hotspot/not specified) as in the figure. To define UDI on the controller’s web interface

navigate to System > General Settings > Cluster Plane > Select an existing Control Plane

> Click on Configure > User Defined Interface. Enter the following details. Click on Add

to add and on OK to save the configuration details.

•Name of the UDI

•Physical Interface

•Service

•IP Address

•Subnet Mask

•Gateway

•VLAN

Figure 4: Configuring UDI

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

The figure describes the request flows per interface.

Figure 5: Request flows per interface

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

User Defined Interface - NBI and UDI

Northbound Portal Interface Support E

This section explains Northbound Portal Interface (NBI) support for Managed Service

Provider (MSP).

The user name is a mandatory field for MSP partner domain. It is used by partner users

to query on Northbound Portal. A new RequestUser name field must be added to the

JSON request coming from the partner user. Question - how does one add a partner

Using this method, a partner user need not share the same NBI password with the

system administrator.

Figure 6: Adding a Partner User Credentials

For example:

{

Vendor: “ruckus”

RequestUserName: “partner”,

RequestPassword: “(PartnerPassword)”,

APIVersion: “1.0”,

RequestCategory: “UserOnlineControl”,

RequestType: “Login”,

UE-IP: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,

UE-MAC: “ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157”,

UE-Proxy: “0”,

UE-Username: “test”,

UE-Password: “test”

}

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

WISPr Portal Details F

The following are the WISPr portal details for GRE tunnels.

Non GRE Tunnel

The below table lists the WISPr details for non GRE tunnel.

Table 11: Non GRE tunnel

IPv6IPv4Non GRE Tunnel

SupportedSupportedIPv4Non WISPr Client

SupportedSupportedIPv6

Table 12: Non GRE tunnel and internal portal

IPv6IPv4Non GRE Tunnel

SupportedSupportedIPv4WISPr Client

Not supportedNot supportedIPv6

Table 13: Non GRE tunnel and external portal

IPv6IPv4Non GRE Tunnel

Supported (This

portal is IPv4)

SupportedIPv4WISPr Client

Not supportedNot supportedIPv6

Ruckus GRE Tunnel

The below table lists the WISPr details for Ruckus GRE tunnel.

Table 14: Non GRE tunnel

IPv6IPv4Non GRE Tunnel

Not supportedSupportedIPv4Non WISPr Client

Not supportedNot supportedIPv6

Table 15: Non GRE tunnel and internal portal

IPv6IPv4Non GRE Tunnel

Not supportedSupportedIPv4WISPr Client

Not supportedNot supportedIPv6

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Table 16: Non GRE tunnel and external portal

IPv6IPv4Non GRE Tunnel

Not supportedSupportedIPv4WISPr Client

Not supportedNot supportedIPv6

Certificate Warning G

Certificate warning when end users are redirecting with HTTPS request.

When a CA-signed certificate is imported to SZ certificate store and applied to Hotspot

(WISPr), SZ captive portal and internal portal page use the imported certificate. However,

if an end user enters a HTTPS URL through the browser manually, one certificate warning

message is still expected to be seen in the UE browser.

SZ captive portal need to complete the SSL handshake before sending 302 redirect

response to UE. Since the FQDN(common name) in the certificate is impossible to match

the URL that UE tries to visit, the browser will display a certificate warning.

To avoid certificate warning messages, major operating systems already have built in

mechanisms to detect captive network and sending HTTP requests (not HTTPS), so

that users can be redirected to a portal page automatically without any certificate error.

•Apple iOS CNA (captive network assistant) sends HTTP requests to some static

URLs to detect captive portal.

•Android devices detected it by sending HTTP requests to

http://clients3.google.com/generate_204.

•Window 7 sends HTTP requests to http://www.msftncsi.com/ncsi.txt to detect captive

portal.

NOTE URL may vary based on different software releases.

In either case, user devices pop up a window and redirect users to the portal page with

HTTP requests instead of HTTPs requests. No certificate warning will be shown if the

UE is redirected automatically by the operating system.

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

Index

aPI 30

asynchronous login 12

authentication 8

Authentication pending 24

authorized 16–17

Bad request 24

blocking command 14

Category not supported 24

certificate warning 45

Client authorized 24

Client error 22

Client unauthorized 24

client_mac 32

Command not supported 24

Decrypt 20

Decrypt for MAC address 24

disconnect command 17

dn 32

Encrypt 20

Encrypt for MAC address 24

external portal 30

general error 14, 16–17

Get Config 22

GRE tunnels 43

Hotspot 30

hotspot services 8

Informational 22

Internal server error 24

IPv4 43

IPv6 43

legal 4

loc 32

logout 30

mac 32

MSP 42

NBI 39

nbilp 32

normal response 14, 17

northbound portal interface 10

Not found 24

password 10

portal logon 30

POST 8, 11

proxy 32

RADIUS server error 24

reason 32

Redirection Attributes 32

Ruckus GRE tunnels 43

Server error 22

service error 14, 16–17

sip 32

ssid 32

startUrl 32

Status Query 22

subscriber portal 20

Success 22

Success information 24

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

synchronous login 14

terminating 8

Terminating User 22

terminating user sessions 12

trademarks 4

UDI 39

uip 32

unauthorized 16

url 32

user account 12

User Authenticate 22

user authentication 12

user defined IP list 20

user name 42

user session 8

user status query 12

UserOnlineControl 12

Version not supported 24

vlan 32

wifi hotspot 8

WISPr portal details 43

wlan 32

wlanName 32

Wrong request password 24

zoneId 32

zoneName 32

Ruckus Wireless™ SmartCell Gateway 200, Virtual SmartZone High-Scale and SmartZone 300 Hotspot WISPr Reference

Guide for SmartZone 3.5

350 West Java Drive, Sunnyvale, CA

www.ruckuswireless.com

Ruckus SCG™200,vSZ H™ And SZ™ 300 Hotspot WISPr Reference Guide For SmartZone 3.5 Smart Zone (GA) Portal Integration (SZ300/SCG200/v SZ H) Scg200Vszh Sz300 35 Rev B 20170628

Navigation menu

Versions of this User Manual:

Views

Navigation