Admin Guide Linux Version | 2015

v031015

Remote Spectrum

better broadband

Remote Spectrum - Linux – ZCorum 2015 0

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Introduction ........................................................................................................... 1

Prerequisites and Initial Configuration .................................................................. 1

Installation ............................................................................................................. 2

Explanation of Property Descriptions .................................................................... 4

Accessing Admin Site ............................................................................................. 5

Adding Users .......................................................................................................... 5

Modifying Users ..................................................................................................... 7

Help and Logout ..................................................................................................... 8

End-User License Agreement ................................................................................. 9

Disclaimer ............................................................................................................ 10

Copyright .............................................................................................................. 10

Remote Spectrum - Linux – ZCorum 2015 1

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

The installation and use for the Remote Spectrum Server Side software allows administrators to manage the software for their company, including applications, and upgrades. This overview guide explains how to install the software and access and use the admin site. Links are included for information on downloading and installing Apache Tomcat, the open source software implementation of the Java Servlet needed for Remote Spectrum installs.

Introduction

This document is part of a step-by-step guide for ZCorum’s Remote Spectrum software and field app.

You will find a brief guide to server side installation and accessing and use of the Remote Spectrum

Admin site once the software is installed.

Prerequisites and Initial Configuration

Before beginning the steps in this guide, you need to ensure that all prerequisites are met, which

specifies a particular hardware and software configuration. If you are not using the required

infrastructure, you need to make the appropriate changes.

Note: Your installation of this software also indicates your acceptance of the End-User License

Agreement on page 9.

1. The person installing the software must have administrative rights to the server where the software is being installed.

2. The server where the admin software is being installed must have: a. SNMP access to all CPE that the system needs to support. b. Web access for the administrator and for all technicians that will use the system. c. Tomcat 7.x installed. For information on downloading and installing Tomcat,

look here.

SStteepp--bbyy--SStteepp AAddmmiinn GGuuiiddee

ffoorr RReemmoottee SSppeeccttrruumm

SSeerrvveerr IInnssttaallllaattiioonn--LLiinnuuxx

Remote Spectrum - Linux – ZCorum 2015 2

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Installation

1. Download the remote-spectrum.war file here.

2. If Tomcat is started, shut it down.

3. Copy the remote-spectrum-collector.war file to the <TOMCAT_HOME>/webapps directory

Note: If you are upgrading or reinstalling, overwrite any pre-existing copy of this file and delete the <TOMCAT_HOME>/webapps/remote-spectrum directory if it exists. 4. Create an Remote Spectrum properties file:

The default location of the file is:

“/etc/remote-spectrum-collector.properties”

The properties file should have the following entries. (The values given for these

properties are sample values and may be changed. Explanation of Properties

follows)

databaseName: /var/remotespectrum

readWriteCommunityString: cpe community string

cpeDiscoveryIps: 10.123.0/24, 68.70.0/18,

67.6.0/12

cpeDiscoverySchedule: 0 2 * * *

Remote Spectrum - Linux – ZCorum 2015 3

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Note: If you would like to override the default location for some reason you may override

it by doing the following: Create a context file named

<TOMCAT_HOME>/conf/Catalina/localhost/remote-spectrum.xml.

The contents of the file would look like this (Where XXX is a fully qualified path

to the Remote Spectrum properties file). For example: XXX might be written as

“etc/remote-spectrum-collector.properties”

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

<Context>

<Environment name="remote-spectrum-

collector.configuration" value="file:///XXX"

type="java.lang.String"/>

</Context>

5. Start Tomcat

Remote Spectrum - Linux – ZCorum 2015 4

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Explanation of Properties Descriptions

databaseName – Full path to store information by Remote Spectrum should have read/write

permission. (You can likely leave this value as is).

captureTimeoutinMinutes: The number of minutes of inactivity Remote Spectrum will wait

when communicating with a modem before giving up. Changing this value is not

recommended and should only be attempted by advanced users. Defaults to 15

readWriteCommunityString - The read/write community string used by the CPE that supports

full spectrum capture.

cpeDiscoveryIps - Comma separated CIDR IP address ranges to discover CPE that support full

spectrum capture OIDs. For more information on CIDR, look here. All the IPs in the list must

have the same “readwrite community string”.

cpeDiscoverySchedule – Quartz cron expression to schedule the CPE discovery. The sample

above defaults to once a day at 2 AM. This schedule can be customized with multiple variables

including time of day, day(s) of week, etc. For more information on Quartz cron expressions,

look here.

The server .xml file is used to control how the embedded tomcat will run. To understand

more about how to do this, please visit: http://tomcat.apache.org/tomcat-7.0-doc/

Remote Spectrum - Linux – ZCorum 2015 5

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Accessing Admin Site

Access the Remote Spectrum user management site at

http://rfauth.zcorum.com

Adding Users

Upon accessing the admin page

