Professional Documents
Culture Documents
Services Server
Quick Start Guide
Product Overview
Client/Server
Requirements
Installation
Discovery
Upgrading Device
Software
Configuration
Monitoring Devices
CAMBIUM NETWORKS
TABLE OF CONTENTS
Server Hardware............................................................................................................................. 5
Server Operating System ............................................................................................................... 5
Firewall/Required Ports.................................................................................................................. 6
Client .............................................................................................................................................. 6
Scalability ....................................................................................................................................... 6
Deployment and Security Recommendations...................................................................................................... 7
Overview ...................................................................................................................................... 28
Configuring Individual Devices .................................................................................................... 28
Creating Templates ...................................................................................................................... 32
Applying Templates ..................................................................................................................... 35
Monitoring Devices ............................................................................................................................................. 38
CAMBIUM NETWORKS
Overview ...................................................................................................................................... 38
Positioning Devices in the Maps View ......................................................................................... 41
Manual Location ......................................................................................................................... 41
CSV Import ................................................................................................................................ 44
Clearing Events ............................................................................................................................ 47
Importing Cambium Networks Device Support Files......................................................................................... 51
User Manual......................................................................................................................................................... 54
CAMBIUM NETWORKS
General information
Version information
2B
Issue
Date of issue
Remarks
001v000
May 2014
001v001
June 2014
http://www.cambiumnetworks.com/support
http://mgmt.community.cambiumnetworks.com/
Main website:
http://www.cambiumnetworks.com
Sales enquiries:
solutions@cambiumnetworks.com
Support enquiries:
support@cambiumnetworks.com
http://www.cambiumnetworks.com/support/contact-support/
Address:
Feedback
We appreciate feedback from the users of our documents. This includes feedback on the structure, content,
accuracy, or completeness of our documents. Send feedback to cnsserverteam@cambiumnetworks.com.
CAMBIUM NETWORKS
Product Description
The Cambium Networks Services (CNS) Server is a network management application provided by Cambium
Networks to manage ePMP devices.
This document provides a brief introduction and walkthrough of the following CNS Server capabilities:
1.
2.
3.
4.
5.
6.
7.
Each of these sections should be reviewed prior to installing and using the CNS Server. For additional details
please refer to the CNS Server User Manual available from the Documentation link at the bottom of the CNS Server
user interface after installation.
Client/Server Requirements
Server Hardware
The CNS Server has been run on several different hardware platforms ranging from laptops to multi core servers.
To achieve the scalability levels referenced in the Scalability section below. The following hardware configuration is
recommended:
For the 1.3 release only 64 bit operating systems are supported.
Important: For Linux systems it is necessary to have the dos2unix utility installed prior to installation.
In addition, the host file must be configured properly otherwise the CNS Server will fail to start properly. In
particular, the IP address of the server needs to be present in the host file.
An example of a valid host file is show below:
CAMBIUM NETWORKS
127.0.0.1
localhost
::1
localhost
10.120.143.1
usil01cnssit01.camnwk.com
usil01cnssit01
Firewall/Required Ports
The CNS Server needs the following ports/connections to be available by default. Alternative ports for some of the
items below can be configured during or post installation. Insure that if a firewall is enabled that the configuration is
such that the connections below cab pass traffic in the indicated direction.
Port
Protocol
Direction
Description
80
TCP (HTTP)
Both
161
UDP (SNMP)
Outbound
162
UDP (SNMP)
Inbound
443
TCP (HTTPs)
Both
514
UDP
(SYSLOG)
Inbound
Client
The CNS Server user interface runs entirely in a web browser. Development has verified client operations for PCs
on Linux, Windows, and Macintosh operating systems using the following browsers:
At this time, smartphone and tablet based browsers are not fully supported.
Important: Be sure to configure the browsers security settings to trust the server on which the CNS Server
is running otherwise the user interface will not operate properly.
Scalability
With the hardware specifications above, each CNS Server instance can reliably manage 1000 devices with 5
concurrent users. Additional devices and clients can be supported, however the user interfaces will begin to get
"sluggish" and other degradations may occur. This is also true if the server does not meet the minimum specs
outlined above.
Additional recommendations for scalability:
CAMBIUM NETWORKS
The "Events Limit" specified in Admin/Monitor may need to be increased to prevent events from getting
automatically deleted. The default is 25000 events.
In cases where greater than 1000 devices are being managed it is strongly recommended to deploy
multiple CNS Server instances.
Security Recommendations
Due to potential security vulnerabilities, if the web interface will be accessible outside of a closed network, it is
recommended that a secure VPN connection be used or that the firewall is configured to only allow only trusted
users to access the server.
The steps below can be used to further configure the CNS Server webserver to whitelist or only allow particular IP
addresses access. <server root> refers to the location at which the CNS Server has been installed on the server.
1.
2.
3.
4.
5.
DHCP Support
The CNS Server does not support systems that change the IP addresses of devices dynamically. If a DHCP server
is being used it must be configured such that the same IP address is given to the device (static mapping).
Client Configuration
In order for the client to run properly in certain web browsers it is necessary to add the server on which the CNS
Server is running to the Trusted Sites List.
Installation
Installing the Server
Important: the CNS Server must be installed using a login with either Administrator or root level (logged in
as root or run with sudo) permissions.
Once CNS Server 1.3 installation executable has been obtained, double click on the installer to launch it. This will
launch a standard installer wizard. Follow the prompts to complete the installation. For Linux systems, the
CAMBIUM NETWORKS
dos2unix script must be installed otherwise the installation will be unsuccessful. In addition, be sure that the
hostname has been properly configured in the hosts file otherwise some operations will fail to work properly.
The installation typically takes around 5 minutes to complete. Note that it is not unusual for the screens to appear
to be paused during the installation process as scripts are being run and services are being configured.
Screenshots of a typical installation are shown below. Note that a console only installation is also available. To run
the console on
Figure 1:
Figure 2:
CAMBIUM NETWORKS
Figure 3:
Figure 4:
CAMBIUM NETWORKS
Figure 5:
Figure 6:
10
CAMBIUM NETWORKS
Figure 7:
Figure 8:
Ready to install.
11
CAMBIUM NETWORKS
Figure 9:
Figure 10:
12
CAMBIUM NETWORKS
Figure 11:
Creating Uninstaller
Figure 12:
13
CAMBIUM NETWORKS
Figure 13:
Installation complete.
Figure 14:
Backend Startup
During installation three services are installed; an Apache webserver, a Postgres database, and the CNS Server
backend services. These are installed as services in Windows and Linux and can be managed with the command
line services utilities. The installation automatically starts the services after they have been installed.
14
CAMBIUM NETWORKS
To confirm the services are running, open a command prompt and type the following commands:
On Linux:
On Windows:
sc query cnsapache
sc query cnspostgresql
sc query cnsserver
If the service is not running it can be started by typing the following commands:
On Linux:
On Windows:
sc start
sc start
sc start
cnsapache
cnspostgresql
cnsserver
Figure 15:
15
CAMBIUM NETWORKS
Figure 16:
16
CAMBIUM NETWORKS
Figure 17:
Admin general page showing Network Facing interface and Device Accessible IP
Address.
Discovery
At this point, all front and backend services will be initialized and the device discovery process can begin. To do so,
perform the following steps:
1. Start a web browser and enter in the URL of the server to get the login page. For example, if you are on
the server you can type https://localhost (or https://localhost:<port number> if the port is different than 443).
2. Login to the server. The default admin credentials are admin/admin.
3. Select the Discover Service (in green on the application bar), then select Discover Devices (eye icon) from
the left side navigation bar to display the discovery configuration table.
4. Right click on the table and select Add Entry from the right click menu. Enter the IP Address Ranges and
SNMP/Login credentials for the devices to discover. Items in orange have not been saved to the database
yet. Once the save button/right click menu is selected, the items will turn green.
5. Select the rows you wish to discover and then select the start discovery button/right click menu.
17
CAMBIUM NETWORKS
Once these steps have been completed, the selected ranges will be probed for devices. A progress bar and
various status results will be displayed on the Discover Devices view. Once discovery is complete, the Inventory
and Discovery Events views should be reviewed to verify that the expected devices were discovered, and to review
any issues found during discovery.
Screenshots for the steps above are shown below.
Figure 18:
Figure 19:
18
CAMBIUM NETWORKS
Figure 20:
Figure 21:
19
CAMBIUM NETWORKS
Figure 22:
Save changes.
Figure 23:
Start discovery.
20
CAMBIUM NETWORKS
Figure 24:
Start discovery.
Figure 25:
21
CAMBIUM NETWORKS
Figure 26:
Figure 27:
22
CAMBIUM NETWORKS
Note that when selecting packages to use with the CNS Server, only the files ending in tar.gz should be used. Files
ending in pkg3 are to be used only for the CNUT application.
Screenshots for the steps above are shown below.
Figure 28:
23
CAMBIUM NETWORKS
Figure 29:
Figure 30:
Upload packages (packages are downloaded from the Cambium Support website.
24
CAMBIUM NETWORKS
Figure 31:
25
CAMBIUM NETWORKS
Figure 32:
Figure 33:
26
CAMBIUM NETWORKS
Figure 34:
Figure 35:
27
CAMBIUM NETWORKS
Figure 36:
Configuring Devices
Overview
When devices are discovered in the CNS server, the current configuration is read and stored on the CNS server.
The configuration can be refreshed at any time by selecting a device (or devices) and clicking Refresh
Configuration.
The CNS server supports two ways to ways to configure a device either directly or through the use of
configuration templates. Configuration templates are used to define a subset of configuration parameters as well as
their values and save them as a template. These configuration templates can then be applied later to either a
single device, or multiple devices of the same type.
The status of any configuration operation can be viewed from the inventory view.
28
CAMBIUM NETWORKS
5. Update parameters as desired, and then click apply. Note that the selections can also be saved as a
template for later use if desired. Only checked items will be included in the newly created template.
After Apply has been selected, the status of the configuration operation will be shown in the inventory view of the
Configuration application. The device will be notified of the update and will upload and apply the new configuration.
Note that only checked values will be updated. The process of updating the configuration on a device can take a
few minutes to complete. Note that the device will always reboot in response to a configuration operation. When
the update is complete the device will either be in an Success or Failed state.
If failures are seen, review the Configuration events view for more details on the failure.
Screenshots for the steps above are shown below.
Figure 37:
29
CAMBIUM NETWORKS
Figure 38:
Figure 39:
30
CAMBIUM NETWORKS
Figure 40:
Figure 41:
31
CAMBIUM NETWORKS
Creating Templates
It is important to note that templates are associated with a given device type. It is not possible to create a template
for one device type and apply it to another.
To create and apply a template, perform the following steps.
1.
2.
3.
4.
Templates can also be modified by selecting a template from the table, right clicking, and selecting edit.
Screenshots for the steps above are shown below.
Figure 42:
32
CAMBIUM NETWORKS
Figure 43:
Figure 44:
33
CAMBIUM NETWORKS
Figure 45:
Figure 46:
34
CAMBIUM NETWORKS
Applying Templates
To apply a previously created template, perform the following steps.
1. From the template view, select the desired template, right click, and select Apply Template.
2. A dialog will be shown with a list of applicable devices. Select the desired devices and click apply.
After Apply has been selected, the status of the configuration operation will be shown in the inventory view as it is
with configuring an individual device.
Note that templates can also be applied after selecting a device or multiple devices of the same type in the
inventory view. In this case, after right clicking and selecting Apply Template a list of applicable templates will be
shown. After selecting a template and clicking ok, the status will be show in the inventory view.
If failures are seen, review the Configuration events view for more details on the failure.
Screenshots for the steps above are shown below.
Figure 47:
35
CAMBIUM NETWORKS
Figure 48:
Figure 49:
36
CAMBIUM NETWORKS
Figure 50:
Figure 51:
37
CAMBIUM NETWORKS
Monitoring Devices
Overview
Once devices have been discovered, the CNS Server will begin monitoring the devices. The CNS Server will begin
to periodically check the devices for reachability, download statistics and other important information, and update
various views that display the status of the devices. In addition, if the devices are configured to send traps and
syslog messages to the CNS Server, the CNS Server will interpret these messages and update the status of the
devices accordingly.
The main Monitor views provide system level views of the network. In addition, double clicking rows in the inventory
and events views, as well as clicking on device in the map view, will display a device page. The device page
provides a consolidated view of various performance and status attributes.
Note that in order for the CNS Server to receive traps and syslog messages from the devices, it is necessary to
configure the device to send traps and syslog messages to the CNS server.
Several screenshots of the various views available are shown below.
Figure 52:
Maps view.
38
CAMBIUM NETWORKS
Figure 53:
Figure 54:
39
CAMBIUM NETWORKS
Figure 55:
Figure 56:
40
CAMBIUM NETWORKS
Figure 57:
41
CAMBIUM NETWORKS
Figure 58:
Figure 59:
42
CAMBIUM NETWORKS
Figure 60:
Figure 61:
43
CAMBIUM NETWORKS
Figure 62:
CSV IMPORT
To simplify moving devices, the CNS Server can import a CSV file of device IDs, latitudes, and longitudes, It is
important that the device IDs match the EXACT format and case as is shown for the device in the inventory view. In
addition, decimal degrees (WGS84) coordinate format must be used for latitude and longitude.
An example of a CSV file is shown below.
0a:00:3e:a0:00:84,41.9303,-88.1555
0a:00:3e:a0:00:93,41.9292,-88.16
0a:00:3e:a0:01:15,41.9338,-88.1624
0a:00:3e:a0:04:38,41.9338,-88.1624
0a:00:3e:3f:ff:54,41.9515,-88.165
0a:00:3e:3f:fe:ac,41.9509,-88.1709
0a:00:3e:3f:fe:b9,41.9483,-88.1639
To import a CSV file perform the following steps:
1.
2.
3.
4.
5.
44
CAMBIUM NETWORKS
Figure 63:
45
CAMBIUM NETWORKS
Figure 64:
Select Import Latitude/Longitude CSV file and select the file to be imported.
Figure 65:
46
CAMBIUM NETWORKS
Figure 66:
Clearing Events
The CNS Server does not automatically clear device alarms. Instead it is necessary to manually clear the alarms.
The CNS Server maintains two views of the events a currently active events view, and a historic events view. The
historic events view shows all events including inactive or cleared events. To switch between the views select the
desired view from the pull down list at the top right side of the event table.
In some cases newly discovered devices will display in a Minor alarm state in the Monitor views after discovery is
completed. This can typically happen if the CNS Server is unable to discover the latitude and longitude of a device
or if the write community string couldnt be determined. The events view of the Monitor application should be
reviewed and actions taken to correct the issue.
After the issues have been corrected, the alarms can be cleared by performing the following steps:
1.
2.
3.
4.
5.
47
CAMBIUM NETWORKS
Figure 67:
Figure 68:
48
CAMBIUM NETWORKS
Figure 69:
Figure 70:
49
CAMBIUM NETWORKS
Figure 71:
Figure 72:
50
CAMBIUM NETWORKS
Download the CNS file from the Cambium Networks support site.
Select the Device Compiler admin screen and then select View Device Definitions.
Select the device type to be updated, right click, and then select Delete Device Definition(s) from the menu.
Right click and select Import Device Definition from the menu.
In the CND File Upload window, select the new CND file and then select Upload CND file.
Restart the CNS Server to apply the new settings.
Figure 73:
51
CAMBIUM NETWORKS
Figure 74:
Figure 75:
Select the device types that will be updated and then delete the definitions. Then,
select Import Device Definitions
52
CAMBIUM NETWORKS
Figure 76:
Select the new CND file and then select Upload CND File.
Figure 77:
53
CAMBIUM NETWORKS
User Manual
The CNS Server contains an online user manual accessible by clicking the Documentation link on the bottom of the
main application page. The user manual is a type of wiki. Clicking on links and entries in the table of contents pane
on the left side will open up the selected item.
A screenshot of the documentation is shown below.
54