Cape Dashboard Documentation

Transcription

1 Cape Dashboard Documentation Release Cape Networks Nov 15, 2017

2

3 Product Overview 1 Introduction 1 2 Getting Started 3 3 Features At-A-Glance Network Health Status Backup Mobile Connection Last Gasp Power Backup Configured SSID Statistics Reporting Network Statistics Reporting Internal and External Service Statistics Reporting Sensor Info Reporting WiFi Environment Data Reporting (AP Scan Data) Data Export Automatic Network Issue Detection Threshold-Based Issue Detection Packet Capture Captive Portal Testing Support for Enterprise WiFi Security Alerting Admin and Restricted User Configuration Sensor Grouping & Group Based User Permissions Service and Network Testing Dashboard Overview 11 5 Dashboard Pages The Dashboard Sensor Page SSID Page DNS and DHCP Pages Internal/External Services Pages Search Page Configuration Sensors WiFi i

4 6.3 Testing Thresholds Alerts User Management My Account Sensor Overview 23 8 Installation Guide Quick Mounting Secure Mounting Fixed Mounting Sizing Guide General Guidelines SMB and Enterprise Hotels Hospitals Education Shopping center or mall Arena Status Light Colour Reference Examples Sensor Hardware WiFi Backup connectivity Power Backup power Mounting Secure mounting Size Color Status indicators Environment Processor Operating system Frequently Asked Questions How do I order more Cape Sensors? How many Cape Sensors do I need to monitor my network? Where can I place Cape Sensors? I have a captive portal. Can Cape test the captive portal experience? How secure are Cape Sensors? Can I move Cape Sensors after installing them? What mobile networks are supported? Where can I get more Command strips? ii

5 CHAPTER 1 Introduction 1

6 2 Chapter 1. Introduction

7 CHAPTER 2 Getting Started Getting started guide goes here 3

8 4 Chapter 2. Getting Started

9 CHAPTER 3 Features 3.1 At-A-Glance Network Health Status The main dashboard view provides 5 traffic lights, each of which display the high level status of a particular area of network health, by means of turning either green (all good), yellow (warnings detected), or red (errors detected). Each of these are a roll-up of multiple items, which also follow this colour convention. These items can be clicked on to drill down to the root cause of a network issue. 3.2 Backup Mobile Connection The fully managed onboard mobile connection makes setup seamless by removing the need to manually set up each sensor. It also provides connectivity to the device when it cannot connect to WiFi, cannot authenticate, or when the WiFi s backhaul is down. A mobile connection means the sensor is always online and always uploading data, so you never lose sight of your network. 3.3 Last Gasp Power Backup An array of supercapacitors provides backup power for the sensor to notify you of power issues, make sure the network is still up, and enter sleep mode gracefully. 3.4 Configured SSID Statistics Reporting We report the following WiFi statistics for SSIDs sensors are connected to: RSSI Bitrate (including MCS values) Packet Retry Rate 5

10 Channel Utilization Band Channel BSSID AP Association Time (including EAP time) 3.5 Network Statistics Reporting We report the following statistics: DHCP Response Time DNS Lookup Time 3.6 Internal and External Service Statistics Reporting For each configured service, we report the following statistics: Latency Packet Loss Jitter Throughput (Down) (Youtube and Dropbox Only) Throughput (Up) (Dropbox Only) 3.7 Sensor Info Reporting We report the following sensor info: Gateway Primary DNS Server Secondary DNS Server WiFi MAC Address WiFi IP Address Ethernet MAC Address Ethernet IP Address 3.8 WiFi Environment Data Reporting (AP Scan Data) For each detected AP, we report the following data: SSID RSSI 6 Chapter 3. Features

11 Channel Number Channel Width Band BSSID Last Seen Date and Time Supported Data Rates Security Vendor 3.9 Data Export All the aforementioned data can be exported to file, for periods of either the last day, the last week, the last 2 weeks, or all time Automatic Network Issue Detection We automatically detect, triage, and determine root-cause for a large number of issues in areas including: AP association Authentication DNS DHCP Gateway connectivity Captive portals Power outages Connectivity to service These issues are then reported via alerts and on the dashboard, where they can be inspected by users Threshold-Based Issue Detection We provide users the ability to configure threshold-based issue detection on statistics such as: Low RSSI Low Bitrate High DHCP Lookup Time High DNS Lookup Time High Packet Loss High Latency High Jitter 3.9. Data Export 7