1. Click on Add User in the main navigation.

2. Complete fields: Last name, first name, email address, and role of the user you are

adding. Multiple roles can be designated for a user.

Note: Roles are defined as:

i. Admin – Description

ii. User – Description

iii. Calibrator - Description

3. Click Submit

4. Continue to add other authorized users by clicking Add User in the main navigation

and completing the required fields and clicking Submit.

Remote Spectrum - Linux – ZCorum 2015 6

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Remote Spectrum - Linux – ZCorum 2015 7

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Modifying Users

1. To see a list of added users click Modify User in the main navigation. All users that

have been added will be displayed in a list as Last Name, First Name and User Email.

2. To delete a user, reset a user’s password or update their user email, click on the user you wish to modify and a Modify User screen for that particular user will be displayed.

a. To delete that user click Delete User. You will be asked to verify the deletion, Yes

or No.

b. To change password, click Reset Password and enter and confirm the new

password. Password will be instantly reset. An email will be sent to the user

instruction them to change their password to his or her preference.

1. c. To correct or change the spelling of a name or change an email address, type the

new name or address into the corresponding field(s) and click Update. Update will

be instant. Click OK.

3. To exit a Modify Screen, click Cancel.

Remote Spectrum - Linux – ZCorum 2015 8

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Help and Logout

1. Clicking Logout in the top navigation will automatically log you out and return you to

the login screen.

Remote Spectrum - Linux – ZCorum 2015 9

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

End-User License Agreement

This End-User License Agreement (EULA) is a legal agreement between you, either an individual or a single entity (“Customer”) and ZCorum (“Author”) of this Remote Spectrum Server Software and Client, which includes computer software and may include associated media, printed materials, and “online” or electronic documentation (“Software”).

By installing, copying, or otherwise using the Software, you agree to be bounded by the terms of this EULA. If you do not agree to the terms of this EULA, do not install or use the Software. From time to time, Author may modify this EULA. Any modified version will be effective at the time it is posted. To keep abreast of your license rights and relevant restrictions, please bookmark this EULA and read it periodically. By using Software after any modifications, Customer agrees to all of the modifications.

1. Customer is not permitted to sublicense distribution rights of the Software. This EULA grants a non-exclusive license/right to use the Software as part of Customer’s internal operation, and not the sale or transfer of ownership of the Software or any intellectual property rights therein.

2. Customer shall not (a) reverse engineer, disassemble, decompile or otherwise attempt to derive Source Code from the Software, (b) make the Software available to any third parties unless expressly permitted in writing by Author, (c) modify, adapt, translate, or create derivative works based on the Software except as expressly permitted herein, (d) reproduce any portion of the Software except as expressly permitted herein, (e) permit or Authorize any party to do any of the foregoing, or (f) rent or timeshare the Software.

3. The Software may only be transferred to the U.S. Government with the prior written consent of an officer of Author and solely with "Restricted Rights", as that term is defined in the Department of Defense ("DOD") Supplement to the Federal Acquisition Regulations ("DFARS") in paragraph 252.227-7202.32 (c)(1) if to the DOD, or, if the Software is supplied to any unit or agency of the US Government other than DOD, the Government's rights in the Software shall be no greater than those set forth in FAR 52.227-19(c)(1) or (c)(2), Commercial Computer Software - Restricted Rights; or FAR 52.227-14, Rights in General Data Alternative III, as applicable.

4. Software under this EULA is subject to U.S. export control laws and may be subject to the export or import regulations in other countries. Customer agrees to strictly comply with all such laws and regulations and acknowledges that it has the responsibility to obtain such licenses to export, re-export or import as may be required by such regulations

5. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR INDIRECT, SPECIAL, CONSEQUENTIAL, PUNITIVE, COLLATERAL, OR INCIDENTAL DAMAGES ARISING OUT OF THIS AGREEMENT OR THE SOFTWARE HEREUNDER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS), EVEN IF IT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND REGARDLESS OF THE NATURE OF THE CAUSE OF ACTION OR THEORY ASSERTED. MAXIMUM LIABILITY TO AUTHOR ARISING FROM OR RELATING TO THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT CUSTOMER PAID HEREUNDER. CUSTOMER EXPRESSLY AGREES TO THE ALLOCATION OF LIABILITY SET FORTH IN THIS SECTION, AND ACKNOWLEDGES THAT WITHOUT AGREEMENT TO THIS LIMITATION, THE FEES CHARGED FOR THE LICENSES AND SUPPORT WOULD BE HIGHER.

Remote Spectrum - Linux – ZCorum 2015 10

This document contains proprietary and confidential information of ZCorum and shall not be used, disclosed or reproduced, in whole or in part, for any purpose other than to evaluate this information, without the prior written consent of ZCorum. Title in and to this document and all information contained herein remains at all times the exclusive property of ZCorum.

Disclaimer

Copyright