vSCG Carrier Administrator Guide for RuckOS 3.0.3

Ruckus Wireless
Virtualized SmartCell Gateway Carrier
™
™
Administrator Guide for RuckOS 3.0.3
Part Number 800-70672-001 Rev C
Published March 2015
www.ruckuswireless.com
Copyright Notice and Proprietary Information
Copyright 2015. Ruckus Wireless, Inc. All rights reserved.
No part of this documentation may be 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, ZoneFlex, FlexMaster, ZoneDirector, SmartMesh, Channelfly, Smartcell,
Dynamic PSK, and Simply Better Wireless 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.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
2
Third Party and Open Source Licenses Used in This Product
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
This product includes software developed by the OpenSymphony Group (http://www.opensymphony.com/).
This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/).
This product includes software written by Tim Hudson (tjh@cryptsoft.com).
This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).
Copyright © 1999-2003 The Apache Software Foundation. All rights reserved.
Copyright © 2001-2004 The OpenSymphony Group. All rights reserved.
Copyright © 2003 The Visigoth Software Society. All rights reserved.
Copyright © 2011 John Resig, http://jquery.com/
Copyright © 1998-2011 The OpenSSL Project. All rights reserved.
Copyright © 1995-1998 Eric Young (eay@cryptsoft.com). All rights reserved.
Apache 2.0
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through
9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under
common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to
cause the direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such
entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code,
documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including
but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as
indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work
and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original
work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable
from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall
mean any work of authorship, including the original version of the Work and any modifications or additions to that Work
or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this
definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its
representatives, including but not limited to communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and
improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by
the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received
by Licensor and subsequently incorporated within the Work.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
2
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to
You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works
in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You
a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent
license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies
only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone
or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute
patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
or without modifications, and in Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the
Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The
contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own
attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from
the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms
and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this
License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for
inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional
terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you
may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product
names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and
reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions
under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or
otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall
any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages
of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited
to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose
to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each
Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting
any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
3
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets
"[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the
appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose
be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
Apache 1.1
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
4
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
Object-Graph Navigation Language (OGNL)
OpenSymphony Apache Software License Version 1.1
General information:
Copyright (c) 2001-2004 The OpenSymphony Group. All rights reserved.
The OpenSymphony Software License, Version 1.1
(this license is derived and fully compatible with the Apache Software License - see http://www.apache.org/LICENSE.txt)
Copyright (c) 2001-2004 The OpenSymphony Group. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment:
'This product includes software developed by the OpenSymphony Group (http://www.opensymphony.com/).' Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments
normally appear.
4. The names 'OpenSymphony' and 'The OpenSymphony Group' must not be used to endorse or promote products
derived from this software without prior written permission. For written permission, please contact license@opensymphony.com.
5. Products derived from this software may not be called 'OpenSymphony' or 'WebWork', nor may 'OpenSymphony'
or 'WebWork' appear in their name, without prior written permission of the OpenSymphony Group.
THIS SOFTWARE IS PROVIDED 'AS IS' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
5
Freemarker
Copyright (c) 2003 The Visigoth Software Society. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. The end-user documentation included with the redistribution, if any, must include the following acknowlegement:
"This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/)." Alternately,
this acknowlegement may appear in the software itself, if and wherever such third-party acknowlegements normally
appear.
3. Neither the name "FreeMarker", "Visigoth", nor any of the names of the project contributors may be used to endorse
or promote products derived from this software without prior written permission. For written permission, please contact
visigoths@visigoths.org.
4. Products derived from this software may not be called "FreeMarker" or "Visigoth" nor may "FreeMarker" or "Visigoth"
appear in their names without prior written permission of the Visigoth Software Society.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR ITS CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING,BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
----------------------------------------------------------------------------This software consists of voluntary contributions made by many individuals on
behalf of the Visigoth Software Society. For more information on the Visigoth
Software Society, please see http://www.visigoths.org/
Java Beans Activation Framework
COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0
1. Definitions.
1.1. Contributor. means each individual or entity that creates or contributes to the creation of Modifications.
1.2. Contributor Version. means the combination of the Original Software, prior Modifications used by a Contributor (if
any), and the Modifications made by that particular Contributor.
1.3. Covered Software. means (a) the Original Software, or (b) Modifications, or (c) the combination of files containing
Original Software with files containing Modifications, in each case including portions thereof.
1.4. Executable. means the Covered Software in any form other than Source Code.
1.5. Initial Developer. means the individual or entity that first makes Original Software available under this License.
1.6. Larger Work. means a work which combines Covered Software or portions thereof with code not governed by the
terms of this License.
1.7. License. means this document.
1.8. Licensable. means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or
subsequently acquired, any and all of the rights conveyed herein.
1.9. Modifications. means the Source Code and Executable form of any of the following:
A. Any file that results from an addition to, deletion from or modification of the contents of a file containing Original
Software or previous Modifications;
B. Any new file that contains any part of the Original Software or previous Modification; or
C. Any new file that is contributed or otherwise made available under the terms of this License.
1.10. Original Software. means the Source Code and Executable form of computer software code that is originally
released under this License.
1.11. Patent Claims. means any patent claim(s), now owned or hereafter acquired, including without limitation, method,
process, and apparatus claims, in any patent Licensable by grantor.
1.12. Source Code. means (a) the common form of computer software code in which modifications are made and (b)
associated documentation included in or with such code.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
6
1.13. You. (or .Your.) means an individual or a legal entity exercising rights under, and complying with all of the terms
of, this License. For legal entities, .You. includes any entity which controls, is controlled by, or is under common control
with You. For purposes of this definition, .control. means (a) the power, direct or indirect, to cause the direction or
management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the
outstanding shares or beneficial ownership of such entity.
2. License Grants.
2.1. The Initial Developer Grant.
Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, the
Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license:
(a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer, to use, reproduce,
modify, display, perform, sublicense and distribute the Original Software (or portions thereof), with or without Modifications, and/or as part of a Larger Work; and
(b) under Patent Claims infringed by the making, using or selling of Original Software, to make, have made, use, practice,
sell, and offer for sale, and/or otherwise dispose of the Original Software (or portions thereof).
(c) The licenses granted in Sections 2.1(a) and (b) are effective on the date Initial Developer first distributes or otherwise
makes the Original Software available to a third party under the terms of this License.
(d) Notwithstanding Section 2.1(b) above, no patent license is granted: (1) for code that You delete from the Original
Software, or (2) for infringements caused by: (i) the modification of the Original Software, or (ii) the combination of the
Original Software with other software or devices.
2.2. Contributor Grant.
Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, each
Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
a) under intellectual property rights (other than patent or trademark) Licensable by Contributor to use, reproduce, modify,
display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof), either
on an unmodified basis, with other Modifications, as Covered Software and/or as part of a Larger Work;
and
(b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone
and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale,
have made, and/or otherwise dispose of: (1) Modifications made by that Contributor (or portions thereof); and (2) the
combination of Modifications made by that Contributor with its Contributor Version (or portions of such
combination).
(c) The licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first distributes or otherwise
makes the Modifications available to a third party.
(d) Notwithstanding Section 2.2(b) above, no patent license is granted: (1) for any code that Contributor has deleted
from the Contributor Version; (2) for infringements caused by: (i) third party modifications of Contributor Version, or (ii)
the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version)
or other devices; or (3) under Patent Claims infringed by Covered Software in the absence of Modifications made by
that Contributor.
3. Distribution Obligations.
3.1. Availability of Source Code.
Any Covered Software that You distribute or otherwise make available in Executable form must also be made available
in Source Code form and that Source Code form must be distributed only under the terms of this License. You must
include a copy of this License with every copy of the Source Code form of the Covered Software You distribute or
otherwise make available. You must inform recipients of any such Covered Software in Executable form as to how they
can obtain such Covered Software in Source Code form in a reasonable manner on or through a medium customarily
used for software exchange.
3.2. Modifications.
The Modifications that You create or to which You contribute are governed by the terms of this License. You represent
that You believe Your Modifications are Your original creation(s) and/or You have sufficient rights to grant the rights
conveyed by this License.
3.3. Required Notices.
You must include a notice in each of Your Modifications that identifies You as the Contributor of the Modification. You
may not remove or alter any copyright, patent or trademark notices contained within the Covered Software, or any
notices of licensing or any descriptive text giving attribution to any Contributor or the Initial Developer.
3.4. Application of Additional Terms.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
7
You may not offer or impose any terms on any Covered Software in Source Code form that alters or restricts the
applicable version of this License or the recipients. rights hereunder. You may choose to offer, and to charge a fee for,
warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, you may
do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely
clear that any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to
indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor
as a result of warranty, support, indemnity or liability terms You offer.
3.5. Distribution of Executable Versions.
You may distribute the Executable form of the Covered Software under the terms of this License or under the terms of
a license of Your choice, which may contain terms different from this License, provided that You are in compliance with
the terms of this License and that the license for the Executable form does not attempt to limit or alter the recipient.s
rights in the Source Code form from the rights set forth in this License. If You distribute the Covered Software in
Executable form under a different license, You must make it absolutely clear that any terms which differ from this License
are offered by You alone, not by the Initial Developer or Contributor. You hereby agree to indemnify the Initial Developer
and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms
You offer.
3.6. Larger Works.
You may create a Larger Work by combining Covered Software with other code not governed by the terms of this
License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of
this License are fulfilled for the Covered Software.
4. Versions of the License.
4.1. New Versions.
Sun Microsystems, Inc. is the initial license steward and may publish revised and/or new versions of this License from
time to time. Each version will be given a distinguishing version number. Except as provided in Section 4.3, no one other
than the license steward has the right to modify this License.
4.2. Effect of New Versions.
You may always continue to use, distribute or otherwise make the Covered Software available under the terms of the
version of the License under which You originally received the Covered Software. If the Initial Developer includes a notice
in the Original Software prohibiting it from being distributed or otherwise made available under any subsequent version
of the License, You must distribute and make the Covered Software available under the terms of the version of the
License under which You originally received the Covered Software. Otherwise, You may also choose to use, distribute
or otherwise make the Covered Software available under the terms of any subsequent version of the License published
by the license steward.
4.3. Modified Versions.
When You are an Initial Developer and You want to create a new license for Your Original Software, You may create and
use a modified version of this License if You: (a) rename the license and remove any references to the name of the
license steward (except to note that the license differs from this License); and (b) otherwise make it clear that the license
contains terms which differ from this License.
5. DISCLAIMER OF WARRANTY.
COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN .AS IS. BASIS, WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED
SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING.
THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD
ANY COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY
OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS
DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED
SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
6. TERMINATION.
6.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein
and fail to cure such breach within 30 days of becoming aware of the breach. Provisions which, by their nature, must
remain in effect beyond the termination of this License shall survive.
6.2. If You assert a patent infringement claim (excluding declaratory judgment actions) against Initial Developer or a
Contributor (the Initial Developer or Contributor against whom You assert such claim is referred to as .Participant.)
alleging that the Participant Software (meaning the Contributor Version where the Participant is a Contributor or the
Original Software where the Participant is the Initial Developer) directly or indirectly infringes any patent, then any and
all rights granted directly or indirectly to You by such Participant, the Initial Developer (if the Initial Developer is not the
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
8
Participant) and all Contributors under Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant
terminate prospectively and automatically at the expiration of such 60 day notice period, unless if within such 60 day
period You withdraw Your claim with respect to the Participant Software against such Participant either unilaterally or
pursuant to a written agreement with Participant.
6.3. In the event of termination under Sections 6.1 or 6.2 above, all end user licenses that have been validly granted by
You or any distributor hereunder prior to termination (excluding licenses granted to You by any distributor) shall survive
termination.
7. LIMITATION OF LIABILITY.
UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE),
CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY
DISTRIBUTOR OF COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY
PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER
INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL, WORK STOPPAGE,
COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN
IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF
LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY.S
NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT
ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION
AND LIMITATION MAY NOT APPLY TO YOU.
8. U.S. GOVERNMENT END USERS.
The Covered Software is a .commercial item,. as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of
.commercial computer software. (as that term is defined at 48 C.F.R. º 252.227-7014(a)(1)) and commercial computer
software documentation. as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and
48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Software with
only those rights set forth herein. This U.S. Government Rights clause is in lieu of, and supersedes, any other FAR,
DFAR, or other clause or provision that addresses Government rights in computer software under this License.
9. MISCELLANEOUS.
This License represents the complete agreement concerning subject matter hereof. If any provision of this License is
held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This
License shall be governed by the law of the jurisdiction specified in a notice contained within the Original Software
(except to the extent applicable law, if any, provides otherwise), excluding such jurisdiction.s conflict-of-law provisions.
Any litigation relating to this License shall be subject to the jurisdiction of the courts located in the jurisdiction and venue
specified in a notice contained within the Original Software, with the losing party responsible for costs, including, without
limitation, court costs and reasonable attorneys. fees and expenses. The application of the United Nations Convention
on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the
language of a contract shall be construed against the drafter shall not apply to this License. You agree that You alone
are responsible for compliance with the United States export administration regulations (and the export control laws
and regulation of any other countries) when You use, distribute or otherwise make available any Covered Software.
10. RESPONSIBILITY FOR CLAIMS.
As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly
or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors
to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any
admission of liability.
NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
The code released under the CDDL shall be governed by the laws of the State of California (excluding conflict-of-law
provisions). Any litigation relating to this License shall be subject to the jurisdiction of the Federal Courts of the Northern
District of California and the state courts of the State of California, with venue lying in Santa Clara County, California.
JQuery
Copyright (c) 2011 John Resig, http://jquery.com/
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to
whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
9
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
OpenSSL
LICENSE ISSUES
==============
The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the original SSLeay
license apply to the toolkit. See below for the actual license texts. Actually both licenses are BSD-style Open Source
licenses. In case of any license issues related to OpenSSL please contact openssl-core@openssl.org.
OpenSSL License
--------------/* ====================================================================
* Copyright (c) 1998-2011 The OpenSSL Project. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. All advertising materials mentioning features or use of this
* software must display the following acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
*
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please contact
* openssl-core@openssl.org.
*
* 5. Products derived from this software may not be called "OpenSSL"
* nor may "OpenSSL" appear in their names without prior written
* permission of the OpenSSL Project.
*
* 6. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
*
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
10
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
* ====================================================================
*
* This product includes cryptographic software written by Eric Young
* (eay@cryptsoft.com). This product includes software written by Tim
* Hudson (tjh@cryptsoft.com).
*
*/
Original SSLeay License
----------------------/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
* All rights reserved.
*
* This package is an SSL implementation written
* by Eric Young (eay@cryptsoft.com).
* The implementation was written so as to conform with Netscapes SSL.
*
* This library is free for commercial and non-commercial use as long as
* the following conditions are aheared to. The following conditions
* apply to all code found in this distribution, be it the RC4, RSA,
* lhash, DES, etc., code; not just the SSL code. The SSL documentation
* included with this distribution is covered by the same copyright terms
* except that the holder is Tim Hudson (tjh@cryptsoft.com).
*
* Copyright remains Eric Young's, and as such any Copyright notices in
* the code are not to be removed.
* If this package is used in a product, Eric Young should be given attribution
* as the author of the parts of the library used.
* This can be in the form of a textual message at program startup or
* in documentation (online or textual) provided with the package.
** Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* "This product includes cryptographic software written by
* Eric Young (eay@cryptsoft.com)"
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
11
* The word 'cryptographic' can be left out if the rouines from the library
* being used are not cryptographic related :-).
* 4. If you include any Windows specific code (or a derivative thereof) from
* the apps directory (application code) you must include an acknowledgement:
* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
*
* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* The licence and distribution terms for any publically available version or
* derivative of this code cannot be changed. i.e. this code cannot simply be
* copied and put under another distribution licence
* [including the GNU Public Licence.]
*/
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
12
Contents
About This Guide
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1
Navigating the Web Interface
Setting Up the Controller for the First Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Logging On to the Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
vSCG Web Interface Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Main Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Submenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Sidebar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Content Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Miscellaneous Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Using Widgets on the Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Widgets That You Can Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Client Count Summary Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
AP Status Summary Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Domain Summary Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
System Summary Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Data Throughput Summary Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Client OS Type Summary Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Widget Slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Adding a Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Adding a Widget to a Widget Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Displaying a Widget in a Widget Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Moving a Widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Deleting a Widget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Changing the Administrator Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Logging Off the Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2
Managing Ruckus Wireless AP Zones
Using the Domain Tree and Search Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
3
Working with AP Zones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Creating an AP Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Creating an AP Zone from a ZoneDirector Backup File. . . . . . . . . . . . . . . . . . . . . . . . . 44
Backing Up the ZoneDirector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Restoring ZoneDirector Backup to the Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Cloning an AP Zone from the Domain Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Cloning an AP Zone from the AP Zone List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Viewing Existing AP Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Viewing the AP Zone Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deleting an AP Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Working with AP Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Creating an AP Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Modifying Model Specific Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Supported LLDP Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring the Port Settings of a Particular AP Model . . . . . . . . . . . . . . . . . . . . . . . 56
Designating an Ethernet Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Trunk Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Access Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
General Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Configuring Client Admission Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Working with AAA Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Creating an AAA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Testing an AAA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Deleting an AAA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Working with Hotspot (WISPr) Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Creating a Hotspot Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Deleting a Hotspot Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Working with Guest Access Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Creating a Guest Access Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Viewing Guest Access Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Deleting Guest Access Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Working with Web Authentication Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Adding an AAA Server for the Web Authentication Service . . . . . . . . . . . . . . . . . . . . . . 70
Creating a Web Authentication Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Creating a WLAN for the Web Authentication Service. . . . . . . . . . . . . . . . . . . . . . . . . . 72
Working with Hotspot 2.0 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
About Hotspot 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Hotspot 2.0 Operators and Service Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Creating a Service Provider Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
4
Creating an Operator Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Viewing Existing Hotspot 2.0 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Deleting a Hotspot 2.0 Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Working with WLANs and WLAN Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Creating a WLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Channel Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Client Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Key Points About Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Band Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Working with WLAN Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Notes About WLAN Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Creating a WLAN Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Viewing Existing WLAN Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Deleting WLAN Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Working with WLAN Schedules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Creating a WLAN Schedule Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Working with Device Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Creating a Device Access Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Viewing Device Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Deleting Device Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Working with L2 Access Control Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Creating an L2 Access Policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Viewing L2 Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Deleting L2 Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Working with Bonjour Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Creating a Bonjour Gateway Rule on the AP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Applying a Bonjour Policy to an AP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3
Managing Global Configuration, Tunnel Profiles, Templates, and AP
Registration Rules
Managing Global Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Creating a Soft GRE Tunnel Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Working with Zone Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Creating and Configuring a Zone Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Step 1: Create the Zone Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Step 2: Configure the AP Model-Specific Configuration. . . . . . . . . . . . . . . . . . . . . . 112
Step 3: Configure the AAA Servers of the Zone Template . . . . . . . . . . . . . . . . . . . . 113
Step 4: Configure the Hotspot (WISPr) Services of the Zone Template . . . . . . . . . . 115
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
5
Step 5: Configure the Hotspot 2.0 Services of the Zone Template . . . . . . . . . . . . . 118
Creating a Service Provider Profile for the Zone Template . . . . . . . . . . . . . . . . . . 118
Creating an Operator Profile for the Zone Template . . . . . . . . . . . . . . . . . . . . . . . 119
Step 6: Configure the WLAN Services of the Zone Template . . . . . . . . . . . . . . . . . . 120
Exporting a Zone Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Importing a Zone Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Deleting a Zone Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Working with WLAN Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Creating and Configuring a WLAN Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Step 1: Create the WLAN Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Step 2: Configure the AAA Servers for the WLAN Template . . . . . . . . . . . . . . . . . . 130
Step 3: Configure the Hotspot (WISPr) Services of the WLAN Template . . . . . . . . . 132
Step 4: Configure the Hotspot 2.0 Services of the WLAN Template . . . . . . . . . . . . 134
Creating a Service Provider Profile for the WLAN Template . . . . . . . . . . . . . . . . . 134
Creating an Operator Profile for the WLAN Template . . . . . . . . . . . . . . . . . . . . . . 135
Step 5: Configure the WLAN Services of the WLAN Template. . . . . . . . . . . . . . . . . 137
Viewing Existing WLAN Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Deleting WLAN Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Working with Registration Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Creating a Registration Rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Configuring Registration Rule Priorities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Deleting a Registration Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
4
Managing Access Points
Overview of Access Point Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Viewing a List of Managed Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Provisioning and Swapping Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Options for Provisioning and Swapping APs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Understanding How Swapping Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Editing AP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Editing Swap Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Moving a Single Access Point to a Different AP Zone . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Moving Multiple Access Points to a Different AP Zone. . . . . . . . . . . . . . . . . . . . . . . . . . 155
Deleting an Access Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
5
Configuring Services and Profiles
Configuring RADIUS Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Adding a RADIUS Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Testing the AAA Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
6
Viewing RADIUS Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Deleting a RADIUS Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Configuring FTP Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Important Notes About FTP Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Configuring Location Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Adding an LBS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Configuring the Controller to Use the LBS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Setting an AP Zone to Use an LBS Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Setting an AP Group to Override the LBS Settings of a Zone . . . . . . . . . . . . . . . . . 170
Configuring an SMS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Working with Authentication Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Creating an Authentication Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Viewing Authentication Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Deleting Authentication Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Working with Accounting Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Creating an Accounting Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Viewing Accounting Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Deleting Accounting Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Working with User Traffic Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Creating a User Traffic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Viewing User Traffic Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Deleting Traffic Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
6
Configuring the System Settings
Overview of the System Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Configuring General System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Setting the System Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
How APs Synchronize Time with the Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Configuring the Syslog Server Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Event Severity Levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Default Event Severity to Syslog Priority Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Configuring the Northbound Portal Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Configuring the SMTP Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Configuring the FTP Server Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Setting Critical AP Auto Tagging Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Managing the Web Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Generate a Certificate Signing Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Import the Signed Certificate for HTTPS Communication . . . . . . . . . . . . . . . . . . . . 195
Importing a Self Signed Web Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
7
Viewing the Currently Installed Web Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Managing the AP Portal Certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Generate a Certificate Signing Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Import the Signed Certificate for HTTPS Communication . . . . . . . . . . . . . . . . . . . . 202
Importing a Self Signed Web Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Viewing the Currently Installed AP Portal Certificate. . . . . . . . . . . . . . . . . . . . . . . . . 205
Managing the User Agent Black List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Configuring Cluster Planes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Configuring Control Planes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Physical Interface Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Static Routes Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Configuring a Data Plane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Configuring Cluster Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
How Cluster Redundancy Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Rehoming Managed APs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Configuring Network Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Configuring the SNMPv2 and SNMPv3 Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Enabling Global SNMP Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Configuring the SNMPv2 Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Configuring the SNMPv3 Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Sending SNMP Traps and Email Notifications for Events . . . . . . . . . . . . . . . . . . . . . . 219
Enabling or Disabling Notifications for a Single Event. . . . . . . . . . . . . . . . . . . . . . . . 221
Viewing Enabled Notifications for Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Controlling Access to the Management Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
7
Working with Management Domains
Overview of Management Domains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Viewing a List of Management Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Creating a New Management Domain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Deleting a Management Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
8
Managing Administrator Accounts
Overview of Administrator Accounts and Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Viewing a List of Administrator Accounts, Roles, and RADIUS Servers . . . . . . . . . . . . . 228
Creating an Administrator Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Creating a New Administrator Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Editing an Administrator Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Cloning an Existing Administrator Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Adding a RADIUS Server for Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
8
Using a Backup RADIUS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Testing an AAA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Deleting an Administrator Account, Role, or RADIUS Server . . . . . . . . . . . . . . . . . . . . . 238
9
Managing Mobile Virtual Network Operator Accounts
Overview of Mobile Virtual Network Operator Accounts. . . . . . . . . . . . . . . . . . . . . . . . . 239
Viewing a List of MVNOs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Creating a New MVNO Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Using a Backup RADIUS Server for Authorizing and Authenticating MVNOs . . . . . . . . . 242
Editing an MVNO Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Deleting an MVNO Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
10 Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring AP Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Viewing a Summary of AP Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Exporting the AP Zone List to CSV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Viewing the Configuration of an AP Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Viewing All APs That Belong to an AP Zone on Google Maps . . . . . . . . . . . . . . . . . . 249
Monitoring Managed Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Viewing a Summary of Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Exporting the Access Point List to CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Viewing the Configuration of an Access Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Downloading the Support Log from an Access Point . . . . . . . . . . . . . . . . . . . . . . . . . 255
Restarting an Access Point Remotely. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Running Ping and Traceroute on an Access Point . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Monitoring Wireless Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Viewing a Summary of Wireless Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Exporting the Wireless Client List to CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Viewing Information About a Wireless Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Measuring Wireless Network Throughput with SpeedFlex . . . . . . . . . . . . . . . . . . . . . 262
11 Monitoring the System, Alarms, Events, and Administrator Activity
Monitoring the vSCG System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Viewing the System Cluster Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Starting the Cluster Real-time Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Monitoring Rogue Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Viewing Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Using the Search Criteria Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Exporting the Alarm List to CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
9
Viewing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Using the Search Criteria Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Exporting the Event List to CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Viewing Administrator Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Using the Search Criteria Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Exporting the Administrator Activity List to CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
12 Working with Reports
Types of Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Client Number Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Client Number vs Airtime Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Continuously Disconnected APs Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Failed Client Associations Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
New Client Associations Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
System Resource Utilization Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
TX/RX Bytes Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Creating a New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Step 1: Define the General Report Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Step 2: Define the Resource Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Step 3: Define the Time Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Step 4: Define the Report Generation Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Step 5: Enable Email Notifications (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Step 6: Export the Report to an FTP Server (Optional) . . . . . . . . . . . . . . . . . . . . . . . . 285
Step 7: Save the Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Viewing a List of Existing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Deleting a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
13 Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Working with Local Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Creating a Local User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Editing a Local User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Working with Guest Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
10
Generating Guest Passes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Step 1: Create a Guest Access Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Step 2: Create a Guest Access WLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Step 3: Generate a Guest Pass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Step 4: Send Guest Passes to Guest Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Printing the Guest Pass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Exporting the Guest Pass to CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Sending the Guest Pass via Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Sending the Guest Pass via SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Generating Guest Passes from an Imported CSV . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Viewing the List of Guest Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Deleting Guest Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Creating a Guest Pass Printout Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Working with Remote Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
How Onboarding Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Step 1: Create the Onboarding Guest WLAN for Remote Users . . . . . . . . . . . . . . . 310
Step 2: Create a Standard WLAN with Zero-IT Activation Enabled . . . . . . . . . . . . . 312
Working with User Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Creating a User Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Managing Subscription Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Viewing a List of Subscription Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Creating a Subscription Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Editing a Subscription Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Deleting a Subscription Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
14 Performing Administrative Tasks
Backing Up and Restoring Clusters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Creating a Cluster Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Restoring a Cluster Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Deleting a Cluster Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server. 324
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
What Information Is Backed Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Backing Up to an FTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Restoring from an FTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Backing Up and Restoring System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Creating a System Configuration Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Exporting the Configuration Backup to an FTP Server Automatically . . . . . . . . . . . . . 334
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
11
Downloading a Copy of the Configuration Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Restoring a System Configuration Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Deleting a Configuration Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Resetting a Node to Factory Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
What Happens After Reset to Factory Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Using the Web Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Upgrading the Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Performing the Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Verifying the Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Rolling Back to a Previous Software Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Recovering a Cluster from an Unsuccessful Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . 346
If the Controller Has Local Configuration Backup . . . . . . . . . . . . . . . . . . . . . . . . . . 346
If the Controller Has an FTP Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Working with Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Available System Log Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Downloading All Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Managing Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Default Licenses in the Virtualized SmartCell Gateway . . . . . . . . . . . . . . . . . . . . . . . . 352
Supported License Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
AP Capacity License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Default AP Capacity License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
AP Tunneling Capacity License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Default AP Tunneling Capacity License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Support License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Default Support License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Instance License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Viewing Installed Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Viewing the License Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Configuring the License Server to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Importing a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Downloading a Copy of the Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Synchronizing the Controller with the License Server . . . . . . . . . . . . . . . . . . . . . . . . . 360
A
Statistics Files the Controller Exports to an FTP Server
AP Inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Control Plane Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Mobility Zone Inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Zone Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
12
AP Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Zone Time Radio Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Zone Time WLAN Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
AP Time Radio Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
AP Time WLAN Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Control Plane Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Data Plane Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Data Plane Ethernet Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
AP Soft GRE Tunnel Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Soft GRE Gateway Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Tenant Time Radio Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Tenant Time WLAN Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Tenant Zone Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Tenant Zone Radio Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Tenant Inventory File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
B
Ports to Open for AP-Controller Communication
AP-SCG/SZ/vSCG Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Required Port Forwarding if the vSCG Is Behind NAT . . . . . . . . . . . . . . . . . . . . . . . . . . 397
AP-ZD Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
C
SoftGRE Support
Overview of SoftGRE Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Supported Deployment Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
SoftGRE Packet Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Creating an AP Zone That Supports SoftGRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Monitoring SoftGRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Checking the AP Tunnel Type of a Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Viewing SoftGRE Traffic Statistics of an AP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
SoftGRE SNMP MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
SoftGRE Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
SoftGRE Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
SoftGRE Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Index
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
13
About This Guide
This Administrator Guide describes how to configure the Ruckus Wireless™ SmartCell Gateway™ 200 (vSCG) and how to use the web interface to manage access
points that are reporting to the vSCG (also referred to as “the controller” in this guide).
This guide is written for those responsible for installing and managing network
equipment. Consequently, it assumes that the reader has basic working knowledge
of local area networking, 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 website at
https://support.ruckuswireless.com/documents.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
14
Document Conventions
Document Conventions
Table 1 and Table 2 list the text and notice conventions that are used throughout
this guide.
Table 1.
Text conventions
Convention
Description
monospace
Represents information as it [Device name]>
appears on screen
monospace bold
Represents information that [Device name]> set
ipaddr 10.0.0.12
you enter
default font bold
Keyboard keys, software
buttons, and field names
On the Start menu, click All
Programs.
italics
Screen or page names
Click Advanced Settings.
The Advanced Settings page
appears.
Table 2.
Example
Notice conventions
Notice Type
Description
NOTE
Information that describes important features or instructions
Caution!
Information that alerts you to potential loss of data or potential
damage to an application, system, or device
Warning
Information that alerts you to potential personal injury
Related Documentation
In addition to this Administrator Guide, each Virtualized SmartCell Gateway documentation set includes the following:
• Getting Started Guide: Provides step-by-step instructions on how to set up and
configure the controller out of the box.
• Online Help: Provides instructions for performing tasks using the controller web
interface. The online help is accessible from the web interface and is searchable.
• Release Notes: Provide information about the current software release, including
new features, enhancements, and known issues.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
15
Documentation Feedback
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)
For example:
• Ruckus Wireless Virtualized SmartCell Gateway Administrator Guide (Release
2.5)
• Part number: 800-70500-001
• Page 88
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
16
Navigating the Web Interface
1
In this chapter:
• Setting Up the Controller for the First Time
• Logging On to the Web Interface
• vSCG Web Interface Features
• Using Widgets on the Dashboard
• Changing the Administrator Password
• Logging Off the Web Interface
NOTE: Before continuing, make sure that you have already set up the Virtualized
SmartCell Gateway on the network as described in the Virtualized SmartCell
Gateway Getting Started Guide.
CAUTION! Some of the new features (for example, location based services, rogue
AP detection, force DHCP, and others) that this guide describes may not be visible
on the controller web interface if the AP firmware deployed to the zone you are
configuring is earlier than this release. To ensure that you can view and configure all
new features that are available in this release, Ruckus Wireless recommends
upgrading the AP firmware to the latest version.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
17
Navigating the Web Interface
Setting Up the Controller for the First Time
Setting Up the Controller for the First Time
For information on how to set up the controller for the first time, including instructions
for running and completing the controller’s Setup Wizard, see the Virtualized
SmartCell Gateway Getting Started Guide.
Logging On to the Web Interface
Before you can log on to the controller web interface, you must have the IP address
that you assigned to the Management (Web) interface when you set up the controller
on the network using the Setup Wizard. Once you have this IP address, you can
access the web interface on any computer that can reach the Management (Web)
interface on the IP network.
NOTE: The Virtualized SmartCell Gateway Getting Started Guide describes how to
use the Setup Wizard to set up the controller on the network.
Follow these steps to log on to the controller web interface.
1 On a computer that is on the same subnet as the Management (Web) interface,
start a web browser. Supported web browsers include:
• Google Chrome 30 and later (recommended)
• Safari 6 and later (on Mac OS)
• Safari 5.1.7 and later (on Windows)
• Mozilla Firefox 28 and later
• Internet Explorer 10 and later
2 In the address bar, type the IP address that you assigned to the Management
(Web) interface, and then append a colon and 8443 (the controller’s
management port number) at the end of the address.
For example, if the IP address that you assigned to the Management (Web)
interface is 10.10.101.1, then you should enter:
https://10.10.101.1:8443
NOTE: The controller web interface requires an HTTPS connection. You must
append https (not http) to the management interface IP address to connect to
the web interface. If a browser security warning appears, this is because the default
SSL certificate (or security certificate) that the controller is using for HTTPS
communication is signed by Ruckus Wireless and is not recognized by most web
browsers.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
18
Navigating the Web Interface
Logging On to the Web Interface
The controller web interface logon page appears.
Figure 1. The controller’s logon page
3 Log on to the controller web interface using the following logon details:
• User Name: admin
• Password: {the password that you set when you ran the Setup Wizard}
4 Click Log On.
The web interface refreshes, and then displays the Dashboard, which indicates that
you have logged on successfully.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
19
Navigating the Web Interface
vSCG Web Interface Features
vSCG Web Interface Features
The web interface (shown in Figure 2) is the primary interface that you will use to:
• Manage AP zones, access points, and management domains
• Create and manage administrator and mobile virtual network operator accounts
• Monitor AP zones, managed access points, wireless clients
• View alarms, events, and administrator activity
• Generate reports
• Perform administrative tasks, including backing up and restoring system configuration, upgrading the cluster upgrade, downloading support logs, performing
system diagnostic tests, viewing the statuses of controller processes, and
uploading additional licenses (among others)
• Configure services and profiles for different network elements, packages, and
configurations specific to the controller.
Figure 2. The controller web interface features
Main menu
Sidebar
Submenu
Miscellaneous bar
Content area
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
20
Navigating the Web Interface
vSCG Web Interface Features
The following sections describe the web interface features that are called out in
Figure 2:
• Main Menu
• Submenu
• Sidebar
• Content Area
• Miscellaneous Bar
Main Menu
This is the primary navigation menu. The main menu contains six items:
• Dashboard: The page that loads after you log on, it provides graphical summary
of what is happening on the controller and its managed access points. The
Dashboard uses widgets to display graphical summaries of system statuses,
access point statuses, client count, management domain statuses, etc. For
more information on the Dashboard widgets, see Using Widgets on the Dashboard.
• Monitor: Contains options for viewing information about AP zones, access
points, wireless clients, system information, alarms, events, and administrator
activity.
For more information, see the following chapters:
• Monitoring AP Zones, Access Points, and Wireless Clients
• Monitoring the System, Alarms, Events, and Administrator Activity
• Configuration: Contains options for managing AP zones, access points, system
settings, management domains, administrator accounts and mobile virtual
network administrator accounts.
For more information, see the following chapters:
• Managing Ruckus Wireless AP Zones
• Managing Access Points
• Configuring Services and Profiles
• Managing Subscription Packages
• Configuring the System Settings
• Working with Management Domains
• Managing Administrator Accounts
• Managing Mobile Virtual Network Operator Accounts
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
21
Navigating the Web Interface
vSCG Web Interface Features
• Report: Contains options for generating various types of reports, including
network tunnel statistics and historical client statistics. For more information, see
Working with Reports.
• Identity: Contains options for creating and managing profiles and guest passes.
For more information, see Working with Local, Guest, and Remote Users.
• Administration: Contains options for performing administrative tasks, such as
backing up and restoring the database, upgrading the system, downloading log
files, and performing diagnostic tests. For more information, see Performing
Administrative Tasks.
Submenu
The submenu appears when you hover the mouse pointer over the Main Menu
items. The submenu provides options related to the main menu item on which you
hovered your mouse pointer. For example, submenu items under the Configuration
menu include options for configuring AP zones and access points.
Sidebar
The sidebar, located on the left side of the Content Area, provides additional options
related to the submenu that you clicked. For example, sidebar items under
Configuration > AP Zones include AP zone templates and AP registration rules.
On some pages, the sidebar also includes a tree that you can use to filter the
information you want to show in the Content Area.
Content Area
This large area displays tables, forms, and information that are relevant to submenu
and sidebar items that you clicked.
Miscellaneous Bar
This shows the following information (from left to right):
• System date and time: Displays the current system date and time. This is
obtained by the controller from the NTP time server that has been configured.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
22
Navigating the Web Interface
Using Widgets on the Dashboard
• Management domain link: If there is more than one management domain
configured on the controller, click Administration Domain to display all of the
existing management domains, and then click the management domain to which
you want to switch the web interface. Refer to the following sections for more
information:
• Creating a new management domain (see Working with Management
Domains)
• Adding an administrator account and assigning a role to the account (see
Managing Administrator Accounts)
• Administrator user name: Displays the user name of the administrator that is
currently logged on.
• Administrator role: Displays the administrator role (for example, Super Admin) of
the user that is currently logged on.
• My Account link: Clicking this link displays the following links:
• Change Password link: Click this to change your administrator password.
For more information, see Changing the Administrator Password.
• Preference: Click this link to configure the session timeout settings. In Session
Timeout Settings, type the number of minutes (1 to 1440 minutes) of inactivity
after which the administrator will be logged off of the web interface automatically.
• Log Off link: Click this to log off the controller web interface. For more information,
see Logging Off the Web Interface.
•
: Click this icon to launch the Online Help, which provides information on how
to perform management tasks using the web interface.
Using Widgets on the Dashboard
The dashboard provides a quick summary of what is happening on the controller
and its managed access points. It uses widgets to display at-a-glance information
about managed access points, AP zones, management domains, client count,
domain summary, and system summary, among others.
This section describes the widgets that you can display and how to add, move, and
delete widgets from the dashboard.
NOTE: To refresh the information on each widget, click
upper-right corner of the widget.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
(refresh button) on the
23
Navigating the Web Interface
Using Widgets on the Dashboard
Widgets That You Can Display
There are six types of dashboard widgets that the controller supports. These include:
• Client Count Summary Widget
• AP Status Summary Widget
• Domain Summary Widget
• System Summary Widget
• Data Throughput Summary Widget
• Client OS Type Summary Widget
Client Count Summary Widget
The client count summary widget displays a graph of the number of wireless clients
that are associated with access points that the controller is managing. You can
display client count based on the management domain, AP zone, or SSID.
The client count summary widget requires two widget slots.
Figure 3. The client count summary widget
AP Status Summary Widget
The AP status summary widget includes a pie chart that shows the connection
status of managed APs that belong to either a management domain or an AP zone.
You can configure the pie chart to show access point data based on their connection
status, model, and mesh role.
The AP status summary widget requires one widget slot.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
24
Navigating the Web Interface
Using Widgets on the Dashboard
Figure 4. The AP status summary widget
Domain Summary Widget
The domain summary widget displays details about the AP zones and access points
that belong to the selected management domain. It shows the AP zones that belong
to the management domain, the total number of APs (including their current
connection status and mesh status), and current number of clients.
The domain summary widget requires two widget slots.
Figure 5. The domain summary widget
System Summary Widget
The system summary widget displays information about the controller system,
including the name and version of the cluster, the number and software versions of
the control planes and data planes that are installed, and the Wi-Fi controller licenses
(consumed versus total).
The system summary widget requires one widget slot.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
25
Navigating the Web Interface
Using Widgets on the Dashboard
Figure 6. The system summary widget
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
26
Navigating the Web Interface
Using Widgets on the Dashboard
Data Throughput Summary Widget
The data throughput summary widget displays a graph of TX and RX throughputs
(in Mbps) based on either AP zone or SSID.
The data throughput summary widget requires two widget slots.
Figure 7. The data throughput summary widget
Client OS Type Summary Widget
The client operating system (OS) type summary widget displays a pie chart that
shows the types of OS that associated wireless clients are using.
The client OS type summary widget requires one widget slot.
NOTE: The default refresh interval for the Client OS Type Summary widget is 15
minutes. When you add the widget, you can configure this refresh interval to any
value between 1 and 30 minutes.
Figure 8. The client OS type summary widget
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
27
Navigating the Web Interface
Using Widgets on the Dashboard
Widget Slots
The controller provides nine slots on the dashboard for placing widgets. Figure 9
marks these nine slots on the dashboard.
Note that some widgets are wider (for example, the client count summary and data
throughput widgets) and require two widget slots. Make sure that there are enough
empty slots on the dashboard before you add or move a widget.
Figure 9. There are nine slots for widgets on the dashboard
1
2
3
4
5
6
7
8
9
Adding a Widget
Follow these steps to add a widget to the dashboard.
1 Click the icon in the upper-left corner of the page (below the Ruckus Wireless
icon). The icons for adding widgets appear (see Table 1).
Table 1.
Icon
Icons for adding widgets
Widget Name
Client count summary widget
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
28
Navigating the Web Interface
Using Widgets on the Dashboard
Table 1.
Icon
Icons for adding widgets
Widget Name
AP status summary widget
Domain summary widget
System summary widget
Data throughput summary widget
Client OS type summary widget
2 Click the icon for the widget that you want to add. A configuration form, which
contains widget settings that you can configure, appears.
3 Configure the widget settings.
4 Click OK. The page refreshes, and then the widget that you added appears on
the dashboard.
You have completed adding a widget. To add another widget, repeat the same
procedure.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
29
Navigating the Web Interface
Using Widgets on the Dashboard
Figure 10. The configuration form for the Client Count Summary widget
Adding a Widget to a Widget Slot
A single widget slot can contain multiple widgets of the same size (one-slot widgets
versus two-slot widgets). For example, you can add the client count summary
widget and data throughput widget (both are two-slot widgets) to the same widget
slot.
Follow these steps to add a widget to a widget slot.
1 Locate an existing widget slot to which you want to add a widget.
2 Click the
icon that is on the upper-right hand corner of the widget slot. A
submenu appears and displays the widgets that you can add to the widget slot.
3 Click the name of the widget that you want to add to the widget slot. The widget
configuration window appears.
NOTE: You can only add a widget once. If a widget already exists in a different
widget slot, you will be unable to add it to another widget slot.
4 Configure the information that you want the widget to display and the interval at
which to refresh the information on the widget.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
30
Navigating the Web Interface
Using Widgets on the Dashboard
NOTE: The refresh intervals for the client count summary and data throughput
summary widgets are non-configurable.
5 Click OK. The widget slot refreshes, and then the widget that you added appears.
You have completed adding a widget to a widget slot.
Figure 11. Click the name of the widget that you want to add to the widget slot
Displaying a Widget in a Widget Slot
A widget slot that contains multiple widgets automatically cycles through the
different widgets that have been added to it at one-minute intervals. If you want to
view a specific widget in a widget slot, you can manually display it.
Follow these steps to display a widget that belongs to a widget slot manually.
1 Locate the widget slot that contains the widget that you want to display.
2 Click the
icon that is on the upper-right hand corner of the widget slot. A
submenu appears and displays the widgets that have been added to the widget
slot.
3 Click the name of the widget that you want to display. The widget slot refreshes,
and the widget that you clicked appears.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
31
Navigating the Web Interface
Using Widgets on the Dashboard
You have completed displaying a widget in a widget slot.
Figure 12. Click the name of the widget that you want to display
Moving a Widget
Follow these steps to move a widget from one widget slot to another.
1 Make sure that there are sufficient slots for the widget that you want to move.
2 Hover your mouse pointer on the title bar of the widget. The pointer changes
into a four-way arrow.
3 Click-and-hold the widget, and then drag it to the empty slot to which you want
to move it.
4 Release the widget.
You have completed moving a widget to another slot.
Deleting a Widget
Follow these steps to delete a widget.
1 Locate the widget that you want to delete.
2 Click the
icon that is on the upper-right hand corner of the widget. A
confirmation message appears.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
32
Navigating the Web Interface
Changing the Administrator Password
3 Click OK to confirm.
The dashboard refreshes, and then the widget that you deleted disappears from
the page.
Click OK to confirm that you want to delete this widget
Figure 13. Click Yes to delete the widget
Changing the Administrator Password
Follow these steps to change the administrator password.
1 On the Miscellaneous Bar, click Change Password. The Change Password form
appears.
2 In Old Password, type your current password.
3 In New Password, type the new password that you want to use.
4 In Confirm Password, retype the new password above.
5 Click Change.
You have completed changing your administrator password. The next time you log
on to the controller, remember to use your new administrator password.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
33
Navigating the Web Interface
Logging Off the Web Interface
Figure 14. The Change Password form
Logging Off the Web Interface
Follow these steps to log off the web interface.
1 On the Miscellaneous Bar, click Log Off. A confirmation message appears.
2 Click Yes. The controller logs you off the web interface. The logon page appears
with the following message above the Ruckus Wireless logo:
Log off successful
You have completed logging off the web interface.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
34
Navigating the Web Interface
Logging Off the Web Interface
Figure 15. The message “Log off successful” indicates that you have successfully logged off
the web interface
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
35
Managing Ruckus Wireless AP
Zones
2
In this chapter:
• Using the Domain Tree and Search Boxes
• Creating an AP Zone
• Working with AP Groups
• Working with AAA Servers
• Working with Hotspot (WISPr) Services
• Working with Guest Access Services
• Working with Web Authentication Services
• Working with Hotspot 2.0 Services
• Working with WLANs and WLAN Groups
• Working with WLAN Schedules
• Working with Device Policies
• Working with L2 Access Control Policies
• Working with Bonjour Policies
An AP zone functions as a way of grouping Ruckus Wireless APs and applying a
particular set of settings (including WLANs and their settings) to these groups of
Ruckus Wireless APs. Each AP zone can include up to six WLAN services.
By default, an AP zone named Staging Zone exists. Any AP that registers with the
controller that is not assigned a specific zone is automatically assigned to the
Staging Zone. This section describes how to use AP zones to manage devices.
NOTE: When an AP is assigned or moved to the Staging Zone, the cluster name
becomes its user name and password after the AP shows up-to-date state. If you
need to log on to the AP, use the cluster name for the user name and password.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
36
Managing Ruckus Wireless AP Zones
Using the Domain Tree and Search Boxes
NOTE: Before creating an AP zone, Ruckus Wireless recommends that you first
set the default country code on the Global Configuration page. This will help ensure
that each new AP zone will use the correct country code. For information on how
to set the default country code, see Managing Global Configuration.
Using the Domain Tree and Search Boxes
Clicking Configuration > AP Zones on the main menu displays a sidebar on the left
side of the page, which includes the domain tree and search boxes.
The domain tree displays the management domains ( ) and AP zones ( ) that
are under Administration Domain. Clicking a domain icon in the tree displays the AP
zones that belong to it in the content area. Clicking an AP zone icon, on the other
hand, displays detailed information about the AP zone, including its general information, AAA server configuration, and hotspot configuration.
Below the domain tree are search boxes that you can use to search for AP zones,
access points, and wireless clients. Each search box is labeled with the search
parameters that it accepts. For example, you can type an AP firmware version
number in the first search box.
NOTE: Search criteria are case-sensitive.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
37
Managing Ruckus Wireless AP Zones
Working with AP Zones
Figure 16. The domain tree and search boxes
Domain tree
Search boxes
Working with AP Zones
• Creating an AP Zone
• Viewing Existing AP Zones
• Viewing the AP Zone Configuration
• Deleting an AP Zone
Creating an AP Zone
NOTE: If you are planning to use Soft GRE tunneling for this AP zone, you must
first create a Soft GRE tunnel profile before creating the AP zone. For instructions
on how to create a Soft GRE tunnel profile, see Creating a Soft GRE Tunnel Profile.
Follow these steps to create an AP zone.
1 Click Configuration > AP Zones.
2 Click Create New. The form for creating a new AP zone appears.
3 Configure General Options.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
38
Managing Ruckus Wireless AP Zones
Working with AP Zones
• Zone Name: Type a name that you want to assign to this new zone.
• Description: Type a description for this new zone. This is an optional field.
• AP Firmware: Select the AP firmware version that you want the AP zone to
use. By default, the latest AP firmware available on the controller is selected.
• Country Code: Select the country in which you are operating the access
points. Different countries and regions maintain different rules that govern
which channels can be used for wireless communications. Setting the
country code to the proper regulatory region helps ensure that the wireless
network does not violate local and national regulatory restrictions.
• AP Admin Logon: Specify the user name and password that administrators
can use to log on directly to the managed access point’s native web interface.
The following boxes are provided:
-
Logon ID: Type the admin user name.
-
Password: Type the admin password.
• Time Zone: Specify the time zone that you want this AP zone to use by clicking
one of the following options:
-
System defined: Click this option, and then select a time zone that you
want to use.
-
User defined: Click this option, and then define the time zone settings
(including the time zone abbreviation, GMT offset, and daylight saving
time settings) that you want to use.
4 Configure Mesh Options.
• Enable: Select the Enable mesh networking in this zone check box if you
want managed devices that belong to this zone to be able to form a mesh
network automatically. When this check box is selected, the following two
options are visible:
-
Mesh Name (ESSID): Type a name for the mesh network. Alternatively,
do nothing to accept the default mesh name that the controller generates.
-
Mesh Passphrase: Type a passphrase that contains at least 8 characters.
This passphrase will be used by the controller to secure the traffic between
mesh APs. Alternatively, click do nothing to accept the passphrase that
the controller has generated. To generate a new random passphrase with
64 characters or more, click Generate.
5 Configure Radio Options.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
39
Managing Ruckus Wireless AP Zones
Working with AP Zones
• Channelization: Select the channel widths for Radio b/g/n (2.4GHz) and
Radio a/n (5GHz). Options include Auto, 20, 40, and 80 (80 is only available
on the 5GHz radio).
• Channel: Select the channel numbers to use for Radio b/g/n (2.4GHz) and
Radio a/n (5GHz). Select Auto to automatically assign a radio channel or
select a specific channel number to manually assign it to a radio.
• Tx Power Adjustment: Select the preferred TX power for each radio, if you
want to manually configure the transmit power on the 2.4GHz and 5GHz
radios. By default, TX power is set to Full on both the 2.4GHz and 5GHz
radios.
6 Configure AP GRE Tunnel Options.
• Tunnel Type: Select a protocol to use for tunneling WLAN traffic back to the
controller. Options include No Tunneled and Soft GRE.
7 Configure Syslog Options.
• To send events related to APs in this zone to an external syslog server, select
the Enable external syslog server for APs in this zone check box.
Additional options appear below.
• Server Address: Type the IP address of the syslog server on the network.
• Port: Type the syslog port number on the server.
• Facility: Select the facility level that will be used by the syslog message.
Options include Local0 (default), Local1, Local2, Local3, Local4, Local5,
Local6, and Local7.
• Priority: Select the lowest priority level for which events will be sent to the
syslog server. For example, to only receive syslog messages for events with
the warning (and higher) priority, select Warning. To receive syslog messages
for all events, select All.
8 Configure Advanced Options.
• Channel Mode: If you want to allow outdoor APs that belong to this zone to
use wireless channels that are regulated as indoor-use only, select the Allow
indoor channels check box. For more information, see Channel Mode.
• Background Scanning: If you want APs to evaluate radio channel usage
automatically, enable and configure the background scanning settings on
both the 2.4GHz and 5GHz radios. By default, background scanning is
enabled on both radios and is configured to run every 20 seconds.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
40
Managing Ruckus Wireless AP Zones
Working with AP Zones
• Smart Monitor: To disable the WLANs of an AP (that belongs to this zone)
whenever the AP uplink or Internet connection becomes unavailable, select
the Enable check box. And then, configure the following options:
-
Health Check Interval: Set the interval (between 5 and 60 seconds) at
which the AP will check its uplink connection. The default value is 10
seconds.
-
Health Check Retry Threshold: Set the number of times (between 1 and
10 times) that the AP will check its uplink connection. If the AP is unable
to detect the uplink after the configured number of retries, the AP will
disable its WLANs. The default value is 3 retries.
NOTE: When the AP disables its WLANs, the AP creates a log for the event. When
the AP’s uplink is restored, it sends the event log (which contains the timestamp
when the WLANs were disabled, and then enabled) to the vSCG.
• Rogue AP Detection: Select the Report rogue access points check box to
enable rogue device detection in logs and email alarm event notifications.
-
Report all rogue devices: Send alerts for all rogue AP events.
-
Report only malicious rogue devices of type: Select which event types
to report. Events include SSID spoofing, same network, and MAC
spoofing.
-
Protect the network from malicious rogue access points: Select this
check box to automatically protect your network from network connected
rogue APs, SSID-spoofing APs and MAC-spoofing APs. When one of
these rogue APs is detected (and this check box is enabled), the Ruckus
Wireless AP automatically begins sending broadcast de-authentication
messages spoofing the rogue’s BSSID (MAC) to prevent wireless clients
from connecting to the malicious rogue AP. This option is disabled by
default.
• Client Load Balancing: Improve WLAN performance by enabling load
balancing. Load balancing spreads the wireless client load between nearby
access points, so that one AP does not get overloaded while another sites
idle. Load balancing must be enabled on a per-radio basis. To enable load
balancing, select the Enable loading balancing on [2.4GHz or 5GHz] check
box, and then set or accept the default Adjacent Radio Threshold (50dB for
the 2.4GHz radio and 43dB for the 5GHz radio).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
41
Managing Ruckus Wireless AP Zones
Working with AP Zones
• Band Balancing: Client band balancing between the 2.4GHz and 5GHz radio
bands is disabled by default on all WLANs. To enable band balancing for this
WLAN, select the Enable band balancing on radios by distributing the
clients on 2.4GHz and 5GHz bands check box, and then set the percentages of client load that will be distributed between the 2.4GHz and 5Ghz
bands. For more information, see Band Balancing.
• Location Based Service: To enable LBS service for this AP zone, select the
Enable LBS Service check box, and then select an LBS server to use from
the drop-down list. For information on how to add an LBS server to the
controller, see Configuring Location Services.
• Client Admission Control: Set the load thresholds on the AP at which it will
stop accepting new clients. See Configuring Client Admission Control.
• AP Reboot Timeout: Set the time after which the AP will reboot automatically
when it is unable to reach the default gateway or the control interface.
-
Reboot AP if it cannot reach default gateway after: Set the time after which
the AP will reboot if it is unable to communicate with the default gateway.
The default timeout is 30 minutes.
-
Reboot AP if it cannot reach vSCG Carrier after: Set the time after which
the AP will reboot if it is unable to communicate with the vSCG. The default
timeout is 2 hours.
9 Click Apply to finish creating your first AP zone. When the controller completes
creating the AP zone, the following confirmation message appears:
AP zone created successfully. Do you want to view the
configuration details?
10 Click Yes to view the AP zone details, or click No to close the confirmation
message and return to the AP zone list.
You have completed creating your first AP zone. You can create additional AP zones
as needed.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
42
Managing Ruckus Wireless AP Zones
Working with AP Zones
Figure 17. The top half of the Create New AP Zone form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
43
Managing Ruckus Wireless AP Zones
Working with AP Zones
Creating an AP Zone from a ZoneDirector Backup File
If your organization was previously using Ruckus Wireless ZoneDirector to manage
access points on the network and you are in the process of migrating to the
controller, you can easily migrate access point management to the controller by
creating an AP zone from the ZoneDirector backup file.
When you import a ZoneDirector backup file to the controller, note that only access
points that are already approved to join ZoneDirector will be migrated to the
controller. Access points that do not have the Approved status will be ignored.
Additionally, if an access point that already exists in the controller also exists in the
ZoneDirector backup file, the access point will be transferred automatically from its
current AP zone to the new AP zone.
This section covers:
• Backing Up the ZoneDirector
• Restoring ZoneDirector Backup to the Controller
NOTE: The controller supports RADIUS for AAA management. If a WLAN or hotspot
in the ZoneDirector backup file is configured to use a non-RADIUS AAA server (for
example, Active Directory, LDAP, or local database), that WLAN or hotspot will not
be migrated to the controller. For information on the authentication methods that
the controller and ZoneDirector support, see the Authentication Options section in
Table 42.
Backing Up the ZoneDirector
Follow these steps to create a ZoneDirector backup.
1 Go to Administer > Back up.
2 In the Backup Configuration section, click Back Up. The File Download dialog
box appears.
3 Click Save. The Save As dialog box appears.
4 Type a name for the backup file, and then select a location where you want to
save it.
5 Verify that the file name ends with .bak extension.
6 Click Save. The Download Complete dialog box appears.
7 Click Close.
You have completed backing up ZoneDirector.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
44
Managing Ruckus Wireless AP Zones
Working with AP Zones
Figure 18. The ZoneDirector backup page
Restoring ZoneDirector Backup to the Controller
Follow these steps to restore the ZoneDirector backup to the controller.
1 Copy the ZoneDirector backup file to a location (local computer or network) that
you can access from the controller web interface.
2 Log on to the controller web interface, and then go to Configuration > AP Zones.
The AP Zone List page appears.
3 Click Create New from ZD Backup. The Create New AP Zone from ZD Backup
File dialog box appears.
4 In AP Firmware, select the firmware that you want the new zone to use.
5 In AP Admin Logon ID, set the user name that administrators can use to log on
directly to the managed access points’ native web interface.
6 In AP Admin Password, set the password for the AP administrator logon ID.
NOTE: The password must be at least eight characters and must consist of at least
one number, one letter, and one special character (for example, !, #, $, %, &, or ?).
7 In ZoneDirector Backup File, click Browse, and then go to the location where
you copied the backup file.
8 Select the backup file (with .bak extension), and then click Open.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
45
Managing Ruckus Wireless AP Zones
Working with AP Zones
9 Click Apply. A progress bar appears as the controller imports the ZoneDirector
backup file and creates an AP zone. When the process is complete, the following
confirmation message appears:
AP zone created successfully. Do you want to view the zone
configuration details?
10 Click Yes to view the zone configuration, or click No to close the confirmation
message and stay on the current page.
11 Verify that an AP zone that uses the system name of the ZoneDirector that you
backed up appears in the AP zone list. For example, if the ZoneDirector system
name is “ZDMain”, look for an AP zone named ZDMain. This is the AP zone that
you created from the ZoneDirector backup file.
You have completed creating a new AP zone from a ZoneDirector backup file.
NOTE: There are a few minor features that the controller supports but ZoneDirector
does not (and vice versa). Because of these differences in features, migrated AP
zones and access points may not have some of the features that they had previously.
For more information on what features are available in AP zones and access pointed
after migration, see ZoneDirector to SmartCell Gateway Migration: Features Matrix.
Figure 19. The Create New AP Zone from ZD Backup File dialog box
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
46
Managing Ruckus Wireless AP Zones
Working with AP Zones
Cloning an AP Zone from the Domain Tree
Cloning an AP zone enables you to copy the configuration of an existing zone and
save it as a new zone. If you need to create an AP zone with configuration settings
that are similar to an existing AP zone, cloning that existing AP zone would be the
easiest way to do it.
Follow these steps to clone an AP zone.
1 Go to Configuration > AP Zones.
2 In the domain tree, find the AP zone that you want to clone.
3 Click Clone. A form appears and prompts you for the name that you want to
assign to the cloned zone. The default name is Clone of {Original Zone Name}.
4 Edit the AP zone name or leave it as is.
5 Click OK to finish cloning the AP zone.
Figure 20. Click the Clone button to save the AP zone as a new zone
Cloning an AP Zone from the AP Zone List
Another method to save an existing AP zone as a new zone is by cloning it from the
AP Zone List page. Follow these steps to clone an AP zone from the AP Zone List
page.
1 Go to Configuration > AP Zones.
2 On the AP Zones List page, find the AP zone that you want to clone.
3 Click the action icon
that is in the same row as the AP zone name.
4 A form appears and prompts you for the name that you want to assign to the
cloned zone. The default name is Clone_of_{Original Zone Name}.
5 Edit the AP zone name or leave it as is.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
47
Managing Ruckus Wireless AP Zones
Working with AP Zones
6 Click Apply. The page refreshes, and then the AP zone that you cloned appears
in the AP Zone List.
You have completed cloning an AP zone from the AP zone list.
Figure 21. A form prompts you for the name that you want to assign to the cloned zone
Viewing Existing AP Zones
Follow these steps to view a list of existing AP zones.
1 Go to Configuration > AP Zones. The AP Zone List page appears and displays
a list of existing AP zones.
2 To view the configuration of a specific zone, locate the zone whose details you
want to view on the AP Zone List page.
3 Under the Zone Name column, click the AP zone name.
The page refreshes and displays the AP zone configuration page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
48
Managing Ruckus Wireless AP Zones
Working with AP Zones
Figure 22. The AP Zone List page
Viewing the AP Zone Configuration
Follow these steps to view a summary of the AP zone configuration.
1 Go to Configuration > AP Zones.
2 On the AP Zone List page, click the name of the AP zone that you want to view.
The Zone Configuration page for the AP zone appears and displays as summary of
the AP zone configuration.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
49
Managing Ruckus Wireless AP Zones
Working with AP Zones
Figure 23. The Zone Configuration page displays a summary of the zone settings
The following buttons and options also appear on the page:
• Edit: Click to edit the AP zone configuration.
• Clone: Click to clone this AP zone.
• Move: Click to move this AP zone from its current management domain to
another.
• Delete: Click to delete this AP zone.
If you want to override the AP zone settings for specific AP models, configure the
AP Model-Specific Configuration section at the bottom of the page (see Modifying
Model Specific Controls for more information).
Deleting an AP Zone
Deleting an AP zone that contains managed devices will automatically move those
devices to the Staging Zone (default zone). Before deleting an AP zone, Ruckus
Wireless recommends moving devices that belong to that zone to another zone.
Follow these steps to delete an AP zone.
1 Go to Configuration > AP Zones.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
50
Managing Ruckus Wireless AP Zones
Working with AP Groups
2 In the domain tree, select the AP zone that you want to delete.
3 Click the Delete Selected button. A confirmation message appears.
4 Click OK to finish deleting the AP zone.
You have completed deleting an AP zone service.
NOTE Ensure that all the AP's associated to that zone needs to be deleted before
deleting the AP Zone.
Working with AP Groups
AP (access point) groups can be used to define configuration options and apply
them to groups of APs at once, without having to modify each AP’s settings
individually.
For each group, administrators can create a configuration profile that defines the
channels, radio settings, Ethernet ports and other configurable fields for all members
of the group or for all APs of a specific model in the group.
AP groups are similar to WLAN groups (see Working with WLAN Groups for more
information). While WLAN groups can be used to specify which WLAN services are
served by which APs, AP groups are used for more specific fine-tuning of how the
APs themselves behave.
NOTE: AP group configuration settings can be overridden by individual AP settings.
For example, if you want to set the transmit power to a lower setting for only a few
specific APs, leave the Tx Power Adjustment at Auto in the AP group configuration
page, then go to the individual AP configuration page (Configuration > Access Points
> Edit [AP MAC address]) and set the Tx Power setting to a lower setting.
Creating an AP Group
Follow these steps to create an AP group.
1 Go to Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone name within which you want to
create the AP group. The page refreshes, and the AP Zone submenu appears
on the sidebar.
3 On the sidebar, click AP Groups.
4 Click Create New. The Create New AP Groups form appears.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
51
Managing Ruckus Wireless AP Zones
Working with AP Groups
5 In General Settings, configure the following:
• Name: Type a name for this AP group.
• Description: Type a description for this AP group.
6 In Group Members, configure the following:
• Members: When you are creating a new AP group, this section will be empty.
This will be populated after you select the access points that you want to
belong to this AP group.
• Access Points: This section shows all the access points that currently belong
to the AP zone. Select the check boxes before the Member column (which
shows the AP MAC addresses) of each AP that you want to add to the AP
group, and then click Add to Group. The APs you selected appear under
the Members section.
7 In Radio Options, select the Override zone config check box for the AP zone
settings that you want to override, and then configure the following for both the
2.4GHz and 5GHz radios:
• Channelization: Select Auto, 20MHz or 40MHz channel width for either the
2.4GHz or 5GHz radio.
• Channel: Select Auto or manually assign a channel for the 2.4GHz or 5GHz
radio.
• TX Power: Set the transmit power on all 2.4GHz or 5GHz radios (default is
Auto).
• WLAN Group: Specify to which WLAN group this AP group belongs.
8 In Model Specific Options, configure LED, LLDP, and port settings of all APs of
each specific model that are members of the AP group. See Modifying Model
Specific Controls.
9 In Advanced Options, select the Override zone config check boxes for the
settings that you want to override, and then configure them.
• Location Based Service: To disable the LBS service for this AP group, clear
the Enable LBS service check box. To use a different LBS server for this AP
group, select the Enable LBS service check box, and then select the LBS
server that you want to use from the drop-down list.
• Client Admission Control: Set the load thresholds on the AP at which it will
stop accepting new clients. See Configuring Client Admission Control.
10 Click OK.
You have completed creating an AP group.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
52
Managing Ruckus Wireless AP Zones
Working with AP Groups
Figure 24. The Create New AP Group form
Modifying Model Specific Controls
The following settings can be applied to all APs of a particular model that are
members of the AP group:
• Internal Heater: Enable internal heaters (specific AP models only).
NOTE: For the internal heater to be operational, ZoneFlex 7762 APs must be
powered by the supplied PoE injector and its associated power adapter or a
standard 802.3at PSE. For the PoE Out port to be operational, ZoneFlex 7762 APs
must be powered by the supplied PoE injector and its associated power adapter.
• PoE Out Ports: Enable PoE out ports (specific ZoneFlex AP models only).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
53
Managing Ruckus Wireless AP Zones
Working with AP Groups
NOTE: If the controller country code is set to United Kingdom, an additional “Enable
5.8 GHz Channels” option will be available for outdoor 11n/11ac APs. Enabling this
option allows the use of restricted C-band channels. These channels are disabled
by default and should only be enabled by customers with a valid license to operate
on these restricted channels.
• Status LEDs: When managed by the controller, you can disable the external LEDs
on certain ZoneFlex models, such as the 7300 series APs. This can be useful if
your APs are installed in a public location and you do not want to draw attention
to them.
• External Antenna: External antenna configuration is available for the 5 GHz radio
on the ZoneFlex 7762, and for the 2.4 and 5 GHz radios on the 7782-E APs.
Once enabled, enter a gain value in the range of 0 to 90dBi.
• Radio Band: (This setting applies to the ZoneFlex 7321, 7321-u, and 7441 APs
only) Select 2.4 GHz or 5 GHz radio band for the 7441/7321/7321-u APs.
• LLDP: To enable the AP model to advertise its identity and capabilities on the
local network via LLDP, select the Enable Link Layer Discovery Protocol check
box. For a list of attributes that APs advertise using LLDP, see Supported LLDP
Attributes.
• Advertise Interval (1-300 seconds): Set the interval (in seconds) at which the
AP model will send out LLDP information. The default value is 30 seconds.
• Hold Time (60-1200 seconds): Set the length of time (in seconds) that a
receiving device will hold the LLDP information sent by the selected AP model
before discarding it. The default value is 120 seconds.
• Management IP TLV: To include the management IP address TLV in the LLDP
information that the AP model sends out, select Enable check box.
• Port Settings: For information on how to configure the port settings, see
Configuring the Port Settings of a Particular AP Model.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
54
Managing Ruckus Wireless AP Zones
Working with AP Groups
Figure 25. The AP Model-Specific Configuration section
Supported LLDP Attributes
The Link Layer Discovery Protocol (LLDP) is a vendor-neutral Layer 2 protocol that
allows a network device (for example, a Ruckus Wireless AP) to advertise its identity
and capabilities on the local network.
LLDP information is sent by devices from each of their interfaces at a fixed interval
(default is 30 seconds), in the form of an Ethernet frame. Each LLDP Ethernet frame
contains a sequence of type-length-value (TLV) structures starting with Chassis ID,
Port ID and Time to Live (TTL) TLV. Table 2 lists the LLDP attributes supported by
the controller.
Table 2.
LLDP attributes supported by the controller
Attribute (TLV)
Description
Chassis ID
Indicates the MAC address of the AP’s br0 interface
Port ID
Identifies the port from which the LLDP packet was sent
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
55
Managing Ruckus Wireless AP Zones
Working with AP Groups
Table 2.
LLDP attributes supported by the controller
Attribute (TLV)
Description
Time to Live
Same as LLDP Hold Time. Indicates the length of time (in
seconds) that a receiving device will hold the LLDP information
sent by the selected AP model before discarding it. The default
value is 120 seconds.
System Name
Indicates the name assigned to the AP. The default name of
Ruckus Wireless APs is RuckusAP.
System Description
Indicates the AP model plus software version
System Capabilities
Indicates the AP’s capabilities (Bridge, WLAN AP, Router,
Docsis), and which capabilities are enabled
Management Address Indicates the management IP address of the AP
Port Description
Indicates the description of the port in alphanumeric format
Configuring the Port Settings of a Particular AP Model
Use Port Settings in the AP Model-Specific Configuration section to configure the
Ethernet ports of a particular AP model.
Follow these steps to configure the port settings of a certain AP model.
1 All ports are enabled by default (the Enable check boxes are all selected). To
disable a particular port entirely, clear the Enable check box next to the port
name (LAN1, LAN2, etc.)
2 For any enabled ports, you can choose whether the port will be used as a Trunk
Port, Access Port, or General Port.
The following restrictions apply:
• All APs must be configured with at least one Trunk Port.
• For single port APs, the single LAN port must be a trunk port and is therefore
not configurable.
• For the H500 AP and ZoneFlex 7025/7055 APs, the LAN5/Uplink port on the
rear of the AP is defined as a Trunk Port and is not configurable. The four
front-facing LAN ports are configurable.
• For all other APs, you can configure each port individually as either a Trunk
Port, Access Port, or General Port. See Designating an Ethernet Port Type
for more information.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
56
Managing Ruckus Wireless AP Zones
Working with AP Groups
Figure 26. The Port Settings section
Designating an Ethernet Port Type
Ethernet ports can be configured as one of the following port types:
• Trunk Ports
• Access Ports
• General Ports
Trunk links are required to pass VLAN information between switches. Access ports
provide access to the network and can be configured as members of specific
VLANs, thereby separating the traffic on these ports from traffic on other VLANs.
General ports are user-defined ports that can have any combination of up to 20
VLAN IDs assigned.
For most ZoneFlex APs, you can set which ports you want to be your Access, Trunk
and General Ports from the controller web interface, as long as at least one port on
each AP is designated as a Trunk Port.
By default, all ports are enabled as Trunk Ports with Untag VLAN set as 1 (except
for ZoneFlex 7025, whose front ports are enabled as Access Ports by default). If
configured as an Access Port, all untagged ingress traffic is the configured Untag
VLAN, and all egress traffic is untagged. If configured as a Trunk Port, all untagged
ingress traffic is the configured Untag VLAN (by default, 1), and all VLAN-tagged
traffic on VLANs 1-4094 will be seen when present on the network.
The default Untag VLAN for each port is VLAN 1. Change the Untag VLAN to:
• Segment all ingress traffic on this Access Port to a specific VLAN.
• Redefine the native VLAN on this Trunk Port to match your network configuration.
Trunk Ports
Trunking is a function that must be enabled on both sides of a link. If two switches
are connected together, for example, both switch ports must be configured as trunk
ports. The Trunk Port is a member of all the VLANs that exist on the AP/switch and
carries traffic for all those VLANs between switches.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
57
Managing Ruckus Wireless AP Zones
Working with AP Groups
Access Ports
All Access Ports are set to Untag VLAN 1 by default. This means that all Access
Ports belong to the native VLAN and are all part of a single broadcast domain. To
remove ports from the native VLAN and assign them to specific VLANs, select
Access Port and enter any valid VLAN ID in the VLAN ID field (valid VLAN IDs are
2-4094).
The following table describes the behavior of incoming and outgoing traffic for
Access Ports with VLANs configured.
Table 3.
Access Ports with VLANs configured
VLAN Settings
Incoming Traffic (from Client) Outgoing Traffic (to Client)
Access Port, Untag
VLAN 1
All incoming traffic is native
VLAN (VLAN 1).
Access Port, Untag
All incoming traffic is sent to the Only traffic belonging to the
VLANs specified.
specified VLAN is forwarded.
All other VLAN traffic is
dropped.
VLAN [2-4094]
All outgoing traffic on the port
is sent untagged.
General Ports
General ports are user-specified ports that can have any combination of up to 20
VLAN IDs assigned. Enter multiple valid VLAN IDs separated by commas or a range
separated by a hyphen.
Configuring Client Admission Control
Client admission control allows APs to adaptively allow or deny the association of
clients based on the potential throughput of the currently associated clients. This
helps prevent APs from becoming overloaded with clients and improves user
experience for wireless users.
As an administrator, you can help maintain a positive user experience for wireless
users on the network by configuring the following client admission control settings:
• Minimum client count
• Maximum radio load
• Minimum client throughput
Client admission control is implemented on a per radio basis and is currently only
supported on 802.11n APs.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
58
Managing Ruckus Wireless AP Zones
Working with AAA Servers
Working with AAA Servers
This section provides information on add and manage AAA servers that the
controller can use to authenticate users.
• Creating an AAA Server
• Testing an AAA Server
• Deleting an AAA Server
Creating an AAA Server
Follow these steps to create a RADIUS or RADIUS Accounting server (if you have
one on the network) for the AP zone.
1 Click Configuration > AP Zones > Zone Name ({AP Zone Name}) > AAA. For
example, if you want to create an AAA server for an AP zone named ap-zone1, click Configuration > AP Zones > Zone Name (ap-zone-1) > AAA.
2 Click Create New. The form for creating a new zone RADIUS server appears.
3 Configure General Options.
• Name: Type a name for the AAA server that you are adding.
• Description: Type a brief description for the AAA server.
• Type: Select the type of AAA server that you have on the network. Options
include:
-
RADIUS
-
RADIUS Accounting
-
Active Directory
-
LDAP
• Backup RADIUS: Select the Enable backup RADIUS server check box if a
secondary RADIUS server exists on the network. Configure the settings in
Step 5.
4 In the Primary Server section, configure the settings of the primary RADIUS
server.
• IP Address: Type the IP address of the AAA server.
• Port: Type the port number of the AAA server. The default RADIUS server
port number is 1812 and the default RADIUS Accounting server port number
is 1813.
• Shared Secret: Type the AAA shared secret.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
59
Managing Ruckus Wireless AP Zones
Working with AAA Servers
• Confirm Secret: Retype the shared secret to confirm.
5 In the Secondary Server section, configure the settings of the secondary RADIUS
server.
NOTE: The Secondary Server section is only visible if you selected the Enable
backup RADIUS server check box earlier.
• IP Address: Type the IP address of the secondary AAA server.
• Port: Type the port number of the secondary AAA server port number. The
default RADIUS server port number is 1812 and the default RADIUS
Accounting server port number is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
6 Click Create New.
You have completed creating an AAA server for the AP zone.
Figure 27. The Create New AAA Server form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
60
Managing Ruckus Wireless AP Zones
Working with AAA Servers
Testing an AAA Server
Follow these steps to test if an AAA server that you have created in the controller is
functioning.
1 On the AAA Servers page, click Test AAA. The Test AAA Servers form appears.
2 In Name, select the name of the AAA server that you want to test.
3 In User Name, type the user name for your AAA server account.
4 In Password, type your AAA server password.
5 In Confirm Password, retype the password above.
6 Click Test.
Figure 28. Testing an AAA server
Deleting an AAA Server
You can delete a single or multiple AAA servers simultaneously.
• To delete a single AAA server, follow these steps:
a Go to the AAA Servers page for a specific AP zone.
b In the list of existing AAA servers, locate the service that you want to delete.
c Under the Actions column, click the icon
that is in the same row as the
AAA server. A confirmation message appears.
d Click Yes. The page refreshes and the AAA server that you deleted disappears from the list.
• To delete multiple AAA servers simultaneously, follow these steps:
a Go to the AAA Services page for a specific AP zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
61
Managing Ruckus Wireless AP Zones
Working with Hotspot (WISPr) Services
b In the list of existing AAA servers, locate the services that you want to delete.
c Select the check boxes before the servers that you want delete.
d Click Delete Selected. A confirmation message appears.
Click Yes. The page refreshes and the AAA servers that you deleted disappears
from the list.
Working with Hotspot (WISPr) Services
NOTE: If you do not want to provide a hotspot service to users, skip this section.
NOTE: This section describes the basic settings that you need to configure to
include a hotspot service in the zone. If you need more information about hotspots,
including third party prerequisites, see Creating and Managing Hotspots.
Creating a Hotspot Service
Follow these steps to configure the hotspot service of the zone template.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create a
hotspot service.
3 On the sidebar, click Hotspot (WISPr). The Hotspot (WISPr) Portal page
appears.
4 Click Create New. The form for creating a new hotspot service appears.
5 In the General Options section, configure the following options:
• Name: Type a name for the hotspot service.
• Description: Type a description for the hotspot service.
6 In the Redirection section, configure the following options:
• Smart Client Support: Select one of the following options:
-
None: Select this option to disable Smart Client support on the hotspot
service.
-
Enable: Selection this option to enable Smart Client support.
-
Only Smart Client Allowed: Select this option to allow only Smart Clients
to connect to the hotspot service.
For more information, see Configuring Smart Client Support.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
62
Managing Ruckus Wireless AP Zones
Working with Hotspot (WISPr) Services
• Logon URL: Type the URL of the subscriber portal (the page where hotspot
users can log in to access the service). For more information, see Configuring
the Logon URL.
• Start Page: Set where users will be redirected after they log in successfully:
-
Redirect to the URL that user intends to visit: You could redirect users
to the page that they want to visit.
-
Redirect to the following URL: You could set a different page where
users will be redirected (for example, your company website).
7 In the User Session section, configure the following options:
• Session Timeout: Set a time limit (in minutes) after which users will be
disconnected from the hotspot service and will be required to log on again.
• Grace Period: Set the time period (in minutes) during which disconnected
users are allowed access to the hotspot service without having to log on
again.
8 In the Location Information section, configure the following options:
• Location ID: Type the ISO and ITU country and area code that the AP includes
in accounting and authentication requests. The required code includes:
-
isocc (ISO-country-code): The ISO country code that the AP includes in
RADIUS authentication and accounting requests.
-
cc (country-code): The ITU country code that the AP includes in RADIUS
authentication and accounting requests.
-
ac (area-code): The ITU area code that the AP includes in RADIUS
authentication and accounting requests.
-
network
The following is an example of what the Location ID entry should look like:
isocc=us,cc=1,ac=408,network=RuckusWireless
• Location Name: Type the name of the location of the hotspot service.
9 In Walled Garden, click Create New to add a walled garden. A walled garden is
a limited environment to which an unauthenticated user is given access for the
purpose of setting up an account.
In the box provided, type a URL or IP address to which you want to grant
unauthenticated users access. You can add up to 128 network destinations to
the walled garden. Network destinations can be any of the following:
• IP address (for example, 10.11.12.13)
• IP range (for example, 10.11.12.13-10.11.12.15)
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
63
Managing Ruckus Wireless AP Zones
Working with Hotspot (WISPr) Services
• Classless Inter-Domain Routing or CIDR (for example, 10.11.12.100/28)
• IP address and mask (for example, 10.11.12.13 255.255.255.0)
• Exact website address (for example, www.ruckuswireless.com)
• Website address with regular expression (for example, *.ruckuswireless.com,
*.com, *)
After the account is established, the user is allowed out of the walled garden.
URLs will be resolved to IP addresses. Users will not be able to click through to
other URLs that may be presented on a page if that page is hosted on a server
with a different IP address. Avoid using common URLs that are translated into
many IP addresses (such as www.yahoo.com), as users may be redirected to
re-authenticate when they navigate through the page.
10 Click OK.
You have completed configuring a hotspot service of the AP zone. For additional
steps that you need to perform to ensure that the hotspot service works, see
Creating and Managing Hotspots.
Figure 29. The Create New Hotspot Service form
Deleting a Hotspot Service
You can delete a single or multiple hotspot services simultaneously.
• To delete a single hotspot service, follow these steps:
a Go to the Hotspot (WISPr) Services page for a specific AP zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
64
Managing Ruckus Wireless AP Zones
Working with Hotspot (WISPr) Services
b In the list of existing hotspot services, locate the service that you want to
delete.
c Under the Actions column, click the icon
that is in the same row as the
hotspot service. A confirmation message appears.
d Click Yes. The page refreshes and the hotspot service that you deleted
disappears from the list.
• To delete multiple hotspot services simultaneously, follow these steps:
a Go to the Hotspot (WISPr) Services page for a specific AP zone.
b In the list of existing hotspot services, locate the hotspots that you want to
delete.
c Select the check boxes before the hotspots that you want delete.
d Click Delete Selected. A confirmation message appears.
e Click Yes. The page refreshes and the hotspot services that you deleted
disappear from the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
65
Managing Ruckus Wireless AP Zones
Working with Guest Access Services
Working with Guest Access Services
Using the controller’s guest access features, you can provide visitors to your
organization limited access to a guest WLAN with configurable guest policies, or
given the option to self-activate their devices to an internal WLAN using Zero-IT
activation via the bring your own device (BYOD) onboarding portal (or both).
The following sections describe how to configure guest WLANs and access policies
that control guest use of your network.
• Creating a Guest Access Service
• Viewing Guest Access Services
• Deleting Guest Access Services
Creating a Guest Access Service
Each guest WLAN must be associated with a guest access service, which defines
the behavior of the guest WLAN interface. Follow these steps to create a guest
access service.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create a
guest access service. The Guest Access Service page appears.
3 Click Create New. The Create New Guest Access Service form appears.
4 In General Options, configure the following:
• Name: Type a name for the guest access service that you are creating.
• Description: Type a short description of the guest access service.
• Language: Select the display language to use for the buttons on the guest
access logon page.
5 In Redirection, select where to redirect the user after successfully completing
authentication.
• Redirect to the URL that the user intends to visit: Allows the guest user
to continue to their destination without redirection.
• Redirect to the following URL: Redirect the user to a specified web page
(entered into the text box) prior to forwarding them to their destination. When
guest users land on this page, they are shown the expiration time for their
guest pass.
6 In Guest Access, configure the following:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
66
Managing Ruckus Wireless AP Zones
Working with Guest Access Services
• Guest Pass SMS Gateway: You can deliver the guest pass to the user using
Short Message Service (SMS). But first you need to configure an SMS server
(see Configuring an SMS Server). If you previously configured an SMS server,
you can select it here or you can click Disabled.
• Terms and Conditions: To require users to read and accept your terms and
conditions prior to use, Show Terms And Conditions check box. The box
below, which contains the default Terms of Use text, becomes editable. Edit
the text or leave it unchanged to use the default text.
• Web Portal Logo: By default, the guest hotspot logon page displays the
Ruckus Wireless logo. To use your own logo, click the Upload button, select
your logo (recommended size is 138 x 40 pixels, maximum file size is 20KB),
and then click Upload.
• Web Portal Title: Type your own guest hotspot welcome text or accept the
default welcome text (“Welcome to the Guest Access login page”).
7 In User Session, configure the following:
• Session Timeout: Specify a time limit after which users will be disconnected
and required to log on again.
• Grace Period: Set the time period during which clients will not need to reauthenticate after getting disconnected from the hotspot. Enter a number (in
minutes) between 1 and 14399.
8 Click OK.
You have completed creating a guest access service.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
67
Managing Ruckus Wireless AP Zones
Working with Guest Access Services
Figure 30. Creating a guest access service
Viewing Guest Access Services
Follow these steps to view a list of existing guest access services.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you created the guest
access service or services.
3 On the sidebar, click Guest Access. The Guest Access Service page appears
and displays all existing guest access services and their basic settings are
shown, including the following:
• Name
• Description
• Actions (that you can perform)
4 To view or update the settings of a guest access service, click the guest access
service name.
You have completed viewing the existing guest access services.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
68
Managing Ruckus Wireless AP Zones
Working with Guest Access Services
Figure 31. Viewing guest access services
Deleting Guest Access Services
Follow these steps to delete guest access services.
1 On the AP Zone List page, click the AP zone for which you created the guest
access service or services.
2 On the sidebar, click Guest Access. The Guest Access Service page appears.
3 Locate the service or services that you want to delete.
4 Select the check boxes (first column) for the services that you want to delete.
5 Click Delete Selected.
The services that you selected disappear from the list. You have completed deleting
guest access services.
NOTE: If you are deleting a single guest access service, you can also click the
icon (under the Actions column) that is in the same row as the service that you want
to delete.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
69
Managing Ruckus Wireless AP Zones
Working with Web Authentication Services
Working with Web Authentication Services
A web authentication service (also known as a “captive portal”) redirects users to a
logon web page the first time they connect to a WLAN, and requires them to log on
before granting access to use the WLAN.
Creating and configuring a web authentication service requires the following steps:
• Adding an AAA Server for the Web Authentication Service
• Creating a Web Authentication Services
• Creating a WLAN for the Web Authentication Service
Adding an AAA Server for the Web Authentication
Service
Add an AAA server that the web authentication service can use to authenticate
users. For instructions on how to add an AAA server to the controller, see Creating
an AAA Server.
Creating a Web Authentication Services
Follow these steps to create a web authentication service.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create a web authentication service.
1 On the AP Zones submenu, click Web Authentication. The Web Authentication
Services page appears.
2 Click Create New. The Create New Web Authentication Service form appears.
3 In General Options, configure the following options:
• Name: Type a name for the web authentication service that you are creating.
• Description: Type a brief description of the service.
• Language: Select the display language that you want to use on the web
authentication portal.
4 In Redirection, select where to redirect the user after successfully completing
authentication.
• Redirect to the URL that the user intends to visit: Allows the guest user
to continue to their destination without redirection.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
70
Managing Ruckus Wireless AP Zones
Working with Web Authentication Services
• Redirect to the following URL: Redirect the user to a specified web page
(entered into the text box) prior to forwarding them to their destination. When
guest users land on this page, they are shown the expiration time for their
guest pass.
5 In User Session, configure the following:
• Session Timeout: Set the time (in minutes) after which inactive users will be
disconnected and required to log in again.
• Grace Period: Set the time period (in minutes) during which disconnected
users are allowed access to the hotspot service without having to log on
again.
6 Click OK.
You have completed creating a web authentication service.
Figure 32. The Create New Web Authentication Portal page
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
71
Managing Ruckus Wireless AP Zones
Working with Web Authentication Services
Creating a WLAN for the Web Authentication Service
Follow these steps to create a WLAN that you can use for a web authentication
service.
1 Go to Configuration > AP Zones > WLANs.
2 In the WLAN Configuration section, click Create New.
3 In General Options, configure the following:
• Name
• SSID
• Description
4 In Authentication Type, click Web Authentication.
5 In Authentication & Accounting Server, select the RADIUS and/or RADIUS
Accounting server that you created earlier in Adding an AAA Server for the Web
Authentication Service.
6 In Web Authentication, select the web authentication service that you created
earlier in Creating a Web Authentication Services. This service contains, among
others, the start page where users will be redirected when they associate with
this WLAN.
7 Configure the remaining WLAN options as desired. For information on these
options, see Creating a WLAN.
8 Click OK.
You have completed creating a WLAN for web authentication.
After you create a WLAN that will be used for web authentication, you must then
provide all users with the URL to your logon page. After they discover the WLAN
on their wireless device or laptop, they open their browser, connect to the logon
page and enter the required login information.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
72
Managing Ruckus Wireless AP Zones
Working with Web Authentication Services
Figure 33. Creating a WLAN to provide web authentication
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
73
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
Working with Hotspot 2.0 Services
This section covers:
• About Hotspot 2.0
• Hotspot 2.0 Operators and Service Providers
• Creating a Service Provider Profile
• Creating an Operator Profile
• Viewing Existing Hotspot 2.0 Services
• Deleting a Hotspot 2.0 Service
NOTE: If you do not want to provide a Hotspot 2.0 service to users, skip this step.
About Hotspot 2.0
Hotspot 2.0 is a newer Wi-Fi Alliance specification that allows for automated roaming
between service provider access points when both the client and access gateway
support the newer protocol. Hotspot 2.0 aims to improve the experience of mobile
users when selecting and joining a Wi-Fi hotspot by providing information to the
station prior to association. This information can then be used by the client to
automatically select an appropriate network based on the services provided and
the conditions under which the user can access them. In this way, rather than being
presented with a list of largely meaningless SSIDs to choose from, the Hotspot 2.0
client can automatically select and authenticate to an SSID based on the client’s
configuration and services offered, or allow the user to manually select an SSID for
which the user has login credentials.
The Hotspot 2.0 implementation of the controller complies with the IEEE 802.11u
standard and the Wi-Fi Alliance Hotspot 2.0 Technical Specifications.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
74
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
Hotspot 2.0 Operators and Service Providers
Hotspot 2.0 has two entities – operators and service providers. An operator is the
owner of a set of Hotspot 2.0 enabled access points. Each operator can resell their
Hotspot 2.0 service to a number of service providers. The operators deal mostly
with physical network elements while the service providers keep track of user
subscriptions and billing.
An operator profile defines all the properties pertaining to an operator while a service
profile defines the properties related to a service provider. If a WLAN is configured
to provide Hotspot 2.0 service, it must be linked exactly as that of Hotspot 2.0
operator profile. However, each operator profile can simultaneously provide service
to a number of service profiles.
Creating a Service Provider Profile
Follow these steps to create a Hotspot 2.0 service provider profile.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create a
Hotspot 2.0 service.
3 On the sidebar, click Hotspot 2.0. The Hotspot 2.0 Services page appears.
4 In the Hotspot 2.0 Service Provider Profiles section, click Create New.
5 In the General Options section, configure the following options:
• Name: Type a name for the service provider.
• Description: Type a description for the service provider.
6 In the Options section, configure the following options:
• NAI Realm List: Click Create New to create a list of NAI (Network Access
Identifier) realms corresponding to SSPs or other entities whose networks or
services are accessible via this AP. Up to five NAI realm entries can be created.
Each NAI realm entry can contain up to four EAP methods. Each EAP method
can contain up to four authentication types.
7 In the Advanced Options section, configure the following options:
• Roaming Consortium List: Click Create New to create a list of organization
identifiers included in the Roaming Consortium list, as defined in
IEEE802.11u, dot11RoamingConsortiumTable. Up to two Roaming Consortium entries can be created.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
75
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
• 3GPP Cellular Network Information: Click Create New to add cellular information, such as network advertisement information, to assist a 3GPP station
in selecting an AP for 3GPP network access, as defined in Annex A of 3GPP
TS 24.234 v8.1.0. Up to eight entries can be created.
8 Click OK.
You have completed creating a Hotspot 2.0 service provider profile.
Figure 34. The Create New Hotspot 2.0 Service Provider Profile form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
76
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
Creating an Operator Profile
Follow these steps to create a Hotspot 2.0 operator profile.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create a
Hotspot 2.0 service.
3 On the sidebar, click Hotspot 2.0. The Hotspot 2.0 Services page appears.
4 In the Hotspot 2.0 Operator Profiles section, click Create New.
5 In the General Options section, configure the following options:
• Name: Type a name for this operator profile. This name identifies the service
operator when assigning an HS2.0 service to a HS2.0 WLAN.
• Description (optional): Type a description for the service.
6 In the Venue Information section, configure select venue group and venue type
as per the drop down list. This is defined as per IEEE802.11u, Table 7.25m/n.
7 In the ASRA Option section, configure the following options:
• ASRA Option: Select the Additional step required for access check box (if
required).
• Internet Option: Select the Specified with connectivity to the Internet
check box if the Hotspot 2.0 network provides connectivity to the Internet.
• Access Network Type: Select a network type (as defined in IEEE802.11u,
Table 7-43b).
8 In the IP Address Type section, select the IP address type availability information,
as defined in IEEE802.11u, 7.3.4.8.
9 In the Domain Name List section, click Create New to create domain names of
the entity operating the access network. Up to five entries can be created.
10 In the Operator Friendly Name section, click Create New to specify network
operator names in multiple languages.
11 In the Hotspot 2.0 Service Provider Profiles section, specify each service
provider, including NAI realm, roaming consortium, and 3GPP cellular network
info. Up to six service provider profiles can be indicated for each operator profile.
NOTE: If you have not created a service profile, this section will not display any
service profiles. See Creating a Service Provider Profile.
12 In the Advanced Options section, click the + link to expand the section, and then
configure the following options:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
77
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
• HESSID: Set the HESSID. A HESSID (Homogeneous Extended Service Set
Identifier) is a 6-octet MAC address that identifies the homogeneous ESS.
The HESSID value must be identical to one of the BSSIDs in the homogeneous ESS.
• WAN Metrics: Provides information about the WAN link connecting an IEEE
802.11 access network and the Internet; includes link status and backhaul
uplink/downlink speed estimates.
• Connection Capability: Provides information on the connection status within
the hotspot of the most commonly used communications protocols and
ports. 11 static rules are available, as defined in WFA Hotspot 2.0 Technical
Specification, section 4.5.
13 In the Additional Connection Capability section, click Create New to add custom
connection capability rules. You can create up to 21 custom rules.
14 Click the OK button at the bottom of the form.
You have completed creating a Hotspot 2.0 operator profile.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
78
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
Figure 35. The Create New Hotspot 2.0 Operator Profile form
Viewing Existing Hotspot 2.0 Services
Follow these steps to view a list of existing Hotspot 2.0 services.
Go to Configuration > AP Zones > Zone Name ({AP Zone Name}) > Hotspot 2.0.
For example, if you want to view the Hotspot 2.0 services for an AP zone named
ap-zone-1, click Configuration > AP Zones > Zone Name (ap-zone-1) >
Hotspot 2.0.
The Hotspot 2.0 Services page for the AP zone appears and displays a list of
operator profiles and service provider profiles that have been created.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
79
Managing Ruckus Wireless AP Zones
Working with Hotspot 2.0 Services
Deleting a Hotspot 2.0 Service
You can delete a single or multiple Hotspot 2.0 services simultaneously.
• To delete a single Hotspot 2.0 service, follow these steps:
a Go to the Hotspot 2.0 Services page for a specific AP zone.
b In the list of existing Hotspot 2.0 services, locate the service that you want
to delete.
c Under the Actions column, click the icon
that is in the same row as the
Hotspot 2.0 service. A confirmation message appears.
d Click Yes. The page refreshes and the Hotspot 2.0 service that you deleted
disappears from the list.
• To delete multiple Hotspot 2.0 services simultaneously, follow these steps:
a Go to the Hotspot 2.0 Services page for a specific AP zone.
b In the list of existing Hotspot 2.0 services, locate the services that you want
to delete.
c Select the check boxes before the services that you want delete.
d Click Delete Selected. A confirmation message appears.
e Click Yes. The page refreshes and the Hotspot 2.0 services that you deleted
disappear from the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
80
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
Working with WLANs and WLAN Groups
• Creating a WLAN
Creating a WLAN
Follow these steps to create a WLAN for an AP zone.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create a
WLAN service.
3 On the sidebar, click WLAN. The WLAN Configuration page appears.
4 In the WLAN Configuration section, click Create New. The form for creating a
new WLAN service appears.
5 In the General Options section, configure the following options.
• Name/SSID: Type a short name (two to 32 alphanumeric characters) for this
WLAN. In general, the WLAN name is the same as the advertised SSID (the
name of the wireless network as displayed in the client’s wireless configuration program). However, you can also separate the SSID from the WLAN
name by entering a name for the WLAN in the first field, and a broadcast
SSID in the second field. In this way, you can advertise the same SSID in
multiple locations (controlled by the same controller) while still being able to
manage the different WLANs independently.
• Description: Type a brief description of the qualifications/purpose for this
WLAN (for example, Engineering or Voice).
6 In WLAN Usage, select the intended usage of the WLAN that you are creating:
• Standard usage (For most regular wireless networks): This is a regular
WLAN suitable for most wireless networks.
• Hotspot (WISPr): Click this option if you want to use a hotspot service that
you previously created. For instructions on how to create a hotspot service,
see Working with Hotspot (WISPr) Services.
• Guest Access + Zero-IT Onboarding: Click this option if you want guest
users to use this WLAN. After you complete creating this WLAN for guest
access, you can start generating guest passes. See Working with Guest
Passes.
• Web Authentication: Click this option if you want to require all WLAN users
to complete a web-based logon to this network every time they attempt to
connect. See Working with Web Authentication Services.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
81
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
• Hotspot 2.0: Click this option if you want a Hotspot 2.0 operator profile that
you previously created to use this WLAN. See Working with Hotspot 2.0
Services.
7 In Authentication Options, click the authentication method by which users will
be authenticated prior to gaining access to the WLAN. The level of security
should be determined by the purpose of the WLAN you are creating.
• Open (Default): No authentication mechanism is applied to connections. If
WPA or WPA2 encryption is used, this implies WPA-PSK authentication.
• 802.1x EAP: A very secure authentication/encryption method that requires
a back-end authentication server, such as a RADIUS server. Your choice
mostly depends on the types of authentication the client devices support and
your local network authentication environment.
• MAC Address: Authenticate clients by MAC address. MAC address authentication requires a RADIUS server and uses the MAC address as the user
logon name and password. You have two options for the MAC address format
to use for authenticating clients:
-
Use user defined text as authentication password (default is device MAC
address)
-
Set device MAC address in 802.1x format 00-10-A4-23-19-C0. (The
default is 0010a42319c0).
8 In Method under Encryption Options, select an encryption method to use. WPA
and WPA2 are both encryption methods certified by the Wi-Fi Alliance and are
the recommended encryption methods. The Wi-Fi Alliance will be mandating the
removal of WEP due to its security vulnerabilities, and Ruckus Wireless
recommends against using WEP, if possible.
• WPA2: Enhanced WPA encryption using stronger TKIP or AES encryption
algorithm.
• WPA-Mixed: Allows mixed networks of WPA and WPA2 compliant devices.
Use this setting if your network has a mixture of older clients that only support
WPA and TKIP, and newer client devices that support WPA2 and AES.
• WEP-64: Provides a lower level of encryption, and is less secure, using 40bit WEP encryption.
• WEP-128: Provides a higher level of encryption than WEP-64, using a 104bit key for WEP encryption. However, WEP is inherently less secure than
WPA.
• None: No encryption; traffic is sent in clear text.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
82
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
CAUTION! If you set the encryption method to WEP-64 (40 bit) or WEP-128 (104
bit) and you are using an 802.11n AP for the WLAN, the AP will operate in 802.11g
mode.
9 In Authentication & Accounting Service, configure the following options:
• Authentication Service: This option appears only when 802.1x EAP is
selected as the authentication method. Select the authentication server that
you want to use for this WLAN. Only AAA servers that you previously added
appear here.
• Accounting Service: Select the RADIUS Accounting server that you want
to use as a proxy for the controller from the drop-down list. You must have
added a RADIUS Accounting server previously (see Working with AAA
Servers).
10 In Hotspot (WISPr) Service, select the hotspot that you want this WLAN to use.
This option appears only when Hotspot service (WISPr) is selected as the WLAN
usage type. This hotspot service may be the hotspot that you created in Creating
a Hotspot Service. Additionally, if you added a RADIUS accounting server to the
controller earlier, you can enable RADIUS proxy accounting by selecting the
Enable RADIUS Accounting Proxy check box.
11 In Options, configure the following options:
• Wireless Client Isolation: Wireless client isolation enables subnet restrictions
for connected clients. Click Enable if you want to prevent wireless clients
associated with the same AP from communicating with each other locally.
The default value is Disable.
• Priority: Set the priority of this WLAN to Low if you would prefer that other
WLAN traffic takes priority. For example, if you want to prioritize internal traffic
over guest WLAN traffic, you can set the priority in the guest WLAN configuration settings to “Low.” By default, all WLANs are set to high priority.
12 In RADIUS Options, click + (plus sign) to display the options, and then configure
the following:
• RADIUS NAS ID: Select how to the RADIUS server will identify the AP:
-
WLAN BSSID
-
AP MAC
-
User-defined
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
83
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
• RADIUS NAS Request Timeout: Type the timeout period (in seconds) after,
which an expected RADIUS response message is considered to have failed.
• RADIUS NAS Max Number of Retries: Type the number of failed connection
attempts after which the controller will fail over to the backup RADIUS server.
• RADIUS NAS Reconnect Primary: If the controller fails over to the backup
RADIUS server, this is the interval (in minutes) at which the controller will
recheck the primary RADIUS server if it is available. The default interval is 5
minutes.
• Call STA ID: Use either WLAN BSSID or AP MAC as the station calling ID.
Select one.
13 In Advanced Options, configure the following options:
• User Traffic Profile: If you want this WLAN to use a user traffic profile that you
previously created, select it from the drop-down menu. Otherwise, select
System Default. For more information, see Working with User Traffic Profiles.
• L2 Access Control: If you want this WLAN to use an L2 access control policy
that you previously created, select it from the drop-down menu. Otherwise,
select Disable. For more information, see Working with L2 Access Control
Policies.
• Device Policy: If you want this WLAN to use a device policy that you previously
created, select it from the drop-down menu. Otherwise, select Disable. For
more information, see Working with Device Policies.
• Rate Limiting: This option controls fair access to the network. When enabled,
the network traffic throughput of each network device (client) is limited to the
rate specified in the traffic policy, and that policy can be applied on either the
uplink or downlink. Toggle the Uplink and Downlink drop-down lists to limit
the rate at which WLAN clients upload/download data. The “Disable” state
means rate limiting is disabled; thus, traffic flows without prescribed limits.
• Access VLAN: By default, all wireless clients associated with APs that the
controller is managing are segmented into a single VLAN (with VLAN ID 1). If
you want to tag this WLAN traffic with a different VLAN ID, enter a valid VLAN
ID (2-4094) in the box.
• Hide SSID: Select this check box if you do not want the ID of this WLAN
advertised at any time. This will not affect performance or force the WLAN
user to perform any unnecessary tasks.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
84
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
• Client Load Balancing: To disable client load balancing on this WLAN, select
the Do not perform client load balancing for this WLAN service check
box. For more information, see Client Load Balancing.
• Proxy ARP: Select this check box to enable proxy ARP. When proxy ARP is
enabled on a WLAN, the AP provides proxy service for stations when
receiving neighbor discovery packets (for example, ARP request and ICMPv6
Neighbor Solicit messages), and acts on behalf of the station in delivering
ARP replies. When the AP receives a broadcast ARP/Neighbor Solicit request
for a known host, the AP replies on behalf of the host. If the AP receives a
request for an unknown host, it forwards the request at the rate limit specified.
• Max Clients: This option limits the number of clients that can associate with
this WLAN per AP (default is 100). You can also limit the total number of
clients that a specific AP (or radio, on dual radio APs) will manage.
• 802.11d: Select this check box to enable this standard on this WLAN.
802.11d provides specifications for compliance with additional regulatory
domains (countries or regions) that were not defined in the original 802.11
standard. Click this option if you are operating in one of these additional
regulatory domains.
• Force DHCP: Enable this option to force clients to obtain a valid IP address
from DHCP within the specified number of seconds. This prevents clients
configured with a static IP address from connecting to the WLAN. Additionally, if a client performs Layer 3 roaming between different subnets, in some
cases the client sticks to the former IP address. This mechanism optimizes
the roaming experience by forcing clients to request a new IP address.
• DHCP Option 82: Select the Enable DHCP Option 82 check box to enable
this feature. When this feature is enabled and an AP receives a DHCP request
from a wireless client, the AP will encapsulate additional information (such as
VLAN ID, AP name, SSID and MAC address) into the DHCP request packets
before forwarding them to the DHCP server. The DHCP server can then use
this information to allocate an IP address to the client from a particular DHCP
pool based on these parameters.
• Client TX/RX Statistics: Select the Ignore statistics from unauthorized
clients check box if you do not want the controller to monitor traffic statistics
for unauthorized clients.
• Inactivity Timeout: Select this check box and enter a value in seconds (60 to
600) after which idle clients will be disconnected.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
85
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
• Client Fingerprinting: By selecting this check box, the controller will attempt
to identify client devices by their operating system, device type and host
name, if available. This makes identifying client devices easier on the Dashboard, Monitor and Client Details pages.
• OFDM Only: Select the check box to force clients associated with this WLAN
to use only Orthogonal Frequency Division Multiplexing (OFDM) to transmit
data. OFDM-only allows the client to increase management frame transmission speed from CCK rates to OFDM rates. This feature is implemented per
WLAN and only affects the 2.4GHz radio.
• BSS Min Rate: Select this check box to set the bss rates of management
frames from default rates (CCK rates for 2.4G or OFDM rate – 6Mbps for 5G]
to the desired rates. By default, BSS Min Rate is disabled.
NOTE OFDM-only takes higher priority than BSS-minrate. However, OFDM-only
relies on BSS-minrate to adjust its rate for management frames.
• Mgmt Tx Rate: To set the maximum transmit rate for management frame,
select a value (in Mbps) from the drop-down list.
• Service Schedule: Use the Service Schedule tool to control which hours of
the day, or days of the week to enable/disable WLAN service. Options
include:
-
Always On: Click this enable this WLAN at all times.
-
Always Off: Click this option to disable the WLAN service at all times.
-
Specific: Click this to set specific hours during which this WLAN will be
enabled. For example, a WLAN for student use at a school can be
configured to provide wireless access only during school hours. Click on
a day of the week to enable/disable this WLAN for the entire day. Colored
cells indicate WLAN enabled. Click and drag to select specific times of
day. You can also disable a WLAN temporarily for testing purposes, for
example.
• Band Balancing: To disable band balancing on this WLAN, select the Do not
perform band balancing for this WLAN service check box. For more
information, see Band Balancing.
14 Click OK at the bottom of the form.
You have completed creating and configuring a WLAN service of the AP zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
86
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
Figure 36. Top half of the Create New WLAN Configuration form
Channel Mode
Some countries restrict certain 5GHz channels to indoor use only. For instance,
Germany restricts channels in the 5.15GHz to 5.25GHz band to indoor use. When
ZoneFlex Outdoor APs and Bridges with 5GHz radios (ZoneFlex 7762, 7762-S,
7762-T, 7761-CM and 7731) are set to a country code where these restrictions
apply, the AP or Bridge can no longer be set to an indoor-only channel and will no
longer select from amongst a channel set that includes these indoor-only channels
when SmartSelect or Auto Channel selection is used, unless the administrator
configures the AP to allow use of these channels.
For instance, if the AP is installed in a challenging indoor environment (such as a
warehouse), the administrator may want to allow the AP to use an indoor-only
channel. These channels can be enabled for use through the AP CLI or the controller
web interface.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
87
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
Client Load Balancing
Enabling load balancing can improve WLAN performance by helping to spread the
wireless client load between nearby access points, so that one AP does not get
overloaded while another sits idle. The load balancing feature can be controlled from
within the controller web interface to balance the number of clients per radio on
adjacent APs.
“Adjacent APs” are determined by the controller at startup by measuring the RSSI
during channel scans. After startup, the controller uses subsequent scans to update
the list of adjacent radios periodically and when a new AP sends its first scan report.
When an AP leaves, the controller immediately updates the list of adjacent radios
and refreshes the client limits at each affected AP.
Once the controller is aware of which APs are adjacent to each other, it begins
managing the client load by sending the configured client limits to the APs. These
limits are “soft values” that can be exceeded in several scenarios, including:
1 When a client’s signal is so weak that it may not be able to support a link with
another AP
2 When a client’s signal is so strong that it really belongs on this AP.
The APs maintain these configured client limits and enforce them once they reach
the limits by withholding probe responses and authentication responses on any
radio that has reached its limit.
Key Points About Load Balancing
Before you enable load balancing, keep the following considerations in mind:
• The load balancing rules apply only to client devices; the AP always responds
to another AP that is attempting to set up or maintain a mesh network.
• Load balancing does not disassociate clients already connected.
• Load balancing takes action before a client association request, reducing the
chance of client misbehavior.
• The process does not require any time-critical interaction between APs and the
controller.
• Provides control of adjacent AP distance with safeguards against abandoning
clients.
• Can be disabled on a per-WLAN basis. For instance, on a voice WLAN, load
balancing may not be desired due to voice roaming considerations.
• Background scanning must be enabled on the WLAN for load balancing to work.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
88
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
Band Balancing
Band balancing balances the client load on radios by distributing clients between
the 2.4GHz and 5GHz radios. This feature is enabled by default and set to a target
of 25% of clients connecting to the 2.4GHz band. To balance the load on a radio,
the AP encourages dual-band clients to connect to the 5GHz band when the
configured percentage threshold is reached.
Working with WLAN Groups
A WLAN group is a way of specifying which APs or AP groups provide which WLAN
services. If your wireless network covers a large physical environment (for example,
multi-floor or multi-building office) and you want to provide different WLAN services
to different areas of your environment, you can use WLAN groups to do this.
For example, if your wireless network covers three building floors (1st floor to 3rd
floor) and you need to provide wireless access to visitors on the 1st floor, you can
do the following:
1 Create a WLAN service (for example, “Guest Only Service”) that provides guestlevel access only.
2 Create a WLAN group (for example, “Guest Only Group”), and then assign “Guest
Only Service” (WLAN service) to “Guest Only Group” (WLAN group).
3 Assign APs on the 1st Floor (where visitors need wireless access) to your “Guest
Only Group”.
Any wireless client that associates with APs assigned to the “Guest Only Group” will
get the guest-level access privileges defined in your “Guest Only Service.” APs on
the 2nd and 3rd floors can remain assigned to the default WLAN Group and provide
normal-level access.
Notes About WLAN Groups
Before you start using WLAN groups to provision WLAN settings to APs or AP
groups, take note of the following important notes:
• Creating WLAN groups is optional. If you do not need to provide different WLAN
services to different areas in your environment, you do not need to create a WLAN
group.
• A default WLAN group called “default” exists. The first 27 WLANs that you create
are automatically assigned to this default WLAN group.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
89
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
• A WLAN group can include a maximum of 27 member WLANs. For dual radio
APs, each radio can be assigned to only one WLAN group (single radio APs can
be assigned to only one WLAN group).
Creating a WLAN Group
Follow these steps to create a WLAN group.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create a device access policy.
3 In the AP Zones submenu, click WLAN. The WLAN Services & Groups page
appears.
4 Look for the WLAN Group Configuration section.
5 Click Create New.
6 In Group Name, type a descriptive name that you want to assign to this WLAN
group. For example, if this WLAN will contain WLANs that are designated for
guest users, you can name this as Guest WLAN Group.
7 In Description (optional), type some notes or comments about this group.
8 Under WLAN List, select the check boxes for the WLANs that you want to be
part of this WLAN group. The VLAN Override and NAS-ID columns for the
selected WLANs become active.
9 In the VLAN override settings, choose whether to override the VLAN configured
for each member WLAN. Available options include:
• No Change: Click this option if you want the WLAN to keep the same VLAN
tag (default: 1).
• Tag: Click this option to override the VLAN configured for the WLAN service.
10 In the NAS-ID settings, choose whether to override the NAS-ID configured for
each member WLAN. Available options include:
• No Change: Click this option if you want the WLAN to keep the same NASID tag.
• User-defined: Click this option to override the NAS-ID that has been assigned
to this WLAN service.
11 Click Create New. The Create New form disappears and the WLAN group that
you created appears in the table under WLAN Groups.
You may now assign this WLAN group to an AP or AP group.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
90
Managing Ruckus Wireless AP Zones
Working with WLANs and WLAN Groups
Viewing Existing WLAN Groups
Follow these steps to view a list of existing WLAN groups.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create a device access policy.
3 In the AP Zones submenu, click WLAN. The WLAN Services & Groups page
appears.
4 Look for the WLAN Group Configuration section. All existing WLAN groups and
their basic settings are shown, including the:
• WLAN group name
• Description
• Actions (that you can perform)
To view WLANs that belong to a particular WLAN group, click the WLAN group
name.
You have completed viewing existing WLAN groups.
Deleting WLAN Groups
Follow these steps to delete WLAN groups.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create a device access policy.
3 In the AP Zones submenu, click WLAN. The WLAN Services & Groups page
appears.
4 Scroll down to the WLAN Group Configuration section.
5 Locate the WLAN group or groups that you want to delete.
6 Select the check boxes (first column) for the WLAN groups that you want to
delete.
7 Click Delete Selected.
The WLAN groups that you selected disappear from the list. You have completed
deleting WLAN groups.
NOTE: If you are deleting a single WLAN group, you can also click the
icon
(under the Actions column) that is in the same row as the WLAN group that you
want to delete.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
91
Managing Ruckus Wireless AP Zones
Working with WLAN Schedules
Working with WLAN Schedules
A WLAN schedule profile specifies the hours of the day or week during which a
WLAN service will be enabled or disabled. For example, a WLAN for student use at
a school can be configured to provide wireless access only during school hours.
Create a WLAN schedule profile, and then when you configure a WLAN, select the
schedule profile to enable or disable the WLAN service during those hours/days.
NOTE: This feature will not work properly if the system does not have the correct
time. To ensure that the system always maintains the correct time, configure an NTP
server and point the system to the NTP server’s IP address, as described in Setting
the System Time.
NOTE: WLAN service schedule times should be configured based on your
browser’s current time zone. If your browser and the target AP/WLAN are in different
time zones, configure the on/off times according to the desired schedule according
to your local browser. For example, if you wanted a WLAN in Los Angeles to turn
on at 9 AM and your browser was set to New York time, configure the WLAN service
schedule to enable the WLAN at noon. When configuring the service schedule, all
times are based on your browser's time zone setting.
Creating a WLAN Schedule Profile
Follow these steps to create a WLAN schedule profile.
1 Go to Configuration > AP Zones.
2 On the AP Zones submenu, click WLAN Scheduler.
3 Click Create New. The Create New WLAN Schedule Table form appears.
4 Set a WLAN schedule.
• To enable or disable the WLAN for an entire day, click the day of the week
under the Time column.
• To enable or disable the WLAN for specific hour of a specific day, click the
squares in the table. A single square represents 30 minutes (two-15 minute
blocks).
Blue-colored cells indicate the hours when the WLAN is enabled. Clear (or white)
cells indicate the hours when the WLAN is disabled.
5 Click Create New. The page refreshes, and then the schedule you created
appears in the WLAN Scheduler section.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
92
Managing Ruckus Wireless AP Zones
Working with WLAN Schedules
You have completed creating a WLAN schedule. This WLAN schedule will now
appear as an option when you set the WLAN service schedule to Specific (see
Figure 38)
Figure 37. Creating a WLAN schedule
Figure 38. The WLAN schedule appears as an option when you set the WLAN service schedule
to “Specific”
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
93
Managing Ruckus Wireless AP Zones
Working with Device Policies
Working with Device Policies
In response to the growing numbers of personally owned mobile devices such as
smart phones and tablets being brought into the network, IT departments are
requiring more sophisticated control over how devices connect, what types of
devices can connect, and what they are allowed to do once connected.
Using device access policies, the system can identify the type of client attempting
to connect, and perform control actions such as permit/deny, rate limiting, and
VLAN tagging based on the device type.
Once a device access policy has been created, you can apply the policy to any
WLANs or WLAN groups for which you want to control access by device type. You
could, for example, allow only Apple OS devices on one WLAN and only Linux
devices on another.
Creating a Device Access Policy
Follow these steps to create a device access policy.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create a device access policy.
3 On the AP Zones submenu, click Device Policy.
4 Click Create New.
5 In Name, type a name for this policy.
6 In Description, type a short description for this policy.
7 In Default Access, click either Allow or Block. This is the default action that the
system will take if no rules are matched.
8 In the Rules section, click Create New. The Create New Device Policy Rules
form appears.
9 Configure the rule settings:
• Description: Type a description for this rule.
• Action: Select either Allow or Block. This is the action that the system will
take if the client matches any of the attributes in the rule.
• Device Type: Select from any of the supported client types.
• Uplink Rate Limit: Select the uplink rate limit for this client type, or click
Disable.
• Downlink Rate Limit: Select the download rate limit for this client type, or click
Disable.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
94
Managing Ruckus Wireless AP Zones
Working with Device Policies
• VLAN: Segment this client type into a specified VLAN (1~4094; if no value is
entered, this policy does not impact device VLAN assignment).
10 To add a new rule, click Create New again, and then repeat Step 9.
11 When you finish creating all the rules that you want to add to the policy, click OK
at the bottom of the form. The page refreshes, and then the policy that you
created appears under the Device Policy Services section.
You have completed creating a device access policy.
Figure 39. The Create New Device Policy Service form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
95
Managing Ruckus Wireless AP Zones
Working with Device Policies
Viewing Device Access Policies
Follow these steps to view a list of existing device access policies.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to view existing device access policies.
3 On the AP Zones submenu, click Device Policy.
The Device Policy Services page appears and lists all existing device access policies
and their basic settings are shown, including the:
• Name
• Description
• Default access (allow or block)
• Actions (that you can perform)
To view or update policy settings, click the policy name.
You have completed viewing device access policies.
Deleting Device Access Policies
Follow these steps to delete device access policies.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create a device access policy.
3 On the AP Zones submenu, click Device Policy.
4 Locate the policy or policies that you want to delete.
5 Select the check boxes (first column) for the policies that you want to delete.
6 Click Delete Selected.
The policies that you selected disappear from the list. You have completed deleting
device access policies.
NOTE: If you are deleting a single policy, you can also click the
icon (under the
Actions column) that is in the same row as the policy that you want to delete.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
96
Managing Ruckus Wireless AP Zones
Working with L2 Access Control Policies
Working with L2 Access Control Policies
Another method to control access to the network is by defining Layer 2/MAC
address access control lists (ACLs), which can then be applied to one or more
WLANs or WLAN groups. L2 ACLs are either allow-only or deny-only; that is, an
ACL can be set up to allow only specified clients or to deny only specified clients.
MAC addresses that are in the deny list are blocked at the AP.
Creating an L2 Access Policy
Follow these steps to create an L2 access policy.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to create an L2 ACL.
3 On the AP Zones submenu, click L2 Access Control.
4 Click Create New. The Create New L2 Access Control Service form appears.
5 In Name, type a name for this policy.
6 In Description, type a short description for this policy.
7 In Restriction, select the default action that the controller will take if no rules are
matched. Available options include:
• Only allow all stations listed below
• Only block all stations listed below
8 In the Rules section, click Create New.
9 In MAC Address, type the MAC address to which this L2 access policy applies.
10 Click Save.
11 To add another MAC address, repeat steps 8 to 10.
12 When you have finished adding all the MAC addresses that you need to add,
click OK. The page refreshes, and then the L2 access policy that you created
appears in the L2 Access Control Services section.
You have completed creating an L2 access policy.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
97
Managing Ruckus Wireless AP Zones
Working with L2 Access Control Policies
Figure 40. The Create New L2 Access Control Services form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
98
Managing Ruckus Wireless AP Zones
Working with L2 Access Control Policies
Viewing L2 Access Policies
Follow these steps to view a list of existing L2 access profiles.
1 Go to Configuration > AP Zones.
2 Click the AP zone for which you want to view existing L2 ACLs.
3 On the AP Zones submenu, click L2 Access Control.
4 Look for the L2 Access Control Services section. All existing L2 access policies
and their basic settings are shown, including the:
• Name
• Description
• Default access (allow or block)
• Actions (that you can perform)
5 To view or change the MAC addresses have been defined in a particular L2
access policy, click the profile name.
You have completed viewing existing L2 access policies.
Deleting L2 Access Policies
Follow these steps to delete L2 access policies.
1 Go to Configuration > AP Zones.
2 Click the AP zone from which you want to delete L2 ACLs.
3 On the AP Zones submenu, click L2 Access Control.
4 In the L2 Access Control Services section, locate the policy or policies that you
want to delete.
5 Select the check boxes (first column) for the policies that you want to delete.
6 Click Delete Selected.
The policies that you selected disappear from the list. You have completed deleting
L2 access policies.
NOTE: If you are deleting a single policy, you can also click the
icon (under the
Actions column) that is in the same row as the policy that you want to delete.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
99
Managing Ruckus Wireless AP Zones
Working with Bonjour Policies
Working with Bonjour Policies
Bonjour™ is Apple’s implementation of a zero-configuration networking protocol
for Apple devices over IP. It allows OS X and iOS devices to locate other devices
such as printers, file servers and other clients on the same broadcast domain and
use the services offered without any network configuration required.
Multicast applications such as Bonjour require special consideration when being
deployed over wireless networks. Bonjour only works within a single broadcast
domain, which is usually a small area. This is by design to prevent flooding a large
network with multicast traffic. However, in some situations, a user may want to offer
Bonjour services from one VLAN to another.
The controller’s Bonjour gateway feature addresses this requirement by providing
an mDNS proxy service configurable from the web interface to allow administrators
to specify which types of Bonjour services can be accessed from/to which VLANs.
In order for the Bonjour Gateway to function, the following network configuration
requirements must be met:
1 The target networks must be segmented into VLANs.
2 VLANs must be mapped to different SSIDs.
3 The controller must be connected to a VLAN trunk port.
Additionally, if the VLANs to be bridged by the gateway are on separate subnets, the
network has to be configured to route traffic between them.
Creating a Bonjour Gateway Rule on the AP
Using the Bonjour gateway feature, Bonjour bridging service is performed on a
designated AP rather than on the controller. Offloading the Bonjour policy to an AP
is necessary if a Layer 3 switch or router exists between the controller and the APs.
The controller identifies a single AP that meets the memory/processor requirements
(this feature is only supported on certain APs), and delivers a set of service rules a Bonjour policy - to the AP to perform the VLAN bridging.
NOTE: This feature is only supported on the following access points: H500, R700,
R300, T300, 7982, 7372/52, 7055, 7782/81, and SC-8800 series.
Here are the requirements and limitations of the Bonjour gateway feature:
• Bonjour policy deployment to an AP takes effect after the AP joins the controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
100
Managing Ruckus Wireless AP Zones
Working with Bonjour Policies
• Some APs of one local area link must be on one subnet. The switch interfaces
connected to these APs in a local area link to must be configured in VLAN-trunk
mode. Only by doing so can the designated AP can receive all the multicast
Bonjour protocol packets from other VLANs.
• Dynamic VLANs are not supported.
• Some AP models are incompatible with this feature due to memory requirements.
Follow these steps to create rules for an AP that will bridge Bonjour services across
VLANs.
1 Go to Configuration > AP Zones.
2 On the AP Zone List page, click the zone name for which you want to configure
the Bonjour gateway.
3 On the AP Zones sidebar, click Bonjour Policy.
4 Click Create New to create a Bonjour gateway policy. The Create Bonjour Policy
form appears.
5 In Name, type a name for the policy.
6 In Description, type a description for the policy.
7 In the Rules section, click Create New to create a rule.
8 Configure the following options:
• Bridge Service: Select the Bonjour service from the list.
• From VLAN: Select the VLAN from which the Bonjour service will be advertised.
• To VLAN: Select the VLAN to which the service should be made available.
• Notes: Add optional notes for this rule.
9 Click Save to save the rule. To create another rule, repeat steps 7 to 9.
10 After you finish creating all rules that you require, click OK to close the Create
Bonjour Policy form.
11 Select the Enable Bonjour gateway on the AP check box.
You have completed creating a Bonjour gateway policy.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
101
Managing Ruckus Wireless AP Zones
Working with Bonjour Policies
Figure 41. The Create Bonjour Policy form
Applying a Bonjour Policy to an AP
Once you have created a Bonjour policy for an AP, you will need to designate the
AP that will be responsible for implementing this policy.
Follow these steps to apply a Bonjour policy to an AP.
1 Go to Configuration > Access Points.
2 From the list of APs, click the MAC address of the AP to which you want to apply
the Bonjour policy. The Edit AP [{MAC address}] form appears.
3 Scroll down to the Advanced Options section, and then locate the Bonjour
Gateway option.
4 Select the Enable as bonjour gateway with policy check box, and then select
the Bonjour policy that you want to apply to the AP (see Figure 42).
5 Click Apply.
You have completed applying a Bonjour gateway policy to an AP.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
102
Managing Ruckus Wireless AP Zones
Working with Bonjour Policies
Figure 42. Select the Bonjour policy that you created earlier
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
103
Managing Global Configuration,
Tunnel Profiles, Templates, and AP
Registration Rules
3
Managing Global Configuration
Global configuration refers to the country code. This country code is across all AP
zones and the managed devices that belong to each AP zone.
Different countries have different regulations on the usage of radio channels. To
ensure that the controller is using an authorized radio channel, select the correct
country code for your location. If you change the country code now, this change
will only be applied to new zones and the APs that will be assigned to them. Existing
zones and the APs that belong to them will retain the country code that was
configured previously.
Follow these steps to set the global configuration.
1 Go to Configuration > AP Zones.
2 On the sidebar, click Global Configuration.
3 In Default Country Code for New Zone, select the correct country code for the
geographical location where the managed devices (or APs) are deployed.
Selecting the correct country code will ensure that managed devices use an
authorized radio channel.
After you select a new country code, the Apply and Cancel buttons become
active.
4 Click Apply.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
104
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Creating a Soft GRE Tunnel Profile
Figure 43. The Global Configuration page
Creating a Soft GRE Tunnel Profile
CAUTION! A Soft GRE tunnel does not support APs that are behind a NAT server.
Follow these steps to create a Soft GRE tunnel profile.
1 Go to Configuration > AP Zones.
2 On the sidebar, click AP Tunnel Profiles > Soft GRE. The Soft GRE page appears.
3 Click Create New. The Create SoftGRE Profile form appears.
4 Configure the following options:
• Name: Type a name for the profile that you are creating.
• Description: Type a short description of the profile.
• Primary Gateway Address: Type the IP address or fully-qualified domain
name (FQDN) of the primary gateway server.
• Secondary Gateway Address: If you have a secondary gateway server on
the network, type its IP address or FQDN in the box provided. If the controller
is unable to reach the primary gateway server, it will automatically attempt to
reach the secondary gateway address that you specify here.
• Gateway Path MTU: Set the maximum transmission unit (MTU) for the
gateway path. Options include Auto (default) and Manual (range is 850 to
1500 bytes).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
105
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Creating a Soft GRE Tunnel Profile
• ICMP Keep Alive Period: Type the time interval (in seconds) at which APs
send a keepalive message to the active third party WLAN gateway. The range
is 1 to 180 seconds and the default value is 10 seconds.
• ICMP Keep Alive Retry: Type the number of keepalive attempts that APs
wait for a response from the active third party WLAN gateway before failing
over to the standby WLAN gateway. The range is 2 to 10 retries and the
default value is 5 retries.
5 Click Create New.
Figure 44. Creating a Soft GRE profile
o
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
106
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
Working with Zone Templates
A zone template contains configuration settings (radio, AP GRE tunnel, channel
mode, and background scanning) that you can apply to all access points that belong
to a particular AP zone. Applying a zone template to an AP zone will overwrite all
settings on all access points that belong that the AP zone.
This section describes the following topics:
• Creating and Configuring a Zone Template
• Exporting a Zone Template
• Importing a Zone Template
• Deleting a Zone Template
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
107
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
Creating and Configuring a Zone Template
Creating a zone template requires that you create the template and configure the
services that will be deployed with the template. Follow these steps to create and
configure a zone template.
Step 1: Create the Zone Template
Step 2: Configure the AP Model-Specific Configuration
Step 3: Configure the AAA Servers of the Zone Template
Step 4: Configure the Hotspot (WISPr) Services of the Zone Template
Step 5: Configure the Hotspot 2.0 Services of the Zone Template
Step 6: Configure the WLAN Services of the Zone Template
Step 1: Create the Zone Template
Follow these steps to create a zone template.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the Create New button. The Create New Zone Template form appears.
4 In General Options, configure the following options:
• Zone Name: Type a name for the zone template that you are creating.
• Description: Type a description for this template.
• AP Firmware: Select the controller firmware version that you want to apply
this template.
• Country Code: Select the correct code for the country in which you are
operating the controller network. Different countries and regions maintain
different rules that govern which channels can be used for wireless communications. Selecting the correct country code will ensure that APs that are
part of the controller network do not violate local and national regulatory
restrictions.
• AP Admin Logon: configure the following options:
-
Logon ID: Set the administrator user name.
-
Password: Set the administrator password.
Any administrator can use this user name and password combination to log
on directly to the managed access point’s native web interface.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
108
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• Time Zone: Specify the time zone that you want this AP zone to use by clicking
one of the following options:
-
System defined: Click this option, and then select a time zone that you
want to use.
-
User defined: Click this option, and then define the time zone settings
(including the time zone abbreviation, GMT offset, and daylight saving
time settings) that you want to use.
5 In Radio Options, configure the following options:
• In the Radio Options b/g/n (2.4GHz) section, configure the following options:
-
Channelization: Select Auto, 20MHz or 40MHz channel width.
-
Channel: Select Auto or manually assign a channel for the 2.4GHz radio.
-
TX Power Adjustment: Manually set the transmit power on all 2.4GHz
radios (default is Full).
• In Radio Options a/n (5GHz), configure the following options:
-
Channelization: Select Auto, 20MHz, 40MHz, or 80MHz channel width.
-
Channel: Select Auto or manually assign a channel for the 5GHz radio.
-
TX Power Adjustment: Manually set the transmit power on all 5GHz radios
(default is Full).
6 In AP GRE Tunnel Options, configure the following options:
• Tunnel Type: Select an option for tunneling WLAN traffic back to the controller:
-
No Tunneled: Select this option to disable tunneling WLAN traffic back
to the controller.
-
SoftGRE: Select this option to tunnel regular WLAN traffic only.
7 In Syslog Options, if you have a syslog server on the network and you want the
controller to send syslog data to it, select the Enable external server for APs
in this zone check box.
8 In Advanced Options, configure the following options:
• Channel Mode: Select the Allow indoor channels check box if you want to
allow ZoneFlex outdoor APs to use indoor-use only channels. For more
information on channel mode, see Channel Mode.
• Background Scanning: If you want APs to automatically evaluate radio
channel usage, enable and configure the background scanning settings on
both the 2.4GHz and 5GHz radios. By default, background scanning is
enabled on both radios and set to run every 20 seconds.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
109
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• Smart Monitor: To disable the WLANs of an AP (that belongs to this zone)
whenever the AP uplink or Internet connection becomes unavailable, select
the Enable check box. And then, configure the following options:
-
Health Check Interval: Set the interval (between 5 and 60 seconds) at
which the AP will check its uplink connection. The default value is 10
seconds.
-
Health Check Retry Threshold: Set the number of times (between 1 and
10 times) that the AP will check its uplink connection. If the AP is unable
to detect the uplink after the configured number of retries, the AP will
disable its WLANs. The default value is 3 retries.
NOTE: When the AP disables its WLANs, the AP creates a log for the event. When
the AP’s uplink is restored, it sends the event log (which contains the timestamp
when the WLANs were disabled, and then enabled) to the vSCG.
• Rogue AP Detection: Select the Report rogue access points check box to
enable rogue device detection in logs and email alarm event notifications.
-
Report all rogue devices: Send alerts for all rogue AP events.
-
Report only malicious rogue devices of type: Select which event types
to report. Events include SSID spoofing, same network, and MAC
spoofing.
-
Protect the network from malicious rogue access points: Select this
check box to automatically protect your network from network connected
rogue APs, SSID-spoofing APs and MAC-spoofing APs. When one of
these rogue APs is detected (and this check box is enabled), the Ruckus
Wireless AP automatically begins sending broadcast de-authentication
messages spoofing the rogue’s BSSID (MAC) to prevent wireless clients
from connecting to the malicious rogue AP. This option is disabled by
default.
• Client Load Balancing: Improve WLAN performance by enabling load
balancing. Load balancing spreads the wireless client load between nearby
access points, so that one AP does not get overloaded while another sites
idle. Load balancing must be enabled on a per-radio basis. To enable load
balancing, select the Enable loading balancing on [2.4GHz or 5GHz] check
box, and then set or accept the default Adjacent Radio Threshold (50dB for
the 2.4GHz radio and 43dB for the 5GHz radio).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
110
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• Band Balancing: Client band balancing between the 2.4GHz and 5GHz radio
bands is disabled by default on all WLANs. To enable band balancing for this
WLAN, select the Enable band balancing on radios by distributing the
clients on 2.4GHz and 5GHz bands check box, and then set the percentages of client load that will be distributed between the 2.4GHz and 5Ghz
bands. For more information, see Band Balancing.
• Location Based Service: To enable LBS service for this AP zone, select the
Enable LBS Service check box, and then select an LBS server to use from
the drop-down list. For information on how to add an LBS server to the
controller, see Configuring Location Services.
• Client Admission Control: Set the load thresholds on the AP at which it will
stop accepting new clients. See Configuring Client Admission Control.
• AP Reboot Timeout: Set the time after which the AP will reboot automatically
when it is unable to reach the default gateway or the control interface.
-
Reboot AP if it cannot reach default gateway after: Set the time after which
the AP will reboot if it is unable to communicate with the default gateway.
The default timeout is 30 minutes.
-
Reboot AP if it cannot reach vSCG Carrier after: Set the time after which
the AP will reboot if it is unable to communicate with the vSCG. The default
timeout is 2 hours.
9 Click Create New to create the zone template.
10 Continue to Step 2: Configure the AP Model-Specific Configuration.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
111
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
Figure 45. The Create New Zone Template form
Step 2: Configure the AP Model-Specific Configuration
Follow these steps to configure the AP model-specific configuration of the zone
template.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the name of the zone template for which you want to configure AP modelspecific settings.
4 On the sidebar, click AP Model-Specific Configuration.
5 In Select an AP Model, select the AP model that you want to configure, and then
click Apply to display the configuration option for the selected AP model.
6 In General Options, configure the following options (depending on the selected
AP model, some of the options listed below may not be visible):
• PoE out port: To enable the PoE out port on the AP model, select the Enable
the PoE out port (requires custom PoE injector) check box.
• Status LEDs: To disable the external status LEDs on the AP model, select
the Disable status LEDs check box. This can be useful if your APs are
installed in a public location and you do not want to draw attention to them.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
112
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• External Antenna (2.4GHz): To enable the external 2.4GHz antenna on the
AP model, select the Enable external antenna with [x] dBi (0-90) check
box, and then a value for the dBi.
• External Antenna (5GHz): To enable the external 5GHz antenna on the AP
model, select the Enable external antenna with [x] dBi (0-90) check box,
and then a value for the dBi.
• LLDP: To enable the AP model to advertise its identity and capabilities on the
local network via LLDP, select the Enable Link Layer Discovery Protocol
check box. For a list of attributes that APs advertise using LLDP, see
Supported LLDP Attributes.
• LLDP Advertise Interval (1-300 seconds): Set the interval (in seconds) at
which the AP model will send out LLDP information. The default value is 30
seconds.
• LLDP Hold Time (60-1200 seconds): Set the length of time (in seconds) that
a receiving device will hold the LLDP information sent by the selected AP
model before discarding it. The default value is 120 seconds.
• LLDP Management IP TLV: To include the management IP address TLV in
the LLDP information that the AP model sends out, select Enable check box.
• Port Settings: For information on how to configure the port settings, see
Configuring the Port Settings of a Particular AP Model.
7 Continue to Step 3: Configure the AAA Servers of the Zone Template.
Step 3: Configure the AAA Servers of the Zone Template
Follow these steps to configure the AAA servers that the zone template will use.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the name of the zone template for which you want to configure an AAA
server.
4 On the sidebar, click AAA.
5 Click Create New. The form for creating a new RADIUS server appears.
6 Configure General Options.
• Name: Type a name for the AAA server that you are adding.
• Type: Select the type of AAA server that you have on the network. Options
include:
-
RADIUS
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
113
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
-
RADIUS Accounting
-
Active Directory
-
LDAP
• Backup RADIUS: Select the Enable backup RADIUS server check box if a
secondary RADIUS server exists on the network. Configure the settings in
Step 8.
7 In the Primary Server section, configure the settings of the primary RADIUS
server.
• IP Address: Type the IP address of the AAA server.
• Port: Type the port number of the AAA server. The default RADIUS server
port number is 1812 and the default RADIUS Accounting server port number
is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
8 In the Secondary Server section, configure the settings of the secondary RADIUS
server.
NOTE: The Secondary Server section is only visible if you selected the Enable
backup RADIUS server check box earlier.
• IP Address: Type the IP address of the secondary AAA server.
• Port: Type the port number of the secondary AAA server port number. The
default RADIUS server port number is 1812 and the default RADIUS
Accounting server port number is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
9 Click Create New to create the AAA server for the zone template.
10 Continue to Step 4: Configure the Hotspot (WISPr) Services of the Zone
Template.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
114
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
Step 4: Configure the Hotspot (WISPr) Services of the Zone
Template
NOTE: If you do not need to provide a hotspot service to users, skip this section.
NOTE: This section describes the basic settings that you need to configure to
include a hotspot service in the zone template. If you need more information about
hotspots, including third party prerequisites, see Creating and Managing Hotspots.
Follow these steps to configure the hotspot settings for the zone template.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the name of the zone template for which you want to configure a hotspot
service.
4 On the sidebar, click Hotspot (WISPr).
5 Click Create New. The form for creating a new hotspot service appears.
6 In the General Options section, configure the following options:
• Name: Type a name for the hotspot service.
• Description: Type a description for the hotspot service.
7 In the Redirection section, configure the following options:
• Smart Client Support: Select one of the following options:
-
None: Select this option to disable Smart Client support on the hotspot
service.
-
Enable: Selection this option to enable Smart Client support.
-
Only Smart Client Allowed: Select this option to allow only Smart Clients
to connect to the hotspot service.
For more information, see Configuring Smart Client Support.
• In Logon URL, type the URL of the subscriber portal (the page where hotspot
users can log in to access the service). For more information, see Configuring
the Logon URL.
• In Start Page, set where users will be redirected after they log in successfully:
-
Redirect to the URL that user intends to visit: You could redirect users
to the page that they want to visit.
-
Redirect to the following URL: You could set a different page where
users will be redirected (for example, your company website).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
115
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
8 In the User Session section, configure the following options:
• Session Timeout: Set a time limit (in minutes) after which users will be
disconnected from the hotspot service and will be required to log on again.
• Grace Period: Set the time period (in minutes) during which disconnected
users are allowed access to the hotspot service without having to log on
again.
9 In the Location Information section, configure the following options:
• Location ID: Type the ISO and ITU country and area code that the AP includes
in accounting and authentication requests. The required code includes:
-
isocc (ISO-country-code): The ISO country code that the AP includes in
RADIUS authentication and accounting requests.
-
cc (country-code): The ITU country code that the AP includes in RADIUS
authentication and accounting requests.
-
ac (area-code): The ITU area code that the AP includes in RADIUS
authentication and accounting requests.
-
network
The following is an example of what the Location ID entry should look like:
isocc=us,cc=1,ac=408,network=RuckusWireless
• Location Name: Type the name of the location of the hotspot service.
10 In Walled Garden, click Create New to add a walled garden. A walled garden is
a limited environment to which an unauthenticated user is given access for the
purpose of setting up an account.
In the box provided, type a URL or IP address to which you want to grant
unauthenticated users access. You can add up to 128 network destinations to
the walled garden. Network destinations can be any of the following:
• IP address (for example, 10.11.12.13)
• Exact website address (for example, www.ruckuswireless.com)
• Website address with regular expression (for example, *.ruckuswireless.com,
*.com, *)
After the account is established, the user is allowed out of the walled garden.
URLs will be resolved to IP addresses. Users will not be able to click through to
other URLs that may be presented on a page if that page is hosted on a server
with a different IP address. Avoid using common URLs that are translated into
many IP addresses (such as www.yahoo.com), as users may be redirected to
re-authenticate when they navigate through the page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
116
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
11 Click Create New to create the hotspot service of the zone template.
12 Continue to Step 5: Configure the Hotspot 2.0 Services of the Zone Template.
NOTE: For additional steps that you need to perform to ensure that the WISPr
service works, see Creating and Managing Hotspots.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
117
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
Step 5: Configure the Hotspot 2.0 Services of the Zone
Template
To configure a Hotspot 2.0 service, you will need to create and configure at least
one service provider profile and one operator profile. Follow these steps to configure
the Hotspot 2.0 services of the zone template.
• Creating a Service Provider Profile for the Zone Template
• Creating an Operator Profile for the Zone Template
Creating a Service Provider Profile for the Zone Template
Follow these steps to create and configure a service provider profile.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the name of the zone template for which you want to create a service
provider profile.
4 On the sidebar, click Hotspot 2.0.
5 In the Hotspot 2.0 Service Provider Profiles section, click Create New.
6 In the General Options section, configure the following options:
• Name: Type a name for the service provider.
• Description: Type a description for the service provider.
7 In the Options section, configure the following options:
• NAI Realm List: Click Create New to create a list of NAI (Network Access
Identifier) realms corresponding to SSPs or other entities whose networks or
services are accessible via this AP. Up to five NAI realm entries can be created.
Each NAI realm entry can contain up to four EAP methods. Each EAP method
can contain up to four authentication types.
8 In the Advanced Options section, configure the following options:
• Roaming Consortium List: Click Create New to create a list of organization
identifiers included in the Roaming Consortium list, as defined in
IEEE802.11u, dot11RoamingConsortiumTable. Up to two Roaming Consortium entries can be created.
• 3GPP Cellular Network Information: Click Create New to add cellular information, such as network advertisement information, to assist a 3GPP station
in selecting an AP for 3GPP network access, as defined in Annex A of 3GPP
TS 24.234 v8.1.0. Up to eight entries can be created.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
118
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
9 Click Create New.
10 Continue to Creating an Operator Profile for the Zone Template.
Creating an Operator Profile for the Zone Template
Follow these steps to create a Hotspot 2.0 operator profile.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the name of the zone template for which you want to create an operator
profile.
4 On the sidebar, click Hotspot 2.0.
5 In the Hotspot 2.0 Operator Profiles section, click Create New.
6 In the General Options section, configure the following options:
• Name: type a name for this operator profile. This name identifies the service
operator when assigning an HS2.0 service to a HS2.0 WLAN.
• Description (optional): type a description for the service.
7 In the Venue Information section, configure select venue group and venue type
as per the drop down list. This is defined as per IEEE802.11u, Table 7.25m/n.
8 In the ASRA Option section, configure the following options:
• ASRA Option: Select the Additional step required for access check box (if
required).
• Internet Option: Select the Specified with connectivity to the Internet
check box if the Hotspot 2.0 network provides connectivity to the Internet.
• Access Network Type: Select a network type (as defined in IEEE802.11u,
Table 7-43b).
9 In the IP Address Type section, select the IP address type availability information,
as defined in IEEE802.11u, 7.3.4.8.
10 In the Domain Name List section, click Create New to create domain names of
the entity operating the access network. Up to five entries can be created.
11 In the Operator Friendly Name section, click Create New to specify network
operator names in multiple languages.
12 In the Hotspot 2.0 Service Provider Profiles section, specify each service
provider, including NAI realm, domain name, roaming consortium, and 3GPP
cellular network info. Up to six service provider profiles can be indicated for each
operator profile.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
119
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
NOTE: If you have not created a service profile, this section will not display any
service profiles. See Creating a Service Provider Profile for the Zone Template.
13 In the Advanced Options section, click the + link to expand the section, and then
configure the following options:
• HESSID: Set the HESSID. A HESSID (Homogeneous Extended Service Set
Identifier) is a 6-octet MAC address that identifies the homogeneous ESS.
The HESSID value must be identical to one of the BSSIDs in the homogeneous ESS.
• WAN Metrics: Provides information about the WAN link connecting an IEEE
802.11 access network and the Internet; includes link status and backhaul
uplink/downlink speed estimates.
• Connection Capability: Provides information on the connection status
within the hotspot of the most commonly used communications protocols
and ports. 11 static rules are available, as defined in WFA Hotspot 2.0
Technical Specification, section 4.5.
14 In the Additional Connection Capability section, click Create New to add custom
connection capability rules. Up to 21 custom rules can be created.
15 Click the Create New button at the bottom of the form.
16 Continue to Step 6: Configure the WLAN Services of the Zone Template.
Step 6: Configure the WLAN Services of the Zone Template
Follow these steps to create and configure a WLAN service of an AP zone.
1 Click Configuration > AP Zones.
2 On the sidebar, click Zone Templates. The Zone Templates page appears.
3 Click the name of the zone template for which you want to create a WLAN
service. The Zone Configuration page appears.
4 On the sidebar, click WLAN.
5 Under the WLAN Configuration section, click Create New. The form for creating
a new WLAN service appears.
6 In the General Options section, configure the following options.
• Name/SSID: Type a short name (two to 32 alphanumeric characters) for this
WLAN. In general, the WLAN name is the same as the advertised SSID (the
name of the wireless network as displayed in the client’s wireless configuration program). However, you can also separate the SSID from the WLAN
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
120
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
name by entering a name for the WLAN in the first field, and a broadcast
SSID in the second field. In this way, you can advertise the same SSID in
multiple locations (controlled by the same controller) while still being able to
manage the different WLANs independently.
• Description: Type a brief description of the qualifications/purpose for this
WLAN (for example, Engineering or Voice).
7 In WLAN Usage, select the intended usage of the WLAN that you are creating:
• Standard usage (For most regular wireless networks): This is a regular
WLAN suitable for most wireless networks.
• Hotspot (WISPr): Click this option if you want to use a hotspot service that
you previously created. For instructions on how to create a hotspot service,
see Working with Hotspot (WISPr) Services.
• Guest Access + Zero-IT Onboarding: Click this option if you want guest
users to use this WLAN. After you complete creating this WLAN for guest
access, you can start generating guest passes. See Working with Guest
Passes.
• Web Authentication: Click this option if you want to require all WLAN users
to complete a web-based logon to this network every time they attempt to
connect. See Working with Web Authentication Services.
• Hotspot 2.0: Click this option if you want a Hotspot 2.0 operator profile that
you previously created to use this WLAN. See Working with Hotspot 2.0
Services.
8 In Authentication Options, click the authentication method by which users will
be authenticated prior to gaining access to the WLAN. The level of security
should be determined by the purpose of the WLAN you are creating.
• Open (Default): No authentication mechanism is applied to connections. If
WPA or WPA2 encryption is used, this implies WPA-PSK authentication.
• 802.1x EAP: A very secure authentication/encryption method that requires
a back-end authentication server, such as a RADIUS server. Your choice
mostly depends on the types of authentication the client devices support and
your local network authentication environment.
• MAC Address: Authenticate clients by MAC address. MAC address authentication requires a RADIUS server and uses the MAC address as the user
logon name and password. You have two options for the MAC address format
to use for authenticating clients:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
121
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
-
Use user defined text as authentication password (default is device MAC
address)
-
Set device MAC address in 802.1x format 00-10-A4-23-19-C0. (The
default is 0010a42319c0).
9 In Method under Encryption Options, select an encryption method to use. WPA2
is an encryption method certified by the Wi-Fi Alliance and is the recommended
encryption method. The Wi-Fi Alliance will be mandating the removal of WEP
due to its security vulnerabilities, and Ruckus Wireless recommends against
using WEP, if possible.
• WPA2: Enhanced WPA encryption using stronger TKIP or AES encryption
algorithm.
• WPA-Mixed: Allows mixed networks of WPA and WPA2 compliant devices.
Use this setting if your network has a mixture of older clients that only support
WPA and TKIP, and newer client devices that support WPA2 and AES.
• WEP-64: Provides a lower level of encryption, and is less secure, using 40bit WEP encryption.
• WEP-128: Provides a higher level of encryption than WEP-64, using a 104bit key for WEP encryption. However, WEP is inherently less secure than
WPA.
• None: No encryption; traffic is sent in clear text.
CAUTION! If you set the encryption method to WEP-64 (40 bit) or WEP-128 (104
bit) and you are using an 802.11n AP for the WLAN, the AP will operate in 802.11g
mode.
10 In Authentication & Accounting Service, configure the following options:
• Authentication Service: This option appears only when 802.1x EAP is
selected as the authentication method. Select the authentication server that
you want to use for this WLAN. Only AAA servers that you previously added
appear here.
• Accounting Service: Select the RADIUS Accounting server that you want
to use as a proxy for the controller from the drop-down list, You must have
added a RADIUS Accounting server previously (see Step 3: Configure the
AAA Servers of the Zone Template).
11 In Hotspot (WISPr) Service, select the hotspot that you want this WLAN to use.
This option appears only when Hotspot service (WISPr) is selected as the WLAN
usage type. This hotspot service may be the hotspot that you created in Step
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
122
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
5: Configure the Hotspot 2.0 Services of the Zone Template. Additionally, if you
added a RADIUS accounting server to the controller earlier, you can enable
RADIUS proxy accounting by selecting the Enable RADIUS Accounting Proxy
check box.
12 In Options, configure the following options:
• Wireless Client Isolation: Wireless client isolation enables subnet restrictions
for connected clients. Click Enable if you want to prevent wireless clients
associated with the same AP from communicating with each other locally.
The default value is Disable.
• Priority: Set the priority of this WLAN to Low if you would prefer that other
WLAN traffic takes priority. For example, if you want to prioritize internal traffic
over guest WLAN traffic, you can set the priority in the guest WLAN configuration settings to “Low.” By default, all WLANs are set to high priority.
13 In RADIUS Options, click + (plus sign) to display the options, and then configure
the following:
• RADIUS NAS ID: Select how to the RADIUS server will identify the AP:
-
WLAN BSSID
-
AP MAC
-
User-defined
• RADIUS NAS Request Timeout: Type the timeout period (in seconds) after,
which an expected RADIUS response message is considered to have failed.
• RADIUS NAS Max Number of Retries: Type the number of failed connection
attempts after which the controller will fail over to the backup RADIUS server.
• RADIUS NAS Reconnect Primary: If the controller fails over to the backup
RADIUS server, this is the interval (in minutes) at which the controller will
recheck the primary RADIUS server if it is available. The default interval is 5
minutes.
• Call STA ID: Use either WLAN BSSID or AP MAC as the station calling ID.
Select one.
14 In Advanced Options, configure the following options:
• User Traffic Profile: If you want this WLAN to use a user traffic profile that you
previously created, select it from the drop-down menu. Otherwise, select
System Default. For more information, see Working with User Traffic Profiles.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
123
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• L2 Access Control: If you want this WLAN to use an L2 access control policy
that you previously created, select it from the drop-down menu. Otherwise,
select Disable. For more information, see Working with L2 Access Control
Policies.
• Device Policy: If you want this WLAN to use a device policy that you previously
created, select it from the drop-down menu. Otherwise, select Disable. For
more information, see Working with Device Policies.
• Rate Limiting: This option controls fair access to the network. When enabled,
the network traffic throughput of each network device (client) is limited to the
rate specified in the traffic policy, and that policy can be applied on either the
uplink or downlink. Toggle the Uplink and Downlink drop-down lists to limit
the rate at which WLAN clients upload/download data. The “Disable” state
means rate limiting is disabled; thus, traffic flows without prescribed limits.
• Access VLAN: By default, all wireless clients associated with APs that the
controller is managing are segmented into a single VLAN (with VLAN ID 1). If
you want to tag this WLAN traffic with a different VLAN ID, enter a valid VLAN
ID (2-4094) in the box.
• Hide SSID: Click this option if you do not want the ID of this WLAN advertised
at any time. This will not affect performance or force the WLAN user to
perform any unnecessary tasks.
• Client Load Balancing: To disable client load balancing on this WLAN, select
the Do not perform client load balancing for this WLAN service check
box. For more information, see Client Load Balancing.
• Proxy ARP: When enabled on a WLAN, the AP provides proxy service for
stations when receiving neighbor discovery packets (e.g., ARP request and
ICMPv6 Neighbor Solicit messages), and acts on behalf of the station in
delivering ARP replies. When the AP receives a broadcast ARP/Neighbor
Solicit request for a known host, the AP replies on behalf of the host. If the
AP receives a request for an unknown host, it forwards the request at the
rate limit specified.
• Max Clients: This option limits the number of clients that can associate with
this WLAN per AP (default is 100). You can also limit the total number of
clients that a specific AP (or radio, on dual radio APs) will manage.
• 802.11d: This standard provides specifications for compliance with additional
regulatory domains (countries or regions) that were not defined in the original
802.11 standard. Click this option if you are operating in one of these
additional regulatory domains.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
124
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• Force DHCP: Enable this option to force clients to obtain a valid IP address
from DHCP within the specified number of seconds. This prevents clients
configured with a static IP address from connecting to the WLAN. Additionally, if a client performs Layer 3 roaming between different subnets, in some
cases the client sticks to the former IP address. This mechanism optimizes
the roaming experience by forcing clients to request a new IP address.
• DHCP Option 82: Select the Enable DHCP Option 82 check box to enable
this feature. When this feature is enabled and an AP receives a DHCP request
from a wireless client, the AP will encapsulate additional information (such as
VLAN ID, AP name, SSID and MAC address) into the DHCP request packets
before forwarding them to the DHCP server. The DHCP server can then use
this information to allocate an IP address to the client from a particular DHCP
pool based on these parameters.
• Client TX/RX Statistics: Select the Ignore statistics from unauthorized
clients check box if you do not want the controller to monitor traffic statistics
for unauthorized clients.
• Inactivity Timeout: Select the check box and enter a value in seconds (60 to
600) after which idle clients will be disconnected.
• Client Fingerprinting: By selecting this check box, the controller will attempt
to identify client devices by their operating system, device type and host
name, if available. This makes identifying client devices easier on the Dashboard, Monitor and Client Details pages.
• OFDM Only: Select the check box to force clients associated with this WLAN
to use only Orthogonal Frequency Division Multiplexing (OFDM) to transmit
data. OFDM-only allows the client to increase management frame transmission speed from CCK rates to OFDM rates. This feature is implemented per
WLAN and only affects the 2.4GHz radio.
• BSS Min Rate: Select this check box to set the bss rates of management
frames from default rates (CCK rates for 2.4G or OFDM rate – 6Mbps for 5G]
to the desired rates. By default, BSS Min Rate is disabled.
NOTE: OFDM-only takes higher priority than BSS-minrate. However, OFDM-only
relies on BSS-minrate to adjust its rate for management frames.
• Mgmt Tx Rate: To set the maximum transmit rate for management frame,
select a value (in Mbps) from the drop-down list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
125
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
• Service Schedule: Use the Service Schedule tool to control which hours of
the day, or days of the week to enable/disable WLAN service. Options
include:
-
Always On: Click this enable this WLAN at all times.
-
Always Off: Click this option to disable the WLAN service at all times.
-
Specific: Click this to set specific hours during which this WLAN will be
enabled. For example, a WLAN for student use at a school can be
configured to provide wireless access only during school hours. Click on
a day of the week to enable/disable this WLAN for the entire day. Colored
cells indicate WLAN enabled. Click and drag to select specific times of
day. You can also disable a WLAN temporarily for testing purposes, for
example.
• Band Balancing: To disable band balancing on this WLAN, select the Do not
perform band balancing for this WLAN service check box. For more
information, see Band Balancing.
15 Click Create New.
You have completed creating and configuring a zone template.
Exporting a Zone Template
If you are planning to create a zone template with settings that are similar to an
existing template, you can simply export the existing zone template, import it as a
new template, and then edit the settings. You can save time by doing this, instead
of creating a new zone template from scratch.
Follow these steps to export a zone template.
1 Go to Configuration > AP Zones.
2 On the sidebar, click Zone Templates.
3 Locate the zone template that you want to export.
4 Click the
export.
icon that is in the same row as the zone template that you want to
5 Alternatively, select the check box before the zone template name, and then click
Export Selected Template(s)
6 Your web browser downloads the zone template from the controller.
7 Go to the default download folder that you have configured for your web browser,
and then verify that the zone template file (with .bak extension) exists.
You have completed exporting a zone template.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
126
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Zone Templates
Importing a Zone Template
Follow these steps to import a zone template.
1 Copy the zone template file (with .bak extension) to a computer or network
location that you can access from the controller web interface.
2 If you are importing the zone template into the same controller, rename the zone
template from which you created the file. If you do not rename the original zone
template, the controller will detect that a duplicate zone template exists and the
import process will be unsuccessful.
3 To edit a zone template, click the template name on the Zone Templates page.
When the Edit Zone Template form appears, edit the template name, and then
click Apply.
4 Go to Configuration > AP Zones.
5 On the sidebar, click Zone Templates.
6 Click Import. The Importing Zone Template form appears.
7 Click Browse, and then browse to the location where you saved the zone
template file.
8 Select the file, and then click Open.
9 On the Importing Zone Template form, click Apply. A progress bar appears as
the controller imports the zone template file.
When the process is complete, the page refreshes, to reflect the zone template that
you imported in the list of zone templates. To edit the zone template, click the
template name, and then make the changes that you want.
You have completed importing a zone template.
Deleting a Zone Template
Follow these steps to delete a zone template.
1 Locate the zone template that you want to delete.
2 Click the
delete.
icon that is in the same row as the zone template that you want to
3 Alternatively, select the check box before the zone template name, and then click
Delete selected.
The following confirmation message appears:
Are you sure you want to delete the selected row?
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
127
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
4 Click Yes. The page refreshes, and then zone template that you deleted
disappears from the list.
You have completed deleting a zone template.
Working with WLAN Templates
A WLAN template contains configuration settings (AAA server, hotspot, and WLAN
settings) that you can apply to all access points that belong to a particular AP zone.
Unlike zone templates, however, WLAN templates will only overwrite the configuration of access points that have the same WLAN name that is defined in the WLAN
template. For example, if an access point has two WLANs named Ruckus1 and
Ruckus2, and then you apply a WLAN template that contains settings for a WLAN
named Ruckus1, the settings of Ruckus1 on the access point (and any other access
point that belongs to the same AP zone) will be overwritten by the settings from the
WLAN template. The settings of the Ruckus2 WLAN, however, will remain the same.
This section covers:
• Creating and Configuring a WLAN Template
• Viewing Existing WLAN Templates
• Deleting WLAN Templates
Creating and Configuring a WLAN Template
Creating a WLAN template requires that you create the template and configure the
services that will be deployed with the template.
Follow these steps to create a WLAN template.
• Step 1: Create the WLAN Template
• Step 2: Configure the AAA Servers for the WLAN Template
• Step 3: Configure the Hotspot (WISPr) Services of the WLAN Template
• Step 4: Configure the Hotspot 2.0 Services of the WLAN Template
• Step 5: Configure the WLAN Services of the WLAN Template
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
128
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
Step 1: Create the WLAN Template
Follow these steps to create a WLAN template.
1 Go to Configuration > AP Zones.
2 On the sidebar, click WLAN Templates.
3 On the WLAN Templates page, click Create New. The Create New WLAN
Template form appears.
4 In Template Name, type a name for the WLAN template that you are creating.
5 In Description, type a description for this template.
6 In Template Firmware, select the controller firmware version to which to apply
this template.
7 Click Create New at the bottom of the form.
8 Continue to Step 2: Configure the AAA Servers for the WLAN Template.
Figure 46. The form for creating a WLAN template
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
129
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
Step 2: Configure the AAA Servers for the WLAN Template
Follow these steps to create and configure an AAA server for the WLAN template.
1 Click Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears.
3 Click the name of the WLAN template for which you want to create an AAA server.
4 On the sidebar, click AAA. The AAA Servers page appears.
5 Click Create New. The Create New Zone RADIUS Server form appears.
6 Configure General Options.
• Name: Type a name for the AAA server that you are adding.
• Type: Select the type of AAA server that you have on the network. Options
include:
-
RADIUS
-
RADIUS Accounting
-
Active Directory
-
LDAP
• Backup RADIUS: Select the Enable backup RADIUS server check box if a
secondary RADIUS server exists on the network. Configure the settings in
Step 8.
7 In the Primary Server section, configure the settings of the primary RADIUS
server.
• IP Address: Type the IP address of the AAA server.
• Port: Type the port number of the AAA server. The default RADIUS server
port number is 1812 and the default RADIUS Accounting server port number
is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
8 In the Secondary Server section, configure the settings of the secondary RADIUS
server.
NOTE: The Secondary Server section is only visible if you selected the Enable
backup RADIUS server check box earlier.
• IP Address: Type the IP address of the secondary AAA server.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
130
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
• Port: Type the port number of the secondary AAA server port number. The
default RADIUS server port number is 1812 and the default RADIUS
Accounting server port number is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
9 Click Create New to create the AAA server for the WLAN template.
10 Continue to Step 3: Configure the Hotspot (WISPr) Services of the WLAN
Template.
Figure 47. The Create New AAA Server form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
131
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
Step 3: Configure the Hotspot (WISPr) Services of the
WLAN Template
NOTE: If you are not providing a hotspot service to users, skip this section.
NOTE: This section describes the basic settings that you need to configure to
include a hotspot service in the zone template. If you need more information about
hotspots, including third party prerequisites, see Creating and Managing Hotspots.
Follow these steps to configure the hotspot settings of the WLAN template.
1 Click Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears.
3 Click the name of the WLAN template for which you want to create a hotspot
service.
4 On the sidebar, click Hotspot (WISPr). The Hotspot (WISPr) Portal page
appears.
5 Click Create New. The Create New Hotspot Service form appears.
6 In the General Options section, configure the following options:
• Name: Type a name for the hotspot service.
• Description: Type a description for the hotspot service.
7 In the Redirection section, configure the following options:
• Smart Client Support: Select one of the following options:
-
None: Select this option to disable Smart Client support on the hotspot
service.
-
Enable: Selection this option to enable Smart Client support.
-
Only Smart Client Allowed: Select this option to allow only Smart Clients
to connect to the hotspot service.
For more information, see Configuring Smart Client Support.
• In Logon URL, type the URL of the subscriber portal (the page where hotspot
users can log in to access the service). For more information, see Configuring
the Logon URL.
• In Start Page, set where users will be redirected after they log in successfully:
-
Redirect to the URL that user intends to visit: You could redirect users
to the page that they want to visit.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
132
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
-
Redirect to the following URL: You could set a different page where
users will be redirected (for example, your company website).
8 In the User Session section, configure the following options:
• Session Timeout: Set a time limit (in minutes) after which users will be
disconnected from the hotspot service and will be required to log on again.
• Grace Period: Set the time period (in minutes) during which disconnected
users are allowed access to the hotspot service without having to log on
again.
9 In the Location Information section, configure the following options:
• Location ID: Type the ISO and ITU country and area code that the AP includes
in accounting and authentication requests. The required code includes:
-
isocc (ISO-country-code): The ISO country code that the AP includes in
RADIUS authentication and accounting requests.
-
cc (country-code): The ITU country code that the AP includes in RADIUS
authentication and accounting requests.
-
ac (area-code): The ITU area code that the AP includes in RADIUS
authentication and accounting requests.
-
network
The following is an example of what the Location ID entry should look like:
isocc=us,cc=1,ac=408,network=RuckusWireless
• Location Name: Type the name of the location of the hotspot service.
10 In Walled Garden, click Create New to add a walled garden. A walled garden is
a limited environment to which an unauthenticated user is given access for the
purpose of setting up an account.
In the box provided, type a URL or IP address to which you want to grant
unauthenticated users access. You can add up to 128 network destinations to
the walled garden. Network destinations can be any of the following:
• IP address (for example, 10.11.12.13)
• Exact website address (for example, www.ruckuswireless.com)
• Website address with regular expression (for example, *.ruckuswireless.com,
*.com, *)
After the account is established, the user is allowed out of the walled garden.
URLs will be resolved to IP addresses. Users will not be able to click through to
other URLs that may be presented on a page if that page is hosted on a server
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
133
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
with a different IP address. Avoid using common URLs that are translated into
many IP addresses (such as www.yahoo.com), as users may be redirected to
re-authenticate when they navigate through the page.
11 Click Create New to create the hotspot service of the WLAN template.
12 Continue to Step 4: Configure the Hotspot 2.0 Services of the WLAN Template.
Step 4: Configure the Hotspot 2.0 Services of the WLAN
Template
To configure a Hotspot 2.0 service, you will need to create and configure at least
one service provider profile and one operator profile. Follow these steps to configure
the Hotspot 2.0 services of the WLAN template.
Creating a Service Provider Profile for the WLAN Template
Creating an Operator Profile for the WLAN Template
Creating a Service Provider Profile for the WLAN Template
Follow these steps to create and configure a service provider profile.
1 Click Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears.
3 Click the name of the WLAN template for which you want to create a Hotspot
(WISPr) service.
4 On the sidebar, click Hotspot 2.0. The Hotspot 2.0 Services page appears.
5 In the Hotspot 2.0 Service Provider Profiles section, click Create New.
6 In the General Options section, configure the following options:
• Name: type a name for the service provider.
• Description: type a description for the service provider.
7 In the Options section, configure the following options:
• NAI Realm List: Click Create New to create a list of NAI (Network Access
Identifier) realms corresponding to SSPs or other entities whose networks or
services are accessible via this AP. Up to five NAI realm entries can be created.
Each NAI realm entry can contain up to four EAP methods. Each EAP method
can contain up to four authentication types.
8 In the Advanced Options section, configure the following options:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
134
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
• Roaming Consortium List: Click Create New to create a list of organization
identifiers included in the Roaming Consortium list, as defined in
IEEE802.11u, dot11RoamingConsortiumTable. Up to two Roaming Consortium entries can be created.
• 3GPP Cellular Network Information: Click Create New to add cellular information, such as network advertisement information, to assist a 3GPP station
in selecting an AP for 3GPP network access, as defined in Annex A of 3GPP
TS 24.234 v8.1.0. You can create up to eight entries.
9 Click Create New.
10 Continue to Creating an Operator Profile for the WLAN Template.
Creating an Operator Profile for the WLAN Template
Follow these steps to create a Hotspot 2.0 operator profile.
1 Click Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears.
3 Click the name of the WLAN template for which you want to create a hotspot
(WISPr) service.
4 On the sidebar, click Hotspot 2.0. The Hotspot 2.0 Services page appears.
5 In the General Options section, configure the following options:
• Name: type a name for this operator profile. This name identifies the service
operator when assigning an HS2.0 service to a HS2.0 WLAN.
• Description (optional): type a description for the service.
6 In the Venue Information section, configure select venue group and venue type
as per the drop down list. This is defined as per IEEE802.11u, Table 7.25m/n.
7 In the ASRA Option section, configure the following options:
• ASRA Option: select the Additional step required for access check box (if
required).
• Internet Option: select the Specified with connectivity to the Internet
check box if the Hotspot 2.0 network provides connectivity to the Internet.
• Access Network Type: select a network type (as defined in IEEE802.11u,
Table 7-43b).
8 In the IP Address Type section, select the IP address type availability information,
as defined in IEEE802.11u, 7.3.4.8.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
135
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
9 In the Domain Name List section, click Create New to create domain names of
the entity operating the access network. Up to five entries can be created.
10 In the Operator Friendly Name section, click Create New to specify network
operator names in multiple languages.
11 In the Hotspot 2.0 Service Provider Profiles section, specify each service
provider, including NAI realm, domain name, roaming consortium, and 3GPP
cellular network info. (If you have not created a service profile, this section will
not display any service profiles. See Creating a Service Provider Profile). Up to
six service provider profiles can be indicated for each operator profile.
12 In the Advanced Options section, click the + link to expand the section, and then
configure the following options:
• HESSID: Set the HESSID. A HESSID (Homogeneous Extended Service Set
Identifier) is a 6-octet MAC address that identifies the homogeneous ESS.
The HESSID value must be identical to one of the BSSIDs in the homogeneous ESS.
• WAN Metrics: Provides information about the WAN link connecting an IEEE
802.11 access network and the Internet; includes link status and backhaul
uplink/downlink speed estimates.
• Connection Capability: Provides information on the connection status
within the hotspot of the most commonly used communications protocols
and ports. 11 static rules are available, as defined in WFA Hotspot 2.0
Technical Specification, section 4.5.
13 In the Additional Connection Capability section, click Create New to add custom
connection capability rules. Up to 21 custom rules can be created.
14 Click the Create New button at the bottom of the form.
15 Continue to Step 5: Configure the WLAN Services of the WLAN Template.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
136
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
Step 5: Configure the WLAN Services of the WLAN
Template
Follow these steps to create and configure a WLAN service for a WLAN template.
1 Click Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears.
3 Click the name of the WLAN template for which you want to create a WLAN
service.
4 On the sidebar, click WLAN.
5 Click Create New. The form for creating a new WLAN service appears.
6 In the General Options section, configure the following options.
• Name/SSID: Type a short name (two to 32 alphanumeric characters) for this
WLAN. In general, the WLAN name is the same as the advertised SSID (the
name of the wireless network as displayed in the client’s wireless configuration program). However, you can also separate the SSID from the WLAN
name by entering a name for the WLAN in the first field, and a broadcast
SSID in the second field. In this way, you can advertise the same SSID in
multiple locations (controlled by the same controller) while still being able to
manage the different WLANs independently.
• Description: Type a brief description of the qualifications/purpose for this
WLAN (for example, Engineering or Voice).
7 In WLAN Usage, select the intended usage of the WLAN that you are creating:
• Standard usage (For most regular wireless networks): This is a regular
WLAN suitable for most wireless networks.
• Hotspot (WISPr): Click this option if you want to use a hotspot service that
you previously created. For instructions on how to create a hotspot service,
see Working with Hotspot (WISPr) Services.
• Guest Access + Zero-IT Onboarding: Click this option if you want guest
users to use this WLAN. After you complete creating this WLAN for guest
access, you can start generating guest passes. See Working with Guest
Passes.
• Web Authentication: Click this option if you want to require all WLAN users
to complete a web-based logon to this network every time they attempt to
connect. See Working with Web Authentication Services.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
137
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
• Hotspot 2.0: Click this option if you want a Hotspot 2.0 operator profile that
you previously created to use this WLAN. See Working with Hotspot 2.0
Services.
8 In Authentication Options, click the authentication method by which users will
be authenticated prior to gaining access to the WLAN. The level of security
should be determined by the purpose of the WLAN you are creating.
• Open (Default): No authentication mechanism is applied to connections. If
WPA or WPA2 encryption is used, this implies WPA-PSK authentication.
• 802.1x EAP: A very secure authentication/encryption method that requires
a back-end authentication server, such as a RADIUS server. Your choice
mostly depends on the types of authentication the client devices support and
your local network authentication environment.
• MAC Address: Authenticate clients by MAC address. MAC address authentication requires a RADIUS server and uses the MAC address as the user
logon name and password. You have two options for the MAC address format
to use for authenticating clients:
-
Use user defined text as authentication password (default is device MAC
address)
-
Set device MAC address in 802.1x format 00-10-A4-23-19-C0. (The
default is 0010a42319c0).
9 In Method under Encryption Options, select an encryption method to use. WPA2
is certified by the Wi-Fi Alliance and is the recommended encryption method.
The Wi-Fi Alliance will be mandating the removal of WEP due to its security
vulnerabilities, and Ruckus Wireless recommends against using WEP if possible.
• WPA2: Enhanced WPA encryption using stronger TKIP or AES encryption
algorithm.
• WPA-Mixed: Allows mixed networks of WPA and WPA2 compliant devices.
Use this setting if your network has a mixture of older clients that only support
WPA and TKIP, and newer client devices that support WPA2 and AES.
• WEP-64: Provides a lower level of encryption, and is less secure, using 40bit WEP encryption.
• WEP-128: Provides a higher level of encryption than WEP-64, using a 104bit key for WEP encryption. However, WEP is inherently less secure than
WPA.
• None: No encryption; traffic is sent in clear text.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
138
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
CAUTION! If you set the encryption method to WEP-64 (40 bit) or WEP-128 (104
bit) and you are using an 802.11n AP for the WLAN, the AP will operate in 802.11g
mode.
10 In Authentication & Accounting Service, configure the following options:
• Authentication Service: This option appears only when 802.1x EAP is
selected as the authentication method. Select the authentication server that
you want to use for this WLAN. Only AAA servers that you previously added
appear here.
• Accounting Service: Select the RADIUS Accounting server that you want
to use as a proxy for the controller from the drop-down list, You must have
added a RADIUS Accounting server previously (see Step 2: Configure the
AAA Servers for the WLAN Template).
11 In Hotspot (WISPr) Service, select the hotspot that you want this WLAN to use.
This option appears only when Hotspot service (WISPr) is selected as the WLAN
usage type. This hotspot service may be the hotspot that you created in Step
3: Configure the Hotspot (WISPr) Services of the WLAN Template. Additionally,
if you added a RADIUS accounting server to the controller earlier, you can enable
RADIUS proxy accounting by selecting the Enable RADIUS Accounting Proxy
check box.
12 In Options, configure the following options:
• Wireless Client Isolation: Wireless client isolation enables subnet restrictions
for connected clients. Click Enable if you want to prevent wireless clients
associated with the same AP from communicating with each other locally.
The default value is Disable.
• Priority: Set the priority of this WLAN to Low if you would prefer that other
WLAN traffic takes priority. For example, if you want to prioritize internal traffic
over guest WLAN traffic, you can set the priority in the guest WLAN configuration settings to “Low.” By default, all WLANs are set to high priority.
13 In RADIUS Options, click + (plus sign) to display the options, and then configure
the following:
• RADIUS NAS ID: Select how to the RADIUS server will identify the AP:
-
WLAN BSSID
-
AP MAC
-
User-defined
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
139
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
• RADIUS NAS Request Timeout: Type the timeout period (in seconds) after,
which an expected RADIUS response message is considered to have failed.
• RADIUS NAS Max Number of Retries: Type the number of failed connection
attempts after which the controller will fail over to the backup RADIUS server.
• RADIUS NAS Reconnect Primary: If the controller fails over to the backup
RADIUS server, this is the interval (in minutes) at which the controller will
recheck the primary RADIUS server if it is available. The default interval is 5
minutes.
• Call STA ID: Use either WLAN BSSID or AP MAC as the station calling ID.
Select one.
14 In Advanced Options, click + (plus sign) to display the options, and then configure
the following options:
• User Traffic Profile: If you want this WLAN to use a user traffic profile that you
previously created, select it from the drop-down menu. Otherwise, select
System Default. For more information, see Working with User Traffic Profiles.
• L2 Access Control: If you want this WLAN to use an L2 access control policy
that you previously created, select it from the drop-down menu. Otherwise,
select Disable. For more information, see Working with L2 Access Control
Policies.
• Device Policy: If you want this WLAN to use a device policy that you previously
created, select it from the drop-down menu. Otherwise, select Disable. For
more information, see Working with Device Policies.
• Rate Limiting: This option controls fair access to the network. When enabled,
the network traffic throughput of each network device (client) is limited to the
rate specified in the traffic policy, and that policy can be applied on either the
uplink or downlink. Toggle the Uplink and Downlink drop-down lists to limit
the rate at which WLAN clients upload/download data. The “Disable” state
means rate limiting is disabled; thus, traffic flows without prescribed limits.
• Access VLAN: By default, all wireless clients associated with APs that the
controller is managing are segmented into a single VLAN (with VLAN ID 1). If
you want to tag this WLAN traffic with a different VLAN ID, enter a valid VLAN
ID (2-4094) in the box.
• Hide SSID: Click this option if you do not want the ID of this WLAN advertised
at any time. This will not affect performance or force the WLAN user to
perform any unnecessary tasks.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
140
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
• Client Load Balancing: To disable client load balancing on this WLAN, select
the Do not perform client load balancing for this WLAN service check
box. For more information, see Client Load Balancing.
• Proxy ARP: When enabled on a WLAN, the AP provides proxy service for
stations when receiving neighbor discovery packets (e.g., ARP request and
ICMPv6 Neighbor Solicit messages), and acts on behalf of the station in
delivering ARP replies. When the AP receives a broadcast ARP/Neighbor
Solicit request for a known host, the AP replies on behalf of the host. If the
AP receives a request for an unknown host, it forwards the request at the
rate limit specified.
• Max Clients: This option limits the number of clients that can associate with
this WLAN per AP (default is 100). You can also limit the total number of
clients that a specific AP (or radio, on dual radio APs) will manage.
• 802.11d: This standard provides specifications for compliance with additional
regulatory domains (countries or regions) that were not defined in the original
802.11 standard. Click this option if you are operating in one of these
additional regulatory domains.
• Force DHCP: Enable this option to force clients to obtain a valid IP address
from DHCP within the specified number of seconds. This prevents clients
configured with a static IP address from connecting to the WLAN. Additionally, if a client performs Layer 3 roaming between different subnets, in some
cases the client sticks to the former IP address. This mechanism optimizes
the roaming experience by forcing clients to request a new IP address.
• DHCP Option 82: Select the Enable DHCP Option 82 check box to enable
this feature. When this feature is enabled and an AP receives a DHCP request
from a wireless client, the AP will encapsulate additional information (such as
VLAN ID, AP name, SSID and MAC address) into the DHCP request packets
before forwarding them to the DHCP server. The DHCP server can then use
this information to allocate an IP address to the client from a particular DHCP
pool based on these parameters.
• Client TX/RX Statistics: Select the Ignore statistics from unauthorized
clients check box if you do not want the controller to monitor traffic statistics
for unauthorized clients.
• Inactivity Timeout: Select the check box and enter a value in seconds (60 to
600) after which idle clients will be disconnected.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
141
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
• Client Fingerprinting: By selecting this check box, the controller will attempt
to identify client devices by their operating system, device type and host
name, if available. This makes identifying client devices easier on the Dashboard, Monitor and Client Details pages.
• OFDM Only: Select the check box to force clients associated with this WLAN
to use only Orthogonal Frequency Division Multiplexing (OFDM) to transmit
data. OFDM-only allows the client to increase management frame transmission speed from CCK rates to OFDM rates. This feature is implemented per
WLAN and only affects the 2.4GHz radio.
• BSS Min Rate: Select this check box to set the bss rates of management
frames from default rates (CCK rates for 2.4G or OFDM rate – 6Mbps for 5G]
to the desired rates. By default, BSS Min Rate is disabled.
NOTE OFDM-only takes higher priority than BSS-minrate. However, OFDM-only
relies on BSS-minrate to adjust its rate for management frames.
• Mgmt Tx Rate: To set the maximum transmit rate for management frame,
select a value (in Mbps) from the drop-down list.
• Service Schedule: Use the Service Schedule tool to control which hours of
the day, or days of the week to enable/disable WLAN service. Options
include:
-
Always On: Click this enable this WLAN at all times.
-
Always Off: Click this option to disable the WLAN service at all times.
-
Specific: Click this to set specific hours during which this WLAN will be
enabled. For example, a WLAN for student use at a school can be
configured to provide wireless access only during school hours. Click on
a day of the week to enable/disable this WLAN for the entire day. Colored
cells indicate WLAN enabled. Click and drag to select specific times of
day. You can also disable a WLAN temporarily for testing purposes, for
example.
• Band Balancing: To disable band balancing on this WLAN, select the Do not
perform band balancing for this WLAN service check box. For more
information, see Band Balancing.
15 Click Create New at the bottom of the form.
You have completed creating and configuring a WLAN template.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
142
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with WLAN Templates
Viewing Existing WLAN Templates
Follow these steps to view the list of WLAN templates created.
1 Click Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears
and displays the details of WLAN templates that have been configured on the
controller.
Figure 48. List view of WLAN templates
Deleting WLAN Templates
You can delete a single or multiple WLAN templates simultaneously. Follow these
steps to delete a single or multiple WLAN templates.
1 Go to Configuration > AP Zones.
2 On the sidebar, click WLAN Templates. The WLAN Templates page appears.
To delete a single WLAN template, follow these steps:
a In the list of existing WLAN templates, locate the template that you want to
delete.
b Under the Actions column, click the icon
that is in the same row as the
WLAN template. A confirmation message appears.
c Click Yes. The page refreshes and the WLAN template that you deleted
disappears from the list.
To delete multiple WLAN templates simultaneously, follow these steps:
a In the list of existing WLAN templates, locate the templates that you want to
delete.
b Select the check boxes before the templates that you want delete.
c Click Delete Selected. A confirmation message appears.
d Click Yes. The page refreshes and the AAA servers that you deleted disappears from the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
143
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Registration Rules
You have completed deleting single or multiple WLAN templates.
Figure 49. Deleting multiple WLAN templates simultaneously
Working with Registration Rules
Registration rules enable the controller to assign an AP to an AP zone automatically
based on the rule that the AP matches.
This section describes the following tasks:
• Creating a Registration Rule
• Configuring Registration Rule Priorities
• Deleting a Registration Rule
NOTE: A registration rule is only applied to an AP the first time it joins the controller.
If an AP’s MAC address already exists on the controller database (whether it is in
connected on disconnected state and whether it belongs to the Staging Zone or
any other zone), the controller will assign the AP to its last known AP zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
144
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Registration Rules
Creating a Registration Rule
Follow these steps to create a registration rule.
1 Go to Configuration > AP Zones.
2 On the sidebar, click AP Registration Rules. The AP Registration Rules page
appears.
3 Click Create New. The AP Registration Rule form appears.
4 In Rule Description, type a name that you want to assign to this rule.
5 In Rule Type, click the basis upon which you want to create the rule. Options
include:
• IP Address Range: If you select this option, enter the From (starting) and To
(ending) IP address that you want to use
• Subnet: If you select this option, enter the IP address and subnet mask pair
to use for matching
• GPS Coordinates: If you select this option, type the GPS coordinates to use
for matching. Access points that have been assigned the same GPS coordinates will be automatically assigned to the AP zone that you will choose in
the next step.
• Provision Tag: If the access points that are joining the controller have been
configured with provision tags, click the Provision Tag option, and then type
a tag name in the Provision Tag box. Access points with matching tags will
be automatically assigned to the AP zone that you will choose in the next step.
NOTE: Provision tags can be configured on a per-AP basis from the access point’s
command line interface.
6 In Zone Name, click the down arrow to display available AP zones, and then
click the AP zone to which APs that match this rule will be assigned.
• Click Create New. A progress bar appears as the controller saves the AP
registration rule.
When the process is complete, the page refreshes, and then registration rule that
you created appears on the AP Registration Rules page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
145
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Registration Rules
Figure 50. Creating an AP registration rule
To create another registration rule, repeat the preceding steps. You can create as
many registration rules as you need to manage the APs on the network.
Configuring Registration Rule Priorities
The controller applies registration rules in the same order as they appear in the AP
Registration Rules table (highest to lowest priority). If you want a particular registration rule to have higher priority, you must move it up the table. Once an AP matches
a registration rule, the controller assigns the AP to the zone specified in the rule and
stops processing the remaining rules.
Follow these steps to configure the registration rule priorities.
1 Go to Configuration > AP Zones.
2 On the sidebar, click AP Registration Rules. The AP Registration Rules page
appears and displays the rules that you have created.
3 Change the priority of each registration rule as required.
4 To give a rule higher priority, move it up the table by clicking the
icon that is in the same row as the rule name.
5 To give a rule lower priority, move it down the table by clicking the
arrow) icon that is in the same row as the rule name.
(up-arrow)
(down-
When you finish configuring the rule priority, click Update Priorities to save your
changes.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
146
Managing Global Configuration, Tunnel Profiles, Templates, and AP Registration Rules
Working with Registration Rules
Deleting a Registration Rule
Follow these steps to delete a registration rule.
1 On the AP Registration Rules page, select the check box that is in the same row
as the registration rule that you want to delete.
2 Click
(trash bin icon). A confirmation message appears.
3 Click Yes to confirm that you want to delete the registration rule.
The AP Registration Rules page refreshes, and then the registration rule that you
deleted disappears from the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
147
Managing Access Points
4
In this chapter:
• Overview of Access Point Configuration
• Viewing a List of Managed Access Points
• Provisioning and Swapping Access Points
• Editing AP Configuration
• Editing Swap Configuration
• Moving a Single Access Point to a Different AP Zone
• Moving Multiple Access Points to a Different AP Zone
• Deleting an Access Point
Overview of Access Point Configuration
Once you have created registration rules and the AP zones to which joining access
points can be assigned automatically, access points will be able to join or register
with the controller automatically. After an access point registers successfully with
the controller, you can update its configuration by following the steps described in
this section.
Viewing a List of Managed Access Points
After an access point registers successfully with the controller, it appears on the
Access Points page, along with other managed access points. Follow these steps
to view a list of managed access points.
1 Go to Configuration > Access Points. A list of access points that are being
managed by the controller appears on the Access Points in Management
Domain page. These are all the access points that belong to all management
domains.
2 The list of managed access points displays details about each access point,
including its:
• AP MAC Address
• AP Name
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
148
Managing Access Points
Viewing a List of Managed Access Points
• Zone (AP zone)
• AP Group
• Model (AP model)
• AP Firmware
• IP Address (internal IP address)
• External IP Address
• Provision Method
• Provision State
• Administrative Status
• Status
• Configuration Status
• Registered On (date the access point joined the controller network)
• Registration Details
• Registration State
• Actions (actions that you can perform)
NOTE: By default, the Access Points page displays 20 access points per page
(although you have the option to display up to 250 access points per page). If the
controller is managing more than 20 access points, the pagination links at the
bottom of the page are active. Click these pagination links to view the succeeding
pages on which the remaining access points are listed.
3 To view access points that belong to a particular administration domain, click
the name of the administration domain in the domain tree (on the sidebar). The
page refreshes, and then displays all access points that belong to that
management domain.
Figure 51. Viewing a list of managed access points
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
149
Managing Access Points
Provisioning and Swapping Access Points
Provisioning and Swapping Access Points
The controller supports the provisioning and swapping of access points. As an
administrator you can:
• Upload a file containing list of AP and the pre-provisioned configuration data for
each AP. The controller processes the file and provides details on regarding the
import results (including a list of failed APs and failure reasons).
• Modify or delete pre-provisioning data if AP does not connect to the controller
• Monitor the status and stage of the pre-provisioned APs
• Manually lock or unlock APs
• Upload a file containing list of AP pairs for swapping. The controller processes
the file and provide the detailed import result (including a list of failed APs and
failure reasons).
• Manually enter the AP swap pair
• Delete the swap configuration if AP fails to contact the controller
• Monitor the status and stage of the swapping AP pairs
• Manually swap the APs
Options for Provisioning and Swapping APs
Use the following buttons on the AP List page to perform the AP provisioning and
swapping.
• Import Batch Provisioning APs: Click this button to import the provisioning file.
The controller displays the import results. Any errors that occur during the import
process will be listed by the controller.
• Export All Batch Provisioning APs: Click this button to download a CSV file
that lists all APs that have been provisioned. The exported CSV contains the
following information:
• AP MAC Address
• Zone Name
• Model
• AP Name
• Description
• Location
• GPS Coordinates
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
150
Managing Access Points
Provisioning and Swapping Access Points
• Logon ID
• Password
• Administrative State
• IP Address
• Network Mask
• Gateway
• Primary DNS
• Secondary DNS
NOTE: The exported CSV file for all batch provisioned APs only contains preprovisioned APs. It does not contain swapping APs or auto discovered APs.
NOTE: If no APs have been pre-provisioned, you will still be able to export the CSV
file but it will be empty (except for the column titles).
• Import Swapping APs: Manually trigger the swapping of two APs by clicking
the swap action in the row. You can also edit the pre-provision configuration only
if the AP does not connect to the controller. Click the AP MAC address to bring
up the configuration edit form, and then select Pre-provision Configuration.
• Export All Batch Swapping APs: Click this button to download a CSV file that
lists all APs that have been swapped. The exported CSV contains the following
information:
• Swap In AP MAC
• Swap In AP Model
• Swap Out AP MAC
NOTE: The exported CSV file for batch swapping APs only contains swapping APs.
It does not contain pre-provisioned APs or auto discovered APs.
• Delete Selected: To delete multiple pre-provisioned APs simultaneously, select
the check boxes before the AP MAC addresses, and then click Delete Selected.
To delete a single pre-provisioned AP, click the
icon that is in the same row
as the AP MAC address. If the AP has not contacted the controller, the AP record
disappears from the table. If the AP comes up later, the controller treats it as a
discovered AP. If the AP is connected to the controller, the delete operation is
similar to the AP delete operation.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
151
Managing Access Points
Provisioning and Swapping Access Points
Figure 52. Options for provisioning and swapping APs
Understanding How Swapping Works
The following table lists how the controller handles swapping by detailing each stage.
For example, you have entered swap configuration as Swap In: A and Swap out: B.
Table 4.
AP swapping stages
Stage
State A
Stage A
State B
Stage B
1. Enter data
Swapping
Not Registered
Approved
Waiting for swap in AP
registration
2. AP register
Swapping
Waiting for
swapping in
Approved
Waiting for swapping
out
3. User swap
Approved
Swapped in
Swapping
Swapped out
4: Second
swap
Swapping
Swapped out
and waiting for
swapping in
Approved
Swapped in and
waiting for swapping
out
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
152
Managing Access Points
Editing AP Configuration
Editing AP Configuration
Follow these steps to update the configuration of a managed access point.
1 On the AP List page, locate the access point whose configuration you want to
update.
2 Click the MAC address of the access point. The AP configuration form appears.
3 Update the access point configuration by modifying the options in the form.
4 Click OK.
You have completed editing the AP configuration.
NOTE: The loc parameter (which holds the Location attribute in the AP
configuration) in the controller's Captive Portal redirection to the configured hotspot
login portal is encoded using the Hex encoder from the
org.apache.commons.codec.binary library. If you have hotspots on the network and
you are using an external portal, take note of the encoding mechanism for the loc
parameter so your external portal can decode it.
Figure 53. The AP Configuration form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
153
Managing Access Points
Editing Swap Configuration
Editing Swap Configuration
The controller supports the swapping or replacement of a managed AP with a new
AP of the same model. This feature is useful when you want to avoid service
interruption because you need to replace an AP in the field.
By configuring the swap settings, you can easily and automatically export and apply
the settings of the old AP to the new AP.
Follow these steps to configure the swap settings of an AP.
1 On the AP List page, locate the access point whose swap configuration you
want to update.
2 Click the AP MAC address of the access point.
3 Click the Swap Configuration tab.
4 Update the access point configuration by modifying the options in the form.
5 Click OK.
You have completed editing the swap configuration.
Figure 54. The Swap Configuration form
Moving a Single Access Point to a Different
AP Zone
Follow these steps to move a single access point from its current AP zone to a
different one.
NOTE: The AP that you move will inherit the configuration of the new AP zone.
1 On the AP List page, locate the access point that you want to move to a different
AP zone.
2 Once you locate the access point, click the
icon that is under the Actions
column. The Select a Destination AP Zone form appears.
3 Select the AP zone to which you want to move the access point.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
154
Managing Access Points
Moving Multiple Access Points to a Different AP Zone
4 Click OK.
You have completed moving an access point to a new AP zone.
Figure 55. Selecting and moving an access point
Moving Multiple Access Points to a Different
AP Zone
Follow these steps to move multiple access points to a different AP zone simultaneously.
1 On the AP List page, locate the access points that you want to move to a different
AP zone.
2 Once you locate the access points that you want to move, select the check
boxes before their MAC addresses.
3 Click the Move Selected button that is above the access points table. The Select
Destination AP Zone form appears.
4 Select the AP zone to which you want to move the access points.
5 Click OK.
You have completed moving the selected access points to a new AP zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
155
Managing Access Points
Deleting an Access Point
Deleting an Access Point
Follow these steps to delete an access point that is currently registered with the
controller.
1 On the AP List page, locate the access point that you want to delete.
2 Once you locate the access point, click the
column. A confirmation message appears.
icon that is under the Actions
3 Click OK.
The list of managed access points refreshes, and then the access point that you
deleted disappears from the list.
NOTE: Wireless clients that are associated with the access point that you deleted
will still be able to connect to the network until the next time the access point
attempts to rejoin the controller. When these access points attempt to rejoin the
controller (through a discovery process), they will be placed in a new AP zone if they
match an existing AP registration rule. If they do not match an AP registration rule,
they will be placed automatically in the Staging Zone, at which point wireless clients
associated with these access points will lose network connectivity.
NOTE: After you delete an access point, it could take approximately two minutes
before it appears in the Staging Zone again (if the access point does not match an
existing AP registration rule). After the access point appears in the Staging Zone, it
may continue to broadcast the previous SSID for the next five minutes, after which
it will stop.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
156
Configuring Services and Profiles
5
In this chapter:
• Configuring RADIUS Services
• Configuring FTP Services
• Configuring Location Services
• Configuring an SMS Server
• Working with Authentication Profiles
• Working with Accounting Profiles
• Working with User Traffic Profiles
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
157
Configuring Services and Profiles
Configuring RADIUS Services
Configuring RADIUS Services
A RADIUS service defines the external RADIUS server configuration. RADIUS
services authenticates profiles to specify external RADIUS services used based on
the realm value.
This section covers:
• Adding a RADIUS Service
• Testing the AAA Server Configuration
• Viewing RADIUS Services
• Deleting a RADIUS Service
NOTE: If you want to use a primary and secondary RADIUS servers for
authenticating administrator, follow the steps in Adding a RADIUS Server for
Administrators.
Adding a RADIUS Service
Follow these steps to add RADIUS service.
1 Go to Configuration > Services & Profiles.
2 On the sidebar (under Services), click RADIUS. The RADIUS Services page
appears.
3 Click Create New. The Create New RADIUS form appears.
4 Configure General Options.
• Name: Type a name for the AAA server that you are adding.
• Type: Select either RADIUS or RADIUS Accounting, depending on the type
of RADIUS server that you have on the network.
• Backup RADIUS: Select the Enable backup RADIUS server check box if a
secondary RADIUS server exists on the network. Configure the settings in
Step 8.
5 Configure the Health Check Policy options. These options define the health
monitoring settings of the primary and secondary RADIUS servers, when the
controller is configured as RADIUS proxy for RADIUS Authentication and
Accounting messages.
• Response Window: Set the time (in seconds) after which, if the AAA server
does not respond to a request, the controller will initiate the “zombie period”
(see below). If the primary AAA server does not respond to RADIUS messages
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
158
Configuring Services and Profiles
Configuring RADIUS Services
sent after Response Window expires, the controller will forward the retransmitted RADIUS messages to the secondary AAA server. Note that the zombie
period is not started immediately after the Response Window expires, but
after the configured Response Window plus ¼ of the configured Zombie
Period. The default Response Window is 20 seconds.
• Zombie Period: Set the time (in seconds) after which, if the AAA server does
not respond to ANY packets during the zombie period, it will be considered
to inactive or unreachable. An AAA server that is marked “zombie” (inactive
or unreachable) will be used for proxying with a low priority. If there are other
live AAA servers, the controller will attempt to use these servers first instead
of the zombie AAA server. The controller will only proxy requests to a zombie
server only when there are no other live servers. Any request that is proxied
to an AAA server will continue to be sent to that AAA server until the home
server is marked inactive or unreachable. At that point, the request will fail
over to another server, if a live AAA server is available. The default Zombie
Period is 40 seconds.
• Revive Interval: Set the time (in seconds) after which, if no RADIUS messages
are proxied to the AAA server after it has been marked as inactive or
unreachable, the controller will mark the AAA server as active again (and
assume that it has become reachable again). The default Revive Interval is
120 seconds.
• No Response Fail: Click Yes to respond with a reject message to the NAS if
no response is received from the RADIUS server. Click No to skip sending a
response.
CAUTION! To ensure that the RADIUS failover mechanism functions correctly,
either accept the default values for the Response Window, Zombie Period, and
Revive Interval, or make sure that the value for Response Window is always higher
than the value for RADIUS NAS request timeout multiplied by the value for RADIUS
NAS max number of retries. For information on configuring the RADIUS NAS request
timeout and max number of retries, see Working with WLANs and WLAN Groups.
6 Configure the Rate Limiting options.
• Maximum Outstanding Requests (MOR): Set the maximum outstanding
requests per server. Type 0 to disable it, or set a value between 10 and 4096.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
159
Configuring Services and Profiles
Configuring RADIUS Services
• Threshold (% of MOR): Set a percentage value of the MOR at which (when
reached) the controller will generate an event. For example, if the MOR is set
to 1000 and the threshold is set to 50%, the controller will generate an event
when the number of outstanding requests reaches 500.
• Sanity Timer: Set a timer (in seconds) that will be started whenever a condition
that generates an event is reached. This helps prevent conditions that trigger
events which occur frequently.
7 In the Primary Server section, configure the settings of the primary RADIUS
server.
• IP Address: Type the IP address of the AAA server.
• Port: Type the port number of the AAA server. The default RADIUS server
port number is 1812 and the default RADIUS Accounting server port number
is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
8 In the Secondary Server section, configure the settings of the secondary RADIUS
server.
NOTE: The Secondary Server section is only visible if you selected the Enable
backup RADIUS server check box earlier.
• IP Address: Type the IP address of the secondary AAA server.
• Port: Type the port number of the secondary AAA server port number. The
default RADIUS server port number is 1812 and the default RADIUS
Accounting server port number is 1813.
• Shared Secret: Type the AAA shared secret.
• Confirm Secret: Retype the shared secret to confirm.
9 Click Create New.
You have completed adding a RADIUS service.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
160
Configuring Services and Profiles
Configuring RADIUS Services
Figure 56. The Create New RADIUS Service form
Testing the AAA Server Configuration
The test AAA server holds the information of authentication or accounting server,
including the server IP, service port, shared secret and other settings of the current
user. If the requested service is successful, the API will display the information.
NOTE: Before you can test the AAA server configuration, you must have created
an AAA server. See Adding a RADIUS Service for more information.
Follow these steps to test the AAA server configuration.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Services, click RADIUS. The RADIUS Services page
appears.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
161
Configuring Services and Profiles
Configuring RADIUS Services
3 Click Test AAA. The Test AAA Servers form appears.
4 Configure the options in the Test AAA Servers form.
• Name: Select the name of the RADIUS server that you want to test.
• User Name: Type the RADIUS user name that you want to use for testing.
• Password: Type the RADIUS password for the user.
• Confirm Password: Retyped the RADIUS password above.
5 Click Test. The message “Please wait...” appears.
If the request service fails, a relevant error message is displayed. Similarly, if the user
name or password is incorrect, the error message includes this information along
with the server IP address and port. If the server IP address, port, or shared secret
is incorrect, the connection to AAA server fails and the error message “Invalid server
setting” appears and displays the server IP address and port.
If both primary and secondary servers exist, the requested service will be interrupted
when controller meets a failure and an error message is displayed.
Figure 57. The Test AAA Servers form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
162
Configuring Services and Profiles
Configuring RADIUS Services
Viewing RADIUS Services
Follow these steps to view a list of RADIUS servers that have been configured on
the controller.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Services, click RADIUS. The RADIUS Services page
appears and displays a list of RADIUS servers that have been configured on the
controller. RADIUS details that are shown on the RADIUS Services page include:
• Name
• Description
• Type: RADIUS or RADIUS Accounting
• Primary IP
• Secondary IP
• Last Modified By
• Last Modified On
• Actions
You have completed viewing a list of RADIUS services.
Figure 58. List view of RADIUS services
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
163
Configuring Services and Profiles
Configuring RADIUS Services
Deleting a RADIUS Service
You can delete a single or multiple RADIUS services simultaneously.
• To delete a single RADIUS service, follow these steps:
a Go to Configuration > Services & Profiles.
b On the sidebar under Services, click RADIUS. The RADIUS Services page
appears.
c In the list of existing RADIUS services, locate the RADIUS server that you
want to delete.
d Under the Actions column, click the icon
that is in the same row as the
RADIUS service name. A confirmation message appears.
e Click Yes. The page refreshes, and the RADIUS service that you deleted
disappears from the view list.
• To delete multiple RADIUS services simultaneously, follow these steps:
a Go to Configuration > Services & Profiles.
b On the sidebar under Services, click RADIUS. The RADIUS Services page
appears.
c In the list of existing RADIUS services, locate the services that you want to
delete.
d Select the check boxes before the services that you want delete.
e Click Delete Selected. A confirmation message appears.
f
Click Yes. The page refreshes and the RADIUS services that you deleted
disappears from the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
164
Configuring Services and Profiles
Configuring FTP Services
Figure 59. Deleting multiple RADIUS services simultaneously
Configuring FTP Services
You can automatically back up statistical data, reports, and system configuration
backups to an external FTP server. However, before you can do this, you must add
at least one FTP server to the controller.
Follow these steps to add an FTP server to which the controller will export data
automatically.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Services, click FTP. The FTP page appears.
3 In FTP Name, type a name that you want to assign to the FTP server that you
are adding.
4 In FTP Host, type the IP address of the FTP server.
5 In Port, type the FTP port number. The default FTP port number is 21.
6 In User Name, type user name of the FTP account that you want to use.
7 In Password, type the password that is associated with the FTP user name
above.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
165
Configuring Services and Profiles
Configuring FTP Services
8 In Remote Directory, type the path on the remote FTP server to which data will
be exported from the controller. The path must start with a forward slash (/), as
shown in Figure 60.
9 To verify that the FTP server settings and logon information are correct, click
Test. If the server and logon settings are correct, the following message appears:
Test completed successfully.
10 Click Create New.
You have completed adding an FTP server to the controller. You may add additional
FTP servers as required.
Figure 60. Adding an FTP server to the controller
Important Notes About FTP Services
Release 2.5 (and later) includes several changes to the FTP server configuration.
Remember the following important notes when configuring FTP services in release
2.5 (and later).
• Duplicate FTP servers are not allowed in release 2.5 (and later). For example,
you cannot add 172.19.7.23 as one FTP server and 172.19.7.23/temp
(/temp is the remote directory) as another.
• FTP servers must be added on the Configuration > Services & Profiles > FTP
page. The FTP servers that you add on this page will appear as options on the
following pages:
• System > FTP Server for Uploading Statistics
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
166
Configuring Services and Profiles
Configuring FTP Services
• Reports > Export Report Results
• System Configuration Backup and Restore: Auto Export Backup
• If, before the controller was upgraded to 2.5 (or later version), statistics upload,
reports, and system configuration backup were configured to be uploaded to
four different FTP servers, then after upgrading to 2.5 (or later version), the
controller will automatically create entries for those four FTP servers on the
Configuration > Services & Profiles > FTP page.
• If, before the controller was upgraded to 2.5, statistics upload, reports, and
system configuration backup were configured to be uploaded to the same FTP
server but using different FTP accounts, then after upgrading to 2.5 or later
version, the controller will automatically create entries for those four FTP servers
on the Configuration > Services & Profiles > FTP page.
• If, before the controller was upgraded to 2.5 (or later version), statistics upload,
reports, and system configuration backup were configured to be uploaded to
the same FTP server and using the same FTP account, then after upgrading to
2.5 (or later version), the controller will automatically create one FTP server entry
on the Configuration > Services & Profiles > FTP page. If one of the previous
FTP server configurations included a remote directory, the same remote directory
will be applied to the new FTP server entry and all data for backup will be
uploaded to this remote directory.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
167
Configuring Services and Profiles
Configuring Location Services
Configuring Location Services
If your organization purchased the Ruckus Wireless SmartPositioning Technology
(SPoT) location service, the controller must be configured with the venue information
that is displayed in the SPoT Administration Portal.
After completing purchase of the SPoT location service, you will be given account
login information that you can use to log into the SPoT Administration Portal. The
Admin Portal provides tools for configuring and managing all of your “venues” (the
physical locations in which SPoT service is deployed). After a venue is successfully
set up, you will need to enter the same venue information on the controller.
Adding an LBS Server
Follow these steps to add an LBS server to the controller for SPoT communication.
1 Log on to the SPoT Administration Portal.
2 On the Venues page, click Config next to the venue for which you want to
configure Location Services.
3 In Controller Settings, take note of the values for the following:
• Venue Name
• Server Address
• Port
• Password
4 On the controller web interface, go to Configuration > Services & Profiles >
Services > Location Services.
5 Click Create New. The Create New LBS Server form appears.
Figure 61. The Create New LBS Server form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
168
Configuring Services and Profiles
Configuring Location Services
6 Enter the information you obtained in Step 3 from the SPoT Administration Portal
into the four fields provided.
• Venue Name
• Server Address
• Port
• Password
7 Click OK to save your changes.
You have completed adding an LBS server to the controller. You can now use this
LBS server along with your zone and AP group configuration (see Configuring the
Controller to Use the LBS Server).
After you configure zones or AP groups to use an LBS server, you can
Configuring the Controller to Use the LBS Server
There are two ways to configure the controller to use the LBS servers you added
in Adding an LBS Server. You can:
• Set an entire AP zone to use an LBS server
• Set an AP group to override the LBS settings of a zone
NOTE: For information on configuring and managing the Ruckus Wireless
SmartPositioning Technology (SPoT) service, refer to the SPoT User Guide, which
is available for download from https://support.ruckuswireless.com.
Setting an AP Zone to Use an LBS Server
When you create or edit an AP zone, you can enable the LBS service for the entire
zone by selecting the Enable LBS Service check box, and then selecting an LBS
server to use.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
169
Configuring Services and Profiles
Configuring Location Services
Figure 62. Enabling and selecting an LBS in the create/edit AP zone form
Setting an AP Group to Override the LBS Settings of a Zone
If you want APs that belong to an AP group to use a different LBS server, you can
override the LBS settings at the AP group level. Follow these steps.
1 Go to Configuration > AP Zones.
2 In the AP Zone List, click the zone name to which the AP group you want to
configure belongs.
3 On the sidebar, click AP Group.
4 Click Create New to create a new AP group, or click the AP group name to edit it.
5 In the form that appears, scroll down to the Advanced Options section. Click the
plus (+) sign before Advanced Options to display all options.
6 In Location Based Service, select the Override zone config check box.
7 Configure the LBS settings as required.
• To disable the LBS service for this AP group, clear the Enable LBS service
check box.
• To use a different LBS server for this AP group, select the Enable LBS service
check box, and then select the LBS server that you want to use from the
drop-down list.
8 Configure the other AP group settings as required. For information on configuring
AP groups, see Creating an AP Group.
9 Click OK.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
170
Configuring Services and Profiles
Configuring an SMS Server
You have completed setting an AP group to override the LBS settings of its zone.
Figure 63. Overriding the LBS settings of a zone at the AP group level
Configuring an SMS Server
If you want to deliver guest passes to guest users via SMS, you can configure the
controller use an existing Twilio account for SMS delivery. The first step is to inform
the controller of your Twilio account information.
Follow these steps to configure an external SMS gateway for the controller.
1 Go to Configuration > Services & Profiles > SMS Server.
2 Select the Enable Twilio SMS Server check box.
3 Under Twilio Account Information, configure the following:
• Server Name
• Account SID
• Auth TokenSCG
• From (phone number)
4 Click Apply.
You have completed configuring the external SMS gateway for the controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
171
Configuring Services and Profiles
Working with Authentication Profiles
Figure 64. Configuring the external SMS gateway settings
Working with Authentication Profiles
An authentication profile defines the authentication policy when the controller is used
as a RADIUS proxy service for WLANs. RADIUS protocol is used for interfacing
between access points and the controller as well as between the controller and a
third party AAA server. The controller acts as RADIUS proxy for authentication and
authorization and as a RADIUS client for accounting.
This section covers:
• Creating an Authentication Profile
• Viewing Authentication Profiles
• Deleting Authentication Profiles
Creating an Authentication Profile
Follow these steps to create an authentication profile.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Profiles, click Authentication. The Authentication Profiles
page appears.
3 Click Create New. The Create New Authentication Profile form appears.
4 In Name, type a name for the authentication profile that you are adding.
5 In Description, type a brief description of the profile. This is an optional field.
6 Under Default Service Settings, configure the following attributes, which are
required for enabling AAA support and 3GPP support. These are also required
when controller authentication works as a proxy.
• In No Matching Realm Found, configure the following:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
172
Configuring Services and Profiles
Working with Authentication Profiles
-
Default Auth Service
-
Authorization Method
-
Dynamic VLAN ID
• In No Realm Specified, configure the following:
-
Default Auth Service: If you select NA-Request Rejected, then the
authorization method will be displayed as 'NA' but the value that will be
sent is 0 (zero).
-
Authorization Method
-
Dynamic VLAN ID
7 In Authentication Service Per Realm, specify the authentication service for each
of the realms specified in this table. If you set the authentication service for a
particular realm to NA-Request Rejected, then the authentication request is
rejected. To create a new service click, Create New, and then configure the
following:
• Realm
• Auth Service
• Authorization Method
• Dynamic VLAN ID
8 Click Create New.
You have completed adding an authentication profile.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
173
Configuring Services and Profiles
Working with Authentication Profiles
Figure 65. The Create New Authentication Profile form
Viewing Authentication Profiles
Follow these steps to view a list of authentication profiles that have been created
on the controller.
NOTE: If you have not created an authentication profile, refer to Creating an
Authentication Profile.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Profiles, click Authentication. The Authentication Profiles
page appears and displays the authentication servers that have been added to
the controller. For each authentication profile, the following details are displayed:
• Profile Name
• Description
• Last Modified By
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
174
Configuring Services and Profiles
Working with Authentication Profiles
• Last Modified On
• Actions: Displays the trash bin icon, which you can click to delete the profile
You have completed viewing a list of authentication profiles.
Figure 66. The Authentication Profiles page lists the profiles that have been created on the
controller
Deleting Authentication Profiles
Follow these steps to delete a single or multiple authentication profiles simultaneously.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Profiles, click Authentication. The Authentication Profiles
page appears and lists the profiles that have been configured on the controller.
3 Delete a single or multiple profiles.
To delete a single profile:
a In the list of existing profiles, locate the profile that you want to delete.
b Under the Actions column, click the icon
profile. A confirmation message appears.
that is in the same row as the
c Click Yes. The page refreshes, and the profile that you deleted disappears
from the view list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
175
Configuring Services and Profiles
Working with Authentication Profiles
To delete multiple profiles simultaneously, follow these steps:
a In the list of existing profiles, locate the profiles that you want to delete.
b Select the check boxes before the profiles that you want delete.
c Click Delete Selected. A confirmation message appears.
d Click Yes. The page refreshes and the profiles that you deleted disappears
from the list.
You have completed deleting authentication profiles.
Figure 67. Deleting multiple profiles simultaneously
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
176
Configuring Services and Profiles
Working with Accounting Profiles
Working with Accounting Profiles
An accounting profile defines the accounting policy when the controller is used as
a RADIUS proxy for WLAN services. This section covers:
• Creating an Accounting Profile
• Viewing Accounting Profiles
• Deleting Accounting Profiles
Creating an Accounting Profile
Follow these steps to create an accounting profile.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Profiles, click Accounting. The Accounting Profiles page
appears
3 Click Create New. The Create New Accounting Profile form appears.
4 In Name, type a name for the authentication profile that you are adding.
5 In Description, type a brief description of the profile. This is an optional field.
6 Under Default Service Settings, configure the following:
• In No Matching Realm Found, select a default accounting service. If you
select NA-Disabled, then the accounting method will be displayed as 'NA'
but the value that will be sent is 0 (zero).
• In No Realm Specified, select a default accounting service. If you select NADisabled, then the accounting method will be displayed as 'NA' but the value
that will be sent is 0 (zero).
7 In Accounting Service Per Realm, specify the accounting service for each of the
realms specified in this table. If you set the accounting service for a particular
realm to NA-Disabled, then the accounting request is rejected. To create a new
service click, Create New, and then configure the following:
• Realm
• Accounting Service
8 Click Create New.
You have completed adding an accounting profile.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
177
Configuring Services and Profiles
Working with Accounting Profiles
Figure 68. The Create New Accounting Profile form
Viewing Accounting Profiles
Follow these steps to view a list of accounting profiles that have been created on
the controller.
NOTE: If you have not created an accounting profile, refer to Creating an Accounting
Profile.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Profiles, click Accounting. The Accounting Profiles page
appears and displays the accounting profiles that have been added to the
controller. For each accounting profile, the following details are displayed:
• Profile Name
• Description
• Last Modified By
• Last Modified On
• Actions: Displays the trash bin and clone icons. Click the trash bin icon to
delete the profile. Click the clone icon to create a copy of the profile.
You have completed viewing a list of accounting profiles.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
178
Configuring Services and Profiles
Working with Accounting Profiles
Figure 69. The Accounting Profiles page lists the profiles that have been created on the
controller
Deleting Accounting Profiles
Follow these steps to delete a single or multiple accounting profiles simultaneously.
1 Go to Configuration > Services & Profiles.
2 On the sidebar under Profiles, click Accounting. The Accounting Profiles page
appears and lists the profiles that have been configured on the controller.
3 Delete a single or multiple profiles.
To delete a single profile:
a In the list of existing profiles, locate the profile that you want to delete.
b Under the Actions column, click the icon
profile. A confirmation message appears.
that is in the same row as the
c Click Yes. The page refreshes, and the profile that you deleted disappears
from the view list.
To delete multiple profiles simultaneously, follow these steps:
a In the list of existing profiles, locate the profiles that you want to delete.
b Select the check boxes before the profiles that you want delete.
c Click Delete Selected. A confirmation message appears.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
179
Configuring Services and Profiles
Working with User Traffic Profiles
d Click Yes. The page refreshes and the profiles that you deleted disappears
from the list.
You have completed deleting accounting profiles.
Figure 70. Deleting multiple profiles simultaneously
Working with User Traffic Profiles
A user traffic profile defines whether the system will allow or block a particular type
of traffic based on a number of attributes, including:
• Source IP address (specific IP address or IP address range)
• Source port number (specific port or port range)
• Destination IP address (specific IP address or IP address range)
• Destination port number (specific port or port range)
• Network protocol (TCP, UDP, etc.)
• Traffic direction
Creating a User Traffic Profile
Follow these steps to create a user traffic profile.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
180
Configuring Services and Profiles
Working with User Traffic Profiles
1 Go to Configuration > Services & Profiles > Profiles > User Traffic. The User Traffic
page appears.
2 Click Create New. The Create New User Traffic Profile page appears.
3 In Name, type a name for this profile.
4 In Description, type a short description for this profile.
5 In Default Access, select whether you want the controller to allow or block users
using this profile if the user traffic does not match any of the rules you defined.
6 In the Rules section, click Create New.
NOTE: By default, two default rules exist (Allow DNS and Allow DHCP) when you
create a new profile. You can modify these rules or even delete them.
7 In Source IP, specify the source IP address to which this rule will apply.
• To apply this rule to an IP address range, type the network address and the
subnet mask.
• To apply this rule to a single IP, clear the Subnet check box, and then enter
the IP address.
8 In Source Port, specify the source port to which this rule will apply.
• To apply this rule to a port range, type the starting and ending port numbers
in the two boxes.
• To apply this rule to a single port number, clear the Range check box, and
then enter the port number.
9 In Destination IP, specify the destination IP address to which this rule will apply.
• To apply this rule to an IP address range, type the network address and the
subnet mask.
• To apply this rule to a single IP, clear the Subnet check box, and then enter
the IP address.
10 In Destination Port, specify the source port to which this rule will apply.
• To apply this rule to a port range, type the starting and ending port numbers
in the two boxes.
• To apply this rule to a single port number, clear the Range check box, and
then enter the port number.
11 In Protocol, select the network protocol to which this rule will apply. Supported
protocols include:
• TCP
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
181
Configuring Services and Profiles
Working with User Traffic Profiles
• UDP
• UDPLITE
• ICMP (ICMPv4)
• IGMP
• ESP
• AH
• SCTP
12 In Direction, leave as is. Only one traffic direction (upstream) is supported in this
release.
13 Click OK.
You have completed creating a user traffic profile. The next time you a WLAN, this
profile will appear as one of the options for User Traffic Profile.
Viewing User Traffic Profiles
Follow these steps to view a list of existing user traffic profiles.
1 Go to Configuration > Services & Profiles > Profiles > User Traffic. The User Traffic
Profile page appears and displays all existing user traffic profiles and their basic
settings are shown, including the:
• User traffic profile name
• Description
• Default access (allow or block)
• Actions (that you can perform)
2 To view the type of traffic that has been defined in a particular user traffic profile,
click the profile name.
You have completed viewing existing user traffic profiles.
Deleting Traffic Profiles
Follow these steps to delete user traffic schedule profiles.
1 Go to Configuration > Services & Profiles > Profiles > User Traffic. The User Traffic
Profile page appears.
2 Locate the profile or profiles that you want to delete.
3 Select the check boxes (first column) for the profiles that you want to delete.
4 Click Delete Selected.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
182
Configuring Services and Profiles
Working with User Traffic Profiles
The profiles that you selected disappear from the list. You have completed deleting
user traffic profiles.
NOTE: If you are deleting a single profile, you can also click the
icon (under the
Actions column) that is in the same row as the profile that you want to delete.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
183
Configuring the System Settings
6
In this chapter:
• Overview of the System Settings
• Configuring General System Settings
• Configuring Cluster Planes
• Configuring Network Management
Overview of the System Settings
System settings refer to general controller settings, network management settings,
and plane settings.
Configuring General System Settings
To configure the general settings, go to the Configuration > vSCG Carrier System
page, and then click General System Settings on the sidebar. Configuration tasks
under general settings include:
• Setting the System Time
• Configuring the Syslog Server Settings
• Configuring the Northbound Portal Interface
• Configuring the SMTP Server Settings
• Configuring the FTP Server Settings
• Setting Critical AP Auto Tagging Rules
• Managing the Web Certificate
• Managing the AP Portal Certificate
• Managing the User Agent Black List
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
184
Configuring the System Settings
Configuring General System Settings
Setting the System Time
The controller uses an external network time protocol (NTP) server to synchronize
the times across cluster nodes and managed access points.
Follow these steps to set the system time.
1 Go to Configuration > vSCG Carrier System.
2 Under General System Settings, click System Time.
3 In NTP Server, type the server address that you want to use. The default NTP
server address is pool.ntp.org.
4 In vSCG Carrier System Time Zone, select the time zone that you want the
controller to use. The default time zone is (GMT +0:00) UTC.
5 Click Apply.
Figure 71. System time settings
How APs Synchronize Time with the Controller
When an AP joins the controller, it automatically synchronizes its time with the
controller system time. After that, the AP automatically synchronizes its time with
the controller every day.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
185
Configuring the System Settings
Configuring General System Settings
Configuring the Syslog Server Settings
The controller maintains an internal log file of current events and this file has a fixed
capacity. At a certain point, the controller will start deleting the oldest entries in log
file to make room for newer entries. If you want to keep a permanent record of all
events that the controller generated, you can configure the controller to send the
log contents to a syslog server on the network.
Follow these steps to configure the syslog server settings.
1 Go to Configuration > vSCG Carrier System.
2 Under General System Settings, click Syslog Server. The Syslog Server Settings
page appears.
3 Select the Enable vSCG Event to Remote Syslog Server check box.
4 In Syslog Server Host, type the IP address of the syslog server on the network.
5 In Syslog Server Port, type the syslog port number on the server.
NOTE: To verify that the syslog server that you intend to use is reachable, click the
Ping Syslog Server button.
6 In Event Filter, select one of the following options to specify which events will be
sent to the syslog server:
• All events: Click this option to send all controller events to the syslog server.
• All events except client associate/disassociate events: Click this option
to send all controller events (except client association and disassociation
events) to the syslog server.
• All events above a severity: Click this option to send all controller events
that are above the event severity that you specify in Event Filter Severity.
-
Event Filter Severity: (This option only appears when All events above a
severity is selected.) Select the lowest severity level for which events will
be sent to the syslog server. For example, if you select Major, all events
that are major and higher (including critical) will be sent to the syslog server.
For the order of event severity that the controller follows, see Event
Severity Levels.
7 In Facility, select the facility level that will be used by the syslog message. Options
include Local0 (default), Local1, Local2, Local3, Local4, Local5, Local6, and
Local7.
8 In Priority, accept or change the default severity to priority mapping. See Default
Event Severity to Syslog Priority Mapping.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
186
Configuring the System Settings
Configuring General System Settings
9 Click Apply.
Figure 72. Syslog server settings
Event Severity Levels
Table 5 describes the event severity levels (1 to 6, with 1 being the most severe)
that the controller follows.
Table 5.
Event severity levels in the controller
Level
Message
Description
1
Critical
A critical condition that must resolved immediately
2
Major
An error condition that must be resolved
3
Minor
An error condition that must be checked to determine if it
needs to be resolved
4
Warning
Warning message, not an error, but indication that an error
will occur if action is not taken
5
Informational
Normal operational messages - may be harvested for
reporting, measuring throughput, etc. - no action required.
6
Debug
Info useful to developers for debugging the application, not
useful during operations.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
187
Configuring the System Settings
Configuring General System Settings
Default Event Severity to Syslog Priority Mapping
Table 6 lists the default event severity to syslog priority mapping in the controller.
Table 6.
Event severity to syslog priority mapping
Event Severity
Syslog Priority
Critical
Error
Major
Error
Minor
Warning
Warning
Warning
Informational
Info
Debug
Debug
Configuring the Northbound Portal Interface
Follow these steps to configure the northbound portal interface.
1 Go to the Northbound Portal Interface section.
2 In Password, type the password for the northbound portal interface.
3 Click Apply.
Figure 73. The Northbound Portal Interface section
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
188
Configuring the System Settings
Configuring General System Settings
Configuring the SMTP Server Settings
If you want to receive copies of the reports that the controller generates, configure
the SMTP server settings and the email address to which the controller will send
the reports. Follow these steps to configure the SMTP server settings.
1 Go to the SMTP Server Settings section.
2 Select the Enable SMTP Server check box.
3 In Logon Name, type the logon or user name provided by your ISP or mail
administrator. This might be just the part of your email address before the @
symbol, or it might be your complete email address. If you are using a free email
service (such as Hotmail™ or Gmail™), you typically have to type your complete
email address.
4 In Password, type the password that is associated with the user name above.
5 In SMTP Server Host, type the full name of the server provided by your ISP or
mail administrator. Typically, the SMTP server name is in the format
smtp.company.com.
• In SMTP Server Port, type the SMTP port number provided by your ISP or mail
administrator. Often, the SMTP port number is 25 or 587. The default SMTP port
value is 25.
• In Mail From, type the email address from which the controller will send email
notifications.
• In Mail To, type the email address to which the controller will send alarm
messages. You can send alarm messages to a single email address.
• If your mail server uses encryption, select the encryption method in Encryption
Options. Options include TLS and STARTTLS. Check with your ISP or mail
administrator for the correct encryption settings that you need to set.
• Click Apply.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
189
Configuring the System Settings
Configuring General System Settings
Figure 74. The SMTP Server Settings section
Configuring the FTP Server Settings
Follow these steps to configure the FTP server settings for uploading raw report
data (in CSV format).
1 Go to the FTP Settings for Uploading Statistics section.
2 Select the Enable uploading statistics data to FTP server check box.
3 In Statistics Data Interval, select the time interval at which the controller uploads
a copy of raw statistical data to the FTP server. Options include:
• Hourly: If you select this option, the controller will upload data to the FTP
server every 20th minute of the hour (for example, 00:20, 01:20, 02:20 and
so on).
• Daily: If you select this option, the controller will upload data to the FTP server
at 12:35AM every day.
4 In FTP Server, select the FTP server to which you want to upload the statistics
data. The FTP server options that appear here are those that you created in
Configuring FTP Services.
5 To verify that the FTP server settings and logon information are correct, click
Test. If the server and logon settings are correct, the following message appears:
Test completed successfully.
6 Click Apply.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
190
Configuring the System Settings
Configuring General System Settings
Figure 75. FTP server settings
NOTE: For detailed information on the statistics files that are exported to the FTP
server and their content, see Statistics Files the Controller Exports to an FTP Server.
Setting Critical AP Auto Tagging Rules
A critical AP is an AP that exceeds the daily traffic threshold (sum of uplink and
downlink) data bytes configured on the controller web interface. Follow these steps
to tag critical APs automatically.
1 Go to the Critical AP Auto Tagging Rules section.
2 Select the Enable Auto Tagging Critical APs check box.
3 Under Auto Tagging Rules, select Daily Traffic Bytes Exceeds Threshold.
4 Under Rule Threshold, specify the threshold:
5 In the first box, type a value that you want to set as the traffic threshold. This
value will be applied in conjunction with the data unit that you will select in the
second box.
6 In the second box, select the data unit for the threshold – M for megabytes or
G for gigabytes.
7 Click Apply.
APs that exceed the daily traffic threshold that you specified will appear highlighted
on the AP List page and the Access Point details page. Additionally, the controller
will send an SNMP trap to notify that an AP has been disconnected.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
191
Configuring the System Settings
Configuring General System Settings
Figure 76. Critical AP Tagging Rules
Managing the Web Certificate
If you have not imported an SSL certificate into the controller, a security warning
appears every time you connect to the web interface. This is because the default
SSL certificate (or security certificate) that the controller is using for HTTPS communication is signed by Ruckus Wireless and is not recognized by most web browsers.
To prevent these security warnings from appearing, you can import an SSL certificate that is issued by a recognized certificate authority.
This section describes the following topics:
• Generate a Certificate Signing Request
• Importing a Self Signed Web Certificate
• Viewing the Currently Installed Web Certificate
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
192
Configuring the System Settings
Configuring General System Settings
Generate a Certificate Signing Request
This section describes how to generate a certificate signing request (which you need
to obtain a signed certificate) and how to import a signed certificate into the
controller.
NOTE: If you already have an SSL certificate, skip this step and continue to Import
the Signed Certificate for HTTPS Communication.
If you do not have an SSL certificate, you will need to create a certificate signing
request (CSR) file and send it to an SSL certificate provider to purchase an SSL
certificate. The controller web interface provides a form that you can use to create
the CSR file. Follow these steps to generate a certificate request.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Web Certificate. The Web Certificate page appears.
3 Click Generate CSR. The Generate New Certificate Request form appears.
4 Fill out the following boxes:
• Common Name: Type the fully qualified domain name of your Web server.
This must be an exact match (for example, www.ruckuswireless.com).
• Email: Type your email address (for example, joe@ruckuswireless.com).
• Organization: Type the complete legal name of your organization (for
example, Ruckus Wireless, Inc.). Do not abbreviate your organization
name.
• Organization Unit: Type the name of the division, department, or section in
your organization that manages network security (for example, Network
Management).
• Locality/City: Type the city where your organization is legally located (for
example, Sunnyvale).
• State/Province: Type the state or province where your organization is legally
located (for example, California) Do not abbreviate the state or province
name.
• Country: Select the country where your organization is location from the dropdown list.
5 Click Generate. The controller generates the certificate request. When the
certificate request file is ready, your web browser automatically downloads it.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
193
Configuring the System Settings
Configuring General System Settings
6 Go to the default download folder of your Web browser and locate the certificate
request file. The file name is myreq.zip.
7 Use a text editor (for example, Notepad) to open the certificate request file.
8 Go to the website of your preferred SSL certificate provider, and then follow the
instructions for purchasing an SSL certificate.
9 When you are prompted for the certificate signing request, copy and paste the
entire content of myreq.csr, and then complete the purchase.
After the SSL certificate provider approves your CSR, you will receive the signed
certificate via email. The following is an example of a signed certificate that you
will receive from your SSL certificate provider:
-----BEGIN CERTIFICATE----MIIFVjCCBD6gAwIBAgIQLfaGuqKukMumWhbVf5v4vDANBgkqhkiG9w0B
AQUFADCBƒnsDELMAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLC
BJbmMuMR8wHQYDVQQLƒnBgEFBQcBAQRtMGswJAYIKwYBBQUHMAGGGGh0
dHA6Ly9vY3NwLnZlcmlzaWduLmNvƒnbTBDBggrBgEFBQcwAoY3aHR0cD
ovL1NWUlNlY3VyZS1haWEudmVyaXNpZ24uY29tƒnL1NWUlNlY3VyZTIw
MDUtYWlhLmNlcjBuBggrBgEFBQcBDARiMGChXqBcMFowWDBWƒnFglpbW
FnZS9naWYwITAfMAcGBSsOAwIaBBRLa7kolgYMu9BSOJsprEsHiyEFGD
AmƒnFiRodHRwOi8vbG9nby52ZXJpc2lnbi5jb20vdnNsb2dvMS5naWYw
DQYJKoZIhvcNƒnAQEFBQADggEBAI/S2dmm/kgPeVAlsIHmx751o4oq8+fwehRDBmQDaKiBvVXGZ5ZMƒnnoc3DMyDjx0SrI9lkPsn223
CV3UVBZo385g1T4iKwXgcQ7/WF6QcUYOE6HK+4ZGcƒnHermFf3fv3C1FoCjq+zEu8ZboUf3fWbGprGRA+MR/dDI1dTPtSUG7/zWjXO5jC//
ƒn0pykSldW/q8hgO8kq30S8JzCwkqrXJfQ050N4TJtgb/
YC4gwH3BuB9wqpRjUahTiƒnK1V1ju9bHB+bFkMWIIMIXc1Js62JClWzwFgaGUS2DLE8xICQ3wU1ez8RUPGn
wSxAƒnYtZ2N7zDxYDP2tEiO5j2cXY7O8mR3ni0C30=ƒn
-----END CERTIFICATE----10 Copy the content of the signed certificate, and then paste it into a text file. Save
the file.
You may now import the signed certificate into the controller. Refer to Import the
Signed Certificate for HTTPS Communication for more information.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
194
Configuring the System Settings
Configuring General System Settings
Figure 77. Generating a certificate signing request
Import the Signed Certificate for HTTPS Communication
When you have an SSL certificate issued by an SSL certificate provider, you can
import it into the controller and use it for HTTPS communication. To complete this
procedure, you will need the following items:
• The signed certificate file
• The intermediate certificate file (at least one)
• The private key file
NOTE: The file size of each signed certificate and intermediate certificate must not
exceed 8192 bytes. If a certificate exceeds 8192 bytes, you will be unable to import
it into the controller.
Follow these steps to import a signed certificate.
1 Copy the signed certificate file, intermediate certificate file, and private key file to
a location (either on the local drive or a network share) that you can access from
the controller web interface.
2 Go to Configuration > vSCG Carrier System.
3 On the sidebar, click Web Certificate. The Web Certificate page appears.
4 Click Upload Certificate.
5 Import the signed certificate by completing the following steps:
a In the Import Custom Certificate section, click Browse. The Open dialog box
appears.
b Locate and select the certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload the intermediate certificate.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
195
Configuring the System Settings
Configuring General System Settings
Figure 78. Uploading a management web certificate
6 Import the intermediate certificate by completing the following steps:
a Click Browse again. The Open dialog box appears.
b Locate and select the intermediate certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload another intermediate certificate.
7 If you need to upload additional intermediate certificates to establish a chain of
trust to the signed certificate, repeat the above step.
8 When you finish uploading all the required intermediate certificates, click Skip.
The Import Private Key section appears.
a Click Browse. The Open dialog box appears.
b Locate and select the private key file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
the page refreshes, and then displays the content of the certificate files that
you imported.
9 Click Import. The following confirmation message appears:
Are you sure you want to apply SSL certificate to vSCG?
10 Click Yes. The page refreshes, to display the currently installed certificate.
You have completed importing a signed certificate to the controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
196
Configuring the System Settings
Configuring General System Settings
Importing a Self Signed Web Certificate
An alternative to purchasing a signed certificate from an SSL certificate provider is
generating a custom certificate using a certificate management tool (for example,
OpenSSL, GnuTLS, NSS and yaSSL).
NOTE: The file size of each signed certificate and intermediate certificate must not
exceed 8192 bytes. If a certificate exceeds 8192 bytes, you will be unable to import
it into the controller.
Follow these steps to import a custom SSL certificate.
1 Generate a custom certificate using your preferred certificate management tool.
Refer to the documentation that is supplied with the tool for more information.
After you complete generating the custom certificate, you will get at least two
certificate files:
• Server certificate
• Intermediate certificate (at least one)
2 Copy the certificate files to a location (either on the local drive or a network share)
that you can access from the controller web interface.
3 On the controller web interface, go to Configuration > vSCG Carrier System.
4 On the sidebar, click Web Certificate. The Web Certificate page appears.
5 Click Upload Certificate.
6 Import the self-signed certificate by completing the following steps:
a In the Import Custom Certificate section, click Browse. The Open dialog box
appears.
b Locate and select the certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload the intermediate certificate.
7 Import the intermediate certificate by completing the following steps:
a Click Browse again. The Open dialog box appears.
b Locate and select the intermediate certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload another intermediate certificate.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
197
Configuring the System Settings
Configuring General System Settings
Figure 79. Importing a self signed web certificate
8 If you need to upload additional intermediate certificates to establish a chain of
trust to the signed certificate, repeat Step 6.
9 When you finish uploading all the required intermediate certificates, click Skip.
The Import Private Key section appears.
a Click Browse. The Open dialog box appears.
b Locate and select the private key file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
the page refreshes, and then displays the content of the certificate files that
you imported.
10 Click Import. The following confirmation message appears:
Are you sure you want to apply SSL certificate to vSCG?
11 Click Yes. The page refreshes, and then displays the currently installed
certificate.
You have completed importing a self-signed certificate to the controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
198
Configuring the System Settings
Configuring General System Settings
Viewing the Currently Installed Web Certificate
Follow these steps to view the web certificate that is currently on the controller.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Web Certificate. The Web Certificate page appears.
3 Click View Certificate.
The web certificate details appear in the Currently Installed Certificate section.
Figure 80. Viewing the currently installed certificate
Managing the AP Portal Certificate
If you have not imported an SSL certificate into the controller, a security warning
appears every time users connect to the guest and Zero-IT onboarding portal. This
is because the default SSL certificate (or security certificate) that the controller is
using for HTTPS communication is signed by Ruckus Wireless and is not recognized
by most web browsers.
To prevent these security warnings from appearing on the portal page, you can
import an SSL certificate that is issued by a recognized certificate authority.
This section describes the following topics:
• Generate a Certificate Signing Request
• Importing a Self Signed Web Certificate
• Viewing the Currently Installed Web Certificate
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
199
Configuring the System Settings
Configuring General System Settings
Generate a Certificate Signing Request
This section describes how to generate a certificate signing request (which you need
to obtain a signed certificate) and how to import a signed certificate into the
controller.
NOTE: If you already have an SSL certificate, skip this step and continue to Import
the Signed Certificate for HTTPS Communication.
If you do not have an SSL certificate, you will need to create a certificate signing
request (CSR) file and send it to an SSL certificate provider to purchase an SSL
certificate. The controller web interface provides a form that you can use to create
the CSR file. Follow these steps to generate a certificate request.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click AP Portal Certificate. The AP Portal Certificate page
appears.
3 Click Generate CSR. The Generate New Certificate Request form appears.
4 Fill out the following boxes:
• Common Name: Type the fully qualified domain name of your Web server.
This must be an exact match (for example, www.ruckuswireless.com).
• Email: Type your email address (for example, joe@ruckuswireless.com).
• Organization: Type the complete legal name of your organization (for
example, Ruckus Wireless, Inc.). Do not abbreviate your organization
name.
• Organization Unit: Type the name of the division, department, or section in
your organization that manages network security (for example, Network
Management).
• Locality/City: Type the city where your organization is legally located (for
example, Sunnyvale).
• State/Province: Type the state or province where your organization is legally
located (for example, California) Do not abbreviate the state or province
name.
• Country: Select the country where your organization is location from the dropdown list.
5 Click Generate. The controller generates the certificate request. When the
certificate request file is ready, your web browser automatically downloads it.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
200
Configuring the System Settings
Configuring General System Settings
6 Go to the default download folder of your Web browser and locate the certificate
request file. The file name is myreq.zip.
7 Use a text editor (for example, Notepad) to open the certificate request file.
8 Go to the website of your preferred SSL certificate provider, and then follow the
instructions for purchasing an SSL certificate.
9 When you are prompted for the certificate signing request, copy and paste the
entire content of myreq.csr, and then complete the purchase.
After the SSL certificate provider approves your CSR, you will receive the signed
certificate via email. The following is an example of a signed certificate that you
will receive from your SSL certificate provider:
-----BEGIN CERTIFICATE----MIIFVjCCBD6gAwIBAgIQLfaGuqKukMumWhbVf5v4vDANBgkqhkiG9w0B
AQUFADCBƒnsDELMAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLC
BJbmMuMR8wHQYDVQQLƒnBgEFBQcBAQRtMGswJAYIKwYBBQUHMAGGGGh0
dHA6Ly9vY3NwLnZlcmlzaWduLmNvƒnbTBDBggrBgEFBQcwAoY3aHR0cD
ovL1NWUlNlY3VyZS1haWEudmVyaXNpZ24uY29tƒnL1NWUlNlY3VyZTIw
MDUtYWlhLmNlcjBuBggrBgEFBQcBDARiMGChXqBcMFowWDBWƒnFglpbW
FnZS9naWYwITAfMAcGBSsOAwIaBBRLa7kolgYMu9BSOJsprEsHiyEFGD
AmƒnFiRodHRwOi8vbG9nby52ZXJpc2lnbi5jb20vdnNsb2dvMS5naWYw
DQYJKoZIhvcNƒnAQEFBQADggEBAI/S2dmm/kgPeVAlsIHmx751o4oq8+fwehRDBmQDaKiBvVXGZ5ZMƒnnoc3DMyDjx0SrI9lkPsn223
CV3UVBZo385g1T4iKwXgcQ7/WF6QcUYOE6HK+4ZGcƒnHermFf3fv3C1FoCjq+zEu8ZboUf3fWbGprGRA+MR/dDI1dTPtSUG7/zWjXO5jC//
ƒn0pykSldW/q8hgO8kq30S8JzCwkqrXJfQ050N4TJtgb/
YC4gwH3BuB9wqpRjUahTiƒnK1V1ju9bHB+bFkMWIIMIXc1Js62JClWzwFgaGUS2DLE8xICQ3wU1ez8RUPGn
wSxAƒnYtZ2N7zDxYDP2tEiO5j2cXY7O8mR3ni0C30=ƒn
-----END CERTIFICATE----10 Copy the content of the signed certificate, and then paste it into a text file. Save
the file.
You may now import the signed certificate into the controller. Refer to Import the
Signed Certificate for HTTPS Communication for more information.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
201
Configuring the System Settings
Configuring General System Settings
Figure 81. Generating a certificate signing request
Import the Signed Certificate for HTTPS Communication
When you have an SSL certificate issued by an SSL certificate provider, you can
import it into the controller and use it for HTTPS communication. To complete this
procedure, you will need the following items:
• The signed certificate file
• The intermediate certificate file (at least one)
• The private key file
NOTE: The file size of each signed certificate and intermediate certificate must not
exceed 8192 bytes. If a certificate exceeds 8192 bytes, you will be unable to import
it into the controller.
Follow these steps to import a signed certificate.
1 Copy the signed certificate file, intermediate certificate file, and private key file to
a location (either on the local drive or a network share) that you can access from
the controller web interface.
2 Go to Configuration > vSCG Carrier System.
3 On the sidebar, click AP Portal Certificate. The AP Portal Certificate page
appears.
4 Click Upload Certificate.
5 Import the signed certificate by completing the following steps:
a In the Import Custom Certificate section, click Browse. The Open dialog box
appears.
b Locate and select the certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload the intermediate certificate.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
202
Configuring the System Settings
Configuring General System Settings
Figure 82. Uploading an AP portal certificate
6 Import the intermediate certificate by completing the following steps:
a Click Browse again. The Open dialog box appears.
b Locate and select the intermediate certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload another intermediate certificate.
7 If you need to upload additional intermediate certificates to establish a chain of
trust to the signed certificate, repeat the above step.
8 When you finish uploading all the required intermediate certificates, click Skip.
The Import Private Key section appears.
a Click Browse. The Open dialog box appears.
b Locate and select the private key file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
the page refreshes, and then displays the content of the certificate files that
you imported.
9 Click Import. The following confirmation message appears:
Are you sure you want to apply SSL certificate to vSCG?
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
203
Configuring the System Settings
Configuring General System Settings
10 Click Yes. The page refreshes, to display the currently installed certificate.
You have completed importing a signed certificate to the controller.
Importing a Self Signed Web Certificate
An alternative to purchasing a signed certificate from an SSL certificate provider is
generating a custom certificate using a certificate management tool (for example,
OpenSSL, GnuTLS, NSS and yaSSL).
NOTE: The file size of each signed certificate and intermediate certificate must not
exceed 8192 bytes. If a certificate exceeds 8192 bytes, you will be unable to import
it into the controller.
Follow these steps to import a custom SSL certificate.
1 Generate a custom certificate using your preferred certificate management tool.
Refer to the documentation that is supplied with the tool for more information.
After you complete generating the custom certificate, you will get at least two
certificate files:
• Server certificate
• Intermediate certificate (at least one)
2 Copy the certificate files to a location (either on the local drive or a network share)
that you can access from the controller web interface.
3 On the controller web interface, go to Configuration > vSCG Carrier System.
4 On the sidebar, click AP Portal Certificate. The AP Portal Certificate page
appears.
5 Click Upload Certificate.
6 Import the self-signed certificate by completing the following steps:
a In the Import Custom Certificate section, click Browse. The Open dialog box
appears.
b Locate and select the certificate file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload the intermediate certificate.
7 Import the intermediate certificate by completing the following steps:
a Click Browse again. The Open dialog box appears.
b Locate and select the intermediate certificate file, and then click Open.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
204
Configuring the System Settings
Configuring General System Settings
c Click Upload. A progress bar appears. When the import process is complete,
a message appears and prompts you to upload another intermediate certificate.
8 If you need to upload additional intermediate certificates to establish a chain of
trust to the signed certificate, repeat Step 6.
9 When you finish uploading all the required intermediate certificates, click Skip.
The Import Private Key section appears.
a Click Browse. The Open dialog box appears.
b Locate and select the private key file, and then click Open.
c Click Upload. A progress bar appears. When the import process is complete,
the page refreshes, and then displays the content of the certificate files that
you imported.
10 Click Import. The following confirmation message appears:
Are you sure you want to apply SSL certificate to vSCG?
11 Click Yes. The page refreshes, and then displays the currently installed
certificate.
You have completed importing a self-signed certificate to the controller.
Viewing the Currently Installed AP Portal Certificate
Follow these steps to view the AP portal certificate that is currently on the controller.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click AP Portal Certificate. The AP Portal Certificate page
appears.
3 Click View Certificate.
The AP portal certificate details appear in the Currently Installed Certificate section.
Managing the User Agent Black List
Follow these steps to configure the global user agent black list.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Manage User Agent Black List to view the page.
3 Click Add New to enter the name, user agent pattern, and error.
4 Click Save.
You have completed adding an agent to the black list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
205
Configuring the System Settings
Configuring General System Settings
Figure 83. The user agent black list
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
206
Configuring the System Settings
Configuring Cluster Planes
Configuring Cluster Planes
To view the cluster planes that exist in the cluster, go to
Configuration > vSCG Carrier System > Cluster Planes. The Cluster Planes page
appears and displays a summary of the data planes and control planes that belong
to the cluster. This section covers:
• Configuring Control Planes
• Configuring Cluster Redundancy
Figure 84. Cluster Plane view
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
207
Configuring the System Settings
Configuring Cluster Planes
Configuring Control Planes
Two tabs exist on the control plane page:
• Physical Interface Tab
• Static Routes Tab
Refer to the following sections on how to configure the settings on these tabs.
CAUTION! If you disable the control plane interface, you will no longer be able to
access to the controller web interface to perform any management or administrative
tasks.
Physical Interface Tab
Follow these steps to configure the physical interface settings of a control plane.
WARNING! You must configure the control, cluster, and management interfaces
to be on three different subnets. Failure to do so may result in loss of access to the
web interface or failure of system functions and services.
1 Locate the interface settings that you want to update. You can update one of
the following interfaces:
a Control Interfaces
b Cluster Interfaces
c Management Interfaces
CAUTION! Although it is possible to use DHCP to assign IP address settings to
the management interface automatically, Ruckus Wireless strongly recommends
assigning a static IP address to this interface.
2 Configure the following settings for the interface that you want to update.
a IP Mode: Configure the IP address mode by clicking one of the following
options:
-
Static: Click this if you want to assign an IP address to this interface
manually.
-
DHCP: Click this if you want this interface to obtain an IP address
automatically from a DHCP server on the network. After you click this
option, most of the options below it will be grayed out. Continue to Step 3.
b IP Address: Enter the IP address that you want to the assign to this interface.
c Subnet Mask: Enter the subnet mask for the IP address above.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
208
Configuring the System Settings
Configuring Cluster Planes
d Gateway: Enter the IP address of the gateway router.
e Primary DNS: Enter the IP address of the primary DNS server.
f
Secondary DNS: Enter the IP address of the secondary DNS server.
3 In Default Gateway, select the gateway that you want to use. The options that
appear here are the gateways that you have defined for control, cluster, and
management interfaces.
4 Click Apply to save your changes.
The controller restarts and applies the updated network interface settings. You have
completed updating the physical interface settings.
NOTE: For information on how to configure the management IP address from the
command line interface, refer to Changing the Management IP Address from the CLI.
Figure 85. The Physical Interface tab
Static Routes Tab
To configure a static route, enter the destination IP address and related information
for the destination. You can also assign a metric (or priority) to help the controller
determines the route to choose when there are multiple routes to the same
destination.
Follow these steps to configure a static route.
1 Click the Static Routes tab.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
209
Configuring the System Settings
Configuring Cluster Planes
2 Click the Create New button.
3 Configure the following interface settings:
a Network Address: Enter the destination IP address of this route.
b Subnet Mask: Enter a subnet mask for the IP address above.
c Gateway: Enter the IP address of the gateway router.
d Interface: Select the physical interface to use for this route.
e Metric: This represents the number of routers between the network and the
destination.
4 Click Save.
5 Click Apply to save your changes.
You have completed configuring a static route.
Figure 86. The Static Route tab
Configuring a Data Plane
Follow these steps to configure the interface settings of a data plane.
1 From the list of data planes in the cluster, click the name of the data plane that
you want to update.
2 Configure the following data plane interface settings:
a IP Mode: Click one of the following options:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
210
Configuring the System Settings
Configuring Cluster Planes
-
Static: Click this if you want to assign an IP address to this interface
manually.
-
DHCP: Click this if you want this interface to obtain an IP address
automatically from a DHCP server on the network. After you click this
option, most of the options below it will be grayed out. Continue to Step 3.
b IP Address: Enter the IP address that you want to the assign to this interface.
c Subnet Mask: Enter the subnet mask for the IP address above.
d Gateway: Enter the IP address of the gateway router.
e Primary DNS: Enter the IP address of the primary DNS server.
f
Secondary DNS: Enter the IP address of the secondary DNS server.
3 Click Apply to save your changes.
You have completed configuring the interface settings of a data plane.
Figure 87. Configuring data planes
Configuring Cluster Redundancy
If you have multiple clusters on the network, you can configure cluster redundancy
to enable APs managed by a particular cluster to fail over automatically to another
cluster if their parent cluster goes out of service or becomes unavailable.
Before you configure cluster redundancy, take note of the following:
• Cluster redundancy is disabled by default.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
211
Configuring the System Settings
Configuring Cluster Planes
• Only super administrators have the capability to configure the cluster redundancy
settings.
• To configure cluster redundancy, you will need to retrieve the IP addresses
assigned to the control interfaces of all nodes on clusters that you want to
configure.
Figure 88. Cluster redundancy
Follow these steps to configure redundancy for a cluster on the network.
1 Go to Configuration > Cluster Planes.
2 Select the Enable Cluster Redundancy check box.
3 Click the Create New button to create a record for a failover cluster. The Cluster
form appears.
4 Configure the settings in the Cluster form.
a In Name, type a name for the cluster (for example, type Cluster B).
b Under Cluster Control IP List, click the Create New IP button.
c In the text box that appears, type the control interface IP address of a node
in this cluster.
d Click Save.
e Repeat steps b to d for every node in the cluster. If this cluster has two nodes,
for example, this cluster control IP list must have two IP addresses. You can
add up to four control IP addresses to the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
212
Configuring the System Settings
Configuring Cluster Planes
Figure 89. Use the Cluster form to set the cluster control IP addresses
5 Click Apply in the Cluster form to save the cluster control IP list.
6 To add another cluster control IP list (for example, for Cluster C), click Create
New. You can add up to four cluster control IP lists.
7 Click Apply on the Cluster Redundancy Settings page.
You have completed configuring cluster redundancy.
NOTE: After configuring redundancy for a cluster, Ruckus Wireless strongly
recommends backing up the controller configuration.
How Cluster Redundancy Works
The following simplified scenario describes how cluster redundancy works and how
managed APs fail over from one controller cluster to another.
1 After you enable and configure cluster redundancy on the controller, managed
APs obtain the updated configuration (which now includes the failover settings)
from the controller. If you have two clusters, for example, managed APs will
obtain a failover list similar to the following:
{“Cluster A”:[ “IP_A1”, “IP_A2, “IP_A3”, “IP_A4”], “Cluster B”:[“IP_B1”, “IP_B2,
“IP_B3”, “IP_B4”]}.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
213
Configuring the System Settings
Configuring Cluster Planes
2 If Cluster A goes out of service or becomes unavailable, APs managed by Cluster
A will attempt to connect to the IP addresses (one node at a time) specified for
Cluster A.
3 If managed APs are unable to connect to the IP addresses specified for Cluster
A, they will attempt to connect to the IP addresses (one node at a time) specified
for Cluster B.
4 If managed APs are able to connect to one of the IP address specified for Cluster
B, they fail over to Cluster B. Then, they apply the registration rules that have
been configured for Cluster B and renew their certificates.
NOTE: The second cluster to which APs fail over must have sufficient license seats
to accommodate the new APs that it will be managing. If the second cluster has
insufficient license seats, the failover will be unsuccessful.
After the APs apply the registration rules and renew their certificates, the failover
process is complete. These APs will continue to be managed by the failover cluster
until you restore them to the original cluster (rehome) manually.
Rehoming Managed APs
Rehoming is the process of returning the APs that have failed over to the second
cluster back to their original cluster (once it becomes available). Rehoming must be
done manually. APs that have failed over will continue to be managed by the failover
cluster until you rehome them.
Rehoming APs must be done on a per-zone basis. Follow these steps to rehome
managed APs to the original cluster.
1 Go to Configuration > AP Zones.
2 From the AP Zone List, click the AP zone name that you want to rehome. The
AP Zone Configuration Details page appears.
3 Click the Switchover Cluster button. The Switchover Cluster dialog box appears.
4 From the drop-down menu, select the cluster to which you want the AP zone to
switch over (for example, the original cluster to which APs in this zone belonged).
5 Click Apply.
You have completed rehoming the APs in the zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
214
Configuring the System Settings
Configuring Network Management
Configuring Network Management
This section covers:
• Configuring the SNMPv2 and SNMPv3 Agents
• Sending SNMP Traps and Email Notifications for Events
• Controlling Access to the Management Interfaces
Configuring the SNMPv2 and SNMPv3 Agents
The controller supports the Simple Network Management Protocol (SNMP v2 and
v3), which allows you to query controller information, such as system status, AP list,
AP zones, etc., and to set a number of system settings using a Network Management System (NMS) or SNMP MIB browser. You can also enable SNMP traps to
receive immediate notifications for possible AP and system issues.
The procedure for enabling the internal SNMP agents depends on whether your
network is using SNMPv2 or SNMPv3. SNMPv3 mainly provides security enhancements over the earlier version, and therefore requires you to enter authorization
passwords and encryption settings, instead of simple clear text community strings.
Both SNMPv2 and SNMPv3 can be enabled at the same time. The SNMPv3
framework provides backward compatibility for SNMPv1 and SNMPv2c management applications so that existing management applications can still be used to
manage the controller with SNMPv3 enabled.
This section covers the following topics:
• Enabling Global SNMP Traps
• Configuring the SNMPv2 Agent
• Configuring the SNMPv3 Agent
Enabling Global SNMP Traps
By default, the global SNMP trap setting is disabled, which means that the controller
will be unable to send out trap notifications, even if you enabled the SNMPv2 and
SNMPv3 agents to send out traps.
Follow these steps to enable global SNMP traps.
1 Go to the SNMP Agent section.
2 Select the Enable SNMP Traps Globally check box.
3 Click Apply. A message appears, confirming that you have updated the global
trap settings.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
215
Configuring the System Settings
Configuring Network Management
Figure 90. The SNMP Agent section
Configuring the SNMPv2 Agent
Follow these steps to configure the SNMPv2 agent.
1 In the SNMPv2 Agent section, click Add Community. Options for adding a
community appear.
2 Configure the read-only community settings by following these steps:
a In the text box under Community, type the read-only community string (for
example, public). Applications that send SNMP Get-Requests to the
controller (to retrieve information) will need to send this string along with the
request before they will be allowed access.
b Under Privilege, select the check boxes for the privileges that you want to
grant to this community. A read-only community is typically granted the Read
privilege. Available privileges include:
-
Read
-
Write
-
Trap: Select this privilege if you want to send SNMP trap notifications for
this community. To add a trap target, click Add Trap Target, and then
configure the following options (required) that appear below:
-
Target IP Address: Type the IP address of the SNMP trap server on the
network.
-
Target Port: Type the SNMP trap server port.
3 Click Add Community again. A second set of configuration options for adding a
community appears.
4 Configure the read-write community settings by following these steps:
a In the text box under Community, type the read-write community string (for
example, private). Applications that send SNMP Set-Requests to the
controller (to set certain SNMP MIB variables) will need to send this string
along with the request before they will be allowed access. The default value
is private.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
216
Configuring the System Settings
Configuring Network Management
b Under Privilege, select the check boxes for the privileges that you want to
grant to this community. A read-write community is typically granted the Read
and Write privileges. Available privileges include:
• Read
• Write
• Trap: Select this privilege if you want to send SNMP trap notifications for this
community. When this check box is selected, the Add Trap Target button
becomes active. Click Add Trap Target, and then configure the following
settings (required):
-
Target IP Address: Type the IP address of the SNMP trap server on the
network.
-
Target Port: Type the SNMP trap server port.
5 Click Apply.
You have completed configuring the read-only and read-write communities for the
SNMPv2 agent. To add another community, click Add Community again, and then
repeat the procedure above.
Figure 91. The SNMPv2 Agent section
Configuring the SNMPv3 Agent
Follow these steps to configure the SNMPv3 agent.
1 In the SNMPv3 Agent section, click Add User. Options for adding a user appear.
2 Under User, type a user name between 1 and 31 characters.
3 Under Authentication, select one of the following authentication methods:
• None: Use no authentication.
• MD5: Message-Digest algorithm 5, message hash function with 128-bit
output.
• SHA: Secure Hash Algorithm, message hash function with 160-bit output.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
217
Configuring the System Settings
Configuring Network Management
4 Under Auth Pass Phrase, type a pass phrase between 8 and 32 characters in
length.
5 Under Privacy, select one of the following privacy methods:
• None: Use no privacy method.
• DES: Data Encryption Standard, data block cipher.
• AES: Advanced Encryption Standard, data block cipher.
6 Under Privacy Phrase (active only if you selected either DES or AES above), enter
a privacy phrase between 8 and 32 characters in length.
7 Under Privilege, select the check boxes for the privileges that you want to grant
to this community. A read-only community is typically granted the Read privilege,
whereas a read-write community is granted the Read and Write privileges.
Available privileges include:
• Read
• Write
• Trap: Select this privilege if you want to send SNMP trap notifications for this
community. When this check box is selected, the Add Trap Target button
becomes active. Click Add Trap Target, and then configure the following
settings (required):
-
Target IP Address: Type the IP address of the SNMP trap server on the
network.
-
Target Port: Type the SNMP trap server port.
8 Repeat the steps above to create as many SNMPv3 agent users are you require.
9 Click Apply.
You have completed configuring the SNMPv3 agent settings.
Figure 92. SNMPv3 Agent section
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
218
Configuring the System Settings
Configuring Network Management
Sending SNMP Traps and Email Notifications for Events
NOTE: Verify that global SNMP traps are enabled to ensure that the controller can
send SNMP traps for alarms. For information on how to enable global SNMP traps,
refer to Enabling Global SNMP Traps.
By default, the controller saves a record of all events that occur to its database. You
can configure the controller to also send SNMP traps and email notifications for
specific events whenever they occur.
Follow these steps to configure the controller to send traps and email notifications
for events.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Event Management. If Event Management is not visible
on the sidebar, click Network Management to expand its submenu, which
contains the Event Management link. The Event Management page appears.
3 In the Email Notification section, select the Enable check box, and then type an
email address or email addresses in the Mail To box. If you want to send
notifications to multiple recipients, use a comma to separate the email
addresses.
4 In the Events section, go over the table and select the events for which you want
to send traps or email notifications (or both).
• If you know the event code, event type, or description, type the full or partial
text into the search box on the upper-right hand corner of the table, and then
click the magnifying glass (search) icon.
• If you want to select all events, click the check box before the Code table
heading.
NOTE: By default, the Events table displays up to 20 events per page. If you are
enabling SNMP traps and email notifications for 10 or more events, Ruckus Wireless
recommends changing the number of events shown per page. To do this, scroll
down to the bottom of the page, and then change the value for Show to 250
(maximum).
5 After you have selected all of the events for which you want to send traps or
email notifications, scroll up to the beginning of the Events table, and then click
Enable. A submenu appears and displays the following links:
• Enable SNMP Trap: Click this link to enable SNMP trap notifications for all
selected events.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
219
Configuring the System Settings
Configuring Network Management
• Enable Email: Click this link to enable email notifications for all selected
events.
• Enable DB Persistence: Click this link to enable saving of all selected events
to the controller database. If an event is already currently enabled, it will stay
enabled after you click this link.
A confirmation message appears.
6 Click Yes.
NOTE: You can only enable one of these three notification options at a time (for
example, SNMP trap notifications only). If you want to enable another option, repeat
steps 5 and 6.
You have completed enabling a notification option for the selected events.
Figure 93. Selecting all events on the Event Management page
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
220
Configuring the System Settings
Configuring Network Management
Enabling or Disabling Notifications for a Single Event
Follow these steps to enable or disable notifications for a single event.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Event Management.
3 Under Events, locate the event for which you want to enable or disable
notifications.
4 Click the event code. The Edit Event [Event Code] form appears.
5 Select the check box for a notification type to enable it, or clear the check box
to disable it. Options include:
• SNMP Trap
• Email Notification
• DB Persistence
6 Click Apply.
You have completed enable or disabling notifications for a single event.
Figure 94. Select or clear check boxes to enable or disable notifications
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
221
Configuring the System Settings
Configuring Network Management
Viewing Enabled Notifications for Events
Follow these steps to view the notification types that are enabled for events.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Event Management.
3 Scroll down to the bottom of the page, and then select 250 in Show. The page
refreshes, and then displays up to 250 events.
4 Check the SNMP Trap, Email, and DB Persistence columns on the right side of
the table. A check mark under each column indicates that the notification option
is enabled for the event.
To view the notification options that are enabled for the events on the next page,
click >> at the bottom of the table. The page refreshes, and then displays the
remaining events.
Figure 95. A check mark under a column indicates the notification is enabled for the event
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
222
Configuring the System Settings
Configuring Network Management
Controlling Access to the Management Interfaces
Management interfaces, which include the web interface and the command line
interface, are the primary methods through which you configure the controller and
its managed devices. Access to these interfaces is password-protected.
To prevent unauthorized devices from accessing these management interfaces, you
can create ACLs. Management interface ACLs in the controller are whitelist (as
opposed to blacklists), which are lists that contain only the IP addresses or IP
address range that are allowed access to the management interfaces.
Follow these steps to configure the management interface ACL.
1 Go to Configuration > vSCG Carrier System.
2 On the sidebar, click Management Interface ACL.
3 In Access Control of Management Interface, click the Enable option.
4 In Name, type a name for this ACL.
5 In Description, type a brief description for this ACL.
6 In Type, select one of the following options, and then provide the required
information:
• Single IP: Type the IP address that you want to allow access to the management interfaces. For example, you can type 192.168.1.1.
• IP Range: Type the IP address range that you want to allow access to the
management interfaces by filling out the Start IP Address and the End IP
Address boxes. For example, you can type 192.168.1.2 - 192.168.1.20.
• Subnet: Fill out the Network Address and Subnet Mask boxes. For example,
you can type 192.168.1.1/255.255.255.0 or 192.168.1.1/24.
7 Click Create New. The page refreshes, and then the ACL that you created
appears in the ACL list.
8 Create additional ACLs as needed.
9 Click Apply.
You have completed creating ACLs to control access to the management interfaces.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
223
Configuring the System Settings
Configuring Network Management
Figure 96. The Management Interface ACL page
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
224
Working with Management
Domains
7
In this chapter:
• Overview of Management Domains
• Viewing a List of Management Domains
• Creating a New Management Domain
• Deleting a Management Domain
Overview of Management Domains
Management domains allow you to segment managed access points into different
groups and assign them to different AP zones and administrators. By default, a
primary management domain named Administration Domain exists. You can create
additional subdomains under the Administration Domain and assign access points
to these subdomains.
Viewing a List of Management Domains
Follow these steps to view a list of existing management domains.
1 Go to Configuration > Management Domains. The Management Domain:
Administration Domain page appears.
2 To view a summary of the administration domain, check the Summary section
at the top of the page. This section displays the following information about the
administration domain:
• Domain Name
• Description
• Created By
• Created On
• # of Zones (more details in the AP Zones in Management Domain section)
• # of APs
• # of Administrators (more details in the Administrators section)
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
225
Working with Management Domains
Creating a New Management Domain
• # of Subdomains
3 To view a list of subdomains that have been created, scroll down to the
Subdomains section. The table in this section shows a list of existing
subdomains, as well as the following information for each subdomain:
• Domain Name
• Description
• Created By
• Created On
• # of Zones
• # of APs
• # of Administrators
• # of Subdomains
• Actions that you can perform
Figure 97. View list of domains
Creating a New Management Domain
Follow these steps to create a new management domain.
1 In the Subdomains section, click Create New. The Create New Management
Domain form appears.
2 In Domain Name, type a name for the management domain that you are creating.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
226
Working with Management Domains
Deleting a Management Domain
3 In Description, type a short description for the management domain.
4 Click OK.
5 The page refreshes, and then the management domain that you created appears
under the Subdomains table.
Figure 98. The Create New Management Domain form
Deleting a Management Domain
Before you can delete a management domain, you must move all AP zones that
belong to it to another management domain.
Follow these steps to delete an existing management domain.
• In the Subdomains section, locate the management domain that you want to
delete.
• Under the Actions column, click the
icon that is in the same row as the
management domain name. A confirmation message appears.
• Click Yes.
You have completed deleting a management domain.
To delete multiple management domains simultaneously, select the check boxes for
the management domains, and then click the Delete Selected button. When the
confirmation message appears, click Yes.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
227
Managing Administrator Accounts
8
In this chapter:
• Overview of Administrator Accounts and Roles
• Viewing a List of Administrator Accounts, Roles, and RADIUS Servers
• Creating an Administrator Account
• Creating a New Administrator Role
• Editing an Administrator Role
• Cloning an Existing Administrator Role
• Adding a RADIUS Server for Administrators
• Using a Backup RADIUS Server
• Deleting an Administrator Account, Role, or RADIUS Server
Overview of Administrator Accounts and
Roles
The controller supports the creation of additional administrator accounts. This allows
you to share or delegate management and monitoring functions with other members
of your organization.
In addition to creating administrator accounts, you can also create administrator
roles, which define the tasks that each administrator can perform. You can also add
RADIUS servers that you want to use for authorizing and authenticating administrators.
Viewing a List of Administrator Accounts,
Roles, and RADIUS Servers
Follow these steps to view a list of existing administrator accounts, roles and
RADIUS servers as seen in Figure 99.
1 Go to Configuration > Administrators. The Administrator Accounts lists a table
of existing administrator accounts along with their basic details as mentioned
below.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
228
Managing Administrator Accounts
Viewing a List of Administrator Accounts, Roles, and RADIUS Servers
2 Click the account name to view the account details or to edit the account.
• Account Name
• Real Name
• # of Assigned Domains: The number of domains that this administrator
account manages.
• Job Title
• Contact Phone
• Email Address
• Created By
• Created On
• Actions that you can perform
3 Click the role name to view the role details or to edit the role. The Administrator
Role defines the tasks assigned to an administrator. The table lists the existing
administrator roles with their basic details as mentioned below.
• Role Name
• Description
• # of Administrators: The number of administrators assigned to a role
• Created By
• Created On
• Actions that you can perform
4 The RADIUS Servers for Administrators Role lists the RADIUS servers assigned
to an administrator for authorization and authentication.
• AAA Server Name
• Type
• Realms
• Primary Server
• Secondary Server
• Created By
• Created On
• Actions that you can perform
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
229
Managing Administrator Accounts
Creating an Administrator Account
Figure 99. Administrator View of Accounts, Roles and RADIUS Servers
Creating an Administrator Account
Follow these steps to create an administrator account.
1 In the Administrator Accounts section, click Create New. The Create New
Administrator Account form appears.
2 In Account Name, type the name that this administrator will use to log on to the
controller.
3 In Real Name, type the actual name (for example, John Smith) of the
administrator.
4 In Password, type the password that this administrator will use (in conjunction
with the Account Name) to log on to the controller.
5 In Confirm Password, type the same password as above.
6 In Phone, type the phone number of this administrator.
7 In Email, type the email address of this administrator.
8 In Job Title, type the job title or position of this administrator in your organization.
9 Click Create New.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
230
Managing Administrator Accounts
Creating a New Administrator Role
The page refreshes, and then the administrator account that you created appears
in the Administrator Accounts section.
Figure 100. The Create New Administrator Account form
Creating a New Administrator Role
An administrator role defines the tasks that an administrator can perform. Follow
these steps to create a new administrator role.
1 In the Administrator Roles section, click Create New. The Create New
Administrator Role form appears.
2 In Role Name, type a name for the administrator role that you are creating.
3 In Description, type a short description for the administrator role.
4 In the Assign Capabilities to Administrator Role tree (located on the left side of
the form), select the administrator capabilities that you want to assign to this
role. If you plan to grant this administrator role most of the capabilities that are
available, click Select All, and then clear the check boxes for the capabilities that
you do not want this role to have.
5 Remember to click the
included.
icon next to each folder to view all capabilities that are
6 Click Create New.
You have completed creating an administrator role.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
231
Managing Administrator Accounts
Editing an Administrator Role
Figure 101. The Create New Administrator Role form
Editing an Administrator Role
Follow these steps to edit an existing administrator role.
1 In the Administrator Roles section, locate the role that you want to edit.
2 Click the name of the administrator role that you want to edit. The Edit
Administrator Role form appears.
3 In the Assign Capabilities to Administrator Role tree (located on the left side of
the form), add or remove capabilities from the role. Remember to click the icon
next to each folder to view all capabilities that are included.
4 To add a capability, select the check box next to it.
5 To remove a capability, clear the check box next to it.
6 Click Apply. A message appears, confirming that the role has been updated.
7 Click Yes to close the message.
You have completed editing an administrator role.
NOTE The system-created administrator account and role, which is present by
default on the controller, cannot be edited.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
232
Managing Administrator Accounts
Cloning an Existing Administrator Role
Cloning an Existing Administrator Role
If you want to create a new administrator role with capabilities that are similar to an
existing role, cloning the existing administrator role may be the faster way to create
that new role.
1 Follow these steps to clone an existing administrator role.
2 In the Administrator Roles section, locate the role that you want to clone.
3 Under the Actions column, click the
icon that is in the same row as the role
that you want to clone. A dialog appears and prompts you for the name that you
want to assign to the clone role. The default name is Clone of [Original Role
Name].
4 Type a new name or leave the name as is.
5 Click Apply. The page refreshes, and then the role that you created appears
under the Administrator Roles section.
You have completed cloning an existing administrator role. Unless you want the new
role to have exactly the same capabilities as the original role, you may want to edit
it. For the steps on editing the role, refer to Editing an Administrator Role.
Adding a RADIUS Server for Administrators
Follow these steps to add a RADIUS server for authenticating administrators.
NOTE: If you want to use a primary and secondary RADIUS servers for
authenticating administrator, follow the steps in Using a Backup RADIUS Server for
Authenticating Administrators.
1 Go to Configuration > Administrators.
2 In the RADIUS Servers for Administrators section, click Create New. The Create
New Administrator RADIUS Server form appears.
3 In Name, type a name for the RADIUS server.
4 In Type, select the type of RADIUS server that you are using. Options include:
• RADIUS: Click this option to use a Remote Authentication Dial-In User
Service (RADIUS) server on the network for authenticating controller administrators.
• TACACS+: Click this option to use a Terminal Access Controller AccessControl System Plus (TACACS+) server on the network for authentication
controller administrators.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
233
Managing Administrator Accounts
Adding a RADIUS Server for Administrators
5 In Realm, type the realm (or realms) to which the RADIUS server belongs. If the
RADIUS server belongs to multiple realms, use a comma (,) to separate the realm
names.
6 Make sure that the Enable backup RADIUS support check box is not selected.
If you want to use a backup RADIUS server, follow the steps in Using a Backup
RADIUS Server instead.
7 In IP Address, type the IP address of the RADIUS server.
8 In Port, type the UDP port that the RADIUS server is using. The default port is
1812.
9 In Shared Secret, type the shared secret. Retype the same secret in Confirm
Secret.
10 Click Create New.
You have completed adding a RADIUS server for authenticating administrators.
Figure 102. The Create New Administrator RADIUS Server form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
234
Managing Administrator Accounts
Using a Backup RADIUS Server
Using a Backup RADIUS Server
If a backup RADIUS server is available on the network, you can select the Enable
backup RADIUS server support check box to use the backup server when the
primary server is unavailable. When you select the check box, additional fields
appear that you need to fill in.
Follow these steps to enable support for a backup RADIUS server for authenticating
administrators.
1 Select the check box next to Enable backup RADIUS support.
2 In the Primary Server section, fill out the IP address, port number, and shared
secret as you did in the previous section.
3 In the Secondary Server section, fill out the IP Address, port number and shared
secret for the backup server (these fields can neither be left empty nor be the
same values as those of the primary server).
4 In the Failover Policy section, configure the following settings:
• Request Timeout: Type the timeout period (in seconds) after which an
expected RADIUS response message is considered to have failed.
• Max Number of Retries: Type the number of failed connection attempts after
which the controller will fail over to the backup RADIUS server.
• Reconnect Primary: Type the number of minutes after which the controller
will attempt to reconnect to the primary RADIUS server after failover to the
backup server.
5 Click Apply.
You have completed adding primary and secondary RADIUS servers for authenticating administrators.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
235
Managing Administrator Accounts
Using a Backup RADIUS Server
Figure 103. Enabling the backup RADIUS server
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
236
Managing Administrator Accounts
Testing an AAA Server
Testing an AAA Server
To ensure that the controller administrators will be able to authenticate successfully
with the RADIUS server type that you selected, Ruckus Wireless strongly recommends testing the AAA server after you set it up. The test queries the RADIUS server
for a known authorized user and return groups associated with the user that can
be used for configuring roles within the controller.
Follow these steps to test an AAA server.
1 Go to Configuration > Administrators.
2 Scroll down to the RADIUS Servers for Administrators section.
3 Click Test AAA. The Test AAA Servers for appears.
4 In Name, select one of the AAA servers that you previous created.
5 In User Name, type an existing user name on the AAA server that you selected.
6 In Password, type the password for the user name you specified.
7 Click Test.
If the controller was able to connect to the authentication server and retrieve the
configured groups/attributes, the information appears at the bottom of the page.
If the test was unsuccessful, there are two possible results (other than success) that
will be displayed to inform you if you have entered information incorrectly:
• Admin invalid
• User name or password invalid
These results can be used to troubleshoot the reasons for failure to authenticate
administrators with an AAA server through the controller.
Figure 104. The Test AAA Servers form
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
237
Managing Administrator Accounts
Deleting an Administrator Account, Role, or RADIUS Server
Deleting an Administrator Account, Role, or
RADIUS Server
Follow these steps to delete an administrator account, role, or RADIUS server that
is used for authenticating administrators.
1 Go to Configuration > Administrators.
2 Locate the administrator account, role, or the RADIUS server that you want to
delete.
3 Under the Actions column, click the
icon that is in the same row as the
account, role, or RADIUS server name. A confirmation message appears.
4 Click Yes. The page refreshes, and then the administrator account, role, or
RADIUS server that you deleted disappears from the Administrators page.
You have completed deleting an administrator account, role, or RADIUS server used
for authenticating administrators.
NOTE The default administrator account and role, which exist on the controller by
default, cannot be deleted.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
238
Managing Mobile Virtual Network
Operator Accounts
9
In this chapter:
• Overview of Mobile Virtual Network Operator Accounts
• Viewing a List of MVNOs
• Creating a New MVNO Account
• Using a Backup RADIUS Server for Authorizing and Authenticating MVNOs
• Editing an MVNO Account
• Deleting an MVNO Account
Overview of Mobile Virtual Network Operator
Accounts
This section describes how to create, edit, and delete mobile virtual network
operator accounts.
Viewing a List of MVNOs
Follow these steps to view a list of mobile virtual network operator (MVNO) accounts.
1 Go to Configuration > Mobile Virtual Network Operators.
2 The MVNO table appears and displays a summary of mobile virtual network
operator accounts that have been created.
Figure 105. The Mobile Virtual Network Operators page
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
239
Managing Mobile Virtual Network Operator Accounts
Creating a New MVNO Account
Creating a New MVNO Account
Follow these steps to create a new virtual network operator account.
1 On the MVNO page, click Create New. The Mobile Virtual Network Operator form
appears.
2 In Mobile Virtual Network Operator Summary section:
• Type a domain name to which this account will be assigned in the Domain
Name box.
• In Description, type a brief description about this domain name.
3 In Configure the AP zones to which the MVNO account that you are creating will
have management privileges. Click Add AP Zone to create an AP Zone(s)
• In AP Zone, select the AP zone to which the MVNO account will have
management privileges.
NOTE: You can only select a single AP zone at a time. If you want to grant the
MVNO account management privileges to multiple AP zones, select them one at
time.
• Click Apply. The AP Zones of Mobile Virtual Network Operator section
refreshes. The AP zone or zones that you selected appears in the section.
4 In Configure the WLAN Services, follow these steps to configure the WLAN
services to which the MVNO account that you are creating will have management
privileges.
• In the WLAN Services section, click Add WLAN(s).
• In SSID, select the WLAN to which the MVNO account will have management
privileges.
NOTE: You can only select a WLAN service at a time. If you want to grant the MVNO
account management privileges to multiple WLAN services zones, select them one
at time.
• Click Apply. The WLAN Services section refreshes. The WLAN service or
services that you selected appears in the section.
5 In Create the Super Administrator Account, follow these steps to create the
MVNO account and define the logon details and management capabilities that
will be assigned to the account.
• Scroll down to the Super Administrator section.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
240
Managing Mobile Virtual Network Operator Accounts
Creating a New MVNO Account
• In Account Name, type the name that this MVNO will use to log on to the
controller.
• In Real Name, type the actual name (for example, John Smith) of the MVNO.
• In Password, type the password that this MVNO will use (in conjunction with
the Account Name) to log on to the controller.
• In Confirm Password, type the same password as above.
• In Phone, type the phone number of this MVNO.
• In Email, type the email address of this MVNO.
• In Job Title, type the job title or position of this MVNO in his organization.
• In the Assign Capabilities to Administrator Role tree (located on the right side
of the form), select the administrator capabilities that you want to assign to
this MVNO. If you plan to grant this MVNO most of the capabilities that are
available, click Select All, and then clear the check boxes for the capabilities
that you do not want this MVNO to have.
• Remember to click the
are included.
icon next to each folder to view all capabilities that
6 In RADIUS Server for Administrator Authorization and Authentication, follow
these steps to add a RADIUS server for authenticating this MVNO.
NOTE: If you want to use a primary and secondary RADIUS servers for
authenticating administrator, follow the steps in Using a Backup RADIUS Server for
Authorizing and Authenticating MVNOs.
• In the RADIUS Servers for Administrator Authorization and Authentication
section, click Create New. The RADIUS Servers for Administrator Authorization and Authentication form appears.
• In Name, type a name for the RADIUS service.
• In Realm, type the realm or realms to which the RADIUS server belongs. If
the RADIUS server belongs to multiple realms, use a comma (,) to separate
the realm names.
• Make sure that the Enable backup RADIUS support check box is not
selected.
• If you want to use a backup RADIUS server, follow the steps in Using a
Backup RADIUS Server for Authenticating Administrators instead.
• In IP Address, type the IP address of the RADIUS server.
• In Port, type the UDP port that the server is using. The default port is 1812.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
241
Managing Mobile Virtual Network Operator Accounts
Using a Backup RADIUS Server for Authorizing and Authenticating MVNOs
• In Shared Secret, type the shared secret. Retype the same secret in Confirm
Secret.
• Click Apply.
After you complete steps 1 through 6, click Create New to save the MVNO account.
The page refreshes, and the MVNO account that you created appears in the list of
existing MVNO accounts.
Figure 106. The Create New Virtual Network Operator form
Using a Backup RADIUS Server for
Authorizing and Authenticating MVNOs
If a backup RADIUS server is available on the network, you can select the Enable
backup RADIUS server support check box to use the backup server when the
primary server is unavailable. When you select the check box, additional fields
appear that you need to fill in.
Follow these steps to enable support for a backup RADIUS server for authorizing
and authenticating MVNOs.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
242
Managing Mobile Virtual Network Operator Accounts
Editing an MVNO Account
1 Select the check box next to Enable backup RADIUS support.
2 In the Primary Server section, fill out the IP address, port number, and shared
secret as you did in the previous section.
3 In the Secondary Server section, fill out the IP Address, port number and shared
secret for the backup server (these fields can neither be left empty nor be the
same values as those of the primary server).
4 Click Apply.
You have completed adding primary and secondary RADIUS servers for authorizing
and authenticating MVNOs.
Editing an MVNO Account
Follow these steps to edit an existing virtual network operator account.
1 Go to Configuration > Mobile Virtual Network Operators. The Mobile Virtual
Network Operator page appears, displaying all MVNO accounts that have been
created.
2 Click the domain name of the MVNO account that you want to edit.
3 Edit or update the account details in the following sections as required:
• Mobile Virtual Network Operator Summary
• AP Zones of Mobile Virtual Network Operator
• WLAN Services
• Super Administrator (and Assign Capabilities to Administrator Role)
• RADIUS Servers for Administrator Authorization and Authentication
4 Click Apply.
You have completed editing the MVNO account.
Deleting an MVNO Account
Follow these steps to delete an existing virtual network operator account.
1 Go to Configuration > Mobile Virtual Network Operators. The Mobile Virtual
Network Operator page appears, displaying all MVNO accounts that have been
created.
2 Locate the domain name of the MVNO account that you want to delete.
3 Once you locate the MVNO account, click the
column. A confirmation message appears.
icon that is under the Actions
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
243
Managing Mobile Virtual Network Operator Accounts
Deleting an MVNO Account
4 Click Yes. The list of MVNO accounts refreshes, and then the MVNO account
that you deleted disappears from the list.
You have completed deleting an MVNO account.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
244
Monitoring AP Zones, Access
Points, and Wireless Clients
10
In this chapter:
• Monitoring AP Zones
• Monitoring Managed Access Points
• Monitoring Wireless Clients
Monitoring AP Zones
This section provides information on how to monitor and view information about AP
zones. Topics covered include:
• Viewing a Summary of AP Zones
• Exporting the AP Zone List to CSV
• Viewing the Configuration of an AP Zone
• Viewing All APs That Belong to an AP Zone on Google Maps
Viewing a Summary of AP Zones
Follow these steps to view a summary of existing AP zones.
Go to Monitor > AP Zones. The AP Zones in Management Domain page appears
and displays a table of all existing AP zones.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
245
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring AP Zones
Figure 107. Select Administration Domain in the domain tree to view all existing AP zones
When you go to the Monitor > AP Zones page, the Administrator Domain is selected
by default in the domain tree, which results in all existing AP zones being displayed
in the table.
If you want to view only AP zones that belong to a particular subdomain (denoted
by the
icon in the domain tree), click the subdomain icon. The table refreshes
and displays only AP Zones that belong to that subdomain.
Table 7 lists the AP zone details that are shown in the table.
Table 7.
AP zone details
Column Name
Description
Zone Name
Name of the AP zone. Clicking the AP zone name (link) loads a
page that displays detailed information about the zone. See
Viewing the Configuration of an AP Zone.
Management
Domain
Administration Domain or subdomain name to which the AP zone
belongs. Clicking this link displays detailed information about the
Administration domain or subdomain.
Description
Brief description of the AP zone
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
246
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring AP Zones
Table 7.
AP zone details
Column Name
Description
AP Firmware
Ruckus Wireless firmware version that is installed on the APs that
belong to the zone
# of Alarms
Number of alarms that have occurred in the AP zone. The numbers
that are separated by a forward slash indicate the number of alarms
per alarm type (from left to right order):
• Critical alarms (red)
• Major alarms (red)
• Minor alarms (orange)
• Warnings (orange)
# of APs
Number of APs that belong to this zone. The numbers that are
separated by a forward slash indicate the total number of APs in
the zone (orange), the number of APs that are currently online
(green), and the number of APs that are currently offline (red).
Clicking the number of APs (link, except when zero) loads a page
that displays detailed information about the APs. See Viewing a
Summary of Access Points.
# of WLANs
Number of WLAN services that exist in this zone
# of Clients
Number of wireless clients that are currently associated with APs
in this zone. Clicking the number of clients (link, except when zero)
loads a page that displays detailed information about the wireless
clients. See Viewing a Summary of Wireless Clients.
Actions
Icons for actions that you can perform, including:
•
•
•
– Click to view detailed configuration of this AP zone.
– Click to view all access points that belong to this AP zone
on Google Maps. See Viewing All APs That Belong to an AP
Zone on Google Maps.
– Click to view the mesh topology of this AP zone.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
247
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring AP Zones
Exporting the AP Zone List to CSV
Follow these steps to export the AP zone list to a CSV file.
1 Go to Monitor > AP Zones. The AP Zone List page appears.
2 Click the Export CSV button in the content area. The following message
appears:
Downloading AP Zone Data. Please wait...
3 When the message disappears, check the default download folder for your web
browser and look for a file named zone.csv.
4 Use a spreadsheet application (for example, Microsoft™ Excel™) to view the
contents of the CSV file.
You have completed exporting the AP zone list to CSV.
Figure 108. Click the Export CSV button
Viewing the Configuration of an AP Zone
Follow these steps to view the configuration of an AP zone.
1 On the AP Zone List page, locate the AP zone whose details you want to view.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
248
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring AP Zones
2 Under the Actions column, click the
zone name.
icon that is in the same row as the AP
The page refreshes and displays the AP zone configuration details (shown in Figure
109).
Figure 109. Page showing the AP zone configuration details
Viewing All APs That Belong to an AP Zone on Google
Maps
Follow these steps to view all APs that belong to a particular AP zone on Google
Maps.
1 On the AP Zone List page, locate the AP zone that you want to view.
2 Under the Actions column, click the
icon that is in the same row as the AP
zone name. The page refreshes and displays the locations of all APs that belong
to the zone on Google Maps.
3 To view a summary of details about an AP on the map, click the icon for the AP.
A text bubble appears and displays the AP details.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
249
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring AP Zones
Figure 110. Page showing APs that belong to the AP zone on Google Maps
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
250
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
Monitoring Managed Access Points
This section provides information on how to monitor and view information about the
access points that you are managing using the controller.
Topics covered include:
• Viewing a Summary of Access Points
• Exporting the Access Point List to CSV
• Viewing the Configuration of an Access Point
• Downloading the Support Log from an Access Point
Viewing a Summary of Access Points
Follow these steps to view a summary of existing access points.
Go to Monitor > Access Points. The AP List page appears and displays a table that
lists all existing access points in the selected AP zone.
Figure 111. Click an AP zone in the tree to view all access points that belong to it
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
251
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
Table 8 lists the access point details are shown in the table on the AP List page.
Table 8. Access point details
Column Name
Description
AP MAC Address
MAC address of the access point. Clicking this link loads a page
that displays detailed information about the access point. See
Viewing the Configuration of an Access Point.
AP Name
Name assigned to the access point
Zone
Name of the AP zone to which the access point belongs. Clicking
the AP zone name (link) loads a page that displays detailed
information about the zone. See Viewing the Configuration of an
AP Zone.
AP Group
Name of the AP group to which the access point belongs
IP Address
Internal IP address assigned to the access point
External IP
Address
If the device is behind a NAT server, this is the IP address and port
number that the controller will use to communicate with the device.
Model
Model number of the Ruckus Wireless access point
AP Firmware
Firmware version that is installed on the access point
Mesh Role
Indicates whether mesh networking is enabled on the access point
and the mesh role that is assigned to it. Possible values include:
• Disabled: Mesh networking is disabled.
• Mesh AP
• Root AP
• eMesh AP
Mesh Mode
If mesh networking is enabled, indicates the mesh mode of the AP
Channel
Indicates the radio channels used by the AP to provide WLAN
services
Status
Indicates whether the access point is currently connected (online)
or disconnected (offline)
# of Clients
Indicates the number of wireless clients that are currently
associated with the access point. Clicking the number of clients
(link, except when zero) loads a page that displays detailed
information about the wireless clients. See Viewing a Summary of
Wireless Clients.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
252
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
Table 8.
Access point details (Continued)
Column Name
Description
Last Seen
Indicates the date and time when the access point last reported to
the controller
Provision Stage
Administrative
State
Registration State
Actions
Icons for actions that you can perform, including:
•
– Click to view detailed configuration of this access point.
•
– Click to download the support log from this access point.
See Downloading the Support Log from an Access Point.
•
– Click to run network connectivity tests (PING and
traceroute) on this access point.
•
– Click to restart the access point.
Exporting the Access Point List to CSV
Follow these steps to export the access point list to a CSV file.
1 Go to Monitor > Access Points.
2 Click the Export CSV button in the content area. The following message
appears:
Downloading AP Data. Please wait...
3 When the message disappears, check the default download folder of your web
browser and look for a file named aps.csv.
4 Use a spreadsheet application (for example, Microsoft™ Excel™) to view the
contents of the CSV file.
You have completed exporting the access point list to CSV.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
253
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
Figure 112. Click Export CSV to download the AP list
Viewing the Configuration of an Access Point
Follow these steps to view the configuration of an access point.
1 Go to Monitor > Access Points.
2 On the AP List page, locate the access point whose details you want to view.
3 Under the Actions column, click the
address of the access point.
icon that is in the same row as the MAC
The page refreshes and displays the AP zone configuration details (shown in Figure
109).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
254
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
Figure 113. Page showing the access point configuration details
Downloading the Support Log from an Access Point
If you are experiencing issues with an access point, Ruckus Wireless Support may
request you to download the support log from the access point. The support log
contains important technical information that may be help Ruckus Wireless Support
troubleshoot the issue with the access point.
Follow these steps to download the support log from an access point.
1 Go to Monitor > Access Points.
2 On the AP List page, locate the access point from which you want to download
the support log.
3 Under the Actions column, click the
icon that is in the same row as the MAC
address of the access point. The following message appears:
Downloading support log file. Please wait...
4 When the message disappears, check the default download folder for your web
browser and look for a file named SupportLog_{random-string}.txt.
5 Use a text editor (for example, Notepad) to view the contents of the text file.
6 Send the support log file to Ruckus Wireless Support, along with your support
request.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
255
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
You have completed downloading the support log from an access point.
Figure 114. Click the icon for downloading the support log
Restarting an Access Point Remotely
Follow these steps to restart an access point remotely from the web interface.
1 Go to Monitor > Access Points.
2 On the AP List page, locate the access point that you want to restart.
3 Click the
icon that is in the same row as the MAC address of the access
point. The following confirmation message appears:
Are you sure you want to restart this AP?
4 Click OK. The controller sends a restart command to the access point, and then
the access point restarts itself.
You have completed restarting an access point remotely.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
256
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Managed Access Points
Figure 115. The restart buttons for restarting access points remotely
Running Ping and Traceroute on an Access Point
The controller web interface provides two commonly used tools – ping and
traceroute – that allow you to diagnose connectivity issues on managed access
points.
Follow these steps to run the ping and traceroute on an access point.
1 Go to Monitor > Access Points.
2 On the AP List page, locate the access point on which you want to run the ping
or traceroute tool.
3 Click the
icon that is in the same row as the MAC address of the access
point. The Network Connectivity window appears.
4 In IP Address, type an IP address to check whether the access point can connect
to it. For example, type 199.238.178.36 if you want to check if the access
point can connect to the Ruckus Wireless website.
5 Click either Ping or Trace Route (depending on which test you want to run).
The blank box below is populated with the test results.
You have completed running a ping or traceroute test.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
257
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Wireless Clients
Figure 116. The Network Connectivity window showing both ping and traceroute results
Monitoring Wireless Clients
This section provides information on how to monitor and view information about
wireless clients that associate with the managed access points. Topics covered
include:
• Viewing a Summary of Wireless Clients
• Exporting the Wireless Client List to CSV
• Viewing Information About a Wireless Client
Viewing a Summary of Wireless Clients
Follow these steps to view a summary of wireless clients that are currently associated with the managed access points.
Go to Monitor > Clients. The Associated Clients List page appears and displays a
table that lists all access points that are currently associated with the managed
access points.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
258
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Wireless Clients
Figure 117. Select an AP zone in the domain tree to view all wireless clients associated with
the APs that belong to the zone
If you want to view only wireless clients that belong to a particular AP zone (denoted
by the
icon in the domain tree), click the AP zone icon. The table refreshes and
displays only the wireless clients that belong to that AP zone.
Table 9 lists the wireless client details that are shown in the table.
Table 9.
Wireless client details
Column Name
Description
STA MAC Address MAC address of the wireless station. Clicking this link loads a page
that displays detailed information about the wireless client. See
Viewing Information About a Wireless Client.
IP Address
IP address assigned to the wireless client
OS Type
Operating system that the wireless client is using
Host Name
Host name of the wireless client
AP Name
Name assigned to the access point. Clicking this link loads a page
that displays detailed information about the access point. See
Viewing the Configuration of an Access Point.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
259
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Wireless Clients
Table 9.
Wireless client details
Column Name
Description
WLAN (SSID)
Name of the WLAN service or SSID with which the wireless client
is associated.
VLAN
VLAN ID assigned to the wireless client
Channel
Radio channel used by the wireless client to access the WLAN
service on the access point
Status
Indicates whether the wireless client is authorized or unauthorized
to access the WLAN service
User Name
Name of the user logged on to the wireless client
Auth Method
Authentication method used by the access point
Encryption Method Encryption method used by the access point
Actions
Icons for actions that you can perform, including:
•
– Click to disconnect the wireless client from the access
point.
Exporting the Wireless Client List to CSV
Follow these steps to export the access point list to a CSV file.
1 Go to Monitor > Clients.
2 Click the Export CSV button in the content area. The following message
appears:
Downloading Client Data. Please wait...
3 When the message disappears, check the default download folder for your web
browser and look for a file named clients.csv.
4 Use a spreadsheet application (for example, Microsoft™ Excel™) to view the
contents of the CSV file.
You have completed exporting the client list to CSV.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
260
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Wireless Clients
Figure 118. A message appears as your browser downloads the CSV file from the controller
Viewing Information About a Wireless Client
Follow these steps to view information about a wireless client.
1 One the Clients List page, locate the wireless client whose details you want to
view.
2 Under the STA MAC Address column, click the MAC address of the wireless
client.
The page refreshes and displays general information about the wireless client,
including its MAC address, IP address, authentication method, encryption method,
connection details, operating system, and traffic statistics, among others. Recent
connectivity events that occurred on the wireless client are displayed in the Events
section at the bottom of the page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
261
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Wireless Clients
Figure 119. Page showing the wireless client information
Measuring Wireless Network Throughput with
SpeedFlex
SpeedFlex is a wireless performance tool included in the controller that you can use
to measure the downlink throughput between the controller and an AP. When
performing a site survey, you can use SpeedFlex to help find the optimum location
for APs on the network with respect to user locations.
NOTE: SpeedFlex is unable to measure the throughput between two devices if
those two devices are not on the same VLAN or the same subnet.
Follow these steps to measure the throughput of an AP from the controller web
interface.
1 Find out the MAC address of the AP that you want to use for this test procedure.
2 Log on to the controller web interface.
3 If you want to test AP throughput, click Monitor > Access Points.
4 In the list of APs, look for the MAC address of the AP that you want to test, and
then click
(SpeedFlex icon) that is in the same row. The SpeedFlex Wireless
Performance Test interface loads, showing a speedometer and the IP address
of the AP that you want to test.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
262
Monitoring AP Zones, Access Points, and Wireless Clients
Monitoring Wireless Clients
5 In Protocol, select UDP.
If you are testing AP throughput, you have the option to test both Downlink and
Uplink throughput. Both options are selected by default. If you only want to test
one of them, clear the check box for the option that you do not want to test.
6 Click the Start button.
A progress bar appears below the speedometer as SpeedFlex generates traffic to
measure the downlink or uplink throughput. One throughput test typically runs for
10-30 seconds. If you are testing AP throughput and you selected both the Downlink
and Uplink options, both tests should take about one minute to complete.
When the tests are complete, the results appear below the Start button. Information
that is shown includes the downlink/uplink throughput and the packet loss
percentage during the tests.
Figure 120. The SpeedFlex page
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
263
Monitoring the System, Alarms,
Events, and Administrator Activity
11
In this chapter:
• Monitoring the vSCG System
• Monitoring Rogue Access Points
• Viewing Alarms
• Viewing Events
• Viewing Administrator Activity
Monitoring the vSCG System
This section provides information on how to view information about the status of
the controller system, including its cluster planes and cluster events. It also
describes how to use the chassis view and to start the cluster monitor.
Topics covered include:
• Viewing the System Cluster Overview
• Starting the Cluster Real-time Monitor
Viewing the System Cluster Overview
The system cluster overview provides summary information about the control planes
and data planes on the controller appliance, any outstanding cluster alarms, and
the latest cluster events.
To view the system cluster overview, go to Monitor > vSCG Carrier System. The
System Cluster Overview page appears, as shown in Figure 121.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
264
Monitoring the System, Alarms, Events, and Administrator Activity
Monitoring the vSCG System
Figure 121. The System Cluster Overview page
Starting the Cluster Real-time Monitor
The Cluster Real-time Monitor displays graphs and charts of the controller system
resources. Use this monitor to understand how system resources on the cluster
nodes are being used.
To start the cluster real-time monitor, click Start Cluster Real-time Monitor on the
System Cluster Overview page. A new browser page or tab appears (depending on
your browser settings), and then the Cluster Real-time Monitor page appears.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
265
Monitoring the System, Alarms, Events, and Administrator Activity
Monitoring the vSCG System
Figure 122. The Cluster Real-time Monitor page
The resource graphs and charts that are shown on the Cluster Real-time Monitor
page include:
• CPU Usage
• Memory Usage
• Disk Usage
• Control Tx (Port0, Port 3)
• Cluster Tx (Port1, Port 4)
• Management Tx (Port2, Port 5)
• Control Rx (Port0, Port 3)
• Cluster Rx (Port1, Port 4)
• Management Rx (Port2, Port5)
To stop the Cluster Real-time Monitor, click the Stop Monitoring button on the
upper-left part of the page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
266
Monitoring the System, Alarms, Events, and Administrator Activity
Monitoring Rogue Access Points
Monitoring Rogue Access Points
“Rogue” (or unauthorized) APs pose problems for a wireless network in terms of
airtime contention, as well as security. Usually, a rogue AP appears in the following
way: an employee obtains another manufacturer's AP and connects it to the LAN,
to gain wireless access to other LAN resources. This would potentially allow even
more unauthorized users to access your corporate LAN - posing a security risk.
Rogue APs also interfere with nearby Ruckus Wireless APs, thus degrading overall
wireless network coverage and performance.
The controller’s rogue AP detection options include identifying the presence of a
rogue AP, categorizing it as either a known neighbor AP or as a malicious rogue.
If you enabled rogue AP detection when you create an AP zone (see Creating an
AP Zone), click Monitor > Rogue Access Points. The Rogue Access Points page
displays all rogue APs that the controller has detected on the network, including the
following information:
• Rogue MAC: MAC address of the rogue AP.
• Type: Type of rogue AP detected. Possible values include:
• Rogue: A normal rogue AP. This rogue AP has not yet been categorized as
malicious or non-malicious.
• Malicious AP (SSID-spoof): A malicious rogue AP that uses the same SSID
as a controller-managed AP (also known as an Evil-twin AP).
• Malicious AP (MAC-spoof): A malicious rogue AP that has the same BSSID
(MAC) as one of the virtual APs managed by the controller.
• Malicious AP (Same-Network): A malicious rogue AP that is connected to the
same wired network.
• Malicious AP (User-Blocked): A rogue AP that has been marked as malicious
by the user.
• Channel: Radio channel used by the rogue AP.
• Radio: WLAN standards with which the rogue AP complies.
• SSID: WLAN name that the rogue AP is broadcasting.
• Encryption: Indicates whether the wireless signal is encrypted or not.
• Last Detected: Date and time when the rogue AP was last detected by the
controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
267
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Alarms
Figure 123. View a list of rogue APs on the Monitor > Rogue Access Points page
Viewing Alarms
Alarms are a type of event that typically warrants your attention. Alarms are
generated by managed access points and the controller system (control plane and
data plane).
Follow these steps to view recent alarms that have been generated.
Go to Monitor > Alarms. The Alarms page displays the 20 most recent alarms.
NOTE: By default, the Alarms page displays up to 20 event entries per page. You
can change the number of alarms to display per page by selecting a number in
Show. Options range from 10 to 250 entries per page. Alternatively, you can click
the >> (next) link to display the next 20 alarms on another page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
268
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Alarms
Figure 124. The Alarms page displays the most recent alarm entries
Table 10 lists the alarm details that are displayed on the Alarms page.
Table 10. Alarm details
Column Name
Description
Date and Time
Date and time when the alarm was triggered
Code
Alarm code (see the Virtualized SmartCell Gateway Event and
Alarm Reference Guide for more information)
Alarm Type
Type of alarm event that occurred (for example, AP reset to factory
settings)
Severity
Severity level assigned to the alarm. Possible values include (from
most severe to least severe):
• Critical
• Major
• Minor
• Warning
Status
Indicates whether the alarm has already been cleared or still
outstanding
Acknowledged On Date and time when you or another administrator acknowledge the
alarm
Activity
Displays additional details about the alarm, including (if available)
the specific access point, control plane, or data plane that triggered
the alarm
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
269
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Alarms
Table 10. Alarm details (Continued)
Column Name
Description
Actions
Icons for actions that you can perform, including:
•
– Click this to take ownership of issue. Acknowledging an
alarm lets other administrators know that someone is already
looking into the issue.
•
– Click this to clear the alarm. You may clear an alarm to let
other administrators know that you have already resolved the
issue. When you click this icon, a text box appears where you
can enter comments or notes about the resolved issue. Click
Clear when done.
Using the Search Criteria Section
By default, the controller displays alarms triggered on all access points (using All
APs as the search criteria) when you load the Alarms page. If you want to filter the
alarms that are displayed on the page (for example, you want to display only critical
alarms), use the Search Criteria section.
Follow these steps to filter alarms.
1 Click the orange down button next to Search Criteria to expand the section.
2 In the Source filter, select source from which to search alarms. Options include
Access Point and vSCG System.
3 Click the
icon to add another filter. Available filters include (in the order that
they appear when you click the
icon):
• Severity
• Triggered Time
• Status
• Acknowledge Time
• Type
NOTE: You do not need to use all these filters. To remove a filter from the search
criteria, click the
icon next to the filter that you want to delete.
4 Define the filters that you want to use. For example, if you want to view all critical
alarms on all access points, select Access Point in Source, and then select
Critical in Severity.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
270
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Events
5 Click Search. The page refreshes and displays the alarms that match the search
criteria that you defined.
Figure 125. Define the filters that you want to use to search for alarms
Exporting the Alarm List to CSV
Follow these steps to export the alarm list to a CSV file.
1 Go to Monitor > Alarms.
2 Click the Export CSV button in the content area. The following message
appears:
Downloading Alarms Data. Please wait...
3 When the message disappears, check the default download folder of your web
browser and look for a file named alarms.csv.
4 Use a spreadsheet application (for example, Microsoft™ Excel™) to view the
contents of the CSV file.
You have completed exporting the alarm list to CSV.
Viewing Events
An event is an occurrence or the detection of certain conditions in and around the
network. An AP being rebooted, an AP changing its IP address, and a user updating
an AP’s configuration are all examples of events.
NOTE: Events that require your attention are called alarms. For information on
alarms, refer to Viewing Alarms.
Follow these steps to view recent events that have been detected by the controller.
Go to Monitor > Events. The Events page appears and displays the 20 most recent
events that have occurred.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
271
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Events
NOTE: By default, the Events page displays up to 20 event entries per page. You
can change the number of events to display per page by selecting a number in
Show. Options range from 10 to 250 entries per page. Alternatively, you can click
the >> (next) link to display the next 20 events on another page.
Figure 126. The Events page lists the most recent events that have occurred
Table 11 lists the event details that are displayed on the Events page.
Table 11. Event details
Column Name
Description
Date and Time
Date and time when the event occurred
Code
Event code (see the Virtualized SmartCell Gateway Event and
Alarm Reference Guide for more information)
Event Type
Type of event that occurred (for example, AP configuration
updated)
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
272
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Events
Table 11. Event details
Column Name
Description
Severity
Severity level assigned to the event. Possible values include (from
most severe to least severe):
• Critical
• Major
• Minor
• Warning
Activity
Displays additional details about the event, including (if available)
the specific access point, control plane, or data plane that triggered
the event
Using the Search Criteria Section
By default, the controller displays all events that occurred on the first access point
that is listed in the domain tree. If you want to filter the events that are displayed on
the page (for example, you want to display events on a client or the controller
system), use the Search Criteria section.
Follow these steps to filter events.
1 Click the orange down button next to Search Criteria to expand the section.
2 In the Source filter, select source from which to search alarms. Options include
Access Point, Client, and vSCG System.
3 Click the
icon to add another filter. Available filters include (in the order that
they appear when you click the
icon):
• Date and Time
• Severity
• Type
NOTE: You do not need to use all these filters. To remove a filter from the search
criteria, click the
icon next to the filter that you want to delete. Search criteria are
case-sensitive.
4 Define the filters that you want to use. For example, if you want to view all critical
events on all access points, select Access Point in Source, leave Search Plane
by blank, and then select Critical in Severity.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
273
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Events
5 Click Search. The page refreshes and displays the events that match the search
criteria that you defined.
Figure 127. Define the filters that you want to use to search for events
Exporting the Event List to CSV
Follow these steps to export the event list to a CSV file.
1 Go to Monitor > Events.
2 Click the Export CSV button in the content area. The following message
appears:
Downloading Events Data. Please wait...
3 When the message disappears, check the default download folder of your web
browser and look for a file named events.csv.
4 Use a spreadsheet application (for example, Microsoft™ Excel™) to view the
contents of the CSV file.
You have completed exporting the event list to CSV.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
274
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Administrator Activity
Figure 128. Exporting the event list to CSV
Viewing Administrator Activity
The controller keeps a record of all actions and configuration changes that administrators perform on the server. This feature enables you and other administrators
in the organization to determine what changes were made to the controller and by
whom.
Follow these steps to view a record of actions that were performed by administrators.
Go to Monitor > Administrator Activity. The Administrator Activity List page displays
the 20 most recent administrator actions.
NOTE: By default, the Administrator Activity List page displays up to 20
administrator actions per page. You can change the number of administrator actions
to display per page by selecting a number in Show. Options range from 10 to 250
entries per page. Alternatively, you can click the >> (next) link to display the next 20
administrator actions on another page.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
275
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Administrator Activity
Figure 129. The Administrator Activity List displays the most recent administrator actions
Table 12 lists the administrator activity details that are displayed on the Administrator
Activity List page.
Table 12. Administrator activity details
Column Name
Description
Date and Time
Date and time when the alarm was triggered
Administrator
Name of the administrator who performed the action
Browser IP
IP address of the browser that the administrator used to log on to
the controller
Action
Action performed by the administrator
Resource
Target of the action performed by the administrator. For example,
if the action is Create and the object is Hotspot Service,
this means that the administrator created a new hotspot service.
Description
Displays additional details about the action. For example, if the
administrator created a new hotspot service, this column may show
the following:
Hotspot [company_hotspot] created
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
276
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Administrator Activity
Using the Search Criteria Section
By default, the controller displays the 30 most recent administrator actions when
you load the Administrator Activity List page. If you want to filter the actions that are
displayed on the page (for example, you want to display only actions that were
performed by a particular admin), use the Search Criteria section.
1 Click the orange down button next to Search Criteria to expand the section.
2 Click the
icon to add a filter. Available filters include (in the order that they
appear when you click the
icon:
• Date/Time
• Administrator
• Browser IP
• Object
NOTE: You do not need to use all these filters. To remove a filter from the search
criteria, click the
icon next to the filter that you want to delete. Search criteria are
case-sensitive.
3 Define the filters that you want to use. For example, if you want to view all actions
performed by a particular administrator for the past month, define the date and
time, and then select the name of the administrator in Administrator.
4 Click Search. The page refreshes and displays the administrator actions that
match the search criteria that you defined.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
277
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Administrator Activity
Figure 130. Define the filters that you want to use to search for administrator actions
Exporting the Administrator Activity List to CSV
Follow these steps to export the administrator activity list to a CSV file.
1 Go to Monitor > Administrator Activity.
2 Click the Export CSV button in the content area. The following message
appears:
Downloading Administrator Data. Please wait...
3 When the message disappears, check the default download folder for your web
browser and look for a file named auditLog.csv.
4 Use a spreadsheet application (for example, Microsoft™ Excel™) to view the
contents of the CSV file.
You have completed exporting the administrator activity list to CSV.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
278
Monitoring the System, Alarms, Events, and Administrator Activity
Viewing Administrator Activity
Figure 131. Click the Export CSV button to download a CSV file that contains details of
administrator activity
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
279
Working with Reports
12
In this chapter:
• Types of Reports
• Creating a New Report
• Viewing a List of Existing Reports
• Deleting a Report
Types of Reports
The controller provides the following types of reports:
• Client Number Report
• Client Number vs Airtime Report
• Continuously Disconnected APs Report
• Failed Client Associations Report
• New Client Associations Report
• System Resource Utilization Report
• TX/RX Bytes Report
Client Number Report
This Client Number Report shows a historical view of the maximum and minimum
number of clients connect to the system. Client number can be shown in different
time intervals for a specified duration. The report can be generated based on specific
management domain, AP zone, AP, SSID, or radio type.
Client Number vs Airtime Report
This Client Number vs Airtime Report shows a historical view of the average number
of clients connected to the system and the corresponding airtime (TX, RX, Busy).
Client number and airtime can be shown in different time intervals for a specified
duration. The report can be generated based on a specific management domain,
AP zone, AP, SSID, or radio type.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
280
Working with Reports
Creating a New Report
Continuously Disconnected APs Report
The Continuously Disconnected APs Report shows the list of access points disconnected with specified time range. The report can be generated based on specific
management domain and AP zone.
Failed Client Associations Report
The Failed Client Associations Report shows a historical view of the number of failed
client associations. Failed client associations can be shown in different time intervals
for a specified duration. The report can be generated based on specific management domain, AP zone, AP, SSID, or radio type.
New Client Associations Report
The New Client Associations Report shows a historical view of the number of new
client associations. New client Associations can be shown in different time intervals
for a specified duration. The report can be generated based on specific management domain, AP zone, AP, SSID, or radio type.
System Resource Utilization Report
The System Resource Utilization Report shows a historical view of the CPU and
memory usage of the system. The CPU and memory usage can be shown in different
time intervals for a specific duration. The report can be generated based on specific
blade.
TX/RX Bytes Report
This TX/RX Bytes Report shows a historical view of the transmitted (TX) and received
(RX) bytes of the system. The transmitted and received bytes can be shown in
different time intervals for a specified duration. The report can be generated based
on a specific management domain, AP zone, AP, SSID or radio type.
Creating a New Report
Follow these steps to create a new report.
1 On the Saved Reports List page, click Create New. The Create New Report
form appears.
2 Perform the following steps to create a new report:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
281
Working with Reports
Creating a New Report
Step 1: Define the General Report Details
Step 2: Define the Resource Filter Criteria
Step 3: Define the Time Filter
Step 4: Define the Report Generation Schedule
Step 5: Enable Email Notifications (Optional)
Step 7: Save the Report
Step 1: Define the General Report Details
Follow these steps to define the general details of the report that you are creating
in the General Information section.
1 In Title, type a name for the report that you are creating.
2 In Description, type a brief description for the report.
3 In Report Type, select the type of report that you want to create. For detailed
description of the various report types, refer to Types of Reports.
4 In Output Format, select one or both of the following check boxes:
• CSV: A comma-separated version of the report. You will need a spreadsheet
application (for example, Microsoft™ Excel™) to view the report in CSV
format.
• PDF: A portable document format version of the report. You will need a PDF
reader (for example, Adobe™ Acrobat™) to view the report in PDF.
5 Continue to Step 2: Define the Resource Filter Criteria.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
282
Working with Reports
Creating a New Report
Step 2: Define the Resource Filter Criteria
Follow these steps to define the resources upon which the report that you are
creating will be generated. These resources can be defined in the Resource Filter
Criteria section.
1 Select the resources upon which to generate the report. Resources include:
• Device: Select one of the following device resources:
-
Management Domain: If you base the report upon this device resource,
you must select at least one management domain from the drop-down
list. If you want to include multiple management domains in the report,
select the management domains from the drop-down list one at a time.
To delete a management domain that you selected previously, click the
icon next to the management domain name.
-
AP Zone: If you base the report upon this device resource, you must
select at least one AP zone from the drop-down list. If you want to include
multiple AP zones in the report, select the AP zones from the drop-down
list one at a time. To delete an AP zone that you selected previously, click
the
icon next to the management domain name.
-
Access Point: If you base the report upon this device resource, you must
select the name of the specific access point from the drop-down list. You
can only select one access point to include in the report.
• SSID: Select the SSID or SSIDs that you want to include in the report. If you
want to include multiple SSIDs in the report, select the SSIDs from the dropdown list one at a time. To delete an SSID that you selected previously, click
the
icon next to the SSID.
If you do not select an SSID, all existing SSIDs that belong to the device
resource you selected in Device will be included in the report.
• Radio: Select the radio (2.4G or 5G) that you want to include in the report.
If you do not select a radio, both 2.4G and 5G radios belong to the device
resource you selected in Device will be included in the report.
NOTE: You must select at least one resource. You can also select and define all
three available resources.
2 Continue to Step 3: Define the Time Filter.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
283
Working with Reports
Creating a New Report
Step 3: Define the Time Filter
Follow these steps to define the time filter to use in generating the report. The time
filter can be defined in the Time Filter section.
1 In Time Interval, select the interval at which to generate the report. Available time
interval options include:
• 15 Minutes
• Hourly
• Daily
• Monthly
2 In Time Filter, select the time or date period for which to generate the report.
Depending on the time interval that you set above, available periods include:
• Hours
• Days
• Months
NOTE: The controller uses this time interval-time filter combination to determine the
period from which to generate the report and how often to generate it.
3 Continue to Step 4: Define the Report Generation Schedule.
Step 4: Define the Report Generation Schedule
Follow these steps to define the report generation schedule. This schedule can be
defined in the Schedules section.
1 In the Schedules section, click Add New.
2 In Interval, select one of the following time intervals:
• Monthly: If you select this interval, select the day of the month in Every when
the controller will generate the report.
• Weekly: If you select this interval, select the day of the week in Every when
the controller will generate the report.
• Daily
• Hourly
3 In @Hour (except when Hourly interval is selected above), select the hour of the
day when the controller will generate the report. The controller uses the 24-hour
clock format.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
284
Working with Reports
Creating a New Report
4 In Minute, select the minute of the hour when the controller will generate the
report. This minute setting will be used in conjunction with the hour setting that
you selected above (except when Hourly interval is selected).
5 If you want to add more schedules, click the Add New button again, and then
repeat steps 2-4. You can create as many schedules as required. Schedules
may overlap if needed.
6 Continue to Step 5: Enable Email Notifications (Optional).
Step 5: Enable Email Notifications (Optional)
Follow these steps to enable the controller to send email notifications when a report
has been generated.
NOTE: Make sure you configure the SMTP settings (see Configuring the SMTP
Server Settings). If the SMTP settings are not configured, the controller will be unable
to send out email notifications even if you enable this feature in this section.
1 In the Email Notification section, click the Enable button.
2 In the text box below, type the email address to which to send the notification.
3 To add another email address, click Add New, and then type the second email
address in the text box that appears.
NOTE: You can add as many email addresses as needed by clicking the Add New
button, and then typing an additional email address. Note, though, that you must
only type a single email address in each text box.
4 Continue to Step 6: Export the Report to an FTP Server (Optional).
Step 6: Export the Report to an FTP Server (Optional)
Follow these steps to automatically export a copy of the report to an FTP server
whenever it is generated.
1 In Export Report Results, click Enable.
2 In FTP Server, select the FTP server to which you want to automatically export
the reports. The FTP server options that appear here are those that you created
in Configuring FTP Services.
3 Continue to Step 7: Save the Report
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
285
Working with Reports
Viewing a List of Existing Reports
Step 7: Save the Report
After you complete steps 1 through 5, review the settings that you have configured
to make sure they are correct. To save the report, click OK at the bottom of the
page. The page refreshes, and the report that you created appears in the Saved
Report List page.
You have completed creating a report.
Viewing a List of Existing Reports
Follow these steps to view a list of reports that have been configured.
Go to Report > Saved Reports. The Saved Report List page appears, displaying
a summary of all reports that have been configured. Summary details include:
• Title
• Description
• Report Template
• Time Filter
• Resource Filter
• Schedule
• Status
• Actions that you can perform
To view a report, click the
icon that is in the same row as the report name. The
Report Result page appears, displaying versions of the report that have been
generated based on the time interval defined in the report schedule. To download
and view a comma-separated value (CSV) version of the report, click the CSV link
that is in the same row as the version that you want to view.
Deleting a Report
Follow these steps to delete an existing report.
1 Go to Report > Saved Reports. The Saved Report List page appears, displaying
a summary of all reports that have been configured.
2 From the list of reports, locate the report that you want to delete.
3 Once you locate the report, click the
A confirmation message appears.
icon that is under the Actions column.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
286
Working with Reports
Deleting a Report
4 Click OK. The list of reports refreshes, and then the report that you deleted
disappears from the list.
You have completed deleting a report.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
287
Working with Local, Guest, and
Remote Users
13
In this chapter:
• Working with Local, Guest, and Remote Users
• Working with User Roles
• Managing Subscription Packages
Working with Local, Guest, and Remote Users
The controller supports the following types of user accounts:
• Local users: Also known as registered users, these are users who have existing
accounts on the controller database. See Working with Local Users.
• Guest users: These are temporary users for whom guest passes have been
generated. See Working with Guest Users.
• Remote users: Also known as Bring Your Own Device (BYOD) users, these are
users who bring and connect their own devices to the network. See Working
with Remote Users.
Working with Local Users
A local user in the controller refers to a registered user who may be given access
to the controller hotspot. A user account contains a user’s personal information,
logon information, and the subscription package that he or she has been assigned.
This section describes the following tasks:
• Creating a Local User Account
• Editing a Local User Account
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
288
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Creating a Local User Account
NOTE: When you create a user account, you will be required to assign a
subscription package to the user. Before creating a user account, Ruckus Wireless
recommends creating at least one subscription package. See Creating a Package
for more information.
Follow these steps to create a user account.
1 Go to Configuration > Identity > Users.
2 Click Create New.
3 In the Contact Details section, fill out the following boxes:
• First Name
• Last Name
• Email
• Phone
• Country
• City
• Street
• Zip Code
• State: Select Enabled to enable this user profile or select Disabled.
• Remark
4 In the Login Details section, fill out the following boxes to create the logon
credentials of this user:
• User Name: Type a name for this user. The user name is not case-sensitive
and will always be displayed in lowercase characters.
• Password: Type a password for this user. The password must be at least
eight characters in length.
• Confirm Password: Retype the password above.
5 In the Subscription Details section, select a subscription package that you want
to assign to this user (see Managing Subscription Packages).
6 Click OK.
You have completed creating a user account.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
289
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 132. Creating a user account
Editing a Local User Account
Follow these steps to edit an existing local user account.
1 Go to Configuration > Identity > Users.
2 Locate the user account that you want to edit, and then click the user name.
The Edit User: [{User Name}] form appears.
3 Edit the user account by updating the fields in the Contact Details and Login
Details sections.
4 Click OK.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
290
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 133. Editing a user account
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
291
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Working with Guest Users
Similar to local user accounts (see Working with Local Users), guest user accounts
in the controller allow users to gain access to the controller hotspots. However,
unlike local user accounts, guest users are not required to provide personal
information to access the controller hotspots and can, therefore, remain anonymous.
Generating Guest Passes
Guest users require guest passes, which are credentials that allow temporary
access to the controller hotspots and are generated for specific WLANs only – guest
pass users will only be able to gain access to the WLANs for which the guest pass
was generated.
Generating guest passes involves the following steps:
Step 1: Create a Guest Access Service
Step 2: Create a Guest Access WLAN
Step 3: Generate a Guest Pass
NOTE: If you want to send the guest pass to guest users via Short Message Service
(SMS), make sure you add the SMS server to the controller before starting the next
procedure. For information on how to add an SMS server to the controller, see
Configuring an SMS Server.
Step 1: Create a Guest Access Service
1 Create an AP zone that you want to use to provide hotspot access to guest
users. See Creating an AP Zone for instructions on how to create one.
2 After you have created an AP zone, go to Configuration > AP Zones.
3 On the AP Zone List page, click the name of the AP zone that you have created
to go to its configuration page. The configuration page for that AP zone appears.
4 On the sidebar, click Guest Access. The Guest Access page appears.
5 Click Create New. The Create New Guest Access Service form appears.
6 In General Options, configure the following:
• Name
• Description
• Language
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
292
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
7 In Start Page under Redirection, set where users will be redirected after they log
in successfully:
• Redirect to the URL that user intends to visit: You could redirect users to
the page that they want to visit.
• Redirect to the following URL: You could set a different page where users
will be redirected (for example, your company website).
8 In Guest Access, configure the following:
• Guest Pass SMS Gateway: If you want to send the guest pass to users using
SMS and you configured an SMS server earlier, select the SMS server.
Otherwise, select Disabled.
• Terms and Conditions: To require users to read and accept your terms and
conditions prior to use, Show Terms And Conditions check box. The box
below, which contains the default Terms of Use text, becomes editable. Edit
the text or leave it unchanged to use the default text.
• Web Portal Logo: By default, the guest hotspot logon page displays the
Ruckus Wireless logo. To use your own logo, click the Upload button, select
your logo (recommended size is 138 x 40 pixels, maximum file size is 20KB),
and then click Upload.
• Web Portal Title: Type your own guest hotspot welcome text or accept the
default welcome text (“Welcome to the Guest Access login page”).
9 In User Session, configure the following:
• Session Timeout: Specify a time limit after which users will be disconnected
and required to log on again.
• Grace Period: Set the time period during which clients will not need to reauthenticate after getting disconnected from the hotspot. Enter a number (in
minutes) between 1 and 144,000.
10 Click OK.
You have completed creating a guest access service. You may now continue to
Step 2: Create a Guest Access WLAN.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
293
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 134. The Create New Guest Access Service form
Step 2: Create a Guest Access WLAN
In this step, you will create a WLAN for the AP zone that you created in Step 1:
Create a Guest Access Service.
1 Create a new WLAN. Follow the instructions in Working with WLANs and WLAN
Groups.
2 Make sure though that you configure Authentication Type and Hotspot (WISPr)
Service exactly as described below.
• In Authentication Type, click Guest Access and Zero-IT Onboarding.
• In Guest Access, select the guest access service that you created earlier in
Step 1: Create a Guest Access Service.
3 Click Create New.
You have completed creating a guest access WLAN. Continue to Step 3: Generate
a Guest Pass.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
294
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 135. Select Guest Access and Zero-IT Onboarding in Authentication Type, and then
select the guest access service you created earlier in Guest Access
Step 3: Generate a Guest Pass
Follow these steps to generate a guest pass.
1 Click Identity > Users. The Users page appears.
2 Click Guest Pass > Guest Pass Service. The Guest Pass page appears.
3 Click Generate Guest Pass, and then click Next.
4 Configure the following options:
• Guest Name: Type a name that you want to assign to the guest user.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
295
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
• Guest WLAN: Select the guest WLAN that you created in Step 2: Create a
Guest Access WLAN.
• Number of Passes: Type the number of guest passes that you want to
generate.
• Pass Valid For: Set the validity period for the guest pass by filling in the two
boxes. For example, if you want the guest pass to be valid for seven days,
type 7 in the first box, and then select Days in the second box.
5 Configure the advanced options:
• Pass Generation: Select the Auto Generate check box if you want the
controller to generate the guest pass key automatically. If you want to
generate the guest pass manually, clear the Auto Generate check box.
NOTE: If you are generating more than one guest pass, the Auto Generate check
box is selected automatically and is not configurable.
• Pass Effective Since: Set the guest pass validity period by selecting one of
the following options:
-
Effective from the creation time: This type of guest pass is valid from
the time it is first created to the specified expiration time, even if it is not
being used by any end user.
-
Effective from first use: This type of guest pass is valid from the time
the user uses it to authenticate with ZoneDirector until the specified
expiration time. An additional parameter (A Guest Pass will expire in X
days) can be configured to specify when an unused guest pass will expire
regardless of use. The default is 7 days.
-
Expire guest pass if not used within [ ] days: If you want this guest
pass to expire if it is unused after you generated it, type the number of
days in the box (maximum value is 365 days).
• Max Devices Allowed: Set the number of users that can share this guest pass.
-
Limited to [ ]: If you want a limited number of users to share this guest
pass, click this option, and then type the number in the box.
-
Unlimited: If you want an unlimited number of users to share this guest
pass, click this option.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
296
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
-
Session Duration: If you clicked Unlimited, this option appears. If you
want require users to log on again after their sessions expire, select the
Require guest re-login after [ ] check box, and then select a time
increment. If this feature is disabled, connected users will not be required
to re-log in until the guest pass expires.
• In Remarks (optional), type your notes about this guest pass, if any.
6 Click Generate. The page refreshes, and then the guest pass you generated
appears in a table, along with other guest passes that exist on the controller.
7 Click OK to close the pop-up message.
You have completed generating a guest pass. You are now ready to send the guest
pass to guest users. See Step 4: Send Guest Passes to Guest Users for information.
Figure 136. Generating a guest pass
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
297
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Step 4: Send Guest Passes to Guest Users
On the page that appears after you generate a guest pass are options for delivering
the guest pass to guest users (see Figure 137). These delivery options include:
• Print Selected: See Printing the Guest Pass.
• Export CSV: See Exporting the Guest Pass to CSV.
• Email: See Sending the Guest Pass via Email.
• SMS: See Sending the Guest Pass via SMS.
Figure 137. Options for delivering guest passes to guest users
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
298
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Printing the Guest Pass
NOTE: If your browser is blocking pop-ups, make you temporarily disable the popup blocker so you can view and print the guest pass.
After you generate the guest pass, you can print the guest pass information, which
contains the guest user information and instructions on how to connect to the
hotspot, and give it to the guest user.
Follow these steps to print a guest pass.
1 Select the guest passes that you want to print by selecting the check boxes
before them.
2 In Guest Instruction HTML Template, select a printout template to use. The
default printout template (default.html) is selected by default. If you created
custom printout templates (see Creating a Guest Pass Printout Template), they
will appear in the drop-down menu.
3 Click Print Selected. A new browser page appears, which displays the guest
pass and available printing options.
4 Configure your printer settings, and then print the guest passes.
You have completed printing the guest passes.
Figure 138. What a guest pass printout looks like
Exporting the Guest Pass to CSV
Follow these steps to export the last generated guest passes to a comma-separated
value (CSV) file.
1 Select the guest passes that you want to export to CSV by selecting the check
boxes before them.
2 Click Export CSV. Your web browser downloads the CSV file to its default
download location.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
299
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
3 Go to your web browser’s default download location and look for a file named
guestpass[number].csv.
4 Using Microsoft Excel or a similar application, open the CSV file. The CSV file
displays the details of the guest passes, including:
• Guest Name
• Remarks
• Key
• Expiration Date
You have completed exporting the last generated guest passes to CSV.
Figure 139. A sample CSV of generated guest passes when opened in Excel
Sending the Guest Pass via Email
NOTE: To send guest passes via email, you must have added an external email
server to the controller. See Configuring the SMTP Server Settings for more
information.
Follow these steps to send the guest pass via email.
1 Select the guest passes that you want to send via email by selecting the check
boxes before them.
2 Click Email. The Recipient Email form appears on the right side of the page (see
Figure 140).
3 Click Add New.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
300
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
4 In the box that appears below, type the email address to which you want to send
the guest passes.
5 To add another recipient, click Add New again, and then type another email
address.
6 When you have finished adding all the email recipients, click Send Email. A
dialog box appears and informs you that the emails have been sent to the
message queue successfully
7 Click OK to close the dialog box.
You have completed sending guest passes via email.
Figure 140. Use the Recipient Email form to specify who will receive the guest passes via
email
Sending the Guest Pass via SMS
NOTE: To send guest passes via email, you must have added an external SMS
gateway to the controller. See Configuring an SMS Server for more information.
Follow these steps to send the guest pass via email.
1 Select the guest passes that you want to send via SMS by selecting the check
boxes before them.
2 Click SMS. SMS options appears on the right side of the page (see Figure 141).
3 In Guest Instruction SMS Template, select the SMS template that you want to
use.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
301
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
4 Click Add New.
5 In the box that appears below, type the phone number to which you want to
send the guest passes via SMS.
6 To add another SMS recipient, click Add New again, and then type another
phone number.
7 When you have finished adding all the SMS recipients, click Send SMS. A dialog
box appears and informs you that the SMS messages have been sent to the
message queue successfully
8 Click OK to close the dialog box.
You have completed sending guest passes via SMS.
Figure 141. Options for sending guest passes via SMS
Generating Guest Passes from an Imported CSV
You can also manually define the guest passes that you want to generate in a
comma-separated value (CSV) file (a sample of which is available for download from
the Guest Pass page).
Follow these steps to generate guest passes from an imported CSV file.
1 Click Configuration > Identity > Users.
2 Click Guest Pass > Guest Pass Service. The Guest Pass page appears.
3 Click Import Guest Pass, and then click Next.
4 Look for the following text under Browse:
To download a sample guest pass, click here.
5 Click the here link to download the sample CSV file.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
302
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
6 Using Microsoft Excel or a similar application, open the CSV file.
7 In the CSV file, fill out the following columns:
• #Guest Name (Must): Assign a user name to the guest pass user.
• Remarks (Optional): Add some notes or comments about this guest pass.
• Key: Enter a guest pass key or leave it blank so the controller can generate
the key automatically.
Figure 142. The sample CSV file when opened in Excel
8 Save the CSV file.
9 Go back to the Guest Pass page, and then configure the following settings on
the Common Guest Pass Settings:
• Guest WLAN: Select the guest WLAN that you created in Step 2: Create a
Guest Access WLAN.
• Pass Valid For: Set the validity period for the guest pass by filling in the two
boxes. For example, if you want the guest pass to be valid for seven days,
type 7 in the first box, and then select Days in the second box.
10 Configure the advanced options:
• Pass Effective Since: Set the guest pass validity period by selecting one of
the following options:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
303
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
-
Effective from the creation time: This type of guest pass is valid from
the time it is first created to the specified expiration time, even if it is not
being used by any end user.
-
Effective from first use: This type of guest pass is valid from the time
the user uses it to authenticate with ZoneDirector until the specified
expiration time. An additional parameter (A Guest Pass will expire in X
days) can be configured to specify when an unused guest pass will expire
regardless of use. The default is 7 days.
-
Expire guest pass if not used within [ ] days: If you want this guest
pass to expire if it is unused after you generated it, type the number of
days in the box (maximum value is 365 days).
• Max Devices Allowed: Set the number of users that can share this guest pass.
-
Limited to [ ]: If you want a limited number of users to share this guest
pass, click this option, and then type the number in the box.
-
Unlimited: If you want an unlimited number of users to share this guest
pass, click this option.
-
Session Duration: If you clicked Unlimited, this option appears. If you
want require users to log on again after their sessions expire, select the
Require guest re-login after [ ] check box, and then select a time
increment. If this feature is disabled, connected users will not be required
to re-log in until the guest pass expires.
11 In Guest List CSV File (at the top of the page), click Browse, and then select the
CSV file you edited earlier. The page refreshes, and the number of guest passes
that the controller has identified in the CSV file appears below the Browse button.
12 Click Generate. The page refreshes, and then the guest pass you generated
appears in a table, along with other guest passes that exist on the controller.
You have completed generating a guest pass. You are now ready to send the guest
pass to guest users. See Step 4: Send Guest Passes to Guest Users for information.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
304
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 143. The Guest Pass page for importing a CSV file
Viewing the List of Guest Users
Follow these steps to view guest users that currently exist on the controller.
1 Click Configuration > Identity > Users.
2 Click the User Type column to sort all existing user accounts by user type.
All users of the user type “Guest” are guest users.
You have completed view the list of guest users.
Deleting Guest Users
Follow these steps to delete guest users.
1 Click Configuration > Identity > Users.
2 Select the check boxes before the guest user accounts that you want to delete.
Click Delete Selected. A confirmation message appears.
3 Click Yes to confirm. The page refreshes, and the guest user accounts that you
deleted disappears from the list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
305
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
NOTE: To delete a single guest pass, click the
row as the guest pass name.
(delete) icon that is in the same
You have completed deleting a guest pass or guest passes.
Figure 144. Deleting a single guest pass or multiple guest passes
Creating a Guest Pass Printout Template
A guest pass printout template contains variables for the information that guest
users need to connect to the controller hotspots (for example, guest name, key,
and WLAN name), as well as the actual instructions for connecting to the WLAN.
A default printout template exists in the controller. If you want to create your own
printout template, follow these steps.
1 Go to Configuration > Identity > Users.
2 Click Guest Pass > Manage Templates. The Manage Guest Instruction
Templates page appears.
3 Using an HTML editor, create a new HTML or text file.
4 Add content to the file. Typically, a printout template contains instructions for
connecting to the controller hotspot. See Figure 145 for the content of the default
printout template.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
306
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 145. Content of the default printout template
5 Insert the following variables into the content of your template:
• {GP_GUEST_NAME}: This is the guest pass user name.
• {GP_GUEST_KEY}: This is the guest pass key.
• {GP_VALID_TIME}: This is the expiration date and time of the guest pass.
• {GP_GUEST_WLAN}: This is the WLAN with which the guest user can
associate using the guest name and guest key.
6 Save the file.
7 On the Manage Guest Instruction Templates page, click the appropriate Upload
button for the template that you are creating. The Upload a Template File form
appears on the right side of the page.
8 Configure the Upload a Template File options:
• Template Name: Type a name for the template that you are uploading.
• Template File: Click Browse, and then select the template file you created.
9 Click Upload. An information message box appears and informs you that the
template file has been uploaded successfully.
10 Click OK. The template file you uploaded now appears in the list of templates.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
307
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 146. The Upload a Template File form
Working with Remote Users
Remote users are users who bring and connect their own devices (for example,
smart phones, laptops, tablets, etc.) to the network. They are also known as Bring
Your Own Device (BYOD) users. Using a process called “onboarding,” you can make
enable these remote users to connect their devices to network.
How Onboarding Works
The following describes how the onboarding process works
1 The user equipment (UE) associates with the onboarding WLAN and
authenticates itself with an external authentication server (for example, Active
Directory).
2 The AP that provides the onboarding WLAN sends a JavaScript Object Notation
(JSON) request to the identity management (IDM) module on the controller. This
JSON request contains the UE’s user name, group name, MAC address, and
WLAN.
3 The IDM module retrieves the role that has been mapped to the UE’s group
name, gets role mapping, and checks the device limit.
4 The IDM module triggers the Zero-IT service on the AP to generate the Zero-IT
binary file.
5 The AP prompts the user of the UE to download and install the Zero-IT binary file.
6 After the user installs the Zero-IT binary file on the UE, the UE disassociates from
the onboarding WLAN, and then associates with the standard WLAN that has
been set up for remote users.
At this point, the onboarding process is complete and the UE is now able to access
the wireless network.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
308
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 147. Overview of the onboarding process
Before You Begin
Before you begin creating the onboarding and standard WLANs for remote users,
make sure that:
• The authentication server that you will use to authenticate remote users exists
on the network. You only need one authentication server and you will use the
same authentication server for both the onboarding and standard WLANs.
• You have added the authentication server to the controller. If you have not yet
added the authentication server to the controller, see Creating an AAA Server.
• The remote users have existing accounts on the authentication server.
• You have created a guest access service to use for the onboarding WLAN. If you
have not yet created a guest access service for the onboarding WLAN, see
Creating a Guest Access Service.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
309
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Step 1: Create the Onboarding Guest WLAN for Remote
Users
Follow these steps to create an onboarding guest WLAN.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create the
onboarding guest WLAN.
3 On the sidebar, click WLAN. The WLAN Configuration page appears.
4 In the WLAN Configuration section, click Create New. The form for creating a
new WLAN service appears.
5 In the General Options section, configure the following options.
• Name/SSID: Type a short name (two to 32 alphanumeric characters) for this
WLAN.
• Description: Type a brief description of the qualifications/purpose for this
WLAN (for example, Onboarding WLAN).
6 In Authentication Type under WLAN Usage, click Guest Access + Zero-IT
Onboarding.
7 In Zero-IT Onboarding, select the Enable Zero-IT device registration from this
guest portal check box.
8 In Onboarding Authentication Server, select the authentication server that you
previously added to the controller.
9 In Guest Access, select the guest access service that you created earlier for this
onboarding WLAN.
10 Configure the other settings in the form as needed.
11 Click OK at the bottom of the form.
You have completed creating the onboarding WLAN.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
310
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Figure 148. Settings that you need to configure to create the onboarding guest WLAN
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
311
Working with Local, Guest, and Remote Users
Working with Local, Guest, and Remote Users
Step 2: Create a Standard WLAN with Zero-IT Activation
Enabled
Follow these steps to create the standard WLAN with which user devices will
associate after they pass authentication and install the Zero-IT binary file.
1 Click Configuration > AP Zones.
2 On the AP Zone List page, click the AP zone for which you want to create the
standard WLAN.
3 On the sidebar, click WLAN. The WLAN Configuration page appears.
4 In the WLAN Configuration section, click Create New. The form for creating a
new WLAN service appears.
5 In the General Options section, configure the following options.
• Name/SSID: Type a short name (two to 32 alphanumeric characters) for this
WLAN.
• Description: Type a brief description of the qualifications/purpose for this
WLAN (for example, Onboarding WLAN).
6 In Authentication Method, click 802.1x EAP.
7 In Authentication Service, select the authentication server that you added earlier
to authenticate remote users.
NOTE: This authentication server must be the same server that you selected when
you created the onboarding WLAN.
8 In Authentication Type under WLAN Usage, click Standard usage (For most
regular wireless networks).
9 In Zero-IT Activation under Options, select the Enable Zero-IT Activation check
box. With this option selected, the remote user will be prompted by the AP to
install the Zero-IT binary file, which will automatically configure the device’s
wireless settings and allow it to connect to the wireless network.
10 Click OK at the bottom of the form.
You have completed creating the standard WLAN for remote users.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
312
Working with Local, Guest, and Remote Users
Working with User Roles
Working with User Roles
Use user roles to limit user access to certain WLANs, to allow them to log on with
non-standard client devices, or to grant permission to generate guest passes.
Creating a User Role
Follow these steps to create a user role.
1 Go to Identity > Roles.
2 Click Create New. The Create User Role form appears.
3 Configure the options in the Create User Role form.
• Name: Type a name for this user role.
• Description: Type a description for this user role.
• Default Group Attribute Value: (Fill in this field only if you are creating a user
role based on group attributes extracted from an Active Directory or LDAP
server.) Enter the User Group name here. Active Directory/LDAP users with
the same group attributes are automatically mapped to this user role.
• WLANS: Specify whether this role will have access to all WLAN or to specific
WLANs only.
-
Allow Zero IT Access to All WLANs: Click this to allow this user role
access to all WLANs.
-
Allow Zero IT Access to Selected WLANs Only. Click to allow this user
role access to specific WLANs only. You must select the WLAN to which
this user role will have access.
• Max Devices Allowed: Set the number of users that can share this role.
-
Limited to [ ]: If you want a limited number of users to share this role
pass, click this option, and then type the number in the box.
-
Unlimited: If you want an unlimited number of users to share this role,
click this option.
4 Click OK.
You have completed creating a user role.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
313
Working with Local, Guest, and Remote Users
Managing Subscription Packages
Figure 149. Creating a user role
Managing Subscription Packages
A subscription package defines the characteristics of a subscription that has been
created for a registered user (see Working with Local Users). These characteristics
include the expiration date of the subscription.
NOTE: If the user is connected at the time when his or her subscription expires, the
user will get disconnected from the AP and any attempts to reauthenticate will fail.
This section covers:
• Viewing a List of Subscription Packages
• Creating a Subscription Package
• Editing a Subscription Package
• Deleting a Subscription Package
Viewing a List of Subscription Packages
Follow these steps to view a list of existing packages.
Go to Identity > Subscription Packages. The Subscription Packages page displays
a table of existing packages along with their basic details, including:
• Name: The name of the package.
• Description: A brief description of the package.
• Expiration Time: The time unit used in conjunction with Expiration Value to define
when the package will expire.
• Expiration Value: The value used in conjunction with Expiration Time to define
when the package will expire.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
314
Working with Local, Guest, and Remote Users
Managing Subscription Packages
• Actions: A list of actions that you can perform. In this release, the only action
available is Delete Packages (see Deleting a Subscription Package).
Figure 150. Viewing existing subscription packages
Creating a Subscription Package
Follow these steps to create a package.
1 Go to Identity > Subscription Packages. The Subscription Packages page
appears.
2 Click Create New.
3 In Package Name, type a name for the subscription package that you are
creating.
4 In Description, type a description for the package. This is an optional field.
5 In Expiration Time, set the time unit to use for the package expiration. Options
available include:
• Hour
• Day
• Week
• Month
• Year
• Never
6 In Expiration Value, set the actual value to use in combination with the Expiration
Time. For example, if you selected Day in Expiration Time and you typed 7 in
Expiration Value, the package will expire 7 days after it is assigned to a user.
7 Click Save.
The page refreshes, and the package that you created appears in the view list.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
315
Working with Local, Guest, and Remote Users
Managing Subscription Packages
Figure 151. Creating a subscription package
Editing a Subscription Package
You can change or update the package settings anytime. Follow these steps to edit
an existing package.
1 Go to Identity > Subscription Packages. The Subscription Packages page
appears.
2 Locate the package that you want to edit.
3 Under the Name column, click the name of the package that you want to edit.
The entire row becomes editable.
4 Edit the profile by changing any of the following options:
• Name
• Description
• Expiration Interval
• Expiration Value
5 Click Save.
You have completed editing a package.
Figure 152. Editing a subscription package
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
316
Working with Local, Guest, and Remote Users
Managing Subscription Packages
Deleting a Subscription Package
Follow these steps to delete a subscription package.
1 Go to Identity > Subscription Packages. The Subscription Packages page
appears.
2 Locate the package that you want to delete.
3 Under the Actions column, click the
icon that is in the same row as the
package name. The following confirmation message appears:
Are you sure you want to delete the selected row?
4 Click Yes. The page refreshes, and the package that you deleted disappears
from the table.
You have completed deleting a package.
Figure 153. Deleting a subscription package
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
317
Performing Administrative Tasks
14
In this chapter:
• Backing Up and Restoring Clusters
• Backing Up and Restoring the Controller’s Network Configuration from an FTP
Server
• Backing Up and Restoring System Configuration
• Resetting a Node to Factory Settings
• Upgrading the Controller
• Working with Logs
• Managing Licenses
Backing Up and Restoring Clusters
Back up the controller cluster periodically to ensure that you can restore the control
plane, data plane, and AP firmware versions as well as the system configuration in
the cluster if is a system failure occurs.
This section covers the following topics:
• Creating a Cluster Backup
• Restoring a Cluster Backup
• Deleting a Cluster Backup
NOTE: You can also perform these procedures from the command line interface.
Note, however, that you will need to execute the commands on each node. For
more information, see the Virtualized SmartCell Gateway Command Line Interface
Reference Guide.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
318
Performing Administrative Tasks
Backing Up and Restoring Clusters
Creating a Cluster Backup
Follow these steps to back up an entire controller cluster.
1 Take note of the current system time. You can view the General System Settings
page under Configuration > vSCG Carrier System > System Time. For more
information, see Setting the System Time.
2 Go to Administration > Cluster Backup and Restore.
3 Click Back Up Entire Cluster. The following confirmation message appears:
Are you sure you want to back up the vSCG cluster?
4 Click Yes. The following message appears:
The cluster is in maintenance mode. Please wait a few
minutes.
When the cluster backup process is complete, a new entry appears in the Cluster
Backups section with a Created On value that is approximate to the time when
you started the cluster backup process.
CAUTION! If you have an FTP server, back up the entire cluster and upload the
backup files from all the nodes in a cluster to a remote FTP server.
You have completed backing up the controller cluster.
Figure 154. A new entry appears in the Cluster Backups section
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
319
Performing Administrative Tasks
Backing Up and Restoring Clusters
Restoring a Cluster Backup
Follow these steps to restore a cluster backup.
CAUTION! You must perform the restore procedure on the exact same node where
you generated the cluster backup.
1 Go to Administration > Cluster Backup and Restore.
2 In the Cluster Backups section, locate the cluster backup that you want to
restore.
3 Click the
icon that is in the same row as the cluster backup. The following
confirmation message appears:
Are you sure you want to restore the vSCG cluster?
4 Click Yes. The page refreshes, and then the following message appears:
System is restoring! Please wait...
NOTE: The cluster restore process may take several minutes to complete.
When the restore process is complete, the controller logs you off the web
interface automatically.
CAUTION! Do not refresh the controller web interface while the restore process is
in progress. Wait for the restore process to complete successfully.
5 Log back on to the controller web interface.
NOTE: If the web interface displays the message “Cluster is out of
service. Please try again in a few minutes.” appears after you log
on to the controller web interface, wait for about three minutes. The dashboard will
appear shortly. The message appears because the controller is still initializing its
processes.
6 Go to Administration > Upgrade, and then check the Current System
Information section and verify that all nodes in the cluster have been restored to
the previous version and are all in service.
7 Go to Administration > Diagnostics, and then click Application Logs & Status
on the sidebar. Check the Health Status column and verify that all of the controller
processes are online (see Figure 156).
You have completed restoring the cluster backup.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
320
Performing Administrative Tasks
Backing Up and Restoring Clusters
Figure 155. Under Actions, click the calendar icon to start the cluster restore process
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
321
Performing Administrative Tasks
Backing Up and Restoring Clusters
Figure 156. After the upgrade is complete, go to the Application Logs & Status page and verify
that all of the controller processes are online
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
322
Performing Administrative Tasks
Backing Up and Restoring Clusters
Deleting a Cluster Backup
Follow these steps to delete a cluster backup.
1 Go to Administration > Cluster Backup and Restore.
2 In the Cluster Backups section, locate the cluster backup that you want to delete.
3 Click the
icon that is in the same row as the cluster backup. The following
confirmation message appears:
Are you sure you want to delete the selected resource?
4 Click Yes. The page refreshes and the row is deleted from the Cluster Backups
list.
Figure 157. A confirmation message appears after you click the trash bin icon
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
323
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
Backing Up and Restoring the Controller’s
Network Configuration from an FTP Server
In addition to backing up and restoring the controller’s network configuration from
its own database, the controller supports backup and restore of its network
configuration from an FTP server using the CLI. This section describes the requirements for backing up and restoring the controller’s network configuration from an
FTP server, the information that is included in the backup file, and how to perform
the backup and restore process.
Requirements
To back up and restore the controller’s network configuration from an FTP server,
the controller must have already been set up and in service. In case of a multi-node
cluster, all the nodes in the cluster must be in service.
What Information Is Backed Up
Table 13 lists the network configuration that is backed up from the control and data
planes when you perform a backup procedure to an FTP server.
Table 13. Information that is backed up to the FTP server
Control Plane
Data Plane
• Control interface
• Primary interface
• Cluster interface
• Static routes
• Management interface
• Internal subnet prefix
• Static routes
• User-defined interfaces
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
324
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
Backing Up to an FTP Server
Follow these steps to back up the controller network configuration to an FTP server.
1 Log on to the controller from the CLI. See Accessing the Command Line Interface
for more information.
2 At the prompt, enter en to enable privileged mode.
Figure 158. Enable privileged mode
3 Enter show cluster-state to display the statuses of the node and the
cluster. Before continuing to the next step, verify that both the node and the
cluster are in service.
Figure 159. Verify that both the node and the cluster are in service
4 Enter backup network to back up the controller network configuration,
including the control plane and data plane information. The controller creates a
backup of its network configuration on its database.
Figure 160. Run “backup network”
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
325
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
5 Enter show backup-network to view a list of backup files that have been
created. Verify that the Created On column displays an entry that has a time
stamp that is approximate to the time you started the backup.
Figure 161. Enter the “show backup-network” command
6 Enter copy backup-network {ftp-url}, where {ftp-url} (remove the
braces) is the URL or IP address of the FTP server to which you want to back
up the cluster configuration.
The CLI prompts you to choose the number that corresponds to the backup file
that you want to export to the FTP server.
7 Enter the number of the backup file that you want to export to the FTP server.
The controller encrypts the backup file, and then exports it to the FTP server.
When the export process is complete, the following message appears on the
CLI:
Succeed to copy to remote FTP server
Successful operation
Figure 162. “Succeed to copy to remote FTP server” indicates that you have exported the
backup file to the FTP server successfully
8 Using an FTP client, log on to the FTP server, and then verify that the backup file
exists. The file format of the backup file is
network_<YYYYMMDDHHmmss>_<vSCG-version>.bak.
For example, if you created the backup file on October 24th 2013 at 02:40:22
and the controller version is 2.5.0.0.402, you should see a file named
network_20131024024022_2.5.0.0.402.bak
on the FTP server.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
326
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
You have completed backing up the controller to an FTP server.
Restoring from an FTP Server
Before you continue, take note of the following limitations with restoring a backup
file of the controller network configuration from an FTP server:
• Only release 2.1 and later support restoring from an FTP server.
• In this current release, restoring the entire cluster from an FTP server is unsupported. The restore process must be performed on one node at a time.
• Restoring from an FTP server can only be performed using the CLI.
CAUTION! Restoring a backup file to the controller requires restarting all of the
controller services.
Follow these steps to restore a backup file of the controller’s network configuration
that you previously uploaded to an FTP back to the controller.
1 Log on to the controller from the CLI. See Accessing the Command Line Interface
for more information.
2 At the prompt, enter en to enable privileged mode.
Figure 163. Enable privileged mode
3 Enter show cluster-state to display the statuses of the node and the
cluster. Before continuing to the next step, verify that both the node and the
cluster are in service.
Figure 164. Verify that both the node and the cluster are in service
4 Enter the following command to log on to the FTP server and check for available
backup files that can be copied to the controller:
copy <ftp-url> backup-network
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
327
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
5 If multiple backup files exist on the FTP server, the CLI prompts you to select the
number that corresponds to the file that you want to copy back to the controller.
If a single backup file exists, the CLI prompts you to confirm that you want to
copy the existing backup file to the controller.
When the controller finishes copying the selected backup file from the FTP server
back to the controller, the following message appears:
Succeed to copy the chosen file from the remote FTP server
6 Enter show backup-network to verify that the backup file was copied back
to the controller successfully.
Figure 165. Verify that the backup file was copied to the controller successfully
7 Run restore network to start restoring the contents of the backup file to
the current controller. The CLI displays a list of backup files, and then prompts
you to select the backup file that you want to restore to the controller.
8 Enter the number that corresponds to the backup file that you want to restore.
The CLI displays the network configuration that the selected backup file contains.
If the serial number of the current controller matches the serial number contained
in one of the backup files, the CLI automatically selects the backup file to restore
and displays the network configuration that it contains.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
328
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
Figure 166. Enter the number that corresponds to the backup file that you want to restore
9 Type yes to confirm that you want to restore the selected backup file. The
controller starts the restore process and performs the following steps:
a Stop all services.
b Back up the current network configuration. This will enable the controller to
roll back to the current configuration, in case there is an issue with the restore
process.
c Clean up the current network configuration. The controller deletes its previous
network configuration, including static routes, name server, etc.
d Restore the network configuration contained in the selected backup file.
e Restart all services.
When the restore process is complete, the following message appears on the
CLI:
All services are up!
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
329
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
Figure 167. The controller performs several steps to restore the backup file
10 Do the following to verify that the restore process was completed successfully:
• Run show cluster-state to verify that the node and the cluster are back
in service.
• Run show interface to verify that all of the network configuration settings
have been restored.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
330
Performing Administrative Tasks
Backing Up and Restoring the Controller’s Network Configuration from an FTP Server
Figure 168. Verify that the node and cluster are back in service and that the network
configuration has been restored successfully
You have completed importing and applying the network configuration backup from
the FTP server to the controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
331
Performing Administrative Tasks
Backing Up and Restoring System Configuration
Backing Up and Restoring System
Configuration
Ruckus Wireless strongly recommends that you back up the controller database
periodically. This will help ensure that you can restore the system configuration
settings easily if the database becomes corrupted for any reason.
Table 14 lists the information that is included in the system configuration backup file.
Table 14. What’s backed up in the system configuration backup file
Configuration Data Administration Data Report Data
Identity Data
• AP zones
• Cluster backups
• Saved reports
• Created profiles
• Services and
profiles
• System
configuration
backups
• Historical client
statistics
• Generated guest
passes
• Packages
• System settings
• Management
domains
• Administrator
accounts
• Upgrade settings
and history
• Network tunnel
statistics
• Uploaded system
diagnostic scripts
• Installed licenses
• Mobile virtual
network operator
accounts
CAUTION! A system configuration backup does not include control plane settings,
data plane settings, and user-defined interface settings.
NOTE: In addition to the web interface, you can also perform system configuration
backup and restore from the controller command line interface. For more
information, see the Virtualized SmartCell Gateway Command Line Interface
Reference Guide.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
332
Performing Administrative Tasks
Backing Up and Restoring System Configuration
Creating a System Configuration Backup
Follow these steps to create a backup of the controller database.
1 Go to Administration > System Configuration Backup and Restore.
2 Click Back Up Configuration. The following confirmation message appears:
Are you sure you want to backup the vSCG configuration?
3 Click OK. A progress bar appears as the controller creates a backup of the its
database.
Figure 169. A progress bar appears as the controller backs up its database
When the backup process is complete, the progress bar disappears, and the
Configuration Backup Status section appears and shows the following information:
• Latest backup started: Date and time when configuration backup was initiated
• Finished at: Date and time when configuration backup was completed
• Status: Shows either Successful or Failed
• Progress Status: Shows the current status of the backup process
The backup file appears under the Configuration Backups section.
Figure 170. The backup file appears in the System Configuration Backups section
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
333
Performing Administrative Tasks
Backing Up and Restoring System Configuration
Exporting the Configuration Backup to an FTP Server
Automatically
In addition to backing up the configuration file manually, you can configure the
controller to export the configuration file to an FTP server automatically whenever
you click Back Up Configuration.
Follow these steps to back up the configuration file to an FTP server automatically.
1 Go to Administration > System Configuration Backup and Restore.
2 Go to the Auto Export Backup section.
3 In Auto Export Backup, click Enable.
4 In FTP Server, select the FTP server to which you want to export the backup file.
The FTP server options that appear here are those that you created in Configuring
FTP Services.
5 Click Test. The controller attempts to establish connection to the FTP server
using the user name and password that you supplied. If the connection attempt
is successful, the following message appears:
FTP server connection established successfully.
If the connection attempt is unsuccessful, verify that the FTP server details
(including the user name and password) are correct, and then click Test again.
6 After you verify the controller is able to connect to the FTP server successfully,
click Apply to save the FTP server settings.
You have completed configuring the controller to export the configuration backup
file to an FTP server. When you click the Back Up Configuration button (see
Creating a System Configuration Backup), a copy of the configuration backup will
be uploaded to the FTP server automatically.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
334
Performing Administrative Tasks
Backing Up and Restoring System Configuration
Figure 171. Configure the FTP server settings in the Auto Export Backup section
Downloading a Copy of the Configuration Backup
After you create a configuration backup, you have the option to download the
backup file from the System Configuration Backups section. Follow these steps to
download the backup file to the computer that you are using to access the controller
web interface.
1 Go to Administration > System Configuration Backup and Restore.
2 Scroll down to the System Configuration Backups section.
3 Locate the entry for the backup file that you want to download. If multiple backup
files appear in the list, use the date when you created the backup to find the
backup entry that you want.
4 Click the
download.
icon that is in the same row as the backup file that you want to
Your web browser downloads the backup file to its default download folder.
NOTE: When your web browser completes downloading the backup file, you may
see a notification at the bottom of the page, similar to what is shown in Table 172.
5 Check the default download folder for your web browser and look for a file that
resembles the following naming convention:
{Cluster Name}_BackupConf_{MMdd}_db_{MM}_{dd}_{HH}_{mm}.bak
For example, if the controller cluster is named ClusterA and you created the
configuration backup on September 7 at 11:08 AM, the backup file name will be:
ClusterA_BackupConf_0907_db_09_07_11_08.bak
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
335
Performing Administrative Tasks
Backing Up and Restoring System Configuration
You have completed downloading a copy of the configuration backup.
Figure 172. When your browser completes downloading the backup file, you may see a
notification at the bottom of the web page
Restoring a System Configuration Backup
Follow these steps to restore a backup controller database.
1 Go to Administration > System Configuration Backup and Restore.
2 In the System Configuration Backups section, locate the backup file that you
want to restore.
3 Once you locate the backup file, click the
icon that is in the same row as the
backup file. A confirmation message appears.
NOTE: Take note of the backup version that you are using. At the end of this
procedure, you will use the backup version to verify that the restore process was
completed successfully.
4 Click Yes. The following message appears:
System is restoring. Please wait...
When the restore process is complete, the controller logs you off the web
interface automatically.
5 Log on to the controller web interface.
6 Check the web interface pages (for example, Configuration, Report, and Identity)
and verify that the setting and data contained in the backup file have been
restored successfully to the controller.
You have completed restoring a system configuration backup file.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
336
Performing Administrative Tasks
Backing Up and Restoring System Configuration
Figure 173. Under the Actions column, click the configuration restore icon
Deleting a Configuration Backup
Follow these steps to delete a backup of the controller database
1 Go to Administration > System Configuration Backup and Restore.
2 In the System Configuration Backups section, locate the backup version that
you want to delete.
3 Once you locate the backup file, click the
confirmation message appears.
icon under the Actions column. A
4 Click Yes. The page refreshes, and the backup file that you deleted disappears
from the System Configuration Backups section.
You have completed deleting a backup file.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
337
Performing Administrative Tasks
Resetting a Node to Factory Settings
Figure 174. Under the Actions column, click the trash bin icon
Resetting a Node to Factory Settings
You can reset a node in a cluster to factory settings by removing it from the cluster.
When you reset a node to factory settings, all of its system configuration settings
are completely erased and its IP address reverts to 192.168.2.2.
There are two methods to reset a node to factory settings:
• Using the Web Interface
• Using the CLI
CAUTION! Resetting a node to factory settings will erase all of its system
configuration settings, backup files, and cluster settings. Before resetting a node to
factory settings, Ruckus Wireless strongly recommends that you export all of the
backup files on the controller to an FTP server using either the web interface or CLI.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
338
Performing Administrative Tasks
Resetting a Node to Factory Settings
What Happens After Reset to Factory Settings
Before resetting a node to factory settings, consider the following notes:
• All of the system configuration settings of the node will be erased. This includes
all of the domain, AP zone, user, and system settings, as well as all of the
controller backups.
• The node will obtain an IP address from a DHCP server on the network
automatically.
• The controller software version will not be reset to its original software version
when you first set it up. It will keep the existing software version at the time you
reset it to factory settings.
Using the Web Interface
To remove a node from a cluster, it must be a follower node. If the node that you
want to remove from the cluster is the leader node, make sure you demote it to a
follower node first before continuing with this procedure.
Follow these steps to remove a node from the cluster and reset it to factory settings.
1 Log on to the controller web interface of the leader node.
2 Go to Configuration > vSCG Carrier System > Cluster & Planes > Cluster Planes.
The Cluster Planes page appears.
3 In the Control Planes table, locate the node that you want to reset to factory
settings.
4 Click the
icon that is in the same row as the node that you want to reset to
factory settings. A confirmation message appears.
5 Click Yes. The page refreshes, and then the node that you deleted disappears
from the Control Plane table.
You have completed removing a node from the cluster and resetting it to factory
settings.
NOTE: To set up this controller again, access the controller setup wizard
http://192.168.2.2:8080. See the Virtualized SmartCell Gateway Getting
Started Guide for more information.
NOTE: After the controller is reset to factory settings, the controller allows the data
blade interface IP address and gateway address to be on different subnets.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
339
Performing Administrative Tasks
Resetting a Node to Factory Settings
Figure 175. Click the delete icon
Using the CLI
You can also use the command line interface to remove a node from a cluster and
reset it to factory settings. See Accessing the Command Line Interface for information on how to gain access to the CLI.
After you log on to the CLI of the node, follow these steps to reset a node to factory
settings.
1 At the prompt, enter set-factory. A confirmation message appears.
Figure 176. Enter set-factory to reset the node to factory settings
2 Enter yes to confirm.
3 Enter reload. This command is required to trigger the factory reset process. A
confirmation message appears.
4 Enter yes to confirm. The controller reboots, and then triggers the factory reset
process.
Figure 177. Enter reload to trigger the factory reset process
The controller reboots. You have completed resetting the node to factory default
settings.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
340
Performing Administrative Tasks
Upgrading the Controller
Upgrading the Controller
NOTE: For a best practice example of upgrading the vSCG from release 2.5.x to
3.0.x, visit https://support.ruckuswireless.com/answers/000004154. Note that the
upgrade procedures that you need to perform depend upon your environment and
your vSCG configuration and may not be exactly the same as in the example.
Ruckus Wireless may periodically release controller software updates that contain
new features, enhancements, and fixes for known issues. These software updates
may be made available on the Ruckus Wireless support website or released through
authorized channels.
This section covers the following topics:
• Performing the Upgrade
• Verifying the Upgrade
• Rolling Back to a Previous Software Version
CAUTION! Although the software upgrade process has been designed to preserve
all controller settings, Ruckus Wireless strongly recommends that you back up the
controller cluster before performing an upgrade. Having a cluster backup will ensure
that you can easily restore the controller system if the upgrade process fails for any
reason. For information on how to back up the controller cluster, refer to Creating a
Cluster Backup.
CAUTION! Ruckus Wireless strongly recommends that you ensure that all interface
cables are intact during the upgrade procedure.
CAUTION! Ruckus Wireless strongly recommends that you ensure that the power
supply is not disrupted during the upgrade procedure.
NOTE: In addition to the web interface, you can also perform system configuration
backup, restore, and upgrade from the controller command line interface. For more
information, see the Virtualized SmartCell Gateway Command Line Interface
Reference Guide.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
341
Performing Administrative Tasks
Upgrading the Controller
Performing the Upgrade
Follow these steps to upgrade the controller software.
CAUTION! Ruckus Wireless strongly recommends backing up the controller cluster
before performing the upgrade. If the upgrade process fails for any reason, you can
use the latest backup file to restore the controller cluster. See Backing Up and
Restoring Clusters.
NOTE: Before starting this procedure, you should have already obtained a valid
controller software upgrade file from Ruckus Wireless Support or an authorized
reseller.
1 Copy the software upgrade file that you received from Ruckus Wireless to the
computer where you are accessing the controller web interface or to any location
on the network that is accessible from the web interface.
2 Go to Administration > Upgrade.
3 In the Patch File Upload section, click the Browse button, and then browse to
the location of the software upgrade file. Typically, the file name of the software
upgrade file is
vSCG-installer_{version}.ximg.
4 Select the software upgrade file, and then click Open.
5 Click Upload to upload the software upgrade file. The controller uploads the file
to its database, and then performs file verification.
After the file is verified, the Upgrade Pending Patch Information section is
populated with information about the upgrade file. The Upgrade and Backup
& Upgrade buttons also appear in this section.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
342
Performing Administrative Tasks
Upgrading the Controller
Figure 178. The “Upgrade” and “Backup & Upgrade” button appear on the right side
6 Start the upgrade process by clicking one of the following buttons:
• Upgrade: Click this button to start the upgrade process without backing up
the current controller cluster or its system configuration.
• Backup & Upgrade: Click this button to back up the controller cluster and
system configuration before performing the upgrade.
CAUTION! Ruckus Wireless strongly recommends usage of backup and upgrade
icon while performing the upgrade. If the upgrade process fails for any reason, you
can use the latest backup file to restore the controller cluster. See Backing Up and
Restoring Clusters.
A confirmation message appears.
7 Click Yes. The controller starts the process that you selected. The screens that
appear next will depend on the process that you selected to upgrade
immediately or to back up and then upgrade the controller.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
343
Performing Administrative Tasks
Upgrading the Controller
Figure 179. “Backup completed” status if you selected Backup & Upgrade
Figure 180. The System Upgrade page displays the status of the upgrade process
When the upgrade (or backup-and-upgrade) process is complete, the controller
logs you off the web interface automatically. The controller web interface may display
the message shown in Figure 181 as it completes the upgrade process. Wait for a
few minutes until the web interface log on page appears.
Figure 181. The controller web interface may display the following message as it completes
the upgrade process
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
344
Performing Administrative Tasks
Upgrading the Controller
When the controller log on page appears again, you have completed upgrading the
controller. Continue to Verifying the Upgrade to check if the upgrade was completed
successfully.
Verifying the Upgrade
Follow these steps to verify that the controller upgrade was completed successfully.
1 Log on to the controller web interface.
2 Go to Administration > Upgrade.
3 In the Current System Information section, check the value for vSCG Version. If
the firmware version is newer than the firmware version that controller was using
before you started the upgrade process, then the upgrade process was
completed successfully.
Figure 182. Check the value for controller Version
Rolling Back to a Previous Software Version
There are two scenarios in which you may want to roll back the controller software
to a previous version:
1 You encounter issues during the software upgrade process and the controller
cannot be upgraded successfully. In this scenario, you can only perform the
software rollback from the CLI using the restore local command. If you
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
345
Performing Administrative Tasks
Upgrading the Controller
have a two-node controller cluster, run the restore local command on each
of the nodes to restore them to the previous software before attempting to
upgrade them again.
2 You prefer a previous software version to the newer version to which you have
upgraded successfully. For example, you feel that the controller does not operate
normally after you upgraded to the newer version and you want to restore the
previous software version, which was more stable. In this scenario, you can
perform the software rollback either from the web interface or the CLI. If you have
a two-node controller cluster, you must have cluster backup on both of the
nodes.
To ensure that you will be able to roll back to a previous version, Ruckus Wireless
strongly recommends the following before attempting to upgrade the controller
software:
• Always back up the controller before attempting a software upgrade. If you are
managing a multi-node cluster, back up the entire cluster, and then verify that
the backup process completes successfully. See Creating a Cluster Backup for
the local backup instructions. If you have a local backup and you want to roll
back the controller to a previous software version, follow the same procedure
described in Restoring a Cluster Backup.
• If you have an FTP server, back up the entire cluster and upload the backup files
from all the nodes in a cluster to a remote FTP server. See Backing Up to an FTP
Server for remote backup instructions and Restoring from an FTP Server for
remote restore instructions.
Recovering a Cluster from an Unsuccessful Upgrade
If an issue occurs during the upgrade process (for example, a power outage occurs
or one of the interfaces goes down), you can recover the cluster if the controller has
either a local configuration backup or a remote (FTP) configuration backup.
If the Controller Has Local Configuration Backup
Follow these steps to recover a cluster when the controller has a configuration
backup stored locally.
1 Unplug the cluster interface cables of each node in the cluster to isolate each
individual node.
2 On each of the nodes in the cluster, perform the following:
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
346
Performing Administrative Tasks
Upgrading the Controller
a Log on to the CLI, and then execute restore local. This command will
restore the system configuration of the node from a local backup.
b When the CLI indicates that the restore local command has been
completed successfully, plug in the cluster interface cable.
You have completed recovering the controller cluster using a local configuration
backup.
If the Controller Has an FTP Backup
Follow these steps to recover a cluster when the controller has a configuration
backup on a remote FTP server. See Backing Up to an FTP Server for more
information.
You must perform steps on each of the nodes in the cluster.
1 Log on to the CLI of each of the nodes.
2 Execute the set-factory command to reset the node to factory settings.
NOTE: See Resetting a Node to Factory Settings for more information.
3 Using the CLI, set up the controller as a standalone unit.
4 Copy the cluster configuration backup from the FTP server to the controller.
5 Execute the restore local command from the CLI.
6 When the CLI indicates that the restore local command has been
completed successfully, plug in the cluster interface cable.
Repeat the same procedure until you have restore the cluster configuration backup
from the FTP server to all of the nodes in the cluster.
You have completed recovering the controller cluster using an FTP backup.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
347
Performing Administrative Tasks
Working with Logs
Working with Logs
This section describes the logs that are available in the controller and how to
download them.
Available System Log Types
The controller generates logs for all the applications that are running on the server.
Table 15 lists the controller applications that are running.
Table 15. Controller applications and log types
Application
Description
AIP
Handles the accounting messages for TTG sessions
AUT
Manages the sessions the vSCG-C TTG module
CaptivePortal
Performs portal redirect for clients and manages the walled garden
and blacklist
Cassandra
The controller’s database server that stores most of the run-time
information and statistical data
Cassandra client
Used as the interface between processes of the TTG-modules and
Cassandra (Persistent Database)
CIP
The Charging Interface module, which handles the Ga interface
towards CGF server
CNR
Communicator
Communicates with access points and retrieves statuses,
statistics, and configuration updates
Configurer
Performs configuration synchronization and cluster operations (for
example, join, remove, upgrade, backup, and restore)
DHCPProxy
DHCPServer
The DHCP server in vSCG-C TTG module, receives DHCP
messages from DHCP relay in d-blade
EventReader
Receives event messages from access points and saves the
information into the database
FreeRadius
Relays the access points’ RADIUS authentication and accounting
requests to the external server
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
348
Performing Administrative Tasks
Working with Logs
Table 15. Controller applications and log types (Continued)
Application
Description
Greyhound
The interface between the vSCG-C TTG module and the AP
interface, used to send and receive proprietary messages for AP
association and disassociation
GTP Stack SM
Module for managing the interfaces towards operator GGSNs and
PGWs
HIP
Module with SIGTRAN stack and interface to operator HLR(s)
Kennel
Diagnostic script service that runs the diagnostic scripts on the
controller
Memcached
The controller’s memory cache that stores client authentication
information for fast authentication or roaming
Memcached client Used as the interface between processes of TTG-modules and
Memcached (Shared memory)
Memproxy
Replicates MemCached entries to other cluster nodes
Monitor
Monitors the health of cluster processes and communicates cluster
state changes to the cluster node
NC
The Node Controller, which monitors all vSCG-C TTG processes
Net-SNMP
SNMP service
Northbound API
Performs UE authentication and handles approval or denial of UEs
to AP
Ntpd
Enables APs to synchronize their time with the parent controller
and synchronizes time with an external NTP server and internal
controller nodes in the same cluster.
RAC
The RADIUS Authentication module, used for processing RADIUS
messages from the AP and the AAA server (CoA,DM)
RadiusProxy
Sets the RADIUS dispatch rules and synchronizes configuration to
each cluster node
RepCached
Replicates client authentication information to each MemCached
server in each cluster node
Resolver
Used by the GTP stack for DNS resolution, retrieves the IP
addresses of GGSN and PGW
Scheduler
Performs task scheduling and aggregates statistical data
SMF
Monitors the health of TTG processes
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
349
Performing Administrative Tasks
Working with Logs
Table 15. Controller applications and log types (Continued)
Application
Description
SNMPAgent
Configures SNMP settings and sends SNMP traps
SSHD
SSD server that establishes sshtunnel and controls port forwarding
with AP in the sshtunnel
SubscriberManage Maintains local user credentials for WISPr authentication.
ment
SubscriberPortal
Internal portal page for hotspot (WISPr)
Syslog-ng
Collects and sends log information from all processes
Web
Runs the controller’s management web server
Zapd
Performs SpeedFlex testing
Downloading All Logs
Follow these steps to download all available logs from the controller.
1 Go to Administration > Diagnostics.
2 On the sidebar, click Application Logs & Status.
3 In Select Control Plane, select the control plane from which you want to
download logs.
4 Click the Download All Logs button. Your web browser downloads the logs in
GZIP Compressed Tar Archive (with .TGZ extension) to its default download
location.
5 Go to your web browser’s default download location and verify that the TGZ file
was downloaded successfully.
6 Use your preferred compression/decompression program to extract the log files
from the TGZ file.
7 When the log files are extracted (for example, adminweb.log,
cassandra.log, communicator.log, etc.), use a text editor to open and
view the log contents.
You have completed downloading all the controller logs.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
350
Performing Administrative Tasks
Managing Licenses
Figure 183. Click the Download All Logs button
Managing Licenses
Depending on the number of Ruckus Wireless APs that you need to manage with
the controller, you may need to upgrade the controller license as your network
expands. The maximum number of access points that the controller can manage
is controlled by the license file that came with the controller. If the number of access
points on the network exceeds the limit in the license file, you will need to obtain an
additional license file and upload it to the controller.
NOTE: For information on obtaining additional license files, contact Ruckus
Wireless Support or an authorized Ruckus Wireless reseller.
The maximum number of access points that a license supports depends on its
stock-keeping unit (SKU).
This section covers the following topics:
• Default Licenses in the Virtualized SmartCell Gateway
• Supported License Types
• Viewing Installed Licenses
• Viewing the License Summary
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
351
Performing Administrative Tasks
Managing Licenses
• Configuring the License Server to Use
• Importing a License File
• Downloading a Copy of the Licenses
• Synchronizing the Controller with the License Server
Default Licenses in the Virtualized SmartCell Gateway
The Virtualized SmartCell Gateway comes embedded with default licenses to enable
you to manage a limited number of APs right out of the box without having to register
or purchase add-on licenses. Table 16 lists the default licenses in the controller.
Table 16. Default licenses
License Type
Number
Default AP Capacity License
1 AP
Default AP Tunneling Capacity License
1 AP tunnel
Default End User Support License
90 days
If the default licenses are insufficient for the number of APs that you are planning to
manage with the controller, contact Ruckus Wireless Support or an authorized
reseller (see Importing a License File for information on how to upload a license file).
All default licenses are activated as soon as you complete the controller setup. Once
the controller connects to the license server and successfully downloads add-on
license data (if any) from it, the behavior of each default license may change.
• AP Capacity License: Any add-on AP capacity licenses will accumulate on top
on the default license. For example, if you purchased 100 AP capacity licenses
and added them to the controller, the controller will show a total of 150 AP
capacity licenses -- this includes the 50 default licenses plus the 100 add-on
licenses.
• AP Tunneling and Support Licenses: Any add-on AP tunneling or support
licenses will replace the default license in controller. Unlike AP capacity licenses,
they will not accumulate on top of the default licenses.
• Time-restricted Default Licenses: Default licenses with time restriction (for
example, the default end user support license) will remain activated until they
expire. If a time-restricted add-on license is removed from the controller and a
default license of the same type exists on the controller and has not expired, this
default license will be reactivated and enabled.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
352
Performing Administrative Tasks
Managing Licenses
Supported License Types
The SZ100 supports the following types of licenses:
• AP Capacity License
• Default AP Capacity License
• AP Tunneling Capacity License
• Default AP Tunneling Capacity License
• Support License
• Default Support License
• Instance License
AP Capacity License
The AP capacity license (CAPACITY-AP) is an add-on license that enables the
management of Ruckus Wireless access points. This is a permanent license (that
is, no expiration date).
Default AP Capacity License
The default AP capacity license (CAPACITY-AP-DEFAULT) is same as the AP
capacity license. This license, however, is embedded into the controller and is nontransferable. The default AP capacity license allows you to manage one (1) AP using
the controller.
AP Tunneling Capacity License
The AP tunneling capacity license (CAPACITY-RXGW) is an add-on license that
enables the management of APs with SoftGRE capability. This is also known as
SoftGRE Capacity License or RXGW Capacity License. The AP tunneling capacity
license is a permanent license (that is, no expiration date).
Default AP Tunneling Capacity License
The default AP tunneling capacity license (CAPACITY-RXGW-DEFAULT) is the same
as the AP tunneling capacity license. This license, however, is embedded into the
controller and is non-transferable. The default AP tunneling capacity license allows
you to manage one (1) AP with SoftGRE capability.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
353
Performing Administrative Tasks
Managing Licenses
Support License
The Support License enables the controller to perform a system upgrade. There are
three types of support licenses:
• End User Support License
• Partner Support License
• Advanced Replacement Support License
Default Support License
The default support license (SUPPORT-EU-DEFAULT) is same as the end user
support license, but with a 90-day expiration time. This license is embedded into
the controller and is non-transferable. The controller comes with one default support
license.
Instance License
The instance license provides the entitlement to use the vSCG software.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
354
Performing Administrative Tasks
Managing Licenses
Viewing Installed Licenses
You can view the details of all the licenses that you have uploaded to the controller
in the Installed Licenses section. Table 17 lists the different columns that appear in
the Installed Licenses section.
Table 17. Information in the Installed License section
Column Name
Description
vSCG Node
The name of the node to which the license was uploaded
Feature
The stock-keeping unit (SKU) code of the license file
Capacity
The number of units or license seats that the license file
provides
Description
The type of license (see Supported License Types)
Start Date
The date when the license file was activated
Expiration Date
For time-bound licenses, this column shows the date when
the license file expires. For permanent licenses, this column
shows “Permanent.”
Figure 184. The Installed Licenses section
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
355
Performing Administrative Tasks
Managing Licenses
Viewing the License Summary
You can view details of total, consumed, and available licenses for the different
license types in the License Summary section. Table 18 lists the different columns
that appear in the Installed Licenses section.
Table 18. Information in the License Summary section
Column Name
Description
License Type
The type of license file
Total
The maximum number of access points that can be supported
by all the licenses that have been uploaded to the controller.
Consumed
The number of license seats that have been used. One access
point uses up one license seat. For example, if three access
points have registered with the controller, the Consumed field
will show 3.
Available
The number of license seats remaining. For example, if all your
licenses support up to 5000 access points, and the controller
has used up three licenses so far, the Available field will show
4997.
Figure 185. The License Summary section
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
356
Performing Administrative Tasks
Managing Licenses
Configuring the License Server to Use
Ruckus Wireless provides two options for managing the licenses that you have
purchased for the controller:
• Cloud License Server: Also known as the SmartLicense server, this a cloudbased server that stores all of the licenses and support entitlements that you
have purchased for the controller. For information on how to set up and activate
your SmartLicense account, see the SmartLicense User Guide.
• Local License Server (LLS): This is a license server that is installed onsite where
the controller is deployed. For information on how to obtain and set up the LLS
server, see the SmartCell Gateway Local Licensing Server User Guide.
Follow these steps to select a license server that the controller will use.
1 Go to Administration > License.
2 In License Server Configuration, select one of the following:
• Cloud License Server: Select this option to use the Ruckus Wireless SmartLicense server.
• Local License Server: Select this option to use an LLS that you have set up
on the network, and then configure the following:
-
Domain or IP: Type the FQDN or IP address of the LLS.
-
Port: Type the port number. Port range is from 0 to 65535 (default is 3333).
3 Click Apply. A confirmation message appears.
4 Click Yes. The controller saves the selected license server configuration, deletes
all of its saved license data, and then automatically synchronizing the license
information with the selected license server.
You have completed configuring the license server that the controller will use.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
357
Performing Administrative Tasks
Managing Licenses
Figure 186. The License Server Configuration section
Importing a License File
If the controller is disconnected from the Internet or is otherwise unable to communicate with the Ruckus Wireless SmartLicense system (due to firewall policies, etc.),
you can manually import a license entitlement file into the controller.
NOTE: The option to import a license file manually into the controller is only available
if the controller is using the cloud license server.
Follow these steps to import a license file into the controller.
1 Obtain the license file. You can do this by logging on to your Ruckus Wireless
Support account, going to the license management page, and then downloading
the license file (the license file is in .bin format).
2 Log on to the controller web interface, and then go to Administration > License.
3 In Select vSCG under Upload License, select the node for which you are
uploading the license file.
4 In Select License File, click Browse, locate the license file (.bin file) that you
downloaded from your Ruckus Wireless Support account, and then select it.
5 Click Upload. The page refreshes, and the information in the Installed Licenses
section changes to reflect the updated information imported from the
SmartLicense platform.
You have completed importing a license file manually.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
358
Performing Administrative Tasks
Managing Licenses
Figure 187. The Upload License section
Downloading a Copy of the Licenses
If you need to release licenses bound to an offline controller and allow those licenses
to be used elsewhere (on a different controller), you can download a copy of the
controller licenses.
NOTE: The option to download a copy of the controller licenses is only available if
the controller is using the Ruckus Wireless cloud license server
Follow these steps to download a binary copy of the license files.
1 Go to Administration > License.
2 In License Server Configuration, verify that Cloud License Server is selected.
3 Locate the Download License section.
4 In Select vSCG, select the controller node for which you want to download the
license files.
5 Click Download. Your web browser downloads the license files from the
controller.
6 When the download is complete, go to the default download folder that you have
configured for your web browser, and then verify that the binary copy of the
license files (with .bin extension) exists.
You have completed downloading copies of the controller licenses.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
359
Performing Administrative Tasks
Managing Licenses
Figure 188. The Download License section
Synchronizing the Controller with the License Server
By default, the controller automatically synchronizes its license data with the
selected license server every 24 hours. If you made changes to the controller
licenses (for example, you purchased additional licenses) and you want the controller
to download the updated license data immediately, you can trigger a manual
synchronization.
Follow these steps to trigger the controller to manually synchronize with the license
server.
1 Go to Administration > License.
2 Click Sync License with Server. The message “Start sync with license server...”
appears as the controller synchronizes its license data with the server.
When the sync process is complete, the message “Sync license with the license
server successful” appears. If the previously saved license data are different the
latest license data on the server, the information in the Installed Licenses section
refreshes to reflect the latest data.
You have completed manually synchronizing the controller with the license server.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
360
Performing Administrative Tasks
Managing Licenses
Figure 189. A message appears to indicate that the sync process was successful
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
361
Statistics Files the Controller
Exports to an FTP Server
A
This appendix describes the content of the statistics files that the controller exports
to an FTP server (if configured).
• AP Inventory
• Control Plane Statistics
• Mobility Zone Inventory
• Zone Statistics
• AP Statistics
• Zone Time Radio Statistics
• Zone Time WLAN Statistics
• AP Time Radio Statistics
• AP Time WLAN Statistics
• Control Plane Statistics
• Data Plane Statistics
• Data Plane Ethernet Port Statistics
• AP Soft GRE Tunnel Statistics
• Soft GRE Gateway Statistics
• Tenant Time Radio Statistics
• Tenant Time WLAN Statistics
• Tenant Zone Statistics
• Tenant Zone Radio Statistics
NOTE: The controller statistics files use Unix timestamps in milliseconds (for
example, “1.40729E+12” is Unix timestamp for “8/6/2014 2:30:00 AM”). You can
use an online timestamp conversion tool to convert Unix timestamps to humanreadable timestamps.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
362
Statistics Files the Controller Exports to an FTP Server
AP Inventory
AP Inventory
The AP inventory file contains detailed information about each AP that the controller
was managing at the time the file was uploaded to the FTP.
The default AP inventory file name format is:
ap_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 19. Attributes in the AP inventory file
Column Name
Description
key
MAC address of the AP
zoneUUID
ID of the zone to which the AP belongs
gpsSource
GPS coordinates (for example, 47.633625,-122.186446)
lastSeen
Unix timestamp of AP’s latest connection
fwVersion
Current AP firmware version
meshRole
Mesh role assigned to the AP. Possible values include:
• 0: Disabled
• 1: RAP
• 2: MAP
• 3: EMAP
• 4: Mesh is down
• 5: Mesh role is undefined
location
AP location info
rebootStartTime
Time when AP reboot was started
type
The type of JSON string
deviceName
Device name assigned to the AP
description
Description of the AP
extIp
External IP address assigned to the AP
registrationState
Registration state of the AP. Possible values include:
• 0: Pending
• 1: Approved
• 2: Rejected
gpsInfo
GPS coordinates of the AP’s location (if configured)
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
363
Statistics Files the Controller Exports to an FTP Server
AP Inventory
Table 19. Attributes in the AP inventory file
Column Name
Description
countryCode
Country code assigned to the AP
cableModemInfo
Cable modem info (if the AP has a cable modem
component)
enableWlanService24
Enable 2.4GHz radio
connectionStatus
Current connection status of the AP
heartbeatLost
Time AP heartbeat was lost (if any). If heartbeat has not
been lost, the value is “FALSE.”
meshSSID
Mesh SSID used by the AP to form the mesh
extPort
External port
apGroupUUID
Table key assigned to the AP group to which the AP
belongs
model
Model of the AP
timeStamp
Timestamp of the record (in Unix timestamp)
wsgWlanIDAndClientCount Client count of each WLAN
clientCount
Current client count on the AP
hops
Number of devices between this mesh AP and the root AP
bladeId
ID of the control blade
enableWlanService50
Enable 5GHz radio
approvedTime
Unix timestamp when the AP registration was approved
registrationTime
Unix timestamp when the AP registered with the controller
uptime
Number of minutes elapsed since AP was last rebooted
lastRegistrationInfo
AP registration info
ip
IP address assigned to the AP
dpMac
Data plane MAC address
ap
MAC address of the AP
provisionTag
Tag used to preprovision the AP to its current zone
tagged
Tagged AP is the AP with daily traffic exceed the
customized threshold value
channel
Radio channel that the AP is using
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
364
Statistics Files the Controller Exports to an FTP Server
AP Inventory
Table 19. Attributes in the AP inventory file
Column Name
Description
serial
Serial number of the AP
apMac
MAC address of the AP
provisionStage
Current provision status of the AP
provisionMethod
AP join method (Discovered/Preprovision/Swap)
registrationState
Registration state of the AP. Possible values include:
• 0: Pending
• 1: Approved
• 2: Rejected
adminstrativeState
AP WLAN state. Possible values include 0 (unlocked) and
1 (locked).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
365
Statistics Files the Controller Exports to an FTP Server
Control Plane Statistics
Control Plane Statistics
The control plane statistics file contains detailed general information about the
control plane. Its default file name format is:
controlBlade__YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 20. Attributes in the control plane statistics file
Column Name
Description
key
Control plane ID
hostName
Name of the control plane
model
Model of the control plane
serialNumber
Serial number of the control plane
mac
Serial number of the control plane
startTime
Timestamp when the control plane was set up
description
Description of the control plane
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
366
Statistics Files the Controller Exports to an FTP Server
Mobility Zone Inventory
Mobility Zone Inventory
The mobility zone inventory file contains detailed information about every zone that
existed on the controller at the time the file was uploaded to the FTP server.
The default zone inventory statistics file name format is:
mobilityZone_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 21. Attributes in the mobility zone inventory file
Column Name
Description
key
ID assigned to the zone
mobilityZoneName
Name assigned to the zone
description
Description of the zone
createdDatetime
Date and time (in Unix timestamp) when the zone was
created
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
367
Statistics Files the Controller Exports to an FTP Server
Zone Statistics
Zone Statistics
The zone statistics file contains detailed information on traffic, client associations,
and AP uptime at the zone level during the configured period of time. The default
file name format depends on the time period specified for uploading the statistics file:
• If the zone statistics file is exported daily:
statsZoneDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the zone statistics file is exported hourly:
statsZoneHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
NOTE: The term “period” in the following table refers to the time interval (hourly or
daily) selected in Statistics Date Interval on the web interface.
Table 22. Attributes in the zone statistics file
Column Name
Description
key
ID of the zone
airtime
Total airtime of channel utilization during the period
minNumClients
Minimum number of concurrently connected clients
during the period
rxFrames_r
Total number of frames received during the period
txRateKbps
Transmit data rate in kilobits per second for the period
rxRateKbps
Receive data rate in kilobits per second for the period
newAssoc
Number of newly associated clients during the period
txBytes_r
Total number of bytes transmitted during the period
rxBytes_r
Total number of bytes received during the period
timeStamp
Data aggregation time (in Unix timestamp)
txFrames_r
Total number of frames transmitted during the period
uptime_r
Percentage of time during which the AP was up during
the period. Uptime is computed based on the up and
down events that occurred.
avgNumClients
Average number of concurrently connected clients during
the period
failedAssoc
Number of failed associated clients during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
368
Statistics Files the Controller Exports to an FTP Server
AP Statistics
Table 22. Attributes in the zone statistics file
Column Name
Description
maxNumClients
Maximum number of concurrently connected clients
during the period
AP Statistics
The AP statistics file contains detailed information on traffic, client associations, and
AP uptime at the AP level during the configured period of time.
The default AP statistics file name format depends on the time period specified for
uploading the file:
• If the AP statistics file is exported daily:
statsAPDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the AP statistics file is exported hourly:
statsAPHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
NOTE: The term “period” in the following table refers to the time interval (hourly or
daily) selected in Statistics Date Interval on the web interface.
Table 23. Attributes in the AP statistics file
Column Name
Description
key
MAC address of the AP
airtime
Total airtime of channel utilization during the period
minNumClients
Minimum number of concurrently connected clients
during the period
txRateKbps
Transmit data rate in kilobits per second for the period
newAssoc
Number of newly associated clients during the period
txBytes_r
Total number of bytes transmitted during the period
rxRateKbps
Received data rate in kilobits per second for the period
rxBytes_r
Total number of bytes received during the period
rxFrames_r
Total number of frames received during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
369
Statistics Files the Controller Exports to an FTP Server
AP Statistics
Table 23. Attributes in the AP statistics file
Column Name
Description
uptime_r
Percentage of time during which the AP was up during
the period. Uptime is computed based on the up and
down events that occurred.
avgNumClients
Average number of concurrently connected clients during
the period
txFrames_r
Total number of frames transmitted during the period
failedAssoc
Number of clients that failed to associate with the AP
during the period
maxNumClients
Maximum number of concurrently connected clients
during the period
timestamp
Data aggregation time (in Unix timestamp)
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
370
Statistics Files the Controller Exports to an FTP Server
Zone Time Radio Statistics
Zone Time Radio Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsZoneTimeRadioDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsZoneTimeRadioHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 24. Attributes in the zone time radio statistics file
Column Name
Description
key
ID of the zone
airtime
Total airtime of channel utilization during the period
minNumClients
Minimum number of concurrently connected clients
during the period
airtimeB
Busy airtime (channel) utilization during the period
txBytes_r
Total number of bytes transmitted during the period
rxFrames_r
Total number of data frames received during the period
newAssoc
Number of newly associated clients during the period
timestamp
Data aggregation time
txFrames_r
Total number of frames transmitted during the period
rxBytes_r
Total number of bytes received during the period
airtimeRx
Total receiving airtime (channel) utilization during the
period
avgNumClients
Average number of concurrently connected clients during
the period
airtimeTx
Total transmitting airtime (channel) utilization during the
period
radioId
Identifies the specific radio used by the AP
failedAssoc
Number of clients that failed to associate with the AP
during the period
maxNumClients
Maximum number of concurrently connected clients
during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
371
Statistics Files the Controller Exports to an FTP Server
Zone Time WLAN Statistics
Table 24. Attributes in the zone time radio statistics file
Column Name
Description
phyError
Number of PHY errors during the period
Zone Time WLAN Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsZoneTimeWlanDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsZoneTimeWlanHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 25. Attributes in the zone time WLAN statistics file
Column Name
Description
key
ID assigned to the zone
tenantId
ID of the MVNO account
minNumClients
Minimum number of concurrently connected clients
during the period
txDataFrames_r
Total number of data frames transmitted during the period
txBytes_r
Total number of bytes transmitted during the period
txRateKbps
Transmit data rate in kilobits per second during the period
rxMgmtFrames_r
Total number of management frames received during the
period
timestamp
Data aggregation time
txFrames_r
Total number of frames transmitted during the period
wsgWlanId
WLAN ID of the controller
rxBytes_r
Total number of bytes received during the period
avgNumClients
Average number of concurrently connected clients during
the period
txDataBytes_r
Total number of data bytes transmitted during the period
radioId
Identifies the specific radio used by the AP
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
372
Statistics Files the Controller Exports to an FTP Server
Zone Time WLAN Statistics
Table 25. Attributes in the zone time WLAN statistics file
Column Name
Description
ssid
SSID of the WLAN
maxNumClients
Maximum number of concurrently connected clients
during the period
rxMgmtBytes_r
Total number of management bytes received during the
period
rxDataBytes_r
Total number of data bytes received during the period
wlanId
Identifies the specific WLAN ID on the AP
rxFrames_r
Total number of frames received during the period
rxRateKbps
Receive data rate in kilobits per second during the period
newAssoc
Number of newly associated clients during the period
txMgmtFrames_r
Total number of management frames transmitted during
the period
bssid
BSSID of the WLAN
txMgmtBytes_r
Total number of management bytes transmitted during the
period
ap
MAC address of the AP
failedAssoc
Number of clients that failed to associate with the AP
during the period
channel
Radio channel that the AP is using
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
373
Statistics Files the Controller Exports to an FTP Server
AP Time Radio Statistics
AP Time Radio Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsAPTimeRadioDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsAPTimeRadioHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 26. Attributes in the AP time radio statistics file
Column Name
Description
key
ID assigned to the AP
airtime
Total airtime (channel) utilization during the period
minNumClients
Minimum number of concurrently connected clients
during the period
airtimeB
Busy airtime (channel) utilization during the period
txBytes_r
Total number of bytes transmitted during the period
rxFrames_r
Total number of data frames received during the period
newAssoc
Number of newly associated clients during the period
timestamp
Data aggregation time
txFrames_r
Total number of data frames transmitted during the period
rxBytes_r
Total number of bytes received during the period
airtimeRx
Total receiving airtime (channel) utilization during the
period
avgNumClients
Average number of concurrently connected clients during
the period
airtimeTx
Total transmitting airtime (channel) utilization during the
period
radioId
Identifies the specific radio used by the AP
failedAssoc
Number of failed associated clients during the period
maxNumClients
Maximum number of concurrently connected clients
during the period
phyError
Number of PHY errors during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
374
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
AP Time WLAN Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsAPTimeWlanDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsAPTimeWlanHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 27. Attributes in the AP time WLAN statistics files
Field name
Description
key
MAC address of the AP
minNumClients
Minimum number of concurrently connected clients
during the period
txFail_r
Total number of packets that failed transmission during
the period
wlanId
Identifies the specific WLAN ID on the AP
txBytes_r
Total number of bytes transmitted during the period
rxFrames_r
Total number of data frames received during the period
txRateKbps
Transmit data rate in kilobits per second during the period
newAssoc
Number of newly associated clients during the period
timeStamp
Data aggregation time
rxRateKbps
Receive data rate in kilobits per second during the period
txFrames_r
Total number of data frames transmitted during the period
bssid
BSSID of the WLAN
wsgWlanId
Identified the WLAN ID in the controller system
rxBytes_r
Total number of bytes received during the period
avgNumClients
Average number of concurrently connected clients during
the period
ssid
SSID of the WLAN
failedAssoc
Number of clients that failed to associate with the WLAN
during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
375
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
Table 27. Attributes in the AP time WLAN statistics files
Field name
Description
maxNumClients
Maximum number of concurrently connected clients
during the period
radioId
The radio on the AP used to provide the WLAN service.
Possible values include 0 (2.4Ghz radio) and 1 (5GHz
radio).
tenantId
ID of the MVNO account
Control Plane Statistics
Control plane statistics describe traffic related information on the control plane. The
default control plane statistics file name format depends on the time period specified
for uploading the file:
• If the control plane statistics file is exported daily:
statsCBladeSysMonDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the control plane statistics file is exported hourly:
statsCBladeSysMonHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
NOTE: The term “period” in the following table refers to the time interval (hourly or
daily) selected in Statistics Date Interval on the web interface.
Table 28. Attributes in the control plane statistics file
Column Name
Description
key
Control plane ID
bond0_rxBytes
Traffic received (in bytes) on bond0
eth1_txBpsMin
Minimum transmitted throughput (in bits per second) on
eth1
eth1_txPackets
Number of packets transmitted on eth1
eth2_txBytes
Transmitted traffic (in bytes) on eth2
eth0_rxBps
Received throughput (in bits per second) on eth0
bond1_rxBpsMin
Minimum received throughput (in bits per second) on
bond1
eth3_rxBps
Received throughput (in bits per second) on eth3
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
376
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
Table 28. Attributes in the control plane statistics file
Column Name
Description
bond1_rxBpsMax
Maximum received throughput (in bits per second) on
bond1
eth0_txBps
Transmitted throughput (in bits per second) on eth0
bond0_txBpsMin
Minimum transmitted throughput (in bits per second) on
bond0
eth1_txBpsMax
Maximum transmitted throughput (in bits per second) on
eth1
eth5_rxBps
Received throughput (in bits per second) on eth5
bond1_rxDropped
Dropped received packets on bond1
eth3_rxBpsMin
Minimum received throughput (in bits per second) on eth3
eth2_txBpsMax
Maximum transmitted throughput (bps) on eth2
eth5_txBps
Transmitted throughput (bps) on
eth5
eth5_txDropped
Dropped transmitted packet on eth5
eth4_rxBpsMin
Minimum transmitted throughput (bps) on eth4
eth0_txPackets
Transmitted packet count on eth0
eth4_rxBpsMax
Maximum received throughput (bps) on eth4
eth5_rxPackets
Received packet count on eth5
eth3_txBps
Transmitted throughput (bps) on eth3
bond2_rxBps
Received throughput (bps) on bond2
diskFreeMax
Maximum free disk space
eth4_rxDropped
Dropped received packets on eth4
diskFreeMin
Minimum free disk space
eth2_txBpsMin
Minimum transmitted throughput (bps) on eth2
eth5_txBpsMin
Minimum transmitted throughput (bps) on eth5
memoryPercMax
Maximum memory percentage
bond2_rxDropped
Dropped received packet on bond2
memoryPercMin
Minimum memory percentage
eth3_txPackets
Transmitted packet count on eth3
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
377
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
Table 28. Attributes in the control plane statistics file
Column Name
Description
eth3_txBytes
Transmitted traffic bytes on eth3
bond0_txBytes
Transmitted traffic bytes on bond0
eth1_rxDropped
Dropped received packets on eth1
eth2_txDropped
Dropped transmitted packet on eth2
eth4_txBpsMin
Minimum transmitted throughput (bps) on eth4
timestamp
UNIX timestamp
eth3_rxDropped
Dropped received packet on eth3
eth4_txBps
Transmitted throughput (bps) on eth4
eth0_rxBpsMax
Maximum received throughput
(bps) on eth0
eth1_txDropped
Dropped transmitted packet on eth1
bond1_txPackets
Transmitted packet count on bond1
bond1_rxBps
Received throughput (bps) on bond1
eth0_txDropped
Dropped transmitted packet on eth0
eth4_txBpsMax
Maximum transmitted throughput (bps) on eth4
diskFree
Free disk volume
eth0_rxDropped
Dropped received packets on eth0
bond0_txBpsMax
Maximum transmitted throughput (bps) on bond0
bond0_txBps
Maximum transmitted throughput (bps) on bond0
bond2_txBps
Transmitted throughput (bps) on bond2
eth0_rxBpsMin
Minimum transmitted throughput (bps) on eth0
eth1_rxBps
Received throughput (bps) on eth1
bond2_txBpsMax
Maximum transmitted throughput (bps) on bond2
bond0_txDropped
Dropped transmitted packets on bond0
eth1_rxBpsMax
Maximum received throughput (bps) on eth1
bond2_txBytes
Transmitted traffic bytes on bond2
eth3_rxPackets
Received packet count on eth3
diskTotalMax
Maximum total disk volume
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
378
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
Table 28. Attributes in the control plane statistics file
Column Name
Description
diskTotalMin
Minimum total disk volume
bond2_rxBpsMax
Maximum received throughput (bps) on bond2
diskTotal
Maximum total disk volume
eth0_txBytes
Transmitted traffic bytes on eth0
bond0_rxDropped
Dropped received packets on bond0
eth2_rxBpsMax
Maximum received throughput (bps) on eth2
eth4_rxBps
Received throughput (bps) on eth4
bond2_txBpsMin
Minimum transmitted throughput (bps) on bond2
eth5_rxBpsMin
Minimum transmitted throughput (bps) on eth5
eth1_txBytes
Transmitted traffic bytes on eth1
eth5_txPackets
Transmitted packet count on eth5
eth3_rxBytes
Received traffic bytes on eth3
bond1_txDropped
Dropped transmitted packet on bond1
eth5_txBytes
Transmitted traffic bytes on eth5
bond1_rxBytes
Received traffic bytes on bond1
bond2_txDropped
Dropped transmitted packets on bond2
bond0_txPackets
Transmitted packet count on bond0
eth5_rxDropped
Dropped received packets on eth5
eth1_rxBytes
Received traffic bytes on eth1
bond1_txBps
Minimum transmitted throughput (bps) on bond1
eth2_rxBpsMin
Minimum transmitted throughput (bps) on eth2
eth3_txBpsMin
Minimum transmitted throughput (bps) on eth3
eth5_txBpsMax
Maximum transmitted throughput (bps) on eth5
cpuPercMin
Minimum CPU usage percentage
bond0_rxBps
Received throughput (bps) on bond0
eth5_rxBpsMax
Maximum received throughput (bps) on eth5
bond0_rxBpsMin
Minimum transmitted throughput (bps) on bond0
eth0_txBpsMax
Maximum transmitted throughput (bps) on eth0
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
379
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
Table 28. Attributes in the control plane statistics file
Column Name
Description
memoryPerc
Memory usage percent
eth1_rxBpsMin
Minimum transmitted throughput (bps) on eth1
bond2_txPackets
Transmitted packet count on bond2
eth2_rxBytes
Received traffic bytes on eth2
eth4_txPackets
Transmitted packet count on eth4
eth4_txDropped
Dropped transmitted packet on eth4
eth2_rxDropped
Dropped received packet on eth2
cpuPerc
CPU usage percent
bond1_txBytes
Transmitted traffic bytes on bond1
bond1_rxPackets
Received packet count on bond1
bond0_rxPackets
Received packet count on bond0
eth5_rxBytes
Received traffic bytes on eth5
eth1_rxPackets
Received packet count on eth1
eth0_rxPackets
Received packet count on eth0
cpuPercMax
Maximum CPU usage percentage
eth2_txPackets
Transmitted packet count on eth2
eth4_txBytes
Transmitted traffic bytes on eth4
eth3_rxBpsMax
Maximum received throughput (bps) on eth3
eth4_rxPackets
Received packet count on eth4
bond1_txBpsMin
Minimum transmitted throughput (bps) on bond1
bond0_rxBpsMax
Maximum received throughput (bps) on bond0
eth4_rxBytes
Received traffic bytes on eth4
bond1_txBpsMax
Maximum transmitted throughput (bps) on bond1
eth0_txBpsMin
Minimum transmitted throughput (bps) on eth0
bond2_rxBytes
Received traffic bytes on bond2
eth2_rxBps
Received throughput (bps) on eth2
eth2_rxPackets
Received packet count on eth2
eth2_txBps
Transmitted throughput (bps) on eth2
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
380
Statistics Files the Controller Exports to an FTP Server
AP Time WLAN Statistics
Table 28. Attributes in the control plane statistics file
Column Name
Description
eth3_txBpsMax
Maximum transmitted throughput (bps) on eth3
eth0_rxBytes
Received traffic bytes on eth0
eth3_txDropped
Dropped transmitted packet on eth3
bond2_rxBpsMin
Minimum transmitted throughput (bps) on bond2
eth1_txBps
Transmitted throughput (bps) on eth1
bond2_rxPackets
Received packet count on bond2
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
381
Statistics Files the Controller Exports to an FTP Server
Data Plane Statistics
Data Plane Statistics
Data plane statistics describe general information about the data plane. The default
data plane statistic file name format is:
dp_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 29. Attributes in the data plane statistics file
Column
Description
key
MAC address of the data plane
bladeId
Data plane ID
name
Name of the data plane
model
Model of the data plane
serialNumber
Serial number of the data plane
fwVersion
Current firmware version of the data plane
uptime
Number of minutes elapsed since the data plane was last
rebooted
chassisID
Data plane associated with the control plane's MAC
address
ip
IP address assigned to the data plane
creationTime
Timestamp when the data plane connected to the
controller
lastSeen
Timestamp of the data plane's latest connection
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
382
Statistics Files the Controller Exports to an FTP Server
Data Plane Ethernet Port Statistics
Data Plane Ethernet Port Statistics
Data plane Ethernet port statistics describe traffic related information on the data
plane. The default data plane statistic file name format is:
dpEthPortStatistics_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 30. Attributes in the data plane Ethernet port statistics file
Column
Description
dBladeId
MAC address of the data plane
portId
Data plane port ID (either 1 or 2)
timeIntervalInMillis
Unix timestamp when these statistics were collected.
These statistics are collected at 15-minute intervals (for
example, 10:00, 10:15. 10:30).
txRate
The rate at which the data plane was transmitting data at
the time the controller generated this report
rxRate
The rate at which the data plane was receiving data at the
time the controller generated this report
txPkts
Incremental packet count transmitted during the 15minute interval
rxPkts
Incremental packet count received during the 15-minute
interval
txDrops
Incremental transmitted packet count dropped during the
15-minute interval
rxDrops
Incremental received packet count dropped during the
15-minute interval
txBytes
Incremental bytes transmitted during the 15-minute
interval
rxBytes
Incremental bytes received during the 15-minute interval
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
383
Statistics Files the Controller Exports to an FTP Server
AP Soft GRE Tunnel Statistics
AP Soft GRE Tunnel Statistics
AP soft GRE tunnel statistics describe soft GRE tunnel-related information. The
default AP soft GRE tunnel statistics file name format is:
statsAPSoftGRETunnel_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 31. Attributes in the AP soft GRE tunnel statistics file
Column
Description
gw
IP address or FQDN of the SoftGRE gateway
apMac
MAC address of the AP
apIpAddress
IP address of the AP
timeIntervalInMillis
Unix timestamp when these statistics were collected.
These statistics are collected at 15-minute intervals (for
example, 10:00, 10:15. 10:30).
accessType
This value is always “SoftGRE.”
zoneId
Zone UUID
txPkts
TX packet count of GRE interface
txBytes
TX byte count of GRE interface
rxPkts
RX packet count of GRE interface
rxBytes
RX byte count of GRE interface
txErrPkts
TX error packet count of GRE interface
rxErrPkts
RX error packet count of GRE interface
txDropPkts
TX drop packet count of GRE interface
rxDropPkts
RX drop packet count of GRE interface
txFragPkts
Oversized packet count
cICMP
ICMP count
cNonICMP
No-reply ICMP count
cDisconnect
Disconnect count
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
384
Statistics Files the Controller Exports to an FTP Server
Soft GRE Gateway Statistics
Soft GRE Gateway Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsSoftGREGatewayDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsSoftGREGatewayHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 32. Attributes in the soft GRE gateway statistics files
Column Name
Description
gw
IP address or FQDN of the SoftGRE gateway
txPkts
MAC address of the AP
txBytes
IP address of the AP
rxPkts
Unix timestamp when these statistics were collected.
These statistics are collected at 15-minute intervals (for
example, 10:00, 10:15. 10:30).
rxBytes
This value is always “SoftGRE.”
txErrPkts
Zone UUID
rxErrPkts
TX packet count of GRE interface
txDropPkts
TX byte count of GRE interface
rxDropPkts
RX packet count of GRE interface
txFragPkts
RX byte count of GRE interface
cICMP
TX Error packet count of GRE interface
cNonICMP
RX Error packet count of GRE interface
cDisconnect
TX Drop packet count of GRE interface
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
385
Statistics Files the Controller Exports to an FTP Server
Tenant Time Radio Statistics
Tenant Time Radio Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsTenantTimeRadioDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsTenantTimeRadioHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 33. Attributes in the tenant time radio statistics file
Column Name
Description
key
Tenant identity
rxDataFrames_r
Total number of data frames received during the period
minNumClients
Minimum number of connected clients (concurrent) during
the period
txDataFrames_r
Total number of data frames transmitted during the period
txBytes_r
Total number of bytes transmitted during the period
txRateKbps
Transmitted data rate expressed in kilobits per second for
the period
rxMgmtFrames_r
Total number of management frames received during the
period
timestamp
Data aggregation time
txFrames_r
Total number of data frames transmitted during the period
rxBytes_r
Total number of bytes received during the period
avgNumClients
Average number of connected clients (concurrent) during
the period
txDataBytes_r
Total number of data bytes transmitted during the period
radioId
Denotes the specific radio within the AP
maxNumClients
Maximum number of connected clients (concurrent)
during the period
rxMgmtBytes_r
Total number of management bytes received during the
period
rxDataBytes_r
Total number of data bytes received during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
386
Statistics Files the Controller Exports to an FTP Server
Tenant Time Radio Statistics
Table 33. Attributes in the tenant time radio statistics file
Column Name
Description
rxFrames_r
Total number of data frames received during the period
rxRateKbps
Received data rate expressed in kilobits per second for
the period
newAssoc
Number of newly associated clients during the period
txMgmtFrames_r
Total number of management frames transmitted during
the period
txMgmtBytes_r
Total number of management bytes transmitted during the
period
ap
MAC address of the AP
failedAssoc
Number of clients that failed to associate during the period
channel
Radio channel that the AP is using
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
387
Statistics Files the Controller Exports to an FTP Server
Tenant Time WLAN Statistics
Tenant Time WLAN Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsTenantTimeWlanDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsTenantTimeWlanHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 34. Attributes in the tenant time WLAN statistics
Column Name
Description
key
Tenant identity
rxDataFrames_r
Total number of data frames received during the period
minNumClients
Minimum number of connected clients (concurrent) during
the period
txDataFrames_r
Total number of data frames transmitted during the period
txBytes_r
Total number of bytes transmitted during the period
txRateKbps
Transmitted data rate expressed in kilobits per second for
the period
rxMgmtFrames_r
Total number of management frames received during the
period
timestamp
Data aggregation time
txFrames_r
Total number of data frames transmitted during the period
wsgWlanId
Represents the WLAN in the controller system
rxBytes_r
Total number of bytes received during the period
avgNumClients
Average number of connected clients (concurrent) during
the period
txDataBytes_r
Total number of data bytes transmitted during the period
radioId
Denotes the specific radio on the AP
ssid
SSID string of the WLAN
maxNumClients
Maximum number of connected clients (concurrent)
during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
388
Statistics Files the Controller Exports to an FTP Server
Tenant Time WLAN Statistics
Table 34. Attributes in the tenant time WLAN statistics
Column Name
Description
rxMgmtBytes_r
Total number of management bytes received during the
period
rxDataBytes_r
Total number of data bytes received during the period
wlanId
Denotes the specific WLAN on the AP
rxFrames_r
Total number of data frames received during the period
rxRateKbps
Received data rate expressed in kilobits per second for
the period
newAssoc
Number of newly associated clients during the period
txMgmtFrames_r
Total number of management frames transmitted during
the period
bssid
BSSID string of the WLAN
txMgmtBytes_r
Total number of management bytes transmitted during the
period
zoneUUID
Zone identity
ap
MAC address of the AP
failedAssoc
Number of clients that failed to associate during the period
channel
Radio channel that the AP is using
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
389
Statistics Files the Controller Exports to an FTP Server
Tenant Zone Statistics
Tenant Zone Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsTenantZoneDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsTenantZoneHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 35. Attributes in the tenant zone statistics
Column Name
Description
key
Tenant identity
rxDataFrames_r
Total number of data frames received during the period
minNumClients
Minimum number of connected clients (concurrent) during
the period
txDataFrames_r
Total number of data frames transmitted during the period
txBytes_r
Total number of bytes transmitted during the period
txRateKbps
Transmitted data rate expressed in kilobits per second for
the period
rxMgmtFrames_r
Total number of management frames received during the
period
timestamp
Data aggregation time
txFrames_r
Total number of data frames transmitted during the period
wsgWlanId
Represents the WLAN in the controller system
rxBytes_r
Total number of bytes received during the period
avgNumClients
Average number of connected clients (concurrent) during
the period
txDataBytes_r
Total number of data bytes transmitted during the period
ssid
SSID string of the WLAN
maxNumClients
Maximum number of connected clients (concurrent)
during the period
rxMgmtBytes_r
Total number of management bytes received during the
period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
390
Statistics Files the Controller Exports to an FTP Server
Tenant Zone Statistics
Table 35. Attributes in the tenant zone statistics
Column Name
Description
rxDataBytes_r
Total number of data bytes received during the period
rxFrames_r
Total number of data frames received during the period
rxRateKbps
Received data rate expressed in kilobits per second for
the period
newAssoc
Number of newly associated clients during the period
txMgmtFrames_r
Total number of management frames transmitted during
the period
txMgmtBytes_r
Total number of management bytes transmitted during the
period
zoneUUID
Zone identity
ap
MAC address of the AP
failedAssoc
Number of clients that failed to associate during the period
channel
Radio channel that the AP is using
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
391
Statistics Files the Controller Exports to an FTP Server
Tenant Zone Radio Statistics
Tenant Zone Radio Statistics
The default file name format depends on the time period specified for uploading the
statistics file:
• If the statistics file is exported daily:
statsTenantZoneRadioDay_YYYY_MM_DD_hh_mm_ss_ms.csv
• If the statistics file is exported hourly:
statsTenantZoneRadioHour_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 36. Attributes in the tenant zone radio statistics
Column Name
Description
key
Tenant identity
rxDataFrames_r
Total number of data frames received during the period
minNumClients
Minimum number of connected clients (concurrent) during
the period
txDataFrames_r
Total number of data frames transmitted during the period
txBytes_r
Total number of bytes transmitted during the period
txRateKbps
Transmitted data rate expressed in kilobits per second for
the period
rxMgmtFrames_r
Total number of management frames received during the
period
timestamp
Data aggregation time
txFrames_r
Total number of data frames transmitted during the period
rxBytes_r
Total number of bytes received during the period
avgNumClients
Average number of connected clients (concurrent) during
the period
txDataBytes_r
Total number of data bytes received during the period
radioId
Denote the specific radio within the AP
maxNumClients
Maximum number of connected clients (concurrent)
during the period
rxMgmtBytes_r
Total number of management bytes received during the
period
rxDataBytes_r
Total number of data bytes received during the period
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
392
Statistics Files the Controller Exports to an FTP Server
Tenant Zone Radio Statistics
Table 36. Attributes in the tenant zone radio statistics
Column Name
Description
rxFrames_r
Total number of data frames received during the period
rxRateKbps
Received data rate expressed in kilobits per second for
the period
newAssoc
Number of newly associated clients during the period
txMgmtFrames_r
Total number of management frames transmitted during
the period
txMgmtBytes_r
Total number of management bytes transmitted during the
period
zoneUUID
Zone identity
ap
MAC address of the AP
failedAssoc
Number of failed associated clients during the period
channel
Radio channel that the AP is using
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
393
Statistics Files the Controller Exports to an FTP Server
Tenant Inventory File
Tenant Inventory File
The tenant inventory file contains detailed information about each tenant account
that has been created on the controller.
The default tenant inventory file name format is:
tenant_YYYY_MM_DD_hh_mm_ss_ms.csv
where ms stands for three-digit milliseconds.
Table 37. Attributes in the tenant inventory statistics
Column Name
Description
key
Tenant identity
Phone
Phone number of the tenant
adminUUID
UUID of the creator
createdDatetime
Unix timestamp when the tenant was created
city
City where the tenant is located
address
Address of the tenant
email
Email address of the tenant
description
Description of the account
modifiedDatetime
Unix timestamp when the account was last updated
name
Name of the tenant
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
394
B
Ports to Open for AP-Controller
Communication
In this appendix:
• AP-SCG/SZ/vSCG Communication
• Required Port Forwarding if the vSCG Is Behind NAT
• AP-ZD Communication
AP-SCG/SZ/vSCG Communication
The table below lists the ports that must be opened on the network firewall to ensure
that the SCG/SZ/vSCG (controller), managed APs, and RADIUS servers can
communicate with each other successfully.
Table 38. Ports to open for AP-SCG/SZ/vSCG communication
Port
Number
Layer 4
Protocol
Source
Destination
Configurable Purpose
from Web
Interface?
21
TCP
AP
Controller
Yes
FTP upload of reports,
statistics, and
configuration backups
22
TCP
AP
Controller
(control plane)
No
SSH tunnel
49
TCP
TACACS Controller
+ server
Yes
TACACS+ based
authentication of
controller administrators
91
TCP
AP
Controller
(control plane)
No
AP firmware upgrade
123
UDP
AP
Controller
(control plane)
No
NTP sync up
• Not required in 2.1.2,
2.1.3, 2.5.1, 2.6, 3.0
• Required in1.x, 2.1,
2.1.1, 2.5
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
395
Ports to Open for AP-Controller Communication
AP-SCG/SZ/vSCG Communication
Table 38. Ports to open for AP-SCG/SZ/vSCG communication
Port
Number
Layer 4
Protocol
Source
Destination
Configurable Purpose
from Web
Interface?
443
TCP
AP
Controller
(control plane)
No
Access to the SCG/
vSCG/SZ web interface
via HTTPS
8443
TCP
Any
Controller
No
Access to the SCG/
vSCG/SZ web interface
via HTTPS
23232
TCP
AP
SCG (data plane) No
GRE tunnel
23233
UDP
AP
SCG (data plane) Yes
GRE tunnel (required only
when tunnel mode is
GRE over UDP)
12222/
12223
UDP
AP
Controller
No
LWAPP discovery
1812/1813 UDP
AP
RADIUS
Yes
AAA authentication and
accounting
8022
No (SSH)
Any
Management
interface
Yes
Management ACL for
one-port configuration
8090
TCP
Any
Controller
No
Allows unauthorized UEs
to browse to an HTTP
website
8099
TCP
Any
Controller
No
Allows unauthorized UEs
to browse to an HTTPS
website
8100
TCP
Any
Controller
No
Allows unauthorized UEs
to browse using a proxy
UE
8111
TCP
Any
Controller
No
Allows authorized UEs to
browse using a proxy UE
9080
HTTP
Any
Controller
No
Northbound Portal
Interface for hotspots
9443
HTTPS
Any
Controller
No
Northbound Portal
Interface for hotspots
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
396
Ports to Open for AP-Controller Communication
Required Port Forwarding if the vSCG Is Behind NAT
Table 38. Ports to open for AP-SCG/SZ/vSCG communication
Port
Number
Layer 4
Protocol
Source
Destination
Configurable Purpose
from Web
Interface?
9998
TCP
Any
Controller
No
Internal WISPr portal
Required Port Forwarding if the vSCG Is
Behind NAT
Table 39 lists the ports that must be opened to ensure that the SCG, managed APs,
and RADIUS servers can communicate with each other successfully.
NOTE: In addition to the ports listed in Table 39, remember to open port 8443 (TCP)
to ensure that the SCG web interface is accessible.
Table 39. Ports that need to be forwarded if the vSCG is behind a NAT server
Port Number
Purpose
UDP Ports
12223
ZD AP using LWAPP join
123
AP sync ntp with SCG
161
SNMP query
TCP Ports
21
ZD AP fw update via FTP
91
SCG AP fw update via HTTP
443
Let SCG AP get SSH private key
8080
SCG setup wizard GUI
8443
SCG GUI
8090, 8099, 8100,
8111, 9997, 9998
For WISPr
9080, 9443
For Northbound API (NBI)
16384-65000
For ZD AP fw update via FTP
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
397
Ports to Open for AP-Controller Communication
AP-ZD Communication
AP-ZD Communication
The table below lists the ports that must be opened on the network firewall to ensure
that the ZoneDirector (ZD), its managed APs, and other network devices can
communicate with each other successfully.
Table 40. Ports to open for AP-ZoneDirector communication
Port
Number
Layer 4
Protocol
Source
Destination Configurable Purpose
from Web
Interface?
21
TCP
AP
ZD
No
AP firmware upgrade (the
firewall must be stateful for
PASV FTP transfers)
22
TCP
AP
ZD
No
AP statistics reporting (via
SSH)
22
TCP
Any
ZD
No
Access to the ZoneDirector
CLI (via SSH)
49
TCP
TACACS+
server
ZD
Yes
TACACS+ based
authentication of
ZoneDirector administrators
80
TCP
Any
ZD
No
Access to the ZoneDirector
web interface (via HTTP)
443
TCP
ZD
FlexMaster
No
Registration, inform,
firmware upgrade
messages
8443
TCP
Any
ZD
No
Access to the ZoneDirector
web interface (via HTTPS)
18301
UDP
AP
ZD
No
SpeedFlex
12222/
12223
UDP
AP
ZD
No
LWAPP discovery
443/33003 TCP
ZD (primary) ZD (backup) No
Smart Redundancy
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
398
Ports to Open for AP-Controller Communication
AP-ZD Communication
Table 40. Ports to open for AP-ZoneDirector communication
Port
Number
Layer 4
Protocol
Varies
TCP
(specified in
FM
Inventory
'Device
Web Port
Number
Mapping')
Source
Destination Configurable Purpose
from Web
Interface?
FlexMaster ZD
Yes
Access to the ZoneDirector
web interface
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
399
SoftGRE Support
C
This appendix describes the SoftGRE support that the SmartCell Gateway provides
and the supported deployment topology. Topics include:
• Overview of SoftGRE Support
• Supported Deployment Scenario
• SoftGRE Packet Format
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
400
SoftGRE Support
Overview of SoftGRE Support
Overview of SoftGRE Support
There are numerous equipment vendors serving the service provider market today.
Among these vendors, the more prominent ones include Alcatel-Lucent (ALU),
Ericsson, NSN, Huawei and Cisco. Most of these vendors support different tunneling
and mobility management protocols at their packet gateways.
Since most (if not all) of these equipment vendors do not develop access points
themselves, they are publishing SoftGRE specifications to enable access point
vendors (such as Ruckus Wireless) to support SoftGRE on their devices.
Supported Deployment Scenario
The controller supports SoftGRE in the deployment scenario wherein the controller
functions purely as an AP controller. In this deployment topology, the controller only
manages the Ruckus Wireless APs and does not perform other functions. All control
paths (RADIUS Authentication/Accounting) and data paths (SoftGRE tunnel) terminate on the third party WLAN gateway.
If 802.1x authentication is used, the RADIUS server will be outside of the SoftGRE
tunnel. If open, WISPr-based authentication is used, the portal or redirect function
will be on the edge router or northbound of the edge router. The controller does not
play any role in the control and data path functions (see Figure 190).
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
401
SoftGRE Support
Overview of SoftGRE Support
Figure 190. The controller as a pure AP controller
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
402
SoftGRE Support
Overview of SoftGRE Support
SoftGRE Packet Format
Figure displays a screen shot of SoftGRE packet capture data.
Figure 191. Example of SoftGRE packet format
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
403
SoftGRE Support
Creating an AP Zone That Supports SoftGRE
Creating an AP Zone That Supports SoftGRE
For information on how to create an AP zone that supports Soft GRE tunneling, see
Working with AP Zones.
NOTE: MVNO accounts are currently unsupported by SoftGRE tunnels. If you
create an MVNO account and assign an AP zone that is using a SoftGRE tunnel,
an error message appears.
Monitoring SoftGRE
You can use the Monitor pages to view AP SoftGRE statistics. This section
describes:
• Checking the AP Tunnel Type of a Zone
• Viewing SoftGRE Traffic Statistics of an AP
Checking the AP Tunnel Type of a Zone
Follow these steps to check if a zone is using SoftGRE tunneling.
1 Go to Monitor > AP Zone.
2 In the Administration Domain tree, click each AP zone name to display their zone
information summary.
3 In the General Information section, check the value for Tunnel. If the value shown
is SoftGRE, this indicates that the zone is using SoftGRE tunneling.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
404
SoftGRE Support
Monitoring SoftGRE
Figure 192. Check the value for “Tunnel” to verify that a zone is using SoftGRE tunneling
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
405
SoftGRE Support
Monitoring SoftGRE
Viewing SoftGRE Traffic Statistics of an AP
Follow these steps to view the SoftGRE tunnel statistics of an AP that belongs to a
zone enabled for SoftGRE.
1 Go to Monitor > Access Points.
2 In the Administration Domain tree, click a zone that is enabled for SoftGRE. The
APs that appear on the AP List page are all using SoftGRE tunneling.
3 Click the MAC address of an AP whose SoftGRE traffic statistics you want to
view.
4 On the AP Status tab, scroll down to the AP SoftGRE Tunnel Statistics section
to view the AP SoftGRE statistics. Additional SoftGRE statistics appear in the
AP SoftGRE Control Signaling Statistics section. Table 41 describes the SoftGRE
statistics that appear.
Figure 193. AP SoftGRE statistics on the Monitor page
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
406
SoftGRE Support
Monitoring SoftGRE
Table 41. SoftGRE statistics of an AP
Statistic
Description
Gateway
The IP address of the gateway server
Is Active
• Yes, if the gateway is currently active
• No, if the gateway is inactive
Bytes (Tx/Rx)
The number bytes transmitted/received (Tx/Rx) through the
SoftGRE tunnel
Packets (Tx/Rx)
The number packets transmitted/received (Tx/Rx) through the
SoftGRE tunnel
Error Packets (Tx/Rx)
The number of packets with errors.
Tx errors may be caused by any of the following:
• No routing entry to destination
• Invalid routing entry (routing traffic to tunnel interface itself)
• Transmission error in core IP layer of Linux
Rx errors may be caused by any of the following:
• Bad packets received, checksum does not match (remote
peer enables CSUM field in GRE header)
• Sequence number does not match (remote peer enables
SEQ field in GRE header)
• SKB error during GRE decapsulation.
Dropped Packets (Tx/ The number of packets that have been dropped.
Rx)
• Tx dropped packets may be due to insufficient space in the
Linux buffer or insufficient memory when allocating extra
buffer for GRE encapsulation.
• Rx dropped packets may be due to insufficient space in the
Linux buffer.
TX Fragmented
Packets
The number of oversized Tx packets.
ICMP Requests
The total number of ICMP requests
Failed ICMP Requests The total number of failed ICMP requests
You have completed viewing the AP SoftGRE statistics.
This chapter lists the SNMP MIBs, alarms, and events that are related to SoftGRE.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
407
SoftGRE Support
SoftGRE SNMP MIBs
SoftGRE SNMP MIBs
Table 42 lists the SoftGRE related OIDs.
Table 42. OIDs related to SoftGRE
Parent Node
Node Name
OID
ruckusWLANAPInfo
ruckusSCGWLANAPMacAddr
1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.1
ruckusSCGWLANAPSoftGREServe 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.2
r
ruckusSCGWLANAPSoftGREGWA 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.3
ddr
ruckusSCGWLANAPSoftGREActiv 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.4
e
ruckusSCGWLANAPSoftGRETxPkt 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.5
s
ruckusSCGWLANAPSoftGRETxByt 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.6
es
ruckusSCGWLANAPSoftGRERxPk 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.7
ts
ruckusSCGWLANAPSoftGRERxBy 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.8
tes
ruckusSCGWLANAPSoftGRETxPkt 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.9
sErr
ruckusSCGWLANAPSoftGRERxPk 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.10
tsErr
ruckusSCGWLANAPSoftGRETxPkt 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.11
sDropped
ruckusSCGWLANAPSoftGRERxPk 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.12
tsDropped
ruckusSCGWLANAPSoftGRETxPkt 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.13
sFrag
ruckusSCGWLANAPSoftGREICMP 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.14
Total
ruckusSCGWLANAPSoftGREICMP 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.15
NoReply
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
408
SoftGRE Support
SoftGRE Alarms and Events
Table 42. OIDs related to SoftGRE
Parent Node
Node Name
OID
ruckusSCGWLANAPSoftGREDisco 1.3.6.1.4.1.25053.1.3.2.1.1.2.3.1.16
nnect
SoftGRE Alarms and Events
If there is no downstream traffic in the tunnel, APs that belong to the zone configured
for SoftGRE send out-of-band ICMP keep-alive messages (interval is configurable)
to the active third party WLAN gateway. If an AP does not receive a response from
the active WLAN gateway, it triggers an alarm and it automatically creates a SoftGRE
tunnel to the standby WLAN gateway.
If the AP does not receive a response from the standby WLAN gateway either, the
AP disconnects all tunneled WLAN services. It continues to send keep-alive
messages to both the active WLAN gateway (primary GRE remote peer) and
standby WLAN gateway (secondary GRE remote peer). If it receives a response
from either WLAN gateway, the AP restores all tunneled WLAN services automatically.
There are four types of events that APs send to the controller:
• Failover from primary GRE remote peer to secondary GRE remote peer
• Failover from secondary GRE remote peer to primary GRE remote peer.
• Tunnel disconnected because both primary and secondary GRE remote peers
are unreachable
• Tunnel restored because either primary or secondary GRE remote peer is
reachable
For the list of alarms and events related to SoftGRE that APs generate, refer to
SoftGRE Events and SoftGRE Alarms.
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
409
SoftGRE Support
SoftGRE Alarms and Events
SoftGRE Events
Table 43lists the SoftGRE related events that APs send to the controller.
Table 43. SoftGRE related events that APs send to the controller
Event Code Event Type
Severity
Event Attributes
Event Description
611
apSoftGRETunne Warning
lFailoverPtoS
"apMac"="xx:xx:xx:xx:xx:xx", "AP
"primaryGRE"="xxx.xxx.xxx.x [{apname@apMac}]
fails over from
xx",
"secondaryGRE"="xxx.xxx.xx primaryGRE
[{address}] to
x.xxx
secondaryGRE
[{address}].
612
apSoftGRETunne Warning
lFailoverStoP
"apMac"="xx:xx:xx:xx:xx:xx", "AP
"secondaryGRE"="xxx.xxx.xx [{apname@apMac}]
fails over from
x.xxx",
"primaryGRE"="xxx,xxx.xxx.x secondaryGRE
[{address }] to
xx
primaryGRE
[{address}].
613
apSoftGREGate Information "apMac"="xx:xx:xx:xx:xx:xx", AP
wayReachable
al
"softgreGW"="primaryGRE", [{apname@apMac}]
is able to reach
"softgreGWAddress" =
[{softgreGW}]
"xxx.xxx.xxx.xxx"
[{softgreGWAddres
s}] successfully.
614
apSoftGREGate Critical
wayNotReachabl
e
apMac"="xx:xx:xx:xx:xx:xx",
AP
"softGREGatewayList"="xxx.x [{apname@apMac
}] is unable to reach
xx.xxx.xxx, yyy,yyy.yyy.yyy"
the following
gateways:
[{gateway list}].
?"
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
410
SoftGRE Support
SoftGRE Alarms and Events
SoftGRE Alarms
Table 44 lists the SoftGRE related alarms that APs send to the controller.
Table 44. SoftGRE related alarms that APs send to the controller
Alarm Alarm Type
Code
611
Default Severity Attributes
to Trap
apSoftGRETunn true
elFailoverPtoS
major
Description
• "apMac"="xx:xx: AP[{apname@apMac}] fails over
xx:xx:xx:xx"
from primaryGRE[{address}] to
• "primaryGRE"=" secondaryGRE[{address}].
xxx.xxx.xxx.xxx
"
• "secondaryGRE"
="xxx.xxx.xxx.x
xx
612
apSoftGRETunn true
elFailoverStoP
major
• "apMac"="xx:xx: AP[{apname@apMac}] fails over
xx:xx:xx:xx"
from secondaryGRE[{address }]
• "secondaryGRE" to primaryGRE[{address}].
="xxx.xxx.xxx.x
xx"
• "primaryGRE"="
xxx,xxx.xxx.xxx
613
apSoftGREGate true
wayReachable
informati • "apMac"="xx:xx: AP [{apname@apMac}] is able to
onal
xx:xx:xx:xx"
reach [{softgreGW}]
• "softgreGW"="pr [{softgreGWAddress}]
successfully.
imaryGRE"
• "softgreGWAddr
ess" =
"xxx.xxx.xxx.xx
x"
614
apSoftGREGate true
wayNotReachabl
e
major
• “apMac"="xx:xx: AP [{apname@apMac }] is
xx:xx:xx:xx"
unable to reach the following
• "softGREGatew gateways: [{gateway list}].
ayList"="xxx.xx
x.xxx.xxx,
yyy,yyy.yyy.yyy"
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
411
Index
Numerics
B
802.11d 85
backing up
FTP 325
backup 333
deleting 337
restoring 336
A
access point
rebooting 256
restarting remotely 256
access points
downloading support log 255
exporting to CSV 253
monitoring 251
viewing a summary 251
viewing configuration 254
acknowledge 269
Administration page 22
administrative tasks
backup 333
deleting
backup 337
restore 336
administrator activity 275
exporting to CSV 278
filtering 277
administrator password 33
changing 33
alarm severity 269, 273
alarm types 269, 272
alarms
exporting to CSV 271
filtering 270, 273
severity 269, 273
types 269, 272
viewing 268
AP status summary 24
AP zone
exporting to CSV 248
monitoring 245
viewing a summary 245
viewing configuration 248
viewing on Google Maps 249
C
client admission control 58
client count summary 24
client fingerprinting 86
client number report 280
client OS type summary widget 27
communication ports 395, 397
Configuration page 22
content area 22
continuously disconnected APs report
281
creating
report 281
D
Dashboard page 22
deleting
report 286
DHCP Option 82 85
domain summary 25
downloading
system logs 350
E
exporting
access points 253
alarms 271
AP zones 248
F
filtering
alarms 270
firewall ports 395, 397
Force DHCP 85
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
412
Index
G
Google Maps 249
I
inactivity timeout 85
L
LLDP
attributes 55
logging off 34
logging on 18
logon page 19
M
main menu 21
management port number 18
mesh role 252
miscellaneous bar 22
Monitor page 22
monitoring
access points 251
AP zones 245
N
network connectivity 257
O
onboarding 309
P
pages
Administration 22
Configuration 22
Dashboard 22
Monitor 22
Report 22
password 19
patch file 342
ping 257
ports to open 395, 397
R
report notification 285
Report page 22
report schedule 284
reports
client number 280
continuously disconnected APs 281
creating 281
deleting 286
email notifications 285
system resource utilization 281
TX/RX bytes 281
types 280
viewing list 286
restarting access point 256
restoring
backup 336
FTP 327
S
sidebar 22
Smart Monitor 42
software upgrade file 342
submenu 22
support log 255
supported web browsers 18
system logs
available logs 348
downloading 350
system resource utilization report 281
system summary 25
T
TACACS+ 233
traceroute 257
TX/RX bytes report 281
U
user name 19
V
verifying upgrade 345
viewing
alarms 268
AP zones 245
rebooting access point 256
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
413
Index
W
Web browser 18
Web interface 18
Administration 22
Configuration 22
Dashboard 22
features 20
logging off 34
logging on 18
Monitor 22
password 19
Report 22
user name 19
widget slot 31
widget slots 28
widgets 23
adding a widget to a widget slot 30
adding to the dashboard 28
AP status summary 24
available slots 28
available widgets 24
client count summary 24
client OS type summary 27
data throughput summary 27
deleting 32
displaying a widget in a widget slot 31
domain summary 25
moving to another slot 32
system summary 25
wireless clients
exporting to CSV 260
monitoring 258
viewing information 261
viewing summary 258
Virtualized SmartCell Gateway Carrier Administrator Guide for RuckOS 3.0.3, 800-70672-001 Rev C
414
Copyright © 2006-2014. Ruckus Wireless, Inc.
350 West Java Dr. Sunnyvale, CA 94089. USA
www.ruckuswireless.com