12 High Retry Rate High Channel Utilisation Significant drops in RSSI 3.12 Packet Capture We provide a mechanism whereby sensors can capture network traffic, either on-demand, or automatically when an error is first detected. These packet captures can then be downloaded from the dashboard as PCAP files Captive Portal Testing Our sensors can operate correctly on networks that have captive portals (provided the necessary portal details) Support for Enterprise WiFi Security We support the following WiFi authentication methods: Open Pre-Shared Key Username and Password (PEAP / LEAP / EAP TTLS) Certificate based (EAP TLS) Alerting Configurable alerts via when issues are detected Admin and Restricted User Configuration Users can be created with either Admin access, or Restricted to selected sensor groups Sensor Grouping & Group Based User Permissions Sensors can be organized into named groups which can then be manipulated as a unit, for example to configure tests or to grant users access. 8 Chapter 3. Features

13 3.18 Service and Network Testing Predefined Tests for Common Services Service Connectivity We provide service connectivity tests by conducting ICMP pings, port connectivity checks and basic HTTP checks to service endpoints. The following list of predefined service connectivity checks are available: Adobe Creative Cloud Asana Box Docusign Facebook GitHub Gmail Google Google Drive Google Docs Hootsuite Hubspot Gusto Hipchat Intercom Jenkins Jira LinkedIn Microsoft Online Okta Salesforce Slack Zendesk Zenefits Dropbox In addition to service connectivity, the DropBox test also performs throughput testing by uploading and downloading files to DropBox Service and Network Testing 9

14 Skype The Skype test performs Microsoft s media quality and network connectivity performance test. Details around this test can be found here. YouTube In addition to service connectivity, the YouTube test also performs throughput testing to YouTube User Customizable Network Tests Zap Ruckus Wireless Zap tests uplink and downlink throughput to Ruckus access points. Details around Zap testing can be found here. iperf3 iperf is a tool for testing maximum achievable bandwidth on IP networks. This test requires an iperf3 server that is reachable by the sesensor. More details about iperf can be found on the iperf website. Generic The generic template allows you to perform ping tests against any port. Webserver The webserver test performs connectivity tests to HTTP (port 80) and HTTPS (port 443) endpoints, as well as checking the HTTP status code that is returned. Printer The printer test performs a connectivity test to any networked printer. 10 Chapter 3. Features

15 CHAPTER 4 Dashboard Overview The Cape Dashboard is the product of years of frustration with existing tools, plus decades of usability, information design and software development expertise. Your job is difficult enough already. We want you to have a dashboard that you don t need to learn, and don t need a certification to use. 11

16 12 Chapter 4. Dashboard Overview

17 CHAPTER 5 Dashboard Pages 5.1 The Dashboard The dashboard consists of two views, which can be toggled using the buttons in the upper left corner of the screen: Dashboard View Sensor View Dashboard View This view consists of five columns: Experience WiFi Network Internal External Experience Describe experience column here WiFi Describe wifi column here 13

18 Network Describe network column here Internal Describe internal column here External Describe external column here Sensor View This view can display sensors in three ways: Map View Sensors By Group Sensors By Status Map View Describe map view here Sensors By Group Describe Sensors By Group view here Sensors By Status Describe Sensors By Status view here 5.2 Sensor Page Describe sensor page here. 14 Chapter 5. Dashboard Pages

19 5.2.1 Issue Detail modal In the Status box on the left side of the Sensor page you can see all Ongoing, Unconfirmed, and Resolved issues. Clicking on any of these issues will allow you to further drill down into the details of it Sensor Page 15

