Ruckus Smart Cell Insight Version 1.4 User Guide Rev A 20150819 3
2015-08-19
User Manual: Ruckus SmartCell Insight Version 1.4 User Guide
Open the PDF directly: View PDF .
Page Count: 168
Download | |
Open PDF In Browser | View PDF |
Ruckus Wireless SmartCell Insight ™ Release 1.4 User Guide Part Number 800-71041-001 Rev A Published August 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. SmartCell Insight User Guide, 800-71041-001 Rev A 3 4 Ruckus Wireless, Inc. Contents Copyright Notice and Proprietary Information About This Guide Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 1 Introducing SmartCell Insight Introducing SmartCell Insight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Off-the-shelf value and easy to use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Greater Network Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Acronyms Used in This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 2 Installing the SmartCell Insight Application Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3 Navigating the SmartCell Insight User Interface Accessing the SCI User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Getting Familiar with the SCI User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Interacting with Workspace Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Viewing AP Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Scheduling Email Report Delivery for Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . 26 4 Using Dashboards and Built-In Reports Using the Ruckus Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Network Health Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Client Health Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Usage Distribution and Trends Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Using the Ruckus Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Client and Session Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Inventory Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Operational Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 SmartCell Insight User Guide, 800-71041-001 Rev A 5 Traffic Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 5 Configuring Custom Reports Overview of Custom Report Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Custom Report Schema Changes in SCI 1.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Creating a New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Choosing a Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 The New Analyzer Report Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Adding Fields and Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Switching to Chart Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Changing the Chart Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Applying Filters to Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Adding a Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Saving the Report to a Shared Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Creating Your Own Folder for Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Available Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 6 Managing the SmartCell Insight System Setting Administrator Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Accessing the Administration Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Getting Familiar with the Administration Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Monitor Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 System Setup Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Sources Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 AP Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 System Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Diagnostics Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Changing the Administrator Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 SCI Upgrade Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Hostname Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 SCI Uninstall Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 SCI Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 SCI AP Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Uploading an SCI License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 System Timekeeping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Using the Enterprise Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Creating Users and Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Using the Scheduler to Define Public Schedules for Custom Reports. . . . . . . . . . . . . 129 6 Ruckus Wireless, Inc. 7 Troubleshooting the SmartCell Insight Application Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Architecture Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Using the SCI Admin Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 The Monitoring Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 The Diagnostics Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Job Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Capture Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Backup Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Backup and Restore Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Uninstall Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Troubleshooting the Vertica Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Using the Vertica Troubleshooting Admin Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Recovering the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 8 Appendix Appendix A: Station Session Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Appendix B: Virtual AP Transmission and Reception Statistics . . . . . . . . . . . . . . . . . . . 155 Appendix C: Aggregation of Measurements by ZoneDirector . . . . . . . . . . . . . . . . . . . . 159 Index SmartCell Insight User Guide, 800-71041-001 Rev A 7 8 Ruckus Wireless, Inc. About This Guide This User Guide provides information on installation, configuration and management of the Ruckus Wireless™ SmartCell Insight (SCI) application. Topics covered in this guide include SCI introduction, built-in report generation, custom report creation, application management and lists of metrics available for reporting. This guide is intended for use by those responsible for managing Ruckus Wireless network equipment. Consequently, it assumes a 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 Web site at https://support.ruckuswireless.com/documents. SmartCell Insight User Guide, 800-71041-001 Rev A 9 Document Conventions Document Conventions Table 1 and Table 2 list the text and notice conventions that are used throughout this guide. Table 1. Convention Description monospace Represents information as it [Device name]> appears on screen monospace bold Represents information that [Device name]> set you enter ipaddr 10.0.0.12 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. 10 Text conventions 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 Ruckus Wireless, Inc. Related Documentation Related Documentation In addition to this User Guide, each SmartCell Insight documentation set includes the following: • Installation Guide: Provides detailed information on how to install SmartCell Insight. The Installation Guide is available for download on the Ruckus Wireless Support Web site at http://support.ruckuswireless.com. • SCI ISO Installation Guide: Provides simplified instructions for installation using an ISO file that combines CentOS installation and SCI installation in an easier format, reducing the number of steps required for the OS installation. • Release Notes: Provide information about the current software release, including new features, enhancements, and known issues. 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: • SmartCell Insight User Guide Release 1.4 • Part number: 800-71041-001 Revision A • Page 88 SmartCell Insight User Guide, 800-71041-001 Rev A 11 Documentation Feedback 12 Ruckus Wireless, Inc. Introducing SmartCell Insight 1 In this chapter: • Introducing SmartCell Insight • Overview • Off-the-shelf value and easy to use • Capabilities • Greater Network Visibility SmartCell Insight User Guide, 800-71041-001 Rev A 13 Introducing SmartCell Insight Overview Introducing SmartCell Insight Overview SmartCell Insight (SCI) is a massively scalable reporting and analytics engine, designed to collect data from Ruckus network equipment, analyze that data, and then present it using a wide variety of standard and custom reports. Off-the-shelf value and easy to use To facilitate immediate value, SmartCell Insight ships with pre-built reports that solve the most common use cases faced by Engineering, Operations, and Planning organizations. These reports cover themes such as traffic usage, client and session measurement, equipment uptime, network latency, etc. For example, some of the reports can highlight the most heavily utilized devices by both the number of subscribers as well as traffic load. If these reports are not sufficient or need to be tweaked, then additional reports can be generated on site. Using any standard browser, network operators can create reports on the fly and get a deep insight into any Key Performance Indicator (KPI) that network equipment exposes to northbound systems. For example, compare subscriber equipment distribution (i.e., iPhone vs. Android vs. Windows Phone) market share growth today compared to last month or last year. Capabilities SmartCell Insight can collect data from the entire line of Ruckus Access Points (APs) along with the ZoneDirectors (ZDs), FlexMasters (FMs), or SmartZone (SZ) controllers. This data can be aggregated in an offline columnar database, which has been optimized for very high volume data retention and quick response time. Ruckus SmartCell Insight can provide a feed to upstream OSS/BSS applications using a wide variety of interfaces. This allows for further analysis of data collected in the WiFi RAN by upstream systems. Greater Network Visibility Getting the most from a carrier WiFi network, once deployed, requires clear visibility into its performance and user activity, both at a very granular level of detail as well as aggregated to measure global trends spanning many years. 14 Ruckus Wireless, Inc. Introducing SmartCell Insight Acronyms Used in This Document Operators need this level of visibility to assess the network’s achievement of their business objectives. These include user experience metrics, traffic load on the WiFi RAN, network uptime, etc. SCI leverages two emerging trends: Firstly, Mobile Internet usage patterns, RAN strategies, and service models are all evolving rapidly, so the visibility required to address these questions must extend beyond typical short-horizon EMS/NMS health and statistics to enable long-term trend analysis that supports network and service evolution planning. With exploding volumes of users, devices, traffic, and radio nodes deployed, these two requirements spell a real scaling challenge for any network measurement and assessment tool. Secondly, the emergence of Big Data brought to market by many popular applications that facilitate the collection, storage, and efficient retrieval and analysis of data. These technologies, in SCI, have been brought to the management of network equipment resulting in a comprehensive offering that can facilitate additional capabilities in future releases. Ruckus’ development of SmartCell Insight, similar to the development of SmartZone, takes whole new approach to measurement and assessment, designed specifically to provide the visibility, trend analysis, and raw scale required to manage a successful carrier WiFi network. The design of SmartCell Insight is informed by our experience powering the world’s largest and most advanced WiFi networks. Acronyms Used in This Document Table 1lists the acronyms used in this document. Table 1. Acronyms Acronym Description A-MDPU aggregated MPDU (feature of an HT AP or STA) A-MSDU aggregated MSDU (feature of an HT AP or STA) AMRI aggregate measurement reporting interval AP access point BSS basic service set CCA clear channel assessment [threshold] (when any received signal is above this threshold, the RF channel is considered "busy" by an 802.11compliant transmitter). CDF cumulative distribution function SmartCell Insight User Guide, 800-71041-001 Rev A 15 Introducing SmartCell Insight Acronyms Used in This Document Table 1. 16 Acronyms Acronym Description CSV comma separated values [file] DA destination [MAC] address DHCP dynamic host configuration protocol; DHCPv4 is DHCP for IPv4 and DHCPv6 is DHCP for IPv6. DMS directed multicast service (see [1]) DNS domain name system eMAP mesh AP having another MAP plugged into its [local] Ethernet interface ETL extract, transform and load FC frame control (field in 802.11 MAC header, see [1]) FCS frame check sequence GCR groupcast with retries (see [5]) HT high throughput (aka 802.11n, see [1]) IE information element MAC medium access control [layer] MAP mesh AP mDNS multicast DNS MI measurement interval MMPDU MAC management protocol data unit (see [1]) MPDU MAC protocol data unit (the MAC header plus payload plus FCS, see Figure 8-1 in [1]) MSDU MAC service data unit (the payload of the MPDU) MTU maximum transmission unit (longest frame/packet which can be transmitted on a link/path without fragmentation) NTP network time protocol OS operating system PHY physical [layer] PLCP physical layer convergence procedure (see [1]) QoS quality of service RAP root AP (mesh AP connected to the wired infrastructure) Ruckus Wireless, Inc. Introducing SmartCell Insight Acronyms Used in This Document Table 1. Acronyms Acronym Description RRM radio resource measurement SZ SmartZone (AP controller) SCI smart cell insight (analytics appliance) SIFS short inter-frame space (see [1]) SINR signal to interference plus noise ratio SLAAC [IPv6] stateless auto-configuration SNR signal to noise ratio STA IEEE 802.11 station VAP virtual AP (aka a BSS in IEEE 802.11 nomenclature) ZD ZoneDirector (AP controller) References: 1 IEEE 802.11-2012, Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications. 2 IEEE 802.2-1998, Part 2: Logical Link Control. 3 RFC-2865, Remote Authentication Dial In User Service (RADIUS), Rigney, Willens, Rubens and Simpson, June 2000. SmartCell Insight User Guide, 800-71041-001 Rev A 17 Introducing SmartCell Insight Acronyms Used in This Document 18 Ruckus Wireless, Inc. Installing the SmartCell Insight Application 2 In this chapter: • Installation Overview SmartCell Insight User Guide, 800-71041-001 Rev A 19 Installation Overview Installation Overview The standard SmartCell Insight package is distributed as a .tar compressed file designed to be installed on a CentOS or Red Hat Enterprise Linux (RHEL) server. For complete installation instructions, see the SmartCell Insight Installation Guide, available from support.ruckuswireless.com. Additionally, SCI is also distributed as an ISO image that contains the SCI application and the OS installation in one to provide a simpler system setup and installation process. The ISO installation method has some limitations however. Please refer to the SmartCell Insight ISO Package Installation Guide for more information. The steps are outlined below for your reference. NOTE: You must perform the installation as detailed in the SCI Installation Guide or the SCI ISO Installation Guide. This installation overview is for reference only. 1 Prepare the hardware for installation. 2 Install CentOS/Redhat Enterprise Linux exactly according to the instructions in the Installation Guide. Failure to do so will result in failure to install SCI properly. 3 Install SCI. 4 Install licenses. 5 Configure ZoneDirector, FlexMaster and/or SmartZone data sources. 20 Ruckus Wireless, Inc. Navigating the SmartCell Insight User Interface 3 In this chapter: • Accessing the SCI User Interface • Getting Familiar with the SCI User Interface • Interacting with Workspace Elements • Scheduling Email Report Delivery for Custom Reports SmartCell Insight User Guide, 800-71041-001 Rev A 21 Accessing the SCI User Interface Accessing the SCI User Interface After you have completed the installation procedures according to the instructions in either the SCI Installation Guide or the SCI ISO Installation Guide, and configured your SmartZone or ZoneDirector controller data sources (as described in Sources Configuration), you can begin using SCI to monitor your wireless networks after approximately 15 minutes. (The reporting interval for many of the data sets reported by ZoneDirector and SmartZone controllers is 15 minutes). To begin using the SCI reporting interface: 1 Point your browser to: https://[SCI-IP-Address] and press Enter. 2 Enter your User Name and Password, and click Login. NOTE: SCI supports Chrome and Firefox browsers. Internet Explorer is not recommended. Figure 1. Log into the SCI reporting interface 22 Ruckus Wireless, Inc. Getting Familiar with the SCI User Interface Getting Familiar with the SCI User Interface The SmartCell Insight User Console interface consists of 6 main elements, as shown in Figure 2. For a description of each UI element, see Table 2. Figure 2. SmartCell Insight Web interface elements 1 2 3 4 6 5 Table 2. SCI User Console Web interface elements Number Description 1 Menu: Contains Logout, Refresh and Help menu items 2 Action icons: • Workspace: Open the My Workspace view, which shows reports that you have submitted to run in the background on the server. You can cancel reports that have not run yet or view or delete completed reports. • Toggle Browser: Toggle the Report and Files browser panels. • New Analyzer Report: Create a new analyzer report. Clicking this button launches the report creation view. 3 Tabs: Displays the windows that are currently open. Click the “x” icon next to a tab name to close the window. SmartCell Insight User Guide, 800-71041-001 Rev A 23 Interacting with Workspace Elements Table 2. SCI User Console Web interface elements Number Description 4 Report browser panel: Use this panel to select which category of report or dashboard to view. 5 Files browser panel: Use this panel to select the individual report/ dashboard to view in the workspace. 6 Workspace: This large area is used to display the report you are currently viewing, or to create and manage custom reports. See Using the Ruckus Dashboards and Using the Ruckus Reports for more information. Interacting with Workspace Elements The Workspace is used for viewing and manipulating reports. Table 3 lists the tools you can use to produce, deliver and interact with dashboards and other built-in reports displayed in the workspace. Figure 3. Report workspace elements 2 1 3 4 24 5 Ruckus Wireless, Inc. Interacting with Workspace Elements Viewing AP Details Table 3. Report workspace elements Number Description 1 Report overview 2 Export this report: • Print this report. • Download as PDF file. • Send this report by email. • Schedule email delivery of this report (see Scheduling Email Report Delivery for Custom Reports for more information on custom report delivery). 3 Filters: Use the drop-down menus to filter the report contents by reportspecific fields. 4 Graph: Select an area on the graph to zoom. Click Reset Zoom to reset. 5 Pie chart: Click a segment of the pie chart to view an exploded view with the selected segment detached. Viewing AP Details You can view specific details on an individual Access Point by clicking on its bar in bar chart type reports. The “AP Info” pop-up includes the AP name, description, IP address, MAC address and location coordinates. Additionally, you can click the Map link to display the AP’s location on Google Maps. You can also click the Open AP Response Time report link to open a report on the individual AP’s response time. SmartCell Insight User Guide, 800-71041-001 Rev A 25 Scheduling Email Report Delivery for Custom Reports Viewing AP Details Figure 4. Click an AP’s bar to display details on the specific AP Scheduling Email Report Delivery for Custom Reports For custom reports, you can schedule email report delivery using the Options pulldown menu from the Files browser panel. To do so, use the following procedure: 1 Select the report for which you want to schedule email delivery from the Files browser panel. 2 Click the Options icon, and select Schedule.... 3 In the New Report Schedule dialog that appears, enter an email subject in the Subscription/Subject field, and enter comma separated destination addresses in the Email To field. 4 Select Report Type (PDF, XLS or CSV) and Public Schedule. 5 Click Schedule to confirm. 26 Ruckus Wireless, Inc. Scheduling Email Report Delivery for Custom Reports Viewing AP Details Figure 5. Scheduling email report delivery for custom reports Figure 6. Scheduling email report delivery for custom reports (2) SmartCell Insight User Guide, 800-71041-001 Rev A 27 Scheduling Email Report Delivery for Custom Reports Viewing AP Details 28 Ruckus Wireless, Inc. Using Dashboards and Built-In Reports 4 In this chapter: • Using the Ruckus Dashboards • Using the Ruckus Reports • Client and Session Reports • Inventory Reports • Operational Reports • Traffic Reports SmartCell Insight User Guide, 800-71041-001 Rev A 29 Using the Ruckus Dashboards Network Health Dashboard Using the Ruckus Dashboards The Ruckus Dashboards (Network Health Dashboard, Client Health Dashboard and Usage Distribution and Trends Dashboard) provide a convenient at-a-glance overview of multiple sets of key network status information in a grid layout. Ruckus Dashboards contain general network and client statistics such as AP traffic volume, number of connected clients, session duration and client OS/manufacturer. Network Health Dashboard The Network Health Dashboard provides a general overview of the entire network using aggregated summary statistics collected by SCI, and consists of four components: AP Traffic, Number of Unique Clients, Sessions per Radio and Top 10 APs by Traffic Volume. Each of these reports can be filtered by date, system name, controller, AP group, AP, SSID, radio and session type (authorized vs. unauthorized). The “Top 10 APs by Traffic Volume” displays your top 10 APs in a map view, allowing you to zoom in on an area of interest, locate specific APs and quickly find basic information about an AP such as its MAC address, IP address and serial number, along with a link to the AP’s traffic report. Figure 7. The Network Health Dashboard 30 Ruckus Wireless, Inc. Using the Ruckus Dashboards Network Health Dashboard Starting and Stopping Auto-Refresh The Auto Refresh button at the top right corner of the dashboard allows you to manually or automatically refresh the page. Auto-refresh is disabled by default. When enabled, the automatic refresh interval is 15 minutes. Figure 8. Starting and stopping Auto-Refresh Using the Map View The map-based “Top 10 APs by Traffic Volume” dashboard report provides an overview of the top 10 APs by physical location, allowing you to quickly locate and troubleshoot a specific device. SmartCell Insight User Guide, 800-71041-001 Rev A 31 Using the Ruckus Dashboards Network Health Dashboard Figure 9. Using the Map View Hovering over an AP on the map displays its name, MAC address and traffic volume. Clicking the AP icon displays more information, including description, Serial Number, map coordinates and a link to the Individual AP Traffic Report. Figure 10. Display more AP details 32 Ruckus Wireless, Inc. Using the Ruckus Dashboards Client Health Dashboard Examples of how the Network Health Dashboard could be used by network administrators: • Used to quickly and easily compare traffic volume and connected clients over time. • Used to compare numbers of clients connected on 2.4 or 5 GHz radios. • Used to identify APs by geographic location. Client Health Dashboard The Client Health Dashboard displays an overview of client information such as session duration, traffic volume, throughput estimate and OS/manufacturer charts. It consists of four client-based reports: Session Duration, Session Traffic Volume, Throughput Estimate of Clients and Manufacturers/Operating Systems. Each of these reports can be filtered by date, system name, controller, AP group, AP, SSID, and radio. Figure 11. Client Health Dashboard - top You can hover over a section of a pie chart in the client Manufacturers/Operating Systems report to view the actual client count and percentage of the total for each device manufacturer or OS. SmartCell Insight User Guide, 800-71041-001 Rev A 33 Using the Ruckus Dashboards Usage Distribution and Trends Dashboard Figure 12. Client Health Dashboard - bottom Examples of how the Client Health Dashboard could be used by network administrators: • Used to identify the device types on the WiFi network over time. • Used to identify average session durations, so that you can understand how much time users are spending connected your WiFi networks. • Used to discover which APs and controllers are being used most often, what time of day or days of the week your networks are most congested, and the difference between number of authorized vs. unauthorized clients. • Used to display the general performance experience connected clients are likely to have. Usage Distribution and Trends Dashboard The Usage Distribution and Trends Dashboard enables network administrators to view WiFi usage trends by comparing data between two equal-length time periods. These reports can be used to compare data such total traffic, unique clients, session length, AP traffic, minutes of use and number of APs grouped by location, SSID or AP group. The graphs can be further filtered to display statistics grouped by controller, and to display either the top 10 or bottom 10 sets of data for each graph. 34 Ruckus Wireless, Inc. Using the Ruckus Dashboards Usage Distribution and Trends Dashboard Figure 13. Usage Distribution and Trends Dashboard - top Figure 14. Usage Distribution and Trends Dashboard - middle The dashboard also displays a table showing the following KPIs per each group (AP Group, AP Location, SSID), during the two periods, and the change, in percent, between the periods: SmartCell Insight User Guide, 800-71041-001 Rev A 35 Using the Ruckus Dashboards Usage Distribution and Trends Dashboard • AP -> User Traffic • User -> AP Traffic • Total Traffic (sum of two previous KPIs) • Number of Unique Clients • Number of Sessions • Average Session Length • Minutes of Use • Average Minutes of Use Per Client • Number of APs Some of these KPIs are hidden by default, in order to not clutter the screen. You may show/hide them by selecting the relevant check box at the table header. You may sort each KPI or its delta by clicking on the column header of the KPI, and reverse the sort order by clicking again. You may click-through some of the KPIs into other reports, filtered for the same group. When that is possible, the mouse cursor will change to a pointer when you hover over these KPIs. You may click on the group name (left-most column) in order to drill down to perAP views of all the above KPIs. Figure 15. Usage Distribution and Trends Dashboard - bottom 36 Ruckus Wireless, Inc. Using the Ruckus Reports Usage Distribution and Trends Dashboard Using the Ruckus Reports In addition to the Ruckus Dashboards, which contain combined views of several reports, SCI comes with a number of detailed reports to help you gain deeper insight into your network statistics using a wide variety of common use cases for analyzing network capacity, traffic trends, client statistics and device inventories. In addition to the built-in reports, you can also create your own custom reports using any of the data provided by your data sources to SCI, as detailed in Configuring Custom Reports. For detailed descriptions of the statistics used in calculating client session, AP transmission and aggregated statistics reports, see the relevant sections in the “Appendix” on page 147. The following key assessments can be made using these built-in Ruckus Reports: • Network capacity, carried traffic and utilization • User experience (getting on the network, connection speed - simple high/low/ average & CDF views) • User activity (devices, applications, sessions, bandwidth) • AP behavior (channel changes, meshing, band steering, load balancing) • Network operating conditions (interference sources) • Usual network mechanics (uptime, alarms, etc.) • Capability to view stats at multiple layers (AP, radio, SSID) and session Table 4 lists the built-in reports that SCI provides. The reports are organized according to the following categories: • Client and Session Reports • Inventory Reports • Operational Reports • Traffic Reports SmartCell Insight User Guide, 800-71041-001 Rev A 37 Using the Ruckus Reports Client and Session Reports Table 4. SCI Reports Category Reports Client and Session Reports Client Fingerprint First Experience of New Clients Number of Sessions Number of Unique Clients Session Bytes Transferred Session Duration Top Clients by Traffic Volume Inventory Reports AP Inventory Controller Inventory Session Inventory Operational AP Groups Response Time Trend Reports AP Response Time Controller Hardware Utilization Distribution of APs by Model Rogue APs Top APs with Most Topology Changes Top AP Reboots Top APs with the Longest Response Time Traffic Reports Access Point Traffic Client Potential Throughput Throughput Estimate of Clients Top APs by Traffic Volume Client and Session Reports Client and Session Reports include number of sessions, session duration, client device type and traffic volume of the most active clients. • Client Fingerprint • First Experience of New Clients • Number of Sessions 38 Ruckus Wireless, Inc. Using the Ruckus Reports Client and Session Reports • Number of Unique Clients • Session Bytes Transferred • Session Duration • Top Clients by Traffic Volume Client Fingerprint This report provides a list of the manufacturers of the mobile devices on the WiFi network along with their OS type during a specific time interval. Examples of how this report could be used by network administrators: • Used to identify the device types on the WiFi network. Figure 16. Client Fingerprint report First Experience of New Clients This report displays statistics about the user experience of the first connection for new clients, including average session duration, noise floor, RSSI and potential throughput. SmartCell Insight User Guide, 800-71041-001 Rev A 39 Using the Ruckus Reports Client and Session Reports Examples of how this report could be used by network administrators: Some service providers have conducted studies which show that if the user’s first experience is good, then the user tends to return and remain as a customer in the long run. Therefore, if metrics show a correlation between session duration and signal strength for new subscribers, then SCI can analytically predict where low RSSI will lead to customer satisfaction issues. Notes: • A new subscriber is one in which this report is for the first time they were observed associated to the WLAN. SCI keeps a database of MAC addresses and detects the existence of statistics for new mobile devices, not in the database. Mobile devices thus detected are then selected for inclusion into the CSV file based on being joined to a particular controller, AP, AP group, SSID or radio. • Each record in the CSV file contains the mobile devices’ MAC address, authentication time, association time, session end time, client throughput, SNR+RSSI statistics and serving AP. • APs measure the SNR and noise floor on frames received from associated STAs. That is, uplink SNR is measured; downlink SNR is not reported by STAs nor is it estimated (in SCIv1.0) by APs. From these measurements RSSI is computed as RSSI (dBm) = SNR (dB) + NFE (dBm), where NFE = a noise floor estimate produced by the WiFi silicon. Note that while the SNR measurement is quite accurate, the NFE is an uncalibrated estimate. Therefore, the error in the RSSI value can be significant (several dB). • Ruckus APs use BeamFlex technology. Indoor Ruckus APs employ omnidirectional BeamFlex antennas (which can be controlled by BeamFlex algorithms to have omni-directional or directional patterns). Outdoor APs can have either omni-directional or directional antennas. The –N SKUs have two 30° beamwidth directional antennas and do not use BeamFlex technology; the gain of a single, 30° beamwidth antenna is ~11dB greater than an omni-directional antenna. The –S SKUs have two or three ~120° sector antennas and employ BeamFlex technology; each sector antenna has a gain ~5dB higher than the gain of an omni-directional antenna. Therefore for given set of link conditions, different SKUs will produce different RSSI values. • BeamFlex algorithms cause each AP antenna to have an approximately omnidirectional pattern when receiving WiFi signals. However, when transmitting WiFi signals, the BeamFlex algorithm will typically control the antennas to have a directional pattern, producing several dB of gain compared to an omni-direc- 40 Ruckus Wireless, Inc. Using the Ruckus Reports Client and Session Reports tional pattern. Thus, the antenna gain in the downlink direction is typically different/higher than in the uplink direction. In addition, Ruckus APs usually have a higher transmitter power capability than STAs. The combination of higher transmitter power and higher antenna gain means that the received SNR at the STA (downlink direction) will typically be 3-6 dB higher than at the AP (uplink direction). This typically results in higher PHY rates in the downlink direction than in the uplink direction. In terms of user experience, higher downlink RSSI is better for the user because for many web services, the perceived quality is based on the time waiting for web pages to arrive. Figure 17. First Experience of New Clients report Number of Sessions The Number of Sessions report displays sessions per radio over time, authorized vs. unauthorized clients, and session distribution per radio (2.4 GHz vs. 5 GHz). Examples of how this report could be used by network administrators: • Used to analyze the number of devices on the network at any given time. Can be applied to network dimensioning, looking at possible revenue (e.g., from SPoT or advertising), etc. SmartCell Insight User Guide, 800-71041-001 Rev A 41 Using the Ruckus Reports Client and Session Reports Notes: • A user may have multiple devices on the network, e.g., an iPhone and iPad. In this case, the number of sessions would be reported as 2 (devices), not 1 (user). • A user may have one device on the network at two different times (e.g., from 1:03pm to 1:08pm and 2:25pm to 2:45pm). In this case, the number of sessions would be reported as 2 (sessions), not 1 (user). Figure 18. Number of Sessions report Number of Unique Clients This report displays the total number of unique subscriber devices during a specific time interval and which radio they are connected to. Examples of how this report could be used by network administrators: • Used to analyze the number of unique subscriber devices using WiFi. Can also be used in conjunction with other reports to determine average number of devices/subscription. Notes: • A mobile device can associate to the WLAN during different time intervals and thus have multiple sessions. The device’s MAC address is used to bind these multiple sessions together. 42 Ruckus Wireless, Inc. Using the Ruckus Reports Client and Session Reports Figure 19. Number of Unique Clients report Session Bytes Transferred This report shows cumulative unicast traffic volume transmitted to or received by VAPs from STAs whose sessions begin and end during a specific time interval. In addition, the report shows a CDF of cumulative session traffic. Examples of how this report could be used by network administrators: • Track the session usage to determine how much traffic and where users are consuming data. Notes: • Included in session bytes are the number of bytes in successfully transmitted MSDUs. SmartCell Insight User Guide, 800-71041-001 Rev A 43 Using the Ruckus Reports Client and Session Reports Figure 20. Session Bytes Transferred report Session Duration This report is a cumulative distribution function (CDF) of the mobile devices’ session durations that exceed a user-specified duration which occurred during a given time interval. The session duration length is defined by the user. Examples of how this report could be used by network administrators: • Used to analyze how long users are on the network. Service delivery can then be optimized accordingly. 44 Ruckus Wireless, Inc. Using the Ruckus Reports Client and Session Reports Figure 21. Session Duration report Top Clients by Traffic Volume This report shows top N mobile devices having the greatest cumulative unicast traffic volume transmitted to or received from a VAP during a specific time interval. The data is represented as a Cumulative Distribution Function (CDF). Examples of how this report could be used by network administrators: • Track high-volume users, identify their subscriptions and potentially target for throttling or band steering. • Discover natural “break points” in usage patterns. Make consequent future subscription price adjustments or set data caps. SmartCell Insight User Guide, 800-71041-001 Rev A 45 Using the Ruckus Reports Client and Session Reports Figure 22. Top Clients by Traffic Volume report 46 Ruckus Wireless, Inc. Using the Ruckus Reports Inventory Reports Inventory Reports Inventory reports consist of AP, Controller and Session inventories. • AP Inventory • Controller Inventory • Session Inventory AP Inventory This report shows the list of all currently reachable APs in the WiFi network connected to a ZD or SmartZone controller during a given time interval. Examples of how this report could be used by network administrators: • Used to ensure all the APs in the network are administratively and operationally online and enabled. Notes: • The following data is included in the report for each AP: name, serial number, model type (e.g., ZF-7982), MAC address, IP address, external IP address, last connection time, connected controller, location (string), latitude/longitude (if available) and uptime. • The SZ version of this report will be provided in a future release. • Click the “Globe” icon ( SmartCell Insight User Guide, 800-71041-001 Rev A )to view the AP on Google Maps. 47 Using the Ruckus Reports Inventory Reports Figure 23. AP Inventory report Controller Inventory The Controller Inventory report displays the currently reachable controllers in the WiFi network. Examples of how this report could be used by network administrators: • Used to ensure all the controllers in the network are administratively and operationally online and enabled. • The following data is included in the report for each controller: name, SW version, MAC address, IP address, unique clients, connected APs, number of licenses and maximum license utilization. Notes: • The SZ version of this report will be provided in a future release. 48 Ruckus Wireless, Inc. Using the Ruckus Reports Inventory Reports Figure 24. Controller Inventory report Session Inventory This report is a CSV file which provides a session log for a set of mobile devices during a given time interval. Examples of how this report could be used by network administrators: • Used to analyze usage statistics using SP defined method; method takes CSV file as input. Notes: • Each record in the CSV file contains the mobile devices’ MAC address, device type, OS type, authentication time, association time, session end time, downstream / upstream bytes transferred and serving AP. • Mobile devices are selected based on being joined to a particular controller, AP, AP group, SSID or radio. SmartCell Insight User Guide, 800-71041-001 Rev A 49 Using the Ruckus Reports Inventory Reports Figure 25. Session Inventory report This table can be filtered using the search button and searching for clients by MAC address. Figure 26. Filtering session inventory by client MAC address 50 Ruckus Wireless, Inc. Using the Ruckus Reports Operational Reports Operational Reports Operational Reports provide information on system operation statistics, such as AP response time, controller hardware resource utilization, and top 10 lists of AP reboots and topology changes. • AP Groups Response Time Trend • AP Response Time • Controller Hardware Utilization • Distribution of APs by Model • Rogue APs • Top APs with Most Topology Changes • Top AP Reboots • Top APs with the Longest Response Time AP Groups Response Time Trend This report shows the Trend of Access Points Response Time (ping), averaged across each AP Group. It can be used to observe cases where the latency of a whole AP Group got worse (or later on, got better, if you took corrective measures) compared to another baseline period. The causes of increased latency could be due to network congestion, faulty hardware, software failure, misconfiguration, etc. You can click on each AP Group in the table to drill down and see the change per AP within the AP Group. Examples of how this report could be used by network administrators: • AP group response times can be used to compare average ping times for an entire AP group over time, allowing the network administrator to see when changes to the network result in increased or decreased latency. SmartCell Insight User Guide, 800-71041-001 Rev A 51 Using the Ruckus Reports Operational Reports Figure 27. AP Groups Response Time Trend report AP Response Time This report shows the ping latency between the SCI and an AP during a specific time interval. Examples of how this report could be used by network administrators: • High latency and missing ping responses between the AP and SCI can be used to identify congested links or overloaded/mis-configured switches/routers. Notes: • Ping latency measured between AP and SCI was used due to the lack of a ping server on the SZ. Note: the SCI may not be on the “normal” data path taken by user traffic to/from a destination network. Therefore, this statistic’s relevance may be limited for some deployments. 52 Ruckus Wireless, Inc. Using the Ruckus Reports Operational Reports Figure 28. AP Response Time Individual AP Response Time Report To view a response time report for an individual AP, click on its bar in the chart, then click the Open AP Response Time report link. Figure 29. Click the link to view an individual AP’s response time report SmartCell Insight User Guide, 800-71041-001 Rev A 53 Using the Ruckus Reports Operational Reports The Response Time report for an individual AP provides the same filter options as the Top N APs With the Longest Response Time report, with the exception of the Access Point filter rather than the number of APs to display filter. Figure 30. Viewing an individual AP’s response time report Controller Hardware Utilization This report shows a ZD or SZ (see note) controller’s CPU, memory and disk utilization during a specific time interval. Examples of how this report could be used by network administrators: • Used to predict when a controller will no longer have sufficient processing resources to adequately handle all its joined AP and users. • Used to identify a software bug (e.g., memory leak or bug causing high CPU utilization). 54 Ruckus Wireless, Inc. Using the Ruckus Reports Operational Reports Figure 31. Controller Hardware Utilization report Distribution of APs by Model This report displays the number of each AP model deployed over time. The AP Models over Time graph can be used to track a deployment as it grows, and see which AP models are increasing and decreasing over time. The pie chart provides a snapshot of the current deployment, displaying the model distribution. Examples of how this report could be used by network administrators: • Used by WiFi managers to show the rate of growth and to compare against Ruckus AP licenses. This report could be run monthly or quarterly by the admin to compare against the contracts that they've signed with Ruckus. • When an issue arises with a particular model, the WiFi administrators will know how many APs of that model they have deployed. SmartCell Insight User Guide, 800-71041-001 Rev A 55 Using the Ruckus Reports Operational Reports Figure 32. Distribution of APs by Model Rogue APs This report can help admins locate and protect the network from malicious APs, maintain data on rogue devices over time, and satisfy legal requirements for wireless security practices. The report displays various types of rogue BSSIDs of rogue APs. Tips • Click on a bar chart to filter the table by rogue AP type. • Click on a table row for details on the AP that is detecting the rogue device. • Click on the Show AP Info icon at the Reporting AP MAC column of an AP for details on the AP that is reporting the rogue BSSID. Notes • Report shows data coming from ZoneDirector only. • The AP Groups filter selects the AP Groups of the APs that reported the rogue BSSID". • Chart shows distinct rogue BSSIDs. 56 Ruckus Wireless, Inc. Using the Ruckus Reports Operational Reports Examples of how this report could be used by network administrators: • An IT Administrator can run this report periodically and go out to locate and disconnect any offending rogue APs when found. • This report can be run over a longer period to show all the events that occurred and demonstrate that the IT Administrator was diligent in finding and fixing the issues. Figure 33. Rogue APs Top APs with Most Topology Changes This report shows which mesh APs had the most topology change events during a given time interval. Examples of how this report could be used by network administrators: • Used to identify mesh APs having deployment issues needing remediation. SmartCell Insight User Guide, 800-71041-001 Rev A 57 Using the Ruckus Reports Operational Reports Figure 34. Top APs with Most Topology Changes Top AP Reboots This report shows which APs have been administratively or autonomously rebooted the most during a given time interval. Examples of how this report could be used by network administrators: • Used to identify APs having hardware or software defects. • Used to identify APs succumbing to attackers. 58 Ruckus Wireless, Inc. Using the Ruckus Reports Operational Reports Figure 35. Top 10 AP Reboots report Top APs with the Longest Response Time This report shows the APs having the greatest ping latency between themselves and the SCI during a specific time interval. Examples of how this report could be used by network administrators: • Identify paths in the wired/wireless network having performance problems. • In mesh networks, identify mesh APs having excessive interference or supporting too many downlink mesh APs (e.g., poor mesh topology). SmartCell Insight User Guide, 800-71041-001 Rev A 59 Using the Ruckus Reports Operational Reports Figure 36. Top APs with the Longest Response Time report 60 Ruckus Wireless, Inc. Using the Ruckus Reports Traffic Reports Traffic Reports Traffic Reports consist of actual AP and client throughput reports as well as client throughput potential and top APs by traffic volume. • Access Point Traffic • Client Potential Throughput • Throughput Estimate of Clients • Top APs by Traffic Volume Access Point Traffic This report provides the cumulative volume of unicast traffic transmitted to or received from mobile devices associated to any WLAN on a physical AP for a specific time interval. Note that the reported traffic is actually traffic density (traffic/time); the value of the traffic reported is scaled to the time dimension on the x-axis of the graph (e.g., traffic/15-min, traffic/hour, traffic/day). The graph displays user traffic only by default. Select Mgmt Rx by AP or Mgmt Tx by AP to display management receive/transmit traffic. Examples of how this report could be used by network administrators: • How busy the AP is with traffic to/from users (includes unicast/multicast packets). • How much traffic is uploaded vs. downloaded. • Find network locations which are the busy areas. • View the relative proportion of total traffic (user + management) to management traffic. Notes: • Data used to create the report includes STA session statistics from all VAPs configured on a [physical] AP. • Includes both 2.4- and 5-GHz radios (if present) on an AP. • Includes the following traffic: • IP datagrams carrying client traffic. • Non IP, layer-3 packets. • Network-layer management traffic a STA needs to access network resources • Data link layer traffic above the 802.11 MAC). SmartCell Insight User Guide, 800-71041-001 Rev A 61 Using the Ruckus Reports Traffic Reports • Mesh AP backhaul traffic. • Includes 802.11 management frame traffic. Figure 37. Access Point Traffic report Client Potential Throughput The Client Potential Throughput report displays the saturated RF channel capacity between an AP radio and given STA. The saturated throughput can be thought of as the throughput an AP would achieve if there were a continuous stream of data for only this STA given the achievable over-the-air PHY layer data-rate and the local interference environment on the RF channel. Examples of how this report could be used by network administrators: • The report can be used to determine how much capacity is available to subscribers at that location at that time of day. If throughputs are low in a given area, it can indicate there is foreign interference present or too much 802.11 interference. The 802.11 interference could come from surrounding ESSs (i.e., not the ESS being analyzed by SCI) or self interference. • The report can be used to see if there is sufficient bandwidth available to subscribers and if the numbers are low, perhaps it’s a candidate for adding additional APs or moving the location, etc. 62 Ruckus Wireless, Inc. Using the Ruckus Reports Traffic Reports Figure 38. Client Potential Throughput report Throughput Estimate of Clients The Throughput Estimate of Clients report displays the devices with the greatest cumulative unicast and multicast traffic volume transmitted to or received during a specific time interval. The data is represented as a Cumulative Distribution Function (CDF). Examples of how this report could be used by network administrators: • Provides a measure of network performance by identifying the top throughput speeds possible for users. • Can be used in conjunction with Client Fingerprint report to determine the best performing mobile devices in the WLAN. SmartCell Insight User Guide, 800-71041-001 Rev A 63 Using the Ruckus Reports Traffic Reports Figure 39. Throughput Estimate of Clients report Top APs by Traffic Volume This report shows the physical APs having the greatest cumulative volume of unicast and multicast traffic transmitted to or received from mobile devices associated to any of its WLANs during a specific time interval. The pie chart represents what percentage of the total traffic in the network is consumed by the N APs. The default value for N is 10. Examples of how this report could be used by network administrators: • Find the busiest APs and locations in the network. 64 Ruckus Wireless, Inc. Using the Ruckus Reports Traffic Reports Figure 40. Top APs by Traffic Volume report Individual AP Traffic Report To view a traffic report for an individual AP, click on its bar in the chart, then click the Open Access Point Traffic report link. Figure 41. Click the link to view an individual AP’s traffic report SmartCell Insight User Guide, 800-71041-001 Rev A 65 Using the Ruckus Reports Traffic Reports The Access Point Traffic report for an individual AP provides the same filter options as the Top N AP traffic report, with the exception of the Access Point filter rather than the number of APs to display filter. Figure 42. Viewing an individual AP’s traffic report 66 Ruckus Wireless, Inc. Configuring Custom Reports 5 In this chapter: • Overview of Custom Report Creation • Creating a New Report • Available Metrics SmartCell Insight User Guide, 800-71041-001 Rev A 67 Overview of Custom Report Creation Overview of Custom Report Creation This chapter describes the procedures for creating custom reports using the New Analyzer Report feature. This feature allows you to query the data in a database without having to understand how the database is structured. You can drill down into the data to discover details that may help you make important business decisions. The Analyzer presents data multi-dimensionally and lets you select which dimensions and measures you want to explore. The Report Analyzer is an interactive data analysis tool that provides you with a rich drag-and-drop user interface that makes it easy for you to create reports quickly based on your exploration of your data. Once your new report is created, you can display reports in a dashboard to make them available for other users. To enter the New Analyzer Report creation interface and begin creating a new report, simply click the New Analyzer Report icon on the dashboard. Figure 43. New Analyzer Report icon 68 Ruckus Wireless, Inc. Overview of Custom Report Creation Custom Report Schema Changes in SCI 1.3 Custom Report Schema Changes in SCI 1.3 SCI 1.3 contains significant changes in the Access Point dimensions of Custom Reports schema. Previously created reports (SCI 1.0-1.2) are not silently upgradeable. Therefore, in order to continue using custom reports created in previous SCI versions, the procedure is as follows: 1 During the upgrade process, if no Custom Reports are found, the schema will be upgraded to 1.3 silently. 2 If any custom reports are found by the upgrade process, there are two possible upgrade paths: a If the upgrade is performed from SCI 1.0, all reports will be upgraded to a newer Custom Report 1.1 schema. Both schema versions (CR 1.1 and 1.3) will be available in the system. b If the upgrade is performed from SCI 1.1 or 1.2, all reports will remain as is. Both schema versions (CR 1.1 and CR 1.3) will be available in the system. 3 The user is required to port all reports from CR 1.1 to CR 1.3 version manually. 4 After the porting process is complete, it is possible to remove all legacy reports together with their CR 1.1 schema, using the /opt/ruckuswireless/sci/scripts/ purge_old_schema_with_reports.sh script. This operation is irreversible, unless a previous backup is used to restore the system. 5 In a later SCI versions (post 1.3), no special treatment will be taken for 1.1-based legacy reports. SmartCell Insight User Guide, 800-71041-001 Rev A 69 Creating a New Report Choosing a Data Source Creating a New Report Creating a new report consists of the following steps: 1 Choosing a Data Source 2 Adding Fields and Filters 3 Adding a Description 4 Changing the Chart Type 5 Adding a Description 6 Saving the Report to a Shared Folder 7 Creating Your Own Folder for Custom Reports Choosing a Data Source To create a new blank report from scratch, complete the following steps: 1 Click the New Analyzer Report icon ( box. ) to open the Select Data Source dialog 2 Choose a Data Source which consists of a schema and data set from the list box in the Select Data Source dialog box. This choice determines which fields will be available when you build your report. For example, if you selected a data source called “AP Statistics,” all AP-related fields (e.g. number of APs) would be available. 3 Click OK to continue. 70 Ruckus Wireless, Inc. Creating a New Report Choosing a Data Source Figure 44. Select a Data Source NOTE: If you are upgrading from a previous release with pre-1.3 custom reports created using pre-1.3 schema, the “Select Data Source” dialog will also include data sources that conform to the previous schema, as shown in Figure 45. Figure 45. Select Data Source with pre-1.3 schema SmartCell Insight User Guide, 800-71041-001 Rev A 71 Creating a New Report Choosing a Data Source About Data Sources Each report must use a single Data Source. The following built-in data sources are available: • AP Response Statistics: Includes measures such as packets transmitted, packets lost percentage, ping total time, minimum, maximum, average and deviance. • AP Statistics: Includes measures such as number of APs, Tx data bytes and Rx data bytes. • Client Complete Sessions: Includes measures such as number of sessions, number of unique clients, session length, Tx and Rx data bytes. • Client Session Intervals: Includes measures such as estimated throughput, maximum/minimum signal strength and RSSI, number of sessions and number of intervals. • Controller Resource Utilization: Includes measures such as CPU, memory and disk usage percentages. • Controller Statistics: Includes measures such as client count, license count and license utilization. • Events: Includes measures such as number of events. • Rogue APs: Includes the Number of Rogue BSSIDs measure and levels such as Rogue AP BSSID & Rogue Type. More about Data Sources: • Each report is tied to one Data Source. • You cannot change the Data Source for a report. • Many Data Sources have overlapping fields. For example, the “AP Model” field exists in multiple Data Sources. Therefore, there could be more than one data source that would work for the report that you want to generate. • The reason you are asked to choose a Data Source before you add fields is that certain fields don't work well together, and using them in the same report leads to incorrect or confusing results. Therefore, Data Sources bundle the appropriate fields together so that your report will make more sense. 72 Ruckus Wireless, Inc. Creating a New Report The New Analyzer Report Page The New Analyzer Report Page Once you have chosen a Data Source, the New Analyzer Report page appears. Figure 46 identifies the main sections of the New Analyzer Report page, and each of these page elements is described in Table 5. Figure 46. The New Analyzer Report page 3 1 2 Table 5. 4 New Analyzer Report page elements Number Description 1 Available Fields: Choose which fields to include in your report. You can drag fields to the Layout section, drag them directly onto the Report Preview. 2 Layout: Use this section to define the layout of your report. 3 Action Icons: See Table 6 for Action Icon descriptions. 4 Report Preview: Displays the actual report as it is currently defined. SmartCell Insight User Guide, 800-71041-001 Rev A 73 Creating a New Report The New Analyzer Report Page Action Icons Table 6 describes the Action Icons available from the New Analyzer Report page. Table 6. Icon Action Icons Description Save icon Save as icon Undo icon Redo icon Hide/show Available Fields icon Hide/show Layout panel icon Hide/show Filters icon Disable/enable Auto refresh icon More Actions and Options icon 74 Ruckus Wireless, Inc. Creating a New Report Adding Fields and Filters Adding Fields and Filters Once you are on the Analyzer Report page, you are ready to add fields and filters. You can do this in any order, but here is a good way to get started: 1 Drag a Time Period field (such as Year or Quarter) onto the report. 2 Add a Measure field (such as Number of Sessions, etc). 3 Click the Time Period field on the report, and select Filter from the menu. Choose the time periods you are interested in from the Filter dialog box. NOTE: You can view the definition of a field by clicking on the field and selecting Tell me About... from the menu. NOTE: Reports make the most sense when they display at least one measure field. (Measure fields are highlighted blue.) NOTE: Add filters early on. To get the best response time and avoid too much data being displayed, add filters before you drag too many fields onto the report. For example, if you already have two or three fields in the report and you want to add another field that you suspect has hundreds or thousands of values, add a filter to this field before you add it to the report. SmartCell Insight User Guide, 800-71041-001 Rev A 75 Creating a New Report Adding Fields and Filters Figure 47. Adding fields and measures About Fields Examples of Fields include "AP Model," "SSID," "OS Type," etc. Fields are what define the content of your report. The following types of fields are available: Level Fields (Names, Types, Categories, etc.): Level fields are usually text-based. “OS Type” is an example of a Level field. “Android” and “Windows 7/Vista” are examples of possible values for the OS Type field. Time Period Fields: “Year” and “Month” are examples of Time Period fields. Possible values for these fields could be 2012 and Jan-2011, respectively. Measure Fields: Measure fields are numeric and most often represent Access Point, client or controller metrics. “Number of Unique Clients” and “Tx Data Bytes” are examples of Measure fields. Fields are color-coded by type in both the report and the Available Fields panes. The colors are assigned as follows: • Level Fields and Time Period Fields: Orange • Measure Fields: Blue 76 Ruckus Wireless, Inc. Creating a New Report Switching to Chart Format Viewing the Definition of a Field Complete the following steps to view the definition of a field: 1 Right-click the field name (in the report or in the list of available fields). 2 Select Tell me about... from the menu to open the About... dialog box. The About... dialog box provides the following information: • Name: The name of the field as it appears in this report. • Type: The type of field. For more about field types, see “About Fields” on page 76. • Description: The description of the field. • MDX: The data source definition. For example, for the Controller Model field, the MDX value is [Controllers].[Controller Model]. • Member Properties*: Certain fields contain member properties that can be used to constrain membership to specific values based on these properties. NOTE: If a field has a number in parenthesis next to its name the field list, this means it has member properties associated with it. You can constrain the data displayed according to one or more of these member properties by selecting Show Properties from the drop-down menu of a field after dragging it onto the Layout pane. Switching to Chart Format By default, new reports are displayed in table format according to the fields and layouts (rows and columns) that you selected. You can easily switch from table format to any of several chart formats by clicking the Chart Format icon. SmartCell Insight User Guide, 800-71041-001 Rev A 77 Creating a New Report Changing the Chart Type Figure 48. The Chart Format icon Changing the Chart Type Click the Choose Another Chart Type icon and select a chart type from the list. Figure 49. Choose another chart type 78 Ruckus Wireless, Inc. Creating a New Report Applying Filters to Reports Applying Filters to Reports If your report contains a large amount of data, it is a good idea to apply filters before you add too many additional fields and measures. Click the blue + icon (next to “No filters” if there are no filters applied so far). Figure 50. Click the + icon to add a new filter When you click the + icon to add a filter, the screen changes to display an area with the label “To add a new filter, drag a field from the Available Fields to this area.” SmartCell Insight User Guide, 800-71041-001 Rev A 79 Creating a New Report Applying Filters to Reports Figure 51. Drag a field to this area to add a new filter For example, if you want to filter for only 2.4 GHz clients, drag the Frequency field to the add filter section. A “Filter on Frequency” dialog appears, from which you can select which values you want to filter for. Select 2.4G from the list, and click the right arrow icon to add it to the filter list. Then click OK to confirm. 80 Ruckus Wireless, Inc. Creating a New Report Applying Filters to Reports Figure 52. Add the 2.4G value to filter results for only 2.4G clients After the filter is applied, you can see which filters are applied in the updated chart view. Figure 53. Frequency includes 2.4G SmartCell Insight User Guide, 800-71041-001 Rev A 81 Creating a New Report Adding a Description Adding a Description A description of your report will help other users understand it. Complete the following steps to add, edit, or view a description of a report. 1 Open the report. 2 Click the More actions and options icon on the toolbar and select About this Report… 3 Use the Description field to add, edit, or view the report description. NOTE: You also can view the description on the Report Home page by clicking the Information symbol (i) next to the report. Figure 54. Select About this Report... from the More Actions list 82 Ruckus Wireless, Inc. Creating a New Report Adding a Description Figure 55. Click the Edit icon to edit the report description \ Figure 56. Type your report description in the text box SmartCell Insight User Guide, 800-71041-001 Rev A 83 Creating a New Report Saving the Report to a Shared Folder Saving the Report to a Shared Folder To let other users access a report you create, save your report into a shared folder. In this example, we will save the new report to the existing “Ruckus Reports” folder. 1 Click the Save Current Report icon. 2 The Save dialog opens. Enter a recognizable name for this report. In this example, we created a report called “OS Type by Day.” 3 Browse to your preferred destination directory. In this example, we saved the report in the existing /ruckus-reports/subscriber-and-session folder. 4 Click Save to save your report. Figure 57. Enter a filename for your report 84 Ruckus Wireless, Inc. Creating a New Report Creating Your Own Folder for Custom Reports Figure 58. Save the report to the Subscriber and Session folder Creating Your Own Folder for Custom Reports In general, Ruckus recommends creating a special folder for your reports under the “Ruckus Reports” folder. In this way, you can have full control over who has access to each of your custom reports. To create a folder for all of your users: 1 Login as a user with an Admin role. 2 Right click Ruckus Reports and click New Folder.... 3 Enter a name for the folder, for example “Company Reports”. The new folder appears in the list under Ruckus Reports. 4 Right click your new folder and click Properties. 5 In the Share tab, click Add.... 6 Select user or role, for example, Authenticated, and click OK. 7 Check All Permissions in the Permissions for Authenticated section. 8 Click OK to apply your changes and close the dialog window. SmartCell Insight User Guide, 800-71041-001 Rev A 85 Creating a New Report Creating Your Own Folder for Custom Reports Figure 59. Create new folder Figure 60. Enter a name for the new folder 86 Ruckus Wireless, Inc. Creating a New Report Creating Your Own Folder for Custom Reports Figure 61. Give all permissions to users with the Authenticated role Now all users with the Authenticated role should have access to this folder and can open and save reports to it. NOTE: It is best practice to allow only users with advanced permissions (such as Admin users) to create reports, while others (such as Authenticated) should have permission to execute reports but not to create or save them. SmartCell Insight User Guide, 800-71041-001 Rev A 87 Available Metrics Creating Your Own Folder for Custom Reports Available Metrics The following table lists the metrics available for report creation. You can create reports for any combination of these metrics, and filter results by any of the values that exist within each metric for each available data source. Table 7. Available metrics Category Metric AP Stats • AP Name, MAC, Description, Serial Number, GPS • Controller Name & MAC • # APs • Tx & Rx bytes AP Response • AP Name, MAC, Description, Serial #, GPS • Min, Max, Avg response time • Deviance • % Packets Lost • Tx & Rx Packets • Ping Total Response Time Controller • Controller Name & MAC • Client Count • License Count • License Utilization Controller Resources • CPU Util % • Disk Usage % • Mem Usage % Client Sessions • AP Name, MAC, Description, Serial #, GPS • Controller Name & MAC • Client Hostname & Username • # of sessions • # of subsessions • # of unique clients • Session Length • Tx & Rx bytes 88 Ruckus Wireless, Inc. Available Metrics Creating Your Own Folder for Custom Reports Table 7. Available metrics Category Metric Events • AP Name, MAC, Description, Serial #, GPS • Controller Name & MAC • Number of Events Client Session Intervals • AP Name, MAC, Description, Serial #, GPS • Controller Name & MAC • Client Hostname & Username • Estimated Throughput • Min, Max RSSI • Max, Min Signal Strength • Noise Floor • Number of Intervals • Number of Sub-Sessions • Tx & Rx Bytes SmartCell Insight User Guide, 800-71041-001 Rev A 89 Available Metrics Creating Your Own Folder for Custom Reports 90 Ruckus Wireless, Inc. Managing the SmartCell Insight System 6 In this chapter: • Setting Administrator Preferences • Getting Familiar with the Administration Interface • Monitor Page • System Setup Page • Diagnostics Page • Changing the Administrator Password • SCI Upgrade Procedure • SCI Uninstall Procedure • SCI Backup and Restore • SCI AP Grouping • Uploading an SCI License • System Timekeeping • Using the Enterprise Console SmartCell Insight User Guide, 800-71041-001 Rev A 91 Setting Administrator Preferences Accessing the Administration Interface Setting Administrator Preferences This section describes the settings and procedures used to configure administrator preferences, such as setting the admin user name and password, configuring data sources, data purge settings and SMTP settings. Accessing the Administration Interface Many administration tasks can be performed through the administration interface (Admin Console). To access the administration interface, point your browser to: https://[SCI-IP-address]:8443, and enter your administrator user name and password. NOTE: If you have not yet changed the default admin password, a warning message appears each time you access an admin interface page, prompting you to change the default password. See Changing the Administrator Password for instructions on changing the admin password. Getting Familiar with the Administration Interface The administration interface consists of the following three pages: • Monitor Page • System Setup Page • Diagnostics Page Use these pages to monitor and configure SCI data sources and to view ETL job status logs. 92 Ruckus Wireless, Inc. Monitor Page Accessing the Administration Interface Monitor Page The Monitor page displays currently configured SCI data sources, and provides options for deactivating/reactivating a data source, and enabling/disabling SCI > AP Response Time Tests. The Monitor page contains the following sections: • Sources: Displays the data sources that have been configured on the System Setup page. • General Information: Includes services status and system information including OS version, system resources and uptime. SCI Data Sources This section displays a list of the data sources configured from the System Setup page. It is divided into the following three sections (depending on which data sources have been configured): • FlexMaster • ZoneDirector Groups • SmartZone FlexMaster Table 8 describes the information provided for each FlexMaster data source. Table 8. SCI Data Source information items Item Description SCI System Name The Name of the FM or SZ data source. FM DB Host The IP address of the FM server. FM DB Port The Port number of the FM server. FM DB User The user name of the FM user account used to access the FM server. FM DB Name The name of the FM database. ZoneDirectors List Displays the IP/Port, Name and Status of configured ZoneDirectors. The Status indicator displays OK if the data source is currently reachable by SCI, or Disconnected if the data source is currently unreachable. SmartCell Insight User Guide, 800-71041-001 Rev A 93 Monitor Page Accessing the Administration Interface Table 8. SCI Data Source information items Item Description Response Time Tests Displays whether the AP Response Time Tests are enabled. This feature gathers data for a special SCI report (AP Response Time) that SCI measures by itself. This feature is only effective if the APs are reachable (i.e., they are not behind NAT, from the SCI’s perspective in the network). Status Displays OK if the data source is currently reachable by SCI, or Error if an error is detected. The “?” icon contains more information on the error on mouse over. ZoneDirector Groups Table 9 describes the information provided for each ZoneDirector Group data source. Table 9. ZD Data Source information items 94 Item Description SCI System Name The Name of the FM or SZ data source. ZD IP Address The IP address of the ZoneDirector controller. ZD Port Number The Port number of the ZD. ZD User Name The user name of the ZD user account used to access the controller. Response Time Tests Displays whether the AP Response Time Tests are enabled. This feature gathers data for a special SCI report (AP Response Time) that SCI measures by itself. This feature is only effective if the APs are reachable (i.e., they are not behind NAT, from the SCI’s perspective in the network). Status Displays OK if the data source is currently reachable by SCI, or Error if an error is detected. The “?” icon contains more information on the error on mouse over. Ruckus Wireless, Inc. Monitor Page Accessing the Administration Interface SmartZone Table 10 describes the information provided for each SZ data source. Table 10. SZ Data Source information items Item Description SCI System Name The Name of the FM or SZ data source. SZ Control Plane Nodes MGMT IPs The Management IP address of the SZ Control Plane. SZ User The SZ User name. Response Time Tests Displays whether the AP Response Time Tests are enabled. This feature gathers data for a special SCI report (AP Response Time) that SCI measures by itself. This feature is only effective if the APs are reachable (i.e., they are not behind NAT, from the SCI’s perspective in the network). Status Displays OK if the data source is currently reachable by SCI, or Error if an error is detected. The “?” icon contains more information on the error on mouse over. Deactivating a Data Source To deactivate a data source, use the following procedure: 1 Locate the SCI System Name that you want to deactivate, and click the deactivate link on the same line. 2 The page refreshes and a confirmation message appears. NOTE: Deactivating a system will not stop active data fetches, if there are any in progress; only future data fetches will be deactivated. SCI fetches data every 15 minutes from each data source. SmartCell Insight User Guide, 800-71041-001 Rev A 95 Monitor Page Accessing the Administration Interface Figure 62. Deactivate an SCI data source Figure 63. Deactivation successful The deactivated data source is now hidden from the list and a new line appears providing a link to display deactivated data sources. If you click the Show link, the list is refreshed to display both the active and deactivated data sources. 96 Ruckus Wireless, Inc. Monitor Page Accessing the Administration Interface Figure 64. Show deactivated data sources Permanently Deleting a Deactivated Data Source To delete a data source permanently, you can now click the red “X” icon in the Delete column. NOTE: Note that you can only delete a Deactivated data source, and once it is deleted, all data stored about this system is deleted forever. SmartCell Insight User Guide, 800-71041-001 Rev A 97 Monitor Page Accessing the Administration Interface Figure 65. Permanently delete a Deactivated data source Reactivating a Deactivated Data Source To reactivate a data source, use the following procedure: 1 Click the Show link to display deactivated data sources as well as active. The page refreshes to display deactivated and active data sources. 2 Click the Reactivate link for the data source you want to reactivate. 98 Ruckus Wireless, Inc. Monitor Page Accessing the Administration Interface Figure 66. Reactivate a deactivated data source Enabling/Disabling SCI - AP Response Time Tests To enable or disable SCI - AP response time tests, use the following procedure: 1 Click the Enable or Disable link for the relevant data source. 2 The page refreshes, and a “Success!” notification appears. SmartCell Insight User Guide, 800-71041-001 Rev A 99 Monitor Page Accessing the Administration Interface Figure 67. Enable or disable SCI > AP Response Time tests Performing AP Group Synchronization The AP Group Sync section allows you to synchronize SCI’s AP groups with ZoneDirector AP groups or SZ zones and AP groups. Click run now to run the sync operation now, or click log to display the log file. Additionally, you can disable AP group synchronization if you do not want SCI to sync AP groups with those configured on the controller. This can be useful if you want to import your own custom AP groups, as described in SCI AP Grouping. 100 Ruckus Wireless, Inc. Monitor Page Accessing the Administration Interface Figure 68. AP group sync Running the AP group sync task may take several minutes, depending on the number of AP zones and groups deployed. Figure 69. AP Group Sync job started Once complete, these AP groups can now be used to filter data displayed in reports such as the Access Point Traffic report for a specific AP group, as shown in Figure 70. SmartCell Insight User Guide, 800-71041-001 Rev A 101 Monitor Page Accessing the Administration Interface Figure 70. Filtering data by AP group 102 Ruckus Wireless, Inc. System Setup Page Sources Configuration System Setup Page The System Setup page provides options for configuring Data Sources, importing AP Licenses, and System Configuration settings, which including options for importing an SSL Certificate, configuring the Data Purge policy, and configuring SMTP settings and email recipients for alerts and scheduled report delivery. Sources Configuration SCI data sources refers to the systems from which SCI collects its data. Data can be collected from Ruckus Wireless ZoneDirector controllers, FlexMaster servers, and/or SmartZone controllers. The following sections provide information on adding each of the data source types: • FlexMaster • ZoneDirectors Group • Standalone ZoneDirector • SmartZone (SCG/SZ/vSZ) FlexMaster To add a new FlexMaster data source, use the following procedure: 1 In the FlexMaster section, enter the following details for connecting to the FlexMaster server: • System Name: Enter a recognizable name for the FM server. NOTE: This is the internal name that SCI uses to identify the FM server. Note that this name cannot be changed afterwards without removing all the data from this source, so choose carefully. • DB Host: Enter the IP address of the FM server. • DB Port: Enter the Port number for the FM server (default: 3306). • DB Name: Enter “itms” as the name for the FM database. (This can only be “itms”.) • DB User: Enter a user name for the FM database. This user name must be configured as a mySQL Reporting user for the FlexMaster database. • DB Password: Enter the user password. SmartCell Insight User Guide, 800-71041-001 Rev A 103 System Setup Page Sources Configuration • AP Response Time Tests: Select Enabled or Disabled. This feature gathers data for the AP Response Time report that SCI measures by itself. This feature is only effective if the APs are reachable (i.e., they are not behind NAT, from the SCI’s perspective in the network). 2 Click the Add FlexMaster Source button. Figure 71. Add a FlexMaster data source NOTE: FlexMaster requires that a read-only user on FlexMaster's MySQL database be created for SmartCell Insight. ZoneDirectors Group ZoneDirector Groups are filterable entities in SCI reports that contain multiple ZoneDirectors. In order to connect a ZoneDirector to SCI without a FlexMaster server controlling the ZD, you must assign the ZD to a ZoneDirectors Group. To create a new ZoneDirector Group data source, use the following procedure: 1 In the ZoneDirectors Group section, enter the following: • System Name: Enter a name for the ZoneDirectors Group. 104 Ruckus Wireless, Inc. System Setup Page Sources Configuration • AP Response Time Tests: Select Enabled or Disabled. This feature gathers data for the AP Response Time report that SCI measures by itself. This feature is only effective if the APs are reachable (i.e., they are not behind NAT, from the SCI’s perspective in the network). 2 Click the Add ZoneDirectors Group Source button. Figure 72. Add a ZoneDirector data source Standalone ZoneDirector Use this section to add a standalone ZoneDirector to an SCI “ZoneDirectors Group” (for reporting to SCI without an FM server). NOTE: The ZoneDirector clock must be synchronized with NTP, and show the same time as SCI. NOTE: The ZoneDirector must run an SCI-compatible firmware. NOTE: Standalone ZoneDirectors do not send event data to SCI, so reports based on events (such as “AP Reboots”) will show no data for these sources. For events, either an FM or SmartZone-based controller is required. SmartCell Insight User Guide, 800-71041-001 Rev A 105 System Setup Page Sources Configuration To add a standalone ZoneDirector to a ZoneDirectors Group, use the following procedure: 1 In the Standalone ZoneDirector section, enter the following: • ZoneDirectors Group: Select a ZD Group from the list of ZD groups you created above in ZoneDirectors Group. • ZoneDirector IP: Enter the IP address of the ZD to be added to the group. • ZoneDirector Port: Enter the TCP Port of the ZD to be added to the group. • ZoneDirector User: Enter the administrator User Name of the ZD to be added to the group. • ZoneDirector Password: Enter the password of the administrative user to be added to the group. 2 Click the Add ZoneDirector to ZoneDirector Group button. Figure 73. Add a standalone ZD to a ZD group SmartZone (SCG/SZ/vSZ) To add a SmartZone data source, use the following procedure: 1 In the SmartZone section, enter the following details for connecting to the SZ controller: • System Name: Enter a recognizable name for the SZ controller. • Management IP: Enter the IP address of the SZ management interface. 106 Ruckus Wireless, Inc. System Setup Page AP Licensing • Username: Enter a user name for the SZ user. This user name must be configured as a valid user with a ‘Super Admin’ role. • Password: Enter the user password. • AP Response Time Tests: Select Enabled or Disabled. This feature gathers data for the AP Response Time report that SCI measures by itself. This feature is only effective if the APs are reachable (i.e., they are not behind NAT, from the SCI’s perspective in the network). 2 Click the Add SmartZone Source button. Figure 74. Add an SZ data source m NOTE: SZ requires that AP statistics delivery be enabled so that APs can send data directly to SCI. To enable AP statistics delivery, enter the command ap-sci enable from the SZ CLI config context (see SZ CLI documentation for instructions on using the SZ command line interface). AP Licensing The AP Licensing section allows you to import an SCI license file. SCI supports a maximum of 10 APs without a license for demo or testing purposes. The SCI license can be upgraded at any time to accommodate more APs as your SCI deployment grows. It includes the customer name and the number of licensed APs. If a license SmartCell Insight User Guide, 800-71041-001 Rev A 107 System Setup Page System Configuration violation exists (more APs reporting stats than the license level), SCI will display a warning message directing you to either upgrade your license or reduce the number of APs reporting to SCI. The SCI license can be upgraded at any time by completing the following procedure: 1 Go to the System Setup page. 2 In the Import an AP License File section, click Choose File to select a license file to import. 3 Select the file and click Import License. Figure 75. Importing an SCI license file System Configuration The System Configuration section provides options for configuring SSL certificate settings, data purge policy, SMTP settings for email report delivery, and Alert Settings for configuring email addresses of recipients for email alerts. SSL Settings During installation, SCI automatically creates a unique RSA 2048 key, Self-Signed Server Certificate and a unique 2048 bit Diffie-Helman Group for all access to SCI. 108 Ruckus Wireless, Inc. System Setup Page System Configuration Self-Signed certificates will cause browsers to issue a warning that the authenticity of the site cannot be verified. This is normal and cannot be avoided if you use a selfsigned certificate. You may opt to use a Certificate Authority (CA)-provided certificate for a DNS name that you will assign to your SCI installation. SCI provides you with an SSL wizard to create your own Private Key and a Certificate Signing Request for that Private Key, to be used when requesting a certificate from a CA. Alternatively, if you already have a Private Key (.pem) and a Server Certificate (.crt) from another server (e.g. if you have a wildcard certificate for your domain), you may directly import them into SCI. Further, if your CA requires it, you may import a CAprovided Intermediate Certificate Chain, to help browsers establish the trust chain between your Server Certificate and one of their Trusted Root CAs. After you create/import a Private Key and a Server Certificate (and possibly an Intermediate Certificate Chain), click "Deploy SSL" to have SCI start using them. Figure 76. SSL Settings SmartCell Insight User Guide, 800-71041-001 Rev A 109 System Setup Page System Configuration Figure 77. SSL Configuration wizard Data Purge Settings To configure the data purge policy, use the following procedure: 1 In Keep reports data for __ years, select the number of years for which SCI will maintain report data before purge. 2 Click Update Data Purge Settings to save your changes. NOTE: When reducing the number of years to a number lower than the current setting, a warning will appear to alert you that you are about to remove old data if you continue. If you approve this operation, data older than the new purge setting will be removed, irrecoverably. By default, SCI keeps data for 1 year. When getting close to 1 year, you will need to monitor disk space usage and evaluate your network volume to determine if your current storage will suffice for storing more than 1 year's worth of data, and only if so, increase this number. 110 Ruckus Wireless, Inc. System Setup Page System Configuration Figure 78. Data Purge Settings SMTP Settings To configure SMTP settings, use the following procedure: 1 Enter the following SMTP settings for email delivery of SCI reports: • SMTP Host: The outgoing mail server for your organization. • SMTP Port: The SMTP port number (default: 25). • SMTP Transport: Select normal SMTP or SMTP with transport layer security. • SMTP Encryption: Select whether to use STARTTLS transport layer security or SSL encryption. • SMTP Authentication: Select whether to use SMTP authentication. • Authentication User: Enter user name if SMTP authentication is used. • Authentication Password: Enter user password if SMTP authentication is used. • Default ‘From:’ address: Enter the email address from which emails will be delivered. 2 Click Update SMTP Settings to save your changes. SmartCell Insight User Guide, 800-71041-001 Rev A 111 System Setup Page System Configuration Figure 79. SMTP Settings for Email Delivery Alert Settings Use the Alert Settings to configure email addresses of recipients of email alerts. The SMTP settings are also used to configure the recipients for automated report delivery. 1 Enter a primary recipient’s email address in Alert To. 2 Enter additional recipient email addresses in the Alert CC, Alert BCC and Escalation CC fields. NOTE: The Escalation CC field can be used to notify a recipient when a problem occurs and has not been resolved. Escalation CC alerts will be sent after two cycles. 3 Enter an interval after which a repeat email will be sent in First Repeat After__. Subsequent repeat alerts will be sent at increasing time intervals, doubling each time. For example, if you enter 3600 seconds (1 hour), the 2nd alert will be sent after 1 hour, the 3rd alert after 2 hours, the 4th alert after 4 hours, etc. 4 In Filesystem Alerts, enter a disk space (in GB) or disk space percentage threshold after which an alert will be sent when the disk space falls below this threshold. 112 Ruckus Wireless, Inc. System Setup Page System Configuration 5 In AP License Alerts, enter a percentage threshold to trigger an alert when the percentage of APs reporting to SCI of the Total Licensed APs exceeds this set threshold. 6 In Load Average Alerts, enter load average thresholds above which alerts will be sent. (To disable these alerts, enter the value 0 in the relevant field/fields.) 7 Click Update Alert Settings to save your changes, or click Update Alert Settings & Send Test E-Mail to save changes and test your settings. Figure 80. Configure email alert settings SmartCell Insight User Guide, 800-71041-001 Rev A 113 Diagnostics Page System Configuration Diagnostics Page The Diagnostics page provides tools for creating diagnostics log files and viewing previously created diagnostics archives. Creating a New Diagnostics Archive 1 To create a new diagnostics archive, click the click here link. The page refreshes and a Diagnostics collection in progress dialog appears. The page will automatically refresh once the diagnostics archive creation is complete. Figure 81. Create a new diagnostics archive 114 Ruckus Wireless, Inc. Diagnostics Page System Configuration Figure 82. Diagnostics collection in progress Once the process is complete (and the page refreshed), you can click the log file name to download the file to your local computer. Figure 83. Download a diagnostics archive file SmartCell Insight User Guide, 800-71041-001 Rev A 115 Diagnostics Page System Configuration Creating a Snapshot Archive Creating a Snapshot Archive may be necessary for debugging purposes if you encounter an ETL error and need help from Ruckus support in identifying the issue. This procedure should only be performed if you are asked to create a snapshot by Ruckus support personnel. It should be used only in the case of ETL failures, and be run only on the specific source where ETL errors were spotted. It creates a compressed archive of all the raw data received from a data source for analysis. 1 If asked to do so by Ruckus customer support, select the data source from the list, and click Create. 2 A snapshot archive file is created for the data source and appears in the archive list for download. 3 Download the file and email it to Ruckus support for analysis. Figure 84. Creating a snapshot archive ETL Log Results Display ETL (Extraction, Transform and Load) is the method by which SCI gathers data from its data sources, transforms it to fit operational needs, and loads it into the target formats. The two tables titled Extraction Job Status and Transform/Load Job Status display the 10 most recent diagnostic log results, displayed from most recent to 116 Ruckus Wireless, Inc. Diagnostics Page System Configuration least recent from left to right. You can click the older > link to view older logs, after which you can browse by using the < newer and older > links. You can also click the Log link for any log entry to view the specific log files. Figure 85. Extraction Job Status display Job Performance Graphs The Job Performance section displays the amount of time required for ETL process completion per data source in a time graph format. In this way, you can easily see and compare how much time (in seconds) the Extract and Transform/Load processes took for each of the last 10 data queries. SmartCell Insight User Guide, 800-71041-001 Rev A 117 Diagnostics Page System Configuration Figure 86. Job Performance graphs Alert History The Alert History table displays the most recent alert messages, their status, source, duration and Escalated status. Click the arrow next to an alert to see the exact alert message. Figure 87. Alert history table 118 Ruckus Wireless, Inc. Changing the Administrator Password System Configuration Changing the Administrator Password To change the admin password, use the following procedure: 1 Open an SSH connection to the SCI server’s location and run the following commands to configure the password for the Root user: $ ssh -l root 172.227.226 Password: Last login: Wed Nov 6 15:32:37 2013 from 172.20.181 [root@sci-dev ~]# /opt/ruckuswireless/sci/scripts/sci_change_admin_password.php ################################################### # Ruckus Wireless SmartCell Insight v1.0.0.0.1407 # ################################################### This utility changes the password for the 'admin' user on Administrative Web Interface, User Console and Enterprise Console. Please enter a new admin password (or hit Ctrl+C to abort)? Please enter the new admin password again to verify (or hit Ctrl+C to abort)? New password accepted. Updating new password across all systems... Updating User Console... SUCCESS! Updating AdminWeb/User Console... SUCCESS! Restarting User Console... Waiting 10 seconds for service to go down... Utility finished. [root@sci-dev ~]# 2 The next time you log in to the Administration Interface, User Console or Enterprise Console (as admin), use the new password to log in. SmartCell Insight User Guide, 800-71041-001 Rev A 119 SCI Upgrade Procedure Hostname Verification SCI Upgrade Procedure Perform the following procedure to upgrade SCI: 1 Upload the TAR package file (sci-repo-[build number].tar) to the SCI host as the 'root' user, to the /root home directory. 2 SSH to the SCI host as the user 'root'. Remain in the home directory (don't 'cd' to another directory). 3 Perform a backup to avoid potential data loss in case upgrade fails (see SCI Backup and Restore). 4 Extract the TAR package using the following command: tar xf sci-repo-[build number].tar 5 Run the SCI installer using the following command: ./deploy-sci.sh 6 While the installer runs, it will ask you if you have backed up your data. If you don't answer 'y', upgrade will not continue. If you opt to not perform the backup and say 'y' anyway, you accept the potential loss of all your data. After the upgrade process finishes, DO NOT reboot the system, it is not necessary. NOTE: During the upgrade process, SCI performs a verification check to ensure that the hostname format meets SCI’s requirements before installation or upgrade can continue. If upgrading from a previous release (which did not have this verification) using an invalid hostname, you will be required to change the hostname first before upgrading, or the upgrade will fail. See Hostname Verification for more information. Hostname Verification Valid hostnames can include lower-case letters, numbers and hyphens. All other characters are invalid. Hostname requirements: • May not be 'localhost'. • May contain only lower-case letters (a-z), numbers (0-9) and hyphen (-) signs. • Must begin with a-z. • May not end with a hyphen (-). If you need to change your hostname to comply with the format requirements, use the following procedure prior to performing the upgrade: 120 Ruckus Wireless, Inc. SCI Uninstall Procedure Hostname Verification 1 Edit /etc/sysconfig/network and/or /etc/sysconfig/network-scripts/ifcfg-eth0 (wherever a HOSTNAME line appears with this hostname). 2 Add the new name without the dot to /etc/hosts on the 127.0.0.1 line as the first item after 127.0.0.1 (do NOT remove the old one, just prefix the new name before it, with a space between the names) Example before: 127.0.0.1 sci-node-1.state.gov localhost localhost.localdomain localhost4 localhost4.localdomain4 ::1 localhost localhost.localdomain localhost6 localhost6.localdomain6 Example after: 127.0.0.1 sci-node-1 sci-node-1.state.gov localhost localhost.localdomain localhost4 localhost4.localdomain4 ::1 localhost localhost.localdomain localhost6 localhost6.localdomain6 3 Run the command: hostnameExample: hostname sci-node-1 4 Continue with the SCI upgrade as normal. SCI Uninstall Procedure 1 Uninstall licenses: yum remove rks-sci-bi-server-license-* 2 Uninstall SCI: /opt/ruckuswireless/sci/scripts/sci_uninstall.sh 3 Refresh repository: yum clean all SCI Backup and Restore Do the following the first time you backup to the backup server: 1 Create a backup server on a different machine. SmartCell Insight User Guide, 800-71041-001 Rev A 121 SCI AP Grouping Hostname Verification 2 On the source server, execute: /opt/ruckuswireless/sci/scripts/setup_backup_host.sh You do not need to repeat these steps when backing up again to the same backup server. Backup From the second time you backup to the backup server: 1 Clean previous backups from the backup server (/opt & /tmp folders). 2 Execute: /opt/ruckuswireless/sci/scripts/sci_backup.sh Restore 1 Once your backup server is set up, execute: /opt/ruckuswireless/sci/scripts/sci_restore.sh SCI AP Grouping AP Grouping is strictly optional. You do not need to perform this procedure if you do not want to create SCI AP Groups. 1 Create a CSV file mapping MAC to AP group in the following format: Figure 88. AP Group CSV file format 2 Save the file as /tmp/ap_group.csv 3 Login as rkssci user: su -s /bin/sh rkssci 4 Switch to the following directory: cd /opt/ruckuswireless/sci/pentaho/data-integration 5 Run the command: sh kitchen.sh -level=Rowlevel -norep -file="/opt/ruckuswireless/sci/pentaho/ etl/external/loadApGroups.kjb" /tmp/ap_group.csv 122 Ruckus Wireless, Inc. Uploading an SCI License Hostname Verification CAUTION! If you do not disable AP Group Sync (from the Monitor page), the AP Groups you have imported will be overwritten when the automatic AP Group Sync function runs (once per day). Uploading an SCI License SCI requires two kinds of licenses – the Business Intelligence (BI) license and the Ruckus SCI license. The BI license only needs to be installed once (as described in the Installation section). The SCI license can be upgraded at any time to accommodate more APs as your SCI deployment grows. It includes the customer name and the number of licensed APs. If a license violation exists (more APs reporting stats than the license level), SCI will display a warning message informing you to either upgrade your license or reduce the number of APs reporting to SCI. The SCI license can be upgraded at any time by completing the following procedure: 1 Go to the System Setup page. 2 In the Licensing section, click Choose File to select a license file to import. 3 Select the file and click Import License. System Timekeeping APs synchronize their time-of-day clock (aka wall clock) every 12 hours to network time using NTP. Each AP’s wall clock is set to the GMT time zone. APs are not configured with their local time zone. Whenever APs reboot, they use NTP to reinitialize their wall clock; system time is not preserved across reboots. There are several important implications stemming from these facts: • System Administrators must ensure that outgoing connections to NTP servers are not blocked on the corporate network or else provide a local NTP Server. Otherwise, APs will not be able to initialize their wall clocks. • APs’ timestamps on statistics will not be perfectly synchronized and AP-to-AP clocks (and therefore timestamps) will drift with respect to one another. • When an AP reboots and doesn’t have access to NTP Servers, it will not be able to properly initialize its wall clock. This could happen, for example, when a WAN connection is down; APs can locally switch traffic, but their timestamps will be incorrect because NTP Servers are unreachable. • APs connected to ZDs will always be able to synchronize their time stamps as they cannot operate without a connection to ZD. SmartCell Insight User Guide, 800-71041-001 Rev A 123 System Timekeeping Hostname Verification • APs connected to SZ, however, are capable of starting their WLAN service without first connecting to their SZ. • SCI is aware of the time zone in which every AP is deployed and ensures that its reports time-zone align with the statistics reported from APs in different time zones. 124 Ruckus Wireless, Inc. Using the Enterprise Console Creating Users and Roles Using the Enterprise Console The Enterprise Console provides tools for managing users and roles, and for scheduling jobs for creation of user-defined reports. CAUTION! The Enterprise Console should not be used for anything other than creating users and roles and scheduling jobs for creation of custom reports. To access the Enterprise Console, enter the following URL in your browser: https://[SCI-IP-address]:9443 Creating Users and Roles Three roles - Admin, Anonymous and Authenticated - are included by default. You can use the Users & Roles page to customize roles and create additional users. CAUTION! The Enterprise Console allows you to change the password for the user admin. You must NOT do this, because the password change will not be synchronized to all places. You must use the script described in the section “Changing the Administrator Password” on page 119. Figure 89. Administration - Users & Roles page SmartCell Insight User Guide, 800-71041-001 Rev A 125 Using the Enterprise Console Creating Users and Roles Adding Users Follow the instructions below to add users to the SCI system: 1 In the Enterprise Console go to Administration > Users & Roles. 2 Click the Users icon if you are not in Users mode. 3 Click the plus sign (+) next to Users. 4 In the Details pane, enter the User Name, Password, Password Confirmation, and Description. 5 Click OK. The new user's name appears in the list of users. Figure 90. Adding a user Editing User Information Follow the instructions below to edit user information: 1 In the Enterprise Console go to Administration > Users & Roles. 2 Select the user whose information you want to edit. 3 In the Details pane, edit the user details as needed. 4 Click Update. 126 Ruckus Wireless, Inc. Using the Enterprise Console Creating Users and Roles Deleting Users Follow the instructions below to delete a users from the SCI system: 1 In the Enterprise Console go to Administration > Users & Roles. 2 Select the user or users you want to delete from the Users list. 3 Click the Delete Users icon (X) next to Users to delete the users you selected. A confirmation dialog appears. 4 Click OK to refresh the user list. Finding Users The User List Filter allows you to find specific users in the list of current users. To find a user, enter the first few letters of the user's name in the text box. A list of names matching your entry appears. Managing Roles Follow the instructions below to add roles to the BI Platform: 1 In the Enterprise Console go to Administration > Users & Roles. 2 Click the Roles icon if you are not in Roles mode. 3 Click the plus sign (+) next to Roles. 4 In the new window, type a new Role Name and Description. 5 Click OK. The new role appears in the list of roles. SmartCell Insight User Guide, 800-71041-001 Rev A 127 Using the Enterprise Console Creating Users and Roles Figure 91. Creating a new Role Editing Roles Follow the instructions below to edit roles: 1 In the Enterprise Console go to Administration > Users & Roles. 2 Select the role you want to edit. 3 In the right pane, edit the details as needed. 4 Click Update. Deleting Roles Follow the instructions below to delete roles: 1 In the Enterprise Console go to Administration > Users & Roles. 2 Select role or roles you want to delete from the Roles list. 3 Click the Delete Roles icon (X) next to Roles to delete the roles you selected. A confirmation dialog appears. 4 Click OK to refresh the roles list. 128 Ruckus Wireless, Inc. Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports Finding Roles The Role List Filter allows you to find specific roles in the list of current roles. To find a role, enter the first few letters of the role name in the text box. A list of role names matching your entry appears. Using the Scheduler to Define Public Schedules for Custom Reports The Scheduler allows you to create, update, delete, run, suspend, and resume one or more schedules, (private and public), in the BI Platform. In addition, you can suspend and resume the Scheduler itself. In the context of the BI platform, a schedule is a time (or group of times) associated with an action sequence (or group of action sequences). In many cases, the output of an action sequence associated with a public schedule is a report; for example, a sales report to which a manager or salesperson can subscribe. As the administrator, the schedule (or schedules) you designate determines when the Scheduler allows the action sequence to run. Regular schedules are ad hoc, non-subscription schedules, which are associated with one action sequence only. In addition to associating a time (or group of times in the case of a repeating schedule) with an action sequence (or group of action sequences), the public schedule is also associated with a user's My Workspace. When an action sequence runs on its defined schedule, the output of the action sequence (typically a report) is archived in the My Workspace of the user(s) who have subscribed to that action sequence. This allows the subscribers to view the output of the action sequence (the report) at any time following its execution. Entering Schedules in the Schedule Creator Dialog Box Enter schedules associated with your action sequences in the Schedule Creator dialog box. The Schedule Creator makes it easy for you to enter schedules without having to learn the arcane syntax of CRON expressions; however, it provides you with the option to enter CRON expressions if that is your preference. Follow the instructions below to use the Schedule Creator: 1 In the main page of the Enterprise Console, click Administration. 2 Click the Scheduler tab. 3 In the Scheduler, click first icon on the left to open the Scheduler Creator dialog box. SmartCell Insight User Guide, 800-71041-001 Rev A 129 Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports 4 Under Schedule, enter a Name for the schedule, for example, Monthly Sales. 5 Enter a Group associated with the schedule, for example, Sales Schedules. 6 Enter a short Description of the schedule. for example, "Schedule runs on the first of each month, schedule runs on Monday of each week." 7 Select a Recurrence Type. You can schedule the action sequence to run once at a particular date and time only, or have it recur in seconds, minutes, hours, daily, weekly, monthly, yearly, or recur based on a CRON string. The options in the Recurrence Editor change depending on the type of recurrence you select. 8 Click OK. NOTE: Note: You can use the Schedule Creator to enter a CRON expression manually by selecting CRON from the Recurrence Type list. See “CRON Expressions in Detail” on page 131 to learn more about CRON expressions. Adding the Action Sequences After you add your schedules, you must associate them with action sequences. Follow the instructions below to enter the paths to the action sequences: 1 Under Scheduled Action, enter the path to each action sequence separated by commas. 2 Click OK. Examining the List of Schedules As you create new schedules, the schedules appear in a list box. By examining the list, you can identify the Name and Group associated with each schedule. You can also determine the status (State) of each schedule and read a brief description of the schedule. In addition, you can determine when the schedule was first run (Fire Time - Last/Next) and when it will run again. The controls on the top corners of the Scheduler page allow you to perform tasks such as: Table 11. Schedule icons Icon 130 Control Name Function Create Schedule Allows you to create a new schedule Edit Schedule Allows you to edit the details of a schedule Ruckus Wireless, Inc. Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports Table 11. Schedule icons Icon Control Name Function Delete Schedule Allows you to delete a specified schedule; however, if the schedule is currently executing in a scheduler thread it continues to execute but no new instances are run Suspend Schedule Allows you to pause a specified schedule. Once the job is paused the only way to start it again is with a Resume Resume selected Schedule(s) Allows you to resume a previously suspended schedule. Once the schedule is resumed the Scheduler applies misfire rules if needed Run Now Allows you to run a schedule immediately Refresh Allows you to refresh the list of schedules Filter by Allows you to search for a specific schedule by group name CRON Expressions in Detail NOTE: The following was copied from the CronTriggers Tutorial located on the Quartz website. Introduction CRON is a UNIX tool that has been around for a long time, so its scheduling capabilities are powerful and proven. The scheduler uses "CRON expressions", which are able to create firing schedules such as: "At 8:00am every Monday through Friday" or "At 1:30am every last Friday of the month". Format A CRON expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows: SmartCell Insight User Guide, 800-71041-001 Rev A 131 Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports Table 12. CRON expression formats Field Name Mandatory? Allowed Values Allowed Special Characters Seconds YES 0-59 ,-*/ Minutes YES 0-59 ,-*/ Hours YES 0-23 ,-*/ Day of month YES 1-31 ,-*?/LWC Month YES 1-12 or JAN-DEC ,-*/ Day of week YES 1-7 or SUN-SAT ,-*?/LC# Year NO empty, 1970-2099 ,-*/ So CRON expressions can be as simple as this: * * * * ? * or more complex, like this: 0 0/5 14,18,3-39,52 ? JAN,MAR,SEP MON-FRI 20022010 Special characters • # ** ("all values") - used to select all values within a field. For example, "" in the minute field means "every minute". • ?* ("no specific value") - useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my trigger to fire on a particular day of the month (say, the 10th), but don't care what day of the week that happens to be, I would put "10" in the dayof-month field, and "?" in the day-of-week field. See the examples below for clarification. • -* - used to specify ranges. For example, "10-12" in the hour field means "the hours 10, 11 and 12". • ,* - used to specify additional values. For example, "MON,WED,FRI" in the dayof-week field means "the days Monday, Wednesday, and Friday". • /* - used to specify increments. For example, "0/15" in the seconds field means "the seconds 0, 15, 30, and 45". And "5/15" in the seconds field means "the seconds 5, 20, 35, and 50". You can also specify '/' after the '' character - in this case '' is equivalent to having '0' before the '/'. '1/3' in the day-of-month field means "fire every 3 days starting on the first day of the month". 132 Ruckus Wireless, Inc. Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports • L* ("last") - has different meaning in each of the two fields in which it is allowed. For example, the value "L" in the day-of-month field means "the last day of the month"- day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month" for example "6L" means "the last friday of the month". When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing results. • W ("weekday") - used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-ofmonth field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify "1W" as the value for dayof-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days. • The 'L' and 'W' characters can also be combined in the day-of-month field to yield 'LW', which translates to "last weekday of the month". • #* - used to specify "the nth" XXX day of the month. For example, the value of "6#3" in the day-of-week field means "the third Friday of the month"(day 6 = Friday and "#3" = the 3rd one in the month). Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month. Note that if you specify "#5" and there is not 5 of the given day-of-week in the month, then no firing will occur that month. • C ("calendar") - this means values are calculated against the associated calendar, if any. If no calendar is associated, then it is equivalent to having an all-inclusive calendar. A value of "5C" in the day-of-month field means "the first day included by the calendar on or after the 5th". A value of "1C" in the day-of-week field means "the first day included by the calendar on or after Sunday". • The legal characters and the names of months and days of the week are not case sensitive. MON is the same as mon. Examples Here are some full examples: SmartCell Insight User Guide, 800-71041-001 Rev A 133 Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports Table 13. CRON expression examples 134 Expression Meaning 0 0 12 * * ? Fire at 12pm (noon) every day 0 15 10 ? * * Fire at 10:15am every day 0 15 10 * * ? Fire at 10:15am every day 0 15 10 * * ? * Fire at 10:15am every day 0 15 10 * * ? 2005 Fire at 10:15am every day during the year 2005 0 * 14 * * ? Fire every minute starting at 2pm and ending at 2:59pm, every day 0 0/5 14 * * ? Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day 0 0/5 14,18 * * ? Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day 0 0-5 14 * * ? Fire every minute starting at 2pm and ending at 2:05pm, every day 0 10,44 14 ? 3 WED Fire at 2:10pm and at 2:44pm every Wednesday in the month of March. 0 15 10 ? * MON-FRI Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday 0 15 10 15 * ? Fire at 10:15am on the 15th day of every month 0 15 10 L * ? Fire at 10:15am on the last day of every month 0 15 10 ? * 6L Fire at 10:15am on the last Friday of every month 0 15 10 ? * 6L Fire at 10:15am on the last Friday of every month 0 15 10 ? * 6L 2002-2005 Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005 0 15 10 ? * 6#3 Fire at 10:15am on the third Friday of every month 0 0 12 1/5 * ? Fire at 12pm (noon) every 5 days every month, starting on the first day of the month. 0 11 11 11 11 ? Fire every November 11th at 11:11am. Ruckus Wireless, Inc. Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports NOTE: • Support for the features described for the 'C' character is not complete. • Support for specifying both a day-of-week and a day-of-month value is not complete (you must currently use the '?' character in one of these fields). • Be careful when setting fire times between mid-night and 1:00 AM - "daylight savings" can cause a skip or a repeat depending on whether the time moves back or jumps forward. SmartCell Insight User Guide, 800-71041-001 Rev A 135 Using the Enterprise Console Using the Scheduler to Define Public Schedules for Custom Reports 136 Ruckus Wireless, Inc. Troubleshooting the SmartCell Insight Application 7 In this chapter: • Before You Begin • Using the SCI Admin Interface • Backup and Restore • Uninstall Process • Troubleshooting the Vertica Database SmartCell Insight User Guide, 800-71041-001 Rev A 137 Before You Begin Architecture Overview Before You Begin SmartCell Insight is designed to be installed on a CentOS or RedHat Enterprise Linux server and is distributed as a .tar file for installation on CentOS/RHEL. Architecture Overview Figure 92 illustrates the data flow from data sources in structured or unstructured data formats to SCI for data integration and consolidation, transformation, query and reporting to various output formats. Figure 92. SCI architecture overview Prerequisites The following prerequisites must be met for proper SCI operation: Ensure NTP Server Is Reachable The time on the machine must be correct with regards to the time zone displayed by the 'date' command. The clock must be synchronized at all times with all other Ruckus equipment by using public clock source such as an Internet NTP or a company’s internal NTP in case of no Internet access. By default, SCI will enable NTP with the CentOS default servers, which are on the Internet. 138 Ruckus Wireless, Inc. Before You Begin Prerequisites Enable SCI-SZ Interaction 1 Login to the SZ CLI: wsgcli 2 Enter privileged mode: enable 3 Enter configuration mode: config 4 Enable SZ > SCI interaction: ap-sci enable 5 Confirm SCI interaction is enabled: • For SCG-200: show running zone-global ap-sci • For SZ-100 (as of 3.0): show running common-settings ap-sci Enable SCI-FlexMaster Interaction 1 Log in to FlexMaster. 2 Enter the MySQL console by running the following command on the FlexMaster host: /opt/FlexMaster/3rdparty/mysql/mysql*/bin/mysql --socket /opt/FlexMaster/3rdparty/mysql/mysql*/mysql.sock -uroot –p 3 Enter the MySQL root user name that you used during the FM installation. 4 Run the following SQL queries: mysql> GRANT SELECT ON itms.* TO [reporting]@'%' IDENTIFIED BY [ruckus] mysql> FLUSH PRIVILEGES; NOTE: Replace [reporting] and [ruckus] with the user name and password you would like to use for SCI. SmartCell Insight User Guide, 800-71041-001 Rev A 139 Using the SCI Admin Interface The Monitoring Page Using the SCI Admin Interface The following Web interface pages provide options for configuring and troubleshooting SCI and its connected data sources. To access the SCI Admin Console, use the following URL: https://[SCI_IP_address]:8443 The Monitoring Page The Monitoring page is the first place to check for information on how the system is doing. It provides a one-stop-shop for information on data source connection status, system processes, RAM distribution, HDD usage, NTP and other important OS information. Figure 93. Data Sources 140 Ruckus Wireless, Inc. Using the SCI Admin Interface The Monitoring Page Figure 94. Service Status Figure 95. Resource Utilization Figure 96. Disk Usage, Uptime, NTP Information, etc. SmartCell Insight User Guide, 800-71041-001 Rev A 141 Using the SCI Admin Interface The Diagnostics Page The Diagnostics Page The Diagnostics page provides advanced debugging options for job execution and polling statistics. It shows relevant information for both Extraction and Transformation jobs including timestamp, runtime, status, link to logs and polled file size. Runtime trend graphs display overall status views. Logs are kept for 7 days and deactivated or removed sources info will be shown for another 7 days. Figure 97. Extraction Job Status Figure 98. Transform & Load Job Status Job Performance The Job Performance graphs display the performance of the most recent Extraction and Transform/Load jobs. 142 Ruckus Wireless, Inc. Using the SCI Admin Interface Capture Logs Figure 99. Job Performance Capture Logs From the Diagnostics page, click the click here link to generate a logs package. The logs will be available for download from the same location after a couple of minutes. This compressed archive contains all logs and relevant information needed for the engineering team to further debug the system. It is advisable to provide the information described in previous sections when a job is suspected to have caused the problem. Figure 100. Create a new diagnostics archive SmartCell Insight User Guide, 800-71041-001 Rev A 143 Backup and Restore Backup Server Backup and Restore Backup Server The following procedure must be followed the first time you perform a backup to a backup server: 1 Create a backup server on a different machine. 2 On the backup server: a Create dbadmin user. b Turn off iptables. c Turn off SELinux. 3 On the source server, execute the following command: /opt/ruckuswireless/sci/scripts/setup_backup_host.sh You do not need to repeat these steps when backing up again to the same backup server. Backup and Restore Process Backup From the second time you backup to the backup server: 1 Clean previous backups from the backup server (/opt & /tmp folders). 2 Run the following command: /opt/ruckuswireless/sci/scripts/sci_backup.sh Restore Once your backup server is set up, run the following command to restore from the backup server: /opt/ruckuswireless/sci/scripts/sci_restore.sh Uninstall Process 1 Uninstall SCI using the following command: /opt/ruckuswireless/sci/scripts/sci_uninstall 2 Refresh repository: yum clean all 144 Ruckus Wireless, Inc. Troubleshooting the Vertica Database Using the Vertica Troubleshooting Admin Tools Troubleshooting the Vertica Database Vertica is very sensitive to abnormal system shutdown. It can recover from corrupted data due to abnormal system shutdown - however, this is NOT recommended as a practice. Some data which has not been fully committed will be lost, and this is not a guaranteed operation. It is advisable to maintain backups at intervals equal to the maximum acceptable amount of data loss in the event of a catastrophe. NOTE: To prevent loss of data due to power outage, SCI should always be run on a redundant power supply such as a UPS system. Using the Vertica Troubleshooting Admin Tools 1 Log into SCI via SSH as the root user. 2 Run the command: su – dbadmin 3 Run the command: adminTools 4 Type 3 and then Enter to run option 3 from the menu. 5 Click the space key to select aa1 DB (an X displays the selected option, as depicted). 6 Press the Enter key to confirm. 7 You will be asked for your password. Figure 101. Vertica Analytic Database Administration Tools Recovering the Database 1 Type dbadmin and press the Enter key to confirm. 2 Since at first it will try a regular startup, it will fail. 3 Press Enter to continue. SmartCell Insight User Guide, 800-71041-001 Rev A 145 Troubleshooting the Vertica Database Recovering the Database 4 A notice asking you if you want to recover will appear. Click Yes. 5 It will restart from the last known good point in time and will tell you that the DB started successfully. 6 Press Enter to confirm, E to exit. Figure 102. Vertica database startup 146 Ruckus Wireless, Inc. Appendix 8 In this chapter: • Appendix A: Station Session Statistics • Appendix B: Virtual AP Transmission and Reception Statistics • Appendix C: Aggregation of Measurements by ZoneDirector SmartCell Insight User Guide, 800-71041-001 Rev A 147 Appendix A: Station Session Statistics Appendix A: Station Session Statistics Each virtual AP (VAP) keeps track of station session statistics and reports them to ZoneDirector or SZ. Session traffic is traffic for which a subscriber can be billed. If a station’s session has not started, statistics on the 802.11 data and management frames exchanged between the station and the VAP is classified, accounted and reported as “Pre-Session” traffic and accumulated as part of VAP statistics. When a station’s session has started, its statistics are accumulated as part of STA session statistics. NOTE: In SCI v1.0, for both ZD and SZ, each WLAN has a configuration to “Ignore statistics from unauthorized clients”. If this configuration is disabled and the WLAN is configured for Hotspot (WISPr) service, the client’s session traffic statistics will erroneously include traffic while the client is in the un-authorized state (e.g., walledgarden traffic). The following table lists the session statistics collected and descriptions of how SCI calculates and consolidates them for use in reports. 148 Ruckus Wireless, Inc. Appendix A: Station Session Statistics Table 14. Station session statistics Name Description AP-ZD: client > interval-stats > tx- The cumulative number of individually addressed (unicast) MSDUs encapsulated into 802.11 frames of type data and sub-type “Data” packets or “QoS-data” successfully transmitted by an AP to a particular AP-SZ: ueSession > txFrames STA during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. Does not include MSDUs from any frames unsuccessfully transmitted (i.e., frames for which AP did not receive an ACK control frame)—these frames will typically be retried at layer 2. However, this statistic does include re-transmitted MSDUs due to upper-layer retransmission mechanisms (e.g., TCP retries). 2. For HT frames (802.11n frames), each MSDU in the A-MSDU frame, A-MPDU frame or A-MPDU frame carrying an A-MSDU payload is decapsulated and counted as an individual packet. Only MSDUs which are successfully transmitted are counted. For example, if an AP transmits an A-MPDU frame containing 20 MSDUs and receives a Block-Ack indicating 18 MSDUs were successfully received, tx-packets would incremented by 18. 3. Frame subtypes of “Data” and “QoS-Data” are mutually exclusive, dependent on whether the STA associates as a QoScapable STA (b13 set in FC) or a WMM STA. 4. If the frame subtype is “QoS-data”, then the user priority value in the 802.11 QoS header can have any value. 5. Frames of subtype “Null” and “QoS-Null” frames are not included in these counts. 6. Includes the following traffic: a. IP datagrams carrying application traffic. b. Non IP, layer-3 packets. c. Network-layer management traffic a STA needs to access network resources (e.g., DHCP, ARP, DNS, IGMP, SIP, etc.). d. Includes data link layer traffic above the 802.11 MAC (e.g., 802.1 frames such as LLDP (802.1ab)). AP-ZD: client > interval-stats > tx- The cumulative number of bytes in all 802.11 MSDUs counted in tx-packets transmitted by an AP to a particular STA during a given bytes MI. AP-SZ: ueSession > txBytes Type: 64-bit unsigned integerUnits: n/a Notes: 1. Same notes as for tx-packets. 2. tx-bytes does not include the 8-octet LLC/SNAP header (see [2]) in an MSDU. SmartCell Insight User Guide, 800-71041-001 Rev A 149 Appendix A: Station Session Statistics Name Description AP-ZD client > interval-stats > rx- The cumulative number of individually addressed (unicast) MSDUs decapsulated from 802.11 frames of type data and sub-type packets “Data” or “QoS-data” received by an AP from a particular STA AP-SZ: ueSession > rxFrames during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. Same notes as for tx-packets. 2. MSDUs received from duplicate frames are excluded. AP-ZD: client > interval-stats > rx- The cumulative number of bytes in all 802.11 MSDUs counted in bytes rx-packets received by an AP from a particular STA during a given MI. AP-SZ: ueSession > rxBytes Type: 64-bit unsigned integerUnits: n/a Notes: same notes as for tx-bytes. AP-ZD: client > interval-stats > Estimated-throughput is the short-time averaged MSDU throughput-est throughput the client is receiving when the AP is actually AP-SZ: ueSession > throughputEst transmitting to that client. It is measured in bits/s and takes into account the PHY rate, error rate, and all contention due to 802.11 and non-802.11 transmitters. Because it takes into account every source of link impairment, Estimated-throughput is the best possible way of numerically characterizing client performance in a single number. AP-ZD: session > session-sta > rssi An estimate of the received signal to noise ratio, reported in dB, at the AP for each received frame from a particular STA during a given AP-SZ: ueSession > rssi MI. The SNR is rounded to the nearest dB. Type: 8-bit integerUnits: dB (a positive number, e.g., 19dB) Notes: 1. For SCIv1, only the last snr-uplink value in an MI is retained by the AP, regardless of the number of frames successfully received from the STA. 2. WiFi silicon produces SNR measurements for each BeamFlex antenna (individually) as well as for the combination of the two or three (depending on the AP model) antennas. The combined SNR measurement is reported to SCI. 3. Note that the combined antenna gain is determined by WiFi radio’s signal processing algorithms (maximal ratio combiner). This means that the on average, the upstream SNR reported is typically 3 to 5dB higher than the single antenna SNR. 150 Ruckus Wireless, Inc. Appendix A: Station Session Statistics Name Description AP-ZD: session > session-sta > received-signal-strength AP-SZ: ueSession > receivedsignal-strength An estimate of the received signal power (aka received signal strength), reported in dBm, at the AP for each received frame from a particular STA during a given MI. The RSSI is rounded to the nearest dB. Type: 8-bit integerUnits: dBm (a negative number, e.g., -62dBm) Notes: 1. RSSI is computed from the WiFi silicon’s measurement of SNR on frames received from associated STAs and a computed noise floor estimate . From these measurements, RSSI is computed as RSSI (dBm) = SNR (dB) + NFE (dBm), where NFE = a noise floor estimate computed by the WiFi silicon. 2. Note that, the combined SNR, which is transformed to a combined RSSI, is reported to SCI. Radio engineers familiar with single-antenna RSSI should be careful to note this difference. 3. The user experience is actually determined by the STA’s throughput, which in turn is governed by SNR / SINR, not the RSSI. The reason for this is because the local noise floor [physically / geographically] around the AP (or STA) can be higher than the thermal noise floor due to spurious transmitters in the environment (e.g., every electronic device transmits so-called unintentional interference, which is regulated by the FCC and other international regulatory agencies). Also, the local environment can have elevated levels of interference (e.g., caused by microwave ovens, cordless phones, distant WiFi transmitters, etc.). The result being that while the RSSI reports an absolute signal level, it does not provide information on the quality of the received signal (unlike SNR)—that is, the underlying amount of interference plus noise. SmartCell Insight User Guide, 800-71041-001 Rev A 151 Appendix A: Station Session Statistics Name Description 4. WiFi silicon computes the NFE as follows: a) Noise floor calibration is scheduled periodically so as to have an updated NFE once per minute. b) When calibration commences, RF switches in the AP’s radio “disconnect” the antennas from the receiver chain. “Disconnect” in the RF sense means the RF switches are placed in the “open” state, maximizing their isolation. This helps to make a more accurate measurement. However, strong signals incident on the antenna(s) can corrupt the measurement because the RF switches are only capable of providing a limited degree of isolation. c) When a NFE measurement is scheduled, the inter-frame gap is used (see SIFS in [1]) because for the AP making the measurement, no other STAs or APs should be transmitting at this time. Note that so-called “hidden stations” (see clause 3 in [1]) could be transmitting; interference could also be received from foreign transmitters. d) The NFE algorithm averages several of the lowest-valued NFE measurements to create the NFE. The concept of taking the minimum-valued measurements is that these are the least likely to have been corrupted by interference. e) Note: in deployments, NFE variations greater than 10dB have been observed, dependent on the environment. 5. The RSSI together with SNR can be used to diagnose throughputs lower than expected in a given environment. For example, if the reported RSSI is high, but the SNR is low, local interference may be the cause. 6. For cost reasons, Ruckus’ AP manufacturing test process does not calibrate the absolute gain of the WiFi radios’ receivers. Therefore, the reported RSSI is an approximation (i.e., an uncalibrated measurement). 7. For SCIv1, only the last rssi [-uplink] value in an MI is retained by the AP, regardless of the number of frames successfully received from the STA. AP-ZD: session > session-sta > noise-floor AP-SZ: ueSession > noiseFloor An estimate of the radio’s thermal noise floor, reported in dBm, at the AP during a given MI. The noise floor estimate is rounded to the nearest dB. Type: 8-bit integerUnits: dBm (a negative number, e.g., 102dBm) Notes: 1. The noise floor is computed by WiFi silicon in the AP. This measurement is made by the silicon during inter-packet gaps (e.g., see SIFS in [1]), when the AP is not otherwise using the airlink. 152 Ruckus Wireless, Inc. Appendix A: Station Session Statistics Name Description 2. Note that even when the AP is not using the airlink, other APs might be using the same RF channel causing low-level interference or there could be Foreign Interference, corrupting the thermal noise floor estimate. 3. Radio firmware on the AP produces one NFE estimate approximately every 60s, and only one values is used per statistics MI. The value reported to statistics is actually the median value of the last 5 NFEs produced by the WiFi silicon. Taking the median value produces a better estimate when interference is present in the environment. 4. The noise floor value will be the same for all VAPs configured on a radio. AP-ZD: session > session-sta > associated-time AP-SZ: ueSession > firstConnection The timestamp of the time at which the STA is successfully associated. This timestamp is used to compute the duration of time a STA must wait for authorization to access the WiFi network. Type: 64-bit signed integerUnits: Unix/Posix time ? 1000 (least significant bit has units of ms ) Notes: 1. When the STA transitions from one AP to another in a given ESS, the first-assoc[-time] is not updated. The associated-time is used only on the initial association to the ESS. 2. The STA is associated when the AP successfully transmits an 802.11 Association Response frame to the STA. AP-ZD: session > session-sta > authorized-time AP-SZ: ueSession > authorizedTime The timestamp of the time at which a particular STA is authorized to access the WiFi network. Type: 64-bit signed integerUnits: Unix/Posix time ? 1000 (least significant bit has units of ms) Notes: 1. When the authentication method is WPA2-Enterprise, the timestamp is the time at which the 4-way handshake completes (i.e., the AP successfully receives Message 4, see clause 11.6.6.1 in [1]). 2. When the authentication method is Open (i.e., 802.11 open system authentication without a captive portal), the timestamp is the time at which the AP successfully transmits the Association Response to the STA. 3. When the authentication method is Captive Portal (or WISPr), the timestamp is the time at which the AP receives from the Captive Portal a signal indicating the STA is authorized. Note for this authentication method, the time-to-authorized state for the STA includes the time for IP address allocation and the first DNS name resolution. SmartCell Insight User Guide, 800-71041-001 Rev A 153 Appendix A: Station Session Statistics Name Description AP-ZD: session > session-sta > end-time AP-SZ: ueSession > disconnectTime The timestamp of the time at which a particular STA’s session ends. Note the events which cause the session to end are described in the introductory paragraphs of this section. Type: 64-bit signed integerUnits: Unix/Posix time ? 1000 (least significant bit has units of ms) AP-ZD: session > session-sta > ap The base MAC address of the AP to which the STA is associated. AP-SZ: apClient > ap Type: StringUnits: MAC address Notes: 1. The 4 least significant bits of the base MAC address are set to 0 (e.g., 01:23:45:2b:de:f0). 2. The two most significant bits of the 7th most significant nibble (i.e., the "y" nibble in xx:xx:xx:yx:xx:x0) can take one of the following four values (in binary): 00xx, 01xx, 10x or 11xx. The base MAC address of the AP has the form 00xx for the "y" nibble. 3. Thus, there are a total of 64 MAC addresses assigned during the manufacturing process to each AP. Up to 32 MAC addresses can be used per radio. The AP's Ethernet MAC address is also drawn from this pool. 4. Each VAP configured on this AP is allocated a unique MAC address so constructed (e.g., 01:23:45:ab:de:f3). AP-ZD: session > session-sta > ssid AP-SZ: apClient > ssid The SSID value identifying the ESS to which the STA is associated. Type: StringUnits: - AP-ZD: session > session-sta > vap-mac AP-SZ: apClient > vapMac The MAC address of the VAP to which the STA is associated. Type: StringUnits: MAC address AP-ZD: session > session-sta > radio-type AP-SZ: apClient > radio > mode The radio type of the STA. Type: StringUnits: Enumeration ? {11b, 11g, 11bg, 11ng, 11a, 11na} AP-ZD: session > session-sta > user AP-SZ: ueSession > user The username of the username/password credential the STA used to authenticate to the WiFi network. Type: StringUnits: Notes: 1. When EAP authentication is used, the user string is set to the value supplied by the STA in the EAP Identity Response frame AP-ZD: session > session-sta > acct-session-id AP-SZ: ueSession > sessionID 154 The session ID is assigned by the WiFi network to the STA while it’s associated to this particular AP. Type: StringUnits: - Ruckus Wireless, Inc. Appendix B: Virtual AP Transmission and Reception Statistics Name Description The multi-session ID is assigned by the WiFi network to the STA AP-ZD: session > session-sta > while it’s authorized on the ESS. This identifier binds together all acct-multi-session-id AP-SZ: ueSession > multiSessionID the acct-session-ids so that statistics for a single STA, while associated to various APs in the ESS, can be properly combined. Type: StringUnits: AP-ZD: client > hostname The STA’s hostname which the AP obtains by snooping on DHCP. AP-SZ: apClient > sta > hostname Type: StringUnits: AP-ZD: session > session-sta > vlan The STA’s VLAN ID is assigned by the WiFi network. AP-SZ: apClient > sta > vlan Type: StringUnits: AP-ZD: session > session-sta > dvcinfo AP-SZ: apClient > sta > devInfo Information on the STA including it's OS (operating system) type. Type: StringUnits: - AP-ZD: session > session-sta > disconnect-reason AP-SZ: ueSession > disconnectReason The reason the STA ended the session. Valid reasons are take from Table 8-36 inn [1]. Type: EnumerationUnits: Notes: 1. Reason code value 64 means the user logged out using the Captive Portal and overrides the reason provided in Table 8-36 of [1]. Notes: 1 “subtype any” means the subtype value in the FC field (802.11 MAC header) can take on values of 0 to 15 inclusive. Appendix B: Virtual AP Transmission and Reception Statistics Each virtual AP keeps track of transmission and reception statistics which are not included in STA session statistics and reports them to ZD/SZ. These statistics are described in Table 15 below. SmartCell Insight User Guide, 800-71041-001 Rev A 155 Appendix B: Virtual AP Transmission and Reception Statistics Table 15. AP Transmission and Reception Statistics Name Description AP-ZD: vap > interval-stats > txpackets AP-SZ: report > bin > radio > wlan > txDataFrames_r The cumulative number of MSDUs encapsulated into 802.11 frames of type data and sub-type “Data” or “QoS-data” successfully transmitted by an AP to any STA during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. This counter includes both individually addressed (unicast) and group addressed (multicast and broadcast) frames. 2. Does not include MSDUs from any frames unsuccessfully transmitted (i.e., frames for which AP did not receive an ACK control frame)—these frames will typically be retried at layer 2. However, this statistic does include re-transmitted MSDUs due to upper-layer retransmission mechanisms (e.g., TCP retries). 3. For HT frames (802.11n frames), each MSDU in the A-MSDU frame, A-MPDU frame or A-MPDU frame carrying an A-MSDU payload is decapsulated and counted as an individual packet. Only MSDUs which are successfully transmitted are counted. For example, if an AP transmits an A-MPDU frame containing 20 MSDUs and receives a Block-Ack indicating 18 MSDUs were successfully received, tx-packets would incremented by 18. 4. Frame subtypes of “Data” and “QoS-Data” are mutually exclusive, dependent on whether the STA associates as a QoScapable STA (b13 set in FC) or a WMM STA. 5. If the frame subtype is “QoS-data”, then the user priority value in the 802.11 QoS header can have any value. 6. Frames of subtype “Null” and “QoS-Null” frames are not included in these counts. 7. Includes the following traffic: a. IP datagrams carrying application traffic. b. Non IP, layer-3 packets. c. Network-layer management traffic a STA needs to access network resources (e.g., DHCP, ARP, DNS, IGMP, SIP, etc.). d. Includes data link layer traffic above the 802.11 MAC (e.g., 802.1 frames such as LLDP (802.1ab)). AP-ZD: vap > interval-stats > txbytes AP-SZ: report > bin > radio > wlan > txDataBytes_r 156 The cumulative number of bytes in all 802.11 MSDUs counted in tx-packets transmitted by an AP to any STA during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. Same notes as for tx-bytes. 2. tx-bytes does not include the 8-octet LLC/SNAP header (see [2]) in an MSDU. Ruckus Wireless, Inc. Appendix B: Virtual AP Transmission and Reception Statistics Name Description AP-ZD: vap > interval-stats > rxpackets AP-SZ: report > bin > radio > wlan > rxDataFrames_r The cumulative number of MSDUs decapsulated from 802.11 frames of type data and sub-type “Data” or “QoS-data” received by an AP from any STA during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. This counter includes both individually addressed (unicast) and group addressed (multicast and broadcast) frames. 2. Same notes as for tx-packets. 3. MSDUs received from duplicate frames are excluded. AP-ZD: vap > interval-stats > rxbytes AP-SZ: report > bin > radio > wlan > rxDataBytes_r The cumulative number of bytes in all 802.11 MSDUs counted in rx-packets received by an AP from a particular STA during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: same notes as for tx-bytes. AP-ZD: vap > interval-stats > txmgmt-frames AP-SZ: report > bin > radio > wlan > txMgmtFrames_r The cumulative number of 802.11 frames of type management and sub-type "any" successfully transmitted by an AP during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. This counter includes both individually addressed (unicast) and group addressed (multicast and broadcast) frames. 2. Does not include any frames unsuccessfully transmitted (i.e., frames for which AP did not receive an ACK control frame)—these frames will typically be retried at layer 2. 3. Does not include any class-1 management frames transmitted to the STA before it associated to the VAP (see clause 10.3.2 and 10.3.3 in [1], e.g., Probe Response frames, Authentication frames and Public Action frames such as IEEE 802.11u GAS, etc.). 4. Includes all class-2 management frames (e.g., (Re)Association Response) and all class-3 management frames. AP-ZD: vap > interval-stats > txmgmt-bytes AP-SZ: report > bin > radio > wlan > txMgmtBytes_r The cumulative number of bytes in all 802.11 frames included in tx-mgmt-frames successfully transmitted by an AP during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. Includes all bytes in the MMDPU—includes the 802.11 MAC header, frame body and FCS (see Figure 8-1 in [1]). Does not include any bytes in the PHY header or PLCP header. SmartCell Insight User Guide, 800-71041-001 Rev A 157 Appendix B: Virtual AP Transmission and Reception Statistics Name Description AP-ZD: vap > interval-stats > rxmgmt-frames AP-SZ: report > bin > radio > wlan > rxMgmtFrames_r The cumulative number of 802.11 frames of type management and sub-type "any" successfully received by an AP during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. This counter includes both individually addressed (unicast) and group addressed (multicast and broadcast) frames. 2. For frame sub-types which require the AP to transmit an ACK control frame (e.g., Association Request frame), duplicate frames are excluded. Note if the AP receives Probe Request frames unicast transmitted to its BSSID, it will exclude duplicate (re-tried) Probe Request frames. 3. An AP receiving Probe Request frames transmitted to the broadcast MAC destination address having a matching SSID (either exact match or wildcard match ) will count each successfully received Probe Request frame in this parameter. AP-ZD: vap > interval-stats > rxmgmt-bytes AP-SZ: report > bin > radio > wlan > rxMgmtBytes_r 158 The cumulative number of bytes in all 802.11 frames included in rx-mgmt-frames successfully received by an AP during a given MI. Type: 64-bit unsigned integerUnits: n/a Notes: 1. Same notes as for tx-mgmt-bytes. 2. Includes all bytes in the MMDPU—includes the 802.11 MAC header, frame body and FCS (see Figure 8-1 in [1]). Does not include any bytes in the PHY header or PLCP header. Ruckus Wireless, Inc. Appendix C: Aggregation of Measurements by ZoneDirector Appendix C: Aggregation of Measurements by ZoneDirector Table 16 explains the method used by ZDs to aggregate statistics reported by APs as well as the method APs used to aggregate data to report to SZ. Statistics for which no aggregation is performed are omitted from this table. Table 16. Mapping of Aggregated Statistics to AP Statistics No. ZD & SZ Aggregated Statistic 1 ZD: vap > interval-stats > tx-bytes AP > SZ: report > bin > radio > wlan > txDataBytes_r Description of Aggregation Method where, • tx-bytes(i) are the number of tx-bytes transmitted by the AP during the ith MI. Note: there are 10 90-s MIs in a 15-min AMRI. 2 ZD: vap > interval-stats > rx-bytes AP > SZ: report > bin > radio > wlan > rxDataBytes_r where, • rx-bytes(i) are the number of rx-bytes received by the AP during the ith MI. Note: in general, the number of STAs associated to the VAP will not remain constant over the duration of the AMRI. Note: there are 10 90-s MIs in a 15-min AMRI. 3 ZD: client > interval-stats > tx-bytes AP > SZ: ueSession > txBytes where, • tx-bytes(i) are the number of tx-bytes transmitted to the STA during the ith MI. Note: there are 10 90-s MIs in a 15-min AMRI. 4 ZD: client > interval-stats > rx-bytes AP > SZ: ueSession > rxBytes where, • rx-bytes(i) are the number of rx-bytes received from the STA during the ith MI. Note: there are 10 90-s MIs in a 15-min AMRI. SmartCell Insight User Guide, 800-71041-001 Rev A 159 Appendix C: Aggregation of Measurements by ZoneDirector No. ZD & SZ Aggregated Statistic Description of Aggregation Method 5 ZD: client > interval-stats > throughput-est AP > SZ: ueSession > throughputEst last(throughput-est(0), throughput-est(1), … throughput-est(9)) where, • throughput-est(i) is the saturated throughput of the VAP towards the STA during the ith MI. • last(•) is a function whose output equals the value of the last argument (i.e., the value of throughput-est on the final MI in the AMRI) 6 ZD: session > session-sta > rssi AP > SZ: ueSession > rssi last(rssi(0), rssi(1), … rssi(9)) where, • rssi(i) is the uplink SNR in the ith MI during an AMRI 7 ZD: session > session-sta > max-rssi AP > SZ: ueSession > maxRssi max(rssi(0), rssi(1), … rssi(9)) where, • max(•) is a function whose output equals the maximum value of all the arguments 8 ZD: session > session-sta > min-rssi AP > SZ: ueSession > minRssi min(rssi(0), rssi(1), … rssi(9)) where, • min(•) is a function whose output equals the minimum value of all the arguments 9 ZD: session > session-sta > first-rssi AP > SZ: ueSession > firstRssi first(rssi(0), rssi(1), … rssi(9)) where, • first(•) is a function whose output equals the value of the first argument 160 10 ZD: session > session-sta > received-signal- last(received-signal-strength(0), receivedsignal-strength(1), … received-signalstrength strength(9)) AP > SZ: ueSession > received-signalstrength where, • received-signal-strength(i) is the uplink received signal power during the ith MI during an AMRI. 11 ZD: session > session-sta > max-receivedsignal-strength AP > SZ: ueSession > max-received-signalstrength max(received-signal-strength(0), receivedsignal-strength(1), … received-signalstrength(9)) Ruckus Wireless, Inc. Appendix C: Aggregation of Measurements by ZoneDirector No. ZD & SZ Aggregated Statistic Description of Aggregation Method 12 ZD: session > session-sta > min-receivedsignal-strength AP > SZ: ueSession > min-received-signalstrength min(received-signal-strength(0), receivedsignal-strength(1), … received-signalstrength(9)) 13 ZD: session > session-sta > first-receivedsignal-strength AP > SZ: ueSession > first-received-signalstrength first(received-signal-strength(0), receivedsignal-strength(1), … received-signalstrength(9)) 14 ZD: session > session-sta > noise-floor AP > SZ: ueSession > noisefloor last(noise-floor(0), noise-floor(1), … noisefloor(9)) where, • nfe(i) is the noise floor estimate of the VAP during the ith MI. SmartCell Insight User Guide, 800-71041-001 Rev A 161 Appendix C: Aggregation of Measurements by ZoneDirector 162 Ruckus Wireless, Inc. Index A Access Point Traffic Report 61 Action Icons 74 Adding a FlexMaster Data Source 103 Adding a Report Description 82 Adding Fields and Filters 75 Adding Users 126 Admin Console 92 Admin Interface Diagnostics Page 114 Monitor Page 93 System Setup Page 103 Administration Interface 92 Administrator Login 119 Alert History 118 Alert Settings 112 AP Groups Response Time Trend Report 51 AP Inventory Report 47 AP Licensing 107 AP Model Distribution 55 AP Reboots Report 58 AP Response Statistics 72 AP Response Time Report 52 AP Statistics 72 AP Traffic Volume Report 64 APs by Model 55 Auto-Refresh 31 Available Metrics 88 B Backup 144 Client Throughput Estimate Report 63 Configuring a FlexMaster Data Source 103 Configuring Data Purge Policy 110 Configuring Data Sources 103 Configuring SmartZone Data Sources 106 Configuring SMPT Settings 111 Controller Hardware Utilization Report 54 Controller Inventory Report 48 Controller Resource Utilization 72 Controller Statistics 72 Creating Users and Roles 125 CRON 131 Custom Report Scheduling 129 Custom Reports 68 D Dashboards 30 Data Purge Policy 110 Data Purge Settings 110 Data Source Configuration 103 Data Sources 93, 103 Deactivated Data Source Reactivating 98 Deactivating a Data Source 95 Deleting a Deactivated Data Source 97 Deleting Roles 128 Deleting Users 127 Description 82 Diagnostics Archive 114 Diagnostics Page 114, 142 Displaying ETL Log Files 116 Distribution of APs by Model 55 C Changing the Admin Password 119 Chart Format 77 Chart Type 78 Client Complete Sessions 72 Client Fingerprint Report 39 Client Health Dashboard 33 Client Potential Throughput Report 62 Client Session Intervals 72 SmartCell Insight User Guide, 800-71041-001 Rev A E Editing Roles 128 Editing User Information 126 Email Alerts 112 Email Settings 111 Enterprise Console 125 ETL Log Results Display 116 Events 72 163 Extraction Job Status 116 Number of Unique Clients Report 42 F O Field Definition 77 Fields and Filters 75 Filters 79 Finding Roles 129 Finding Users 127 First Experience of New Clients Report 39 FlexMaster Data Source Configuration Operational Reports 51 P 103 Performance Graphs 117 Potential Throughput Report 62 Pre-installation Procedures 20, 138 Purge Policy 110 I R Importing a License File 107 Importing a SmartZone Data Source 106 Individual AP Response Time Report 53 Individual AP Traffic Report 65 Installation Overview 20 Interface settings 23 Introducing SmartCell Insight 14 Inventory Reports 47 Reactivating a Deactivated Data Source J 98 Report Description 82 Report Workspace Elements 24 Response Time Report 59 Response Time Tests 94, 95, 99 Restore 144 Rogue APs 72 Rogue APs Report 56 Ruckus Dashboards 30 Ruckus Reports 37 Job Performance 117 S L Managing Roles 127 Map View 31 Measure Fields 76 Metrics 88 Monitor Page 93 Monitoring Page 140 Schedling Custom Reports 129 SCI - AP Response Time Tests 99 SCI > AP Response Time Tests 94, 95 SCI Sources Configuration 103 Session Bytes Transferred report 43 Session Duration Report 44 Session Inventory Report 49 SmartZone Data Source 106 SMTP Settings 111 Snapshot Archive 116 SSL Settings 108 System Configuration 108 System Setup Page 103 System Timekeeping 123 N T Network Health Dashboard 30 New Analyzer Report 68, 70 New Analyzer Report Page 73 NTP 123, 138 Number of Sessions Report 41 Throughput Estimate of Clients Report 63 Throughput Estimate Report 63 Time Period Fields 76 Top AP Reboots Report 58 Top APs by Traffic Volume Report 64 Level Fields 76 Licensing 107 Log Files 116 Longest Response Time Report 59 M 164 Ruckus Wireless, Inc. Top APs with Most Topology Changes Report 57 Top Clients by Traffic Volume Report 45 TopN APs with the Longest Response Time Report 59 Topology Change Report 57 Traffic Report 61 Traffic Reports 61 Transform/Load Job Status 116 Troubleshooting Vertica 145 U Uninstall 144 Upgrading the SCI License 107 Usage Distribution and Trends Dashboard 34 User interface 23 Users and Roles 125 Using the Enterprise Console 125 Using the Map View 31 Using the Scheduler 129 V Vertica 145 W Workspace 24 Z ZoneDirector Groups 104 SmartCell Insight User Guide, 800-71041-001 Rev A 165 166 Ruckus Wireless, Inc. Copyright © 2006-2015. Ruckus Wireless, Inc. 350 West Java Dr. Sunnyvale, CA 94089. USA www.ruckuswireless.com
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.6 Linearized : No Language : en XMP Toolkit : Adobe XMP Core 5.4-c005 78.147326, 2012/08/23-13:03:03 Creator Tool : FrameMaker 11.0.2 Modify Date : 2015:08:19 19:10:22+08:00 Create Date : 2015:08:19 18:50:25Z Metadata Date : 2015:08:19 19:10:22+08:00 Format : application/pdf Title : Creator : Producer : Acrobat Distiller 11.0 (Windows) Document ID : uuid:4c74726b-1ce2-4a80-9749-9035561f2ef6 Instance ID : uuid:3ae1a801-952f-4f73-bcf7-8efdf51bc522 Page Mode : UseOutlines Page Count : 168 Warning : [Minor] Ignored duplicate Info dictionaryEXIF Metadata provided by EXIF.tools