20 In this example, we are drilling down into a DHCP issue where the sensor was not assigned an IP by a DHCP server. In the detail page you can see the exact time of the issue, the affected test, and our root cause analysis (typically referred to as triage ). Most of the triage sections are expandable, allowing you to see the raw output of the commands. Here we have expanded the No DHCP Offers section to see exactly what is happening - the raw output shows us that two DHCPDIS- COVER events were triggered, but there was no resulting DHCPOFFER from the network. Furthermore, we can see the exact timing of these events (indicated by the arrow). 16 Chapter 5. Dashboard Pages

21 Types of issues DHCP did not return an IP shows the raw output from dhclient, including timing of the entire DORA (Discovery, Offer, Request, Acknowledge) process. 5.3 SSID Page Describe SSID page here 5.4 DNS and DHCP Pages Describe DNS and DHCP pages here 5.3. SSID Page 17

22 5.5 Internal/External Services Pages Describe service pages here 5.6 Search Page Describe search page here. 18 Chapter 5. Dashboard Pages

23 CHAPTER 6 Configuration 6.1 Sensors The sensors tab consists of 2 sections: Sensor Management Group Management Sensor Management TODO Group Management TODO 6.2 WiFi The configuration options when setting up a new SSID SSID An SSID (Service Set Identifier) is the name used to identify the network. 19

24 6.2.2 SSID Alias Allows for multiple SSIDs with the same name to be configured separately, e.g., one can be configured for 2.4 GHz, and one for 5 GHz Hidden If the SSID name is broadcasted or not, i.e. if the name will be displayed in an AP scan Security The network security of the WiFi network. Open: No security required Passphrase: Passphrase/password is required Enterprise: 2 options Username and Password (PEAP / LEAP / EAP TTLS) Username and Certificate (EAP TLS) Band Locking What WiFi band to connect to the SSID on. Auto: Switch based on most appropriate band 2.4: Only test 2.4 GHz band 5: Only test 5 Ghz band External Connectivity Toggle Disabling external connectivity suppresses any errors related to external connectivity and prevents external tests from being executed. 6.3 Testing The testing tab consists of 2 sections: Test Configuration Core Configuration Test Configuration TODO 20 Chapter 6. Configuration

25 6.3.2 Core Configuration TODO 6.4 Thresholds Threshold Settings Info TODO 6.5 Alerts Alert Config Info TODO 6.6 User Management User Settings Info TODO 6.7 My Account Account Config Info TODO 6.4. Thresholds 21

26 22 Chapter 6. Configuration

27 CHAPTER 7 Sensor Overview Describe sensor here 23

28 24 Chapter 7. Sensor Overview

29 CHAPTER 8 Installation Guide There are three mounting options to choose from: Quick Mounting On walls or other vertical surfaces that are painted, stained or varnished wood, glass, tile, painted cinder block, plaster, metal, and painted wallboard. Secure Mounting In any public or semi-public area, or any other location where the sensor should not be removed without tools. Fixed Mounting On any other surface, including ceilings and all other horizontal surfaces, wallpaper, fresh paint (less than one week old), rough surfaces such as cement board, unpainted cinder block, brick or rough-sawn wood. 8.1 Quick Mounting For walls or other vertical surfaces that are painted, stained or varnished wood, glass, tile, painted cinder block, plaster, metal, and painted wallboard. On any other surface, the adhesive strips may not stick over time. If you are unsure about whether the surface is appropriate for quick mounting, use fixed mounting. In any public or semi-public area, or any other location where the sensor should not be removable without tools, use secure mounting. Note: Ensure surface is cleaned with alcohol before installation not household or industrial cleaner, which leaves a thin residue. Step 1 25

30 Power up you sensor. Use either Power over Ethernet (PoE) or the supplied power adapter (DC). Warning: do not plug in PoE and DC simultaneously, as this reduces the sensor s lifespan. Step 2 Use the supplied mounting bracket. Step 3 Remove liner, stick to a dry, clean wall with arrow pointed upwards and hold for 30 seconds. Step 4 Slide the sensor onto the mounting bracket. Wait for the light to begin blinking green and proceed to the dashboard to configure the sensor. 8.2 Secure Mounting You will need: Phillips screw driver size 2 and a drill bit 13/64 (#9 / 5mm) Note: Always use appropriate protective gear when drilling or operating machinery. Check for electrical wiring before drilling into walls. For dry wall mounting use the dry wall anchor. For brick wall mounting, use the masonry plug. Step 1 Power up you sensor. Use either Power over Ethernet (PoE) or the supplied power adapter (DC). Warning: do not plug in PoE and DC simultaneously, as this reduces the sensor s lifespan. Step 2 Use the supplied drill stencil to drill holes for the security fins AND mounting bracket. Step 3 Screw the mounting bracket into the wall. See Wall Fasteners above for what to use in different wall types. Step 4 Snap both security fins onto the sensor. Step 5 Slide the sensor with security fins onto the mounting bracket. 26 Chapter 8. Installation Guide

31 Step 6 Screw the security fins into the wall. Wait for the light to begin blinking green and proceed to the dashboard to configure the sensor. 8.3 Fixed Mounting You will need: Phillips screw driver size 2 and a drill bit 13/64 (#9 / 5mm) Warning: Always use screws for mounting on ceilings or other horizontal surfaces. Do not rely on the adhesive tape alone. Note: Always use appropriate protective gear when drilling or operating machinery. Check for electrical wiring before drilling into walls. For dry wall mounting use the dry wall anchor. For brick wall mounting, use the masonry plug. Step 1 Power up you sensor. Use either Power over Ethernet (PoE) or the supplied power adapter (DC). Warning: do not plug in PoE and DC simultaneously, as this reduces the sensor s lifespan. Step 2 Use the supplied drill stencil to drill holes for the security fins AND mounting bracket. Step 3 Screw the mounting bracket into the ceiling/surface. See Wall Fasteners above for what to use in different wall types. Step 4 Slide sensor onto mounting bracket and make sure you feed the cable correctly through the gap Fixed Mounting 27

32 28 Chapter 8. Installation Guide

33 CHAPTER 9 Sizing Guide The number of Sensors you need depends on your environment and monitoring needs. Here are some guidelines which can help you decide how many Sensors are right for you. 9.1 General Guidelines Place at least one Sensor in each area that users congregate or use WiFi the most, and in areas with WiFi complaints Place Sensors in areas with WiFi or network performance concerns or complaints Place Sensors in locations that are difficult, time consuming or expensive to reach in person (e.g. branches) Place Sensors in any areas with mission-critical equipment connected to WiFi Use at least one Sensor per SSID tested remote Do not place Sensors in areas with access points that get very little data traffic such as coverage access points on the edge of your building or in less frequented areas (e.g. storage rooms) In large networks with multiple access and aggregation switches, consider placing at least one Sensor per access switch Try not to move Sensors after installation as this invalidates comparisons with historical data. If you plan to move a Sensor to trouble spots in response to user complaints, we recommend keeping a spare Sensor for temporary, tactical deployments Typically, expect a ratio of one Sensor for every six to 24 Access Points When in doubt, start small and add more Sensors over time Speak to a Cape product expert if you need more information Read on for additional guidelines and ideas by type of environment. 29

34 9.2 SMB and Enterprise 1-2 Sensors per open-plan working area 1 Sensor per: Lobby or reception area CEO / executive office Busy conference / meeting room Cafeteria Remote branch 9.3 Hotels 1-3 Sensors in the hallway on each of the hotel floors 1-2 Sensors per lobby 1 Sensor per: Business center Hotel conference and meeting rooms Restaurant or cafeteria Fitness center High occupancy staff areas (kitchen, working areas, housekeeping etc.) 9.4 Hospitals 1-3 Sensors in the hallway of each hospital floor 1-2 Sensors in high occupancy staff / nurse and doctor areas (kitchen, working quarters, resting areas, finance, insurance, medical records etc.) 1 Sensor per: Lobby or reception areas (ground level and receptions on respective floors) Cafeteria or food court Patient waiting area Family visitation areas 9.5 Education 1-3 Sensors in the hallway of each university or school floor 1-2 Sensors per cafeteria 1-2 Sensors per library or study Area 30 Chapter 9. Sizing Guide

35 1-2 Sensors per indoor sports facility 1-2 Sensors per high occupancy staff/teacher/management areas (kitchen, working areas, principal office, finance and accounting, etc.) 1 Sensor per: Large classroom / lecture venue Computer room / public computer desk area Laboratory 9.6 Shopping center or mall 1-3 Sensors per food court 1-2 Sensors per major store / anchor tenant 1 Sensor per entrance area 1 Sensor near rest rooms 9.7 Arena The number of Sensors needed highly depends on the venue size and capacity. Please get in touch for a free assessment Shopping center or mall 31

36 32 Chapter 9. Sizing Guide

37 CHAPTER 10 Status Light Colour Reference Indicates what state your sensor is in Examples Green: testing and monitoring your network. Green flashing: waiting for configuration. 33

38 34 Chapter 10. Status Light Colour Reference

39 CHAPTER 11 Sensor Hardware 11.1 WiFi a/b/g/n dual-band WiFi (2.4 & 5GHz) with dual-stream MIMO 11.2 Backup connectivity Gigabit ethernet 10/100/1000 3G (HSPA+) connection with fully managed SIM card and service 11.3 Power Power over Ethernet: 802.3af POE AC power adapter 11.4 Backup power Last-gasp power backup using an array of supercapacitors provides extra connectivity when there is no power Mounting Wall and ceiling mounting bracket with adhesive backing for quick install. Adhesive: no-residue 3M Command Strips. Recommended mounting location: near users, on a wall or pillar ±4-5 feet (±1.5m) off the ground 35

40 11.6 Secure mounting Mounting bracket can be screwed to wall or ceiling for added security. Included security fins prevent removal from mounting bracket without a screwdriver Size 6 x 6 x 1.6 inches / 152 x 152 x 40mm 11.8 Color White and charcoal 11.9 Status indicators Full color status LED on side Green power LED on underside Environment Indoors, 14 to 113 degrees Fahrenheit / -10 to 45 degrees Celcius Processor Dual core ARM Cortex A9 operating at 1.6GHz Operating system Linux 36 Chapter 11. Sensor Hardware

41 CHAPTER 12 Frequently Asked Questions 12.1 How do I order more Cape Sensors? Adding new sensors is easy. Get in touch with us online or send an to sales@capenetwork.com How many Cape Sensors do I need to monitor my network? As a rule of thumb, place at least one sensor in each of the areas where your users congregate and use WiFi the most, or areas with WiFi performance concerns. In large networks with multiple access and aggregation switches, consider placing at least one sensor per access switch. In most cases, plan for one sensors for every 6 access points (in smaller venues) up to every 24 access points (for larger venues). When in doubt, start smaller it is easy to add more sensors over time. See our Sizing Guide for more Where can I place Cape Sensors? Each sensor should be as close to users as possible. You can place it on a desk, or use the mounting plate to mount it on a wall or pillar. The mounting bracket works on ceilings too, but the sensor will provide better data on a wall or desk. Avoid placing sensors inside closets, near metal, or within 7 feet (2 metres) of an Access Point. You can use either POE or AC as a power source I have a captive portal. Can Cape test the captive portal experience? Yes! Cape is perfect for testing captive portals. We ve found that captive portals can generate a disproportional percentage of the issues we detect. Get in touch to find out how to setup captive portal testing. 37

42 12.5 How secure are Cape Sensors? We have engineered our sensors with security in mind. In short, if your network allows BYOD or IoT devices, the Cape Sensor is likely to be more secure than other devices on your network today. Several large companies with strict security policies trust our sensors on their internal networks. See our Security Policy for more Can I move Cape Sensors after installing them? Yes, but we don t typically recommend it. Moving a sensor means the new data it collects is not comparable with its historical data. If you would like a device to move around to trouble spots in response to user complaints we recommend keeping a spare sensor for temporary, tactical deployments. Alternatively consider preemptively placing additional sensors in areas where users congregate or use WiFi the most What mobile networks are supported? Mobile coverage is required to take advantage of Cape s Ethernet-free setup process and to provide backup connectivity in the event of a network outage. Supported providers are: T-Mobile within the USA Vodacom within South Africa Vodafone within New Zealand 12.8 Where can I get more Command strips? Additional Command Strips can be purchased from 3M or Amazon. 38 Chapter 12. Frequently Asked Questions