spectralink 84-series handsets release 2.6 · 721-0036-000 rev k april 2020 spectralink...
TRANSCRIPT
721-0036-000 Rev K April 2020
Spectralink Configuration Management Server
Administration Guide Spectralink 84-Series Handsets
Release 2.6.x
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 2
Copyright Notice
© 2016-2020 Spectralink Corporation All rights reserved. SpectralinkTM, the Spectralink logo and the
names and marks associated with Spectralink’s products are trademarks and/or service marks of
Spectralink Corporation and are common law marks in the United States and various other countries. All
other trademarks are property of their respective owners. No portion hereof may be reproduced or
transmitted in any form or by any means, for any purpose other than the recipient’s personal use, without
the express written permission of Spectralink.
All rights reserved under the International and pan-American Copyright Conventions. No part of this
manual, or the software described herein, may be reproduced or transmitted in any form or by any
means, or translated into another language or format, in whole or in part, without the express written
permission of Spectralink Corporation.
Do not remove (or allow any third party to remove) any product identification, copyright or other notices.
Notice
Spectralink Corporation has prepared this document for use by Spectralink personnel and customers.
The drawings and specifications contained herein are the property of Spectralink and shall be neither
reproduced in whole or in part without the prior written approval of Spectralink, nor be implied to grant any
license to make, use, or sell equipment manufactured in accordance herewith.
Spectralink reserves the right to make changes in specifications and other information contained in this
document without prior notice, and the reader should in all cases consult Spectralink to determine
whether any such changes have been made.
NO REPRESENTATION OR OTHER AFFIRMATION OF FACT CONTAINED IN THIS DOCUMENT
INCLUDING BUT NOT LIMITED TO STATEMENTS REGARDING CAPACITY, RESPONSE-TIME
PERFORMANCE, SUITABILITY FOR USE, OR PERFORMANCE OF PRODUCTS DESCRIBED
HEREIN SHALL BE DEEMED TO BE A WARRANTY BY SPECTRALINK FOR ANY PURPOSE, OR
GIVE RISE TO ANY LIABILITY OF SPECTRALINK WHATSOEVER.
Warranty
The Product Warranty and Software License and Warranty and other support documents are available at
http://support.spectralink.com.
Contact Information
US Location Denmark Location UK Location
+1 800-775-5330 +45 7560 2850 +44 (0) 20 3284 1536
Spectralink Corporation Spectralink Europe ApS Spectralink Europe UK
2560 55th Street Bygholm Soepark 21 E Stuen 329 Bracknell, Doncastle Road
Boulder, CO 80301 8700 Horsens Bracknell, Berkshire, RG12 8PE
USA Denmark United Kingdom
721-0036-000_K.docx April 2020 3
Contents
About This Guide ............................................................... 7
Deployment process ......................................................................................................... 7
What is QNC? .............................................................................................................. 7
What is CMS? .............................................................................................................. 8
What is Manual Configuration? .................................................................................... 8
Product Support ............................................................................................................... 8
Spectralink References .................................................................................................... 8
Specific Documents—Spectralink 84-Series handsets ................................................. 9
White Papers ..............................................................................................................10
Conventions Used In This Document .............................................................................10
Icons ...........................................................................................................................10
Typography .................................................................................................................12
Part I: Getting Started with CMS ......................... 13
How Secure is CMS? .......................................................................................................13
Setting HTTPS ............................................................................................................14
Chapter 1: CMS 2.6+ Server Requirements .............................. 15
Minimum Requirements ..................................................................................................15
Capacity Guidelines .........................................................................................................15
Chapter 2: Installing the CMS Server ...................................... 17
VM ESXi 5.x Server Installation Overview ......................................................................17
CMS 2.0 Infrastructure Installation Instructions ............................................................17
Backing up the VM ...........................................................................................................21
Using the Export/Import Function ..................................................................................21
Export .........................................................................................................................21
Import ..........................................................................................................................22
Creating your CMS Account and Logging in .................................................................22
Chapter 3: Updating CMS Code: Installing a Patch .................... 24
Step 1: In the CMS browser ........................................................................................24
Step 2: On the host machine .......................................................................................24
Step 3: Verify in the CMS browser ..............................................................................26
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 4
Part II: Spectralink 84-Series Configuration
Management .................................................. 27
Logging in to CMS ...........................................................................................................27
Navigation ........................................................................................................................28
Banner ........................................................................................................................28
Navigation pane ..........................................................................................................28
Logout ..............................................................................................................................30
Deployment Sequence ....................................................................................................30
Basic Configuration .....................................................................................................30
Advanced Configuration ..............................................................................................31
Chapter 4: About Us .......................................................... 33
What is the Account Key? ...............................................................................................34
What is the CMS Server Certificate? ..............................................................................34
Chapter 5: Licenses ........................................................... 35
CMS License ....................................................................................................................36
Chapter 6: Spectralink 84-Series Batch Configuration ................ 37
SIP setup ..........................................................................................................................37
MAC address ..............................................................................................................38
Type ............................................................................................................................39
Server address ............................................................................................................39
Server Port ..................................................................................................................40
Extension ....................................................................................................................40
UserID .........................................................................................................................40
Display name ..............................................................................................................41
Line Label ...................................................................................................................41
Upload .csv to CMS .........................................................................................................42
Chapter 7: Spectralink 84-Series Devices ................................ 43
Device Holding Area ........................................................................................................43
Approving Devices via Holding Area ...........................................................................43
Device List ........................................................................................................................45
Device List actions ......................................................................................................46
Re-Deploying Devices .....................................................................................................47
Chapter 8: Spectralink 84-Series Groups ................................ 48
Group Name ...............................................................................................................49
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 5
Associate Devices .......................................................................................................49
Manage Groups ..........................................................................................................50
Chapter 9: Spectralink 84-Series Feature Configuration .............. 51
Understanding Enterprise, Group and Device Levels ...................................................51
Enterprise settings ......................................................................................................51
Group settings .............................................................................................................51
Device settings ............................................................................................................52
Understanding Default Settings ......................................................................................53
Config Manager ................................................................................................................54
Logging ............................................................................................................................55
Global Log settings .....................................................................................................55
Module Log Level Limits ..............................................................................................56
SIP Registration ...............................................................................................................59
Base Profile .................................................................................................................59
Skype for Business (not available in R2.4) ..................................................................59
Open SIP ....................................................................................................................59
Registrations (Lines) ...................................................................................................60
Server Settings ...........................................................................................................62
Web App ...........................................................................................................................64
APP URL(s) ................................................................................................................64
Web Browser ..............................................................................................................64
Phone State Polling .....................................................................................................65
Push Request .............................................................................................................66
Telephony Notification .................................................................................................68
Open Application Interface ..........................................................................................69
Feature Config .................................................................................................................71
Call Handling ...............................................................................................................71
Phone Lock .................................................................................................................71
Tones ................................................................................................................................72
Ring Type Mapper .......................................................................................................72
Alert Type Mapper .......................................................................................................72
Personal Alarms ..............................................................................................................73
Motion events ..............................................................................................................74
Alarms and Warnings ..................................................................................................76
Duress Settings ...........................................................................................................78
Enhanced Feature Keys ..................................................................................................81
Push to Talk .....................................................................................................................81
General Settings .........................................................................................................82
PTT Channels .............................................................................................................82
Wireless ............................................................................................................................84
Configuring radio frequency settings ...........................................................................84
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 6
Chapter 10: Spectralink 84-Series Custom Settings ................... 87
Import Configuration .......................................................................................................87
Create Configuration .......................................................................................................88
Download and Edit Custom Settings Files.....................................................................89
Apply Custom Settings File(s) ........................................................................................89
Apply Custom Setting to a Device ...............................................................................89
Apply Custom Setting to a Group ................................................................................90
Apply Custom Settings to the Enterprise .....................................................................91
Chapter 11: Spectralink 84-Series Resource File ....................... 92
Chapter 12: Spectralink 84-Series OTA Files—Updating Spectralink
84xx Code ....................................................................... 93
Upload files .................................................................................................................93
Manage files ................................................................................................................94
Chapter 13: Spectralink 84-Series RMA--Replace Device ............. 95
Chapter 14: Wireless Profiles ............................................... 98
Wireless Profile Security .................................................................................................98
Open Network .............................................................................................................99
WEP ............................................................................................................................99
WPA/WPA2 PSK ....................................................................................................... 100
802.1x EAP (WPA2 Enterprise) Set up ..................................................................... 100
Managing Wireless Profiles .......................................................................................... 102
Part III: Appendices ....................................... 103
Appendix A: Open Source Information ................................. 104
OFFER for Source for GPL and LGPL Software .......................................................... 104
Contact Information for Requesting Source Code ..................................................... 104
Appendix B: Products Mentioned in this Document ................. 105
721-0036-000_K.docx April 2020 7
About This Guide
The primary tool for administering a volume of Spectralink devices is CMS, the Configuration
Management System. CMS provides a GUI program that is opened in a browser and provides
an easy and intuitive way to configure and manage the deployment of many devices.
Spectralink 84-Series feature phones can be administered with CMS.
An administrator can configure any handset or smartphone’s administrative settings in CMS.
These settings can be configured at the Device level for a single device, at a Group level for a
subset of devices or at an Enterprise level for every device deployed within a facility. These
settings are picked up by all registered devices when they heartbeat into CMS.
An administrator can “see” devices in the Device list. Each device provides information as part
of its heartbeat and this information enables an administrator to check on activity and usage
information.
CMS is designed to be the exclusive configuration method for Admin menu options. If devices
are configured manually through their Admin menus, CMS will not “know” about these changes.
Existing CMS configuration settings will overwrite any manual changes at the next heartbeat.
Deployment process
What is QNC?
Quick Network Connect utilizes a customized version of a commercially available Raspberry Pi
to simplify the wireless provisioning of your Spectralink devices.
When connected to a PC, QNC provides a browser-based GUI that provides you with the
wireless configuration parameters you need to associate with the wireless LAN.
Once the configuration is completed, a connection between QNC and a device loads the
wireless parameters into the smartphone. See Quick Network Connect Administration Guide for
complete information.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 8
What is CMS?
The primary tool for administering a volume of Spectralink devices is CMS---Configuration
Management System. It is a GUI program that is opened in a browser and provides an easy and
intuitive way to configure the devices and manage the deployment of many devices at once.
What is Manual Configuration?
Spectralink devices provide menus for configuring options that provide functionality and
features. Two types of menus are available, the familiar user-level menus used by all devices
and administrator menus that are behind a password. Manual configuration refers to using these
menus to set up each device individually.
Practically any deployment will require some manual adjustments so this step is included to put
the final polish on your deployment.
Product Support
Spectralink wants you to have a successful installation. If you have questions please contact the
Customer Support Hotline at 1-800-775-5330.
The hotline is open Monday through Friday, 6 a.m. to 6 p.m. Mountain time.
For Technical Support: mailto:[email protected]
For Knowledge Base: http://support.spectralink.com
For Return Material Authorization: mailto:[email protected]
Spectralink References
All Spectralink documents are available at http://support.spectralink.com.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 9
To go to a specific product page:
Select the Product Category and Product Type from the dropdown lists and then select the
product from the next page. All resources for that particular product are displayed by default
under the All tab. Documents, downloads and other resources are sorted by the date they were
created so the most recently created resource is at the top of the list. You can further sort the
list by the tabs across the top of the list to find exactly what you are looking for. Click the title to
open the link.
Specific Documents—Spectralink 84-Series handsets
The Spectralink 84-Series Wireless Telephone Administration Guide provides a comprehensive
list of every parameter available on Spectralink 84-Series Wireless Telephones.
Spectralink 84 Series Wireless Telephone Deployment Guide Using Spectralink CMS This
document introduces deployment concepts and the methods of provisioning the 84-Series
handsets when using CMS as your provisioning server.
Spectralink Configuration Management System Administration Guide The CMS Administration
Guide provides information about every setting and option available to the administrator on
Spectralink 84-Series handsets and CMS. Time-saving shortcuts, troubleshooting tips and other
important maintenance instructions are also found in this document. CMS software and
documents are available on the Spectralink support site at http://support.spectralink.com/cms.
Spectralink 84-Series Wireless Telephone Deployment Guide This document introduces
deployment concepts and the methods of provisioning the 84-Series handsets in any type of
facility when not using CMS as a provisioning server.
Barcode Administration Guide Provides information about barcode symbologies and how to
configure and implement the barcode feature on the handset. The Spectralink 84-Series User
Guide also contains information about using the barcode feature.
Quick Barcode Connector Administration Guide Provides instruction for implementation of the
barcode application. The Spectralink 84-Series User Guide contains information about using the
barcode feature.
The Spectralink 84-Series User Guide offers comprehensive instructions on using each of the
features deployed on the handsets.
The Web Configuration Utility User Guide is used for troubleshooting in certain isolated cases
as explained in the text.
For information on IP PBX and softswitch vendors, see the Spectralink 84-Series Call Server
Interoperability Guide.
For information about combining Polycom desksets and Spectralink 84-Series handsets in the
same facility, see the Interoperability Guide: Spectralink 84-Series Wireless Telephones and
Polycom Desksets.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 10
AP Configuration Guides explain how to correctly configure access points and WLAN controllers
(if applicable) and identify the optimal settings that support Spectralink 84-Series handsets.
Technical Bulletins and Feature Descriptions explain workarounds to existing issues and
provides expanded descriptions and examples.
Release Notes describe the new and changed features, and resolved issues in the latest
version of the software. Find them in the Downloads section of the support site.
White Papers
Spectralink White Papers are available at http://www.spectralink.com/resources/white-papers.
For the Spectralink 84-Series Wireless Telephones, please refer to Best Practices Guide for
Deploying Spectralink 84-Series Handsets for detailed information on wireless LAN layout,
network infrastructure, QoS, security and subnets.
For additional details on RF deployment please see The challenges of ensuring excellent voice
quality in a Wi-Fi workplace and Deploying Enterprise-Grade Wi-Fi Telephony.
These White Papers identify issues and solutions based on Spectralink’s extensive experience
in enterprise-class Wi-Fi telephony. It provides recommendations for ensuring that a network
environment is adequately optimized for use with Spectralink Wireless Telephones.
Conventions Used In This Document
Icons
Icons indicate extra information about nearby text.
Warning
The Warning icon highlights an action you must perform (or avoid) to avoid
exposing yourself or others to hazardous conditions.
Caution
The Caution icon highlights information you need to know to avoid a hazard that
could potentially impact device performance, application functionality, successful
feature configuration and/or affect smartphone or network performance.
Spectralink recommends
A recommendation from the experts at Spectralink.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 11
Note
The Note icon highlights information of interest or important information that will
help you be successful in accomplishing a procedure or understanding a concept.
Tip
The Tip icon highlights information that may be valuable or helpful for users to
know, such as special techniques, shortcut methods, or information that will make
user tasks easier to perform.
Web
The Web Info icon highlights supplementary information available online such as
documents or downloads on support.spectralink.com or other locations.
Timesaver
A time-saving tip is typically used to mention or highlight a faster or alternative
method for users who may already be familiar with the operation or method being
discussed.
Admin Tip
This tip advises the administrator of a smarter, more productive or alternative
method of performing an administrator-level task or procedure.
Power User
A Power User Tip is typically reserved for information directed specifically at high-
level users who are familiar with the information or procedure being discussed and
are looking for better or more efficient ways of performing the task. For example,
this might highlight customization of a feature for a specific purpose.
Troubleshooting
This element can be used in any type of document and is typically used to highlight
information to help you solve a relevant problem you may encounter, or to point to
other relevant troubleshooting reference information.
Settings
The Settings icon highlights information to help you zero in on settings you need to
choose for a specific behavior, to enable a specific feature, or access customization
options.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 12
Typography
A few typographic conventions, listed next, are used in this guide to distinguish types of in-text
information.
Convention Description
Bold Highlights interface items such as menus, soft keys, file names, and directories. Also used to represent menu selections and text entry to the smartphone.
Italics Used to emphasize text, to show example values or inputs, and to show titles of reference documents available from the Spectralink Support Web site and other reference sites.
Underlined blue Used for URL links to external Web pages or documents. If you click on text in this style, you will be linked to an external document or Web page.
Bright orange text Used for cross references to other sections within this document. If you click on text in this style, you will be taken to another part of this document.
Fixed-width-font Used for code fragments and parameter names.
This guide also uses a few writing conventions to distinguish conditional information.
Convention Description
<MACaddress> Indicates that you must enter information specific to your installation, smartphone, or network. For example, when you see <MACaddress>, enter your smartphone’s 12-digit MAC address. If you see <installed-directory>, enter the path to your installation directory.
> Indicates that you need to select an item from a menu. For example, Settings> Basic indicates that you need to select Basic from the Settings menu.
721-0036-000_K.docx April 2020 13
Part I: Getting Started with CMS
CMS is a powerful interface for configuring and managing Spectralink devices. Let’s take a
moment to look at some big questions.
Caution: CMS 2.4 and above compatibility
Spectralink 84-Series must use R5.4.4 and above to operate with CMS 2.4.
Settings: Is CMS necessary?
The question will arise if CMS is strictly necessary for configuring and managing
the smartphones. The short answer is “No, not if you are deploying only a few
smartphones.” The Admin menu is behind a password and can be used to
manually set parameters. This document covers nearly all the settings you will find
in the Admin menu.
The longer answer is “Yes; if you are deploying many devices, have complex
settings such as security certificates, device groups, etc., or if the devices cannot
be easily retrieved for user support functions.” The CMS is a boon to Wi-Fi and IT
administrators as it can keep track of and manage any number of devices remotely.
Settings: Not using CMS?
If you are not deploying a CMS, please refer to deployment documents for the sequence of steps to take when manually configuring the devices.
How Secure is CMS?
CMS transfers configuration information to the devices over the air which could expose the data
to unauthorized parties. CMS uses both HTTP and HTTPS protocols but the default is HTTPS.
If your facility uses the HTTPS protocol, you can take advantage of the mutual authentication
feature built into CMS.
Mutual authentication is implemented by generating a public key on the CMS server and loading
it into the device using QNC. This is the “server key” that ensures the device recognizes the
CMS server as genuine. The device contains a device certificate that is loaded during
manufacturing. The CMS can recognize this key and therefore knows that the device is genuine.
Once this authentication handshake is complete, the device and the CMS server exchange
information over a secure connection.
This secure connection is not possible using HTTP.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 14
Setting HTTPS
The following settings are required when using HTTPS to establish the secure tunnel.
1 Setting https://[IP address] for CMS in the device and
2 Using QNC to install the CMS certificate.
721-0036-000_K.docx April 2020 15
Chapter 1: CMS 2.6+ Server
Requirements
Minimum Requirements
• VMWare ESXi server 5.0 (or later) host machine capable of running 64-bit guest OS
Virtual Machines (VM)
(see this knowledge base article on VMWare's site:
http://kb.vmware.com/selfservice/microsites/microsite.do?cmd=displayKC&docType=kc&
externalId=1003945&sliceId=1&docTypeID=DT_KB_1_1
• ESXi VM is a OS and will take over the HW
• Utility - Processor Check for 64-Bit Compatibility.
• 100GB free on ESXi server datastore
• CMS Virtual Machine requires the following resources from the ESXi host server:
○ 4 virtual CPU
○ 4GB RAM
○ 50GB Hard drive (Thick provisioned)
○ 1 NIC
• CMS VM is Ubuntu 16.xx LTS server 64-bit
• Administrator needs to be knowledgeable about using VMWare vSphere
Capacity Guidelines
Estimated guidelines for larger installations are outlined below.
Admin Tip: Testing environment
Testing for capacity was conducted on a Vsphere host with an Intel Xeon x5670
processor running at 2.93 GHz. This is a mid-grade host machine. Performance will
certainly vary if the administrator loads CMS on a laptop or a less powerful host.
Conversely, an administrator might expect slightly better performance from a host
with a more robust processor.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 16
General guidelines for larger installations:
Number of handsets Heartbeat interval
Up to 1000 handsets No more frequent than every 1 minute.
Between 1000 and 2000 handsets No more frequent than every 2 minutes.
Between 2000 and 3000 handsets, No more frequent than every 3 minutes.
Between 3000 and 4000 handsets No more frequent than every 4 minutes.
More than 5000 handsets No more frequent than every 5 minutes.
Caution: Capacity guidelines
The R2.4+ OVF requires 4 processors and 4GB. This configuration will handle up
to 5000 devices based on our testing. Start with 500 devices and test. As you add
each 100 devices beyond 500, add 10 seconds to the heartbeat interval up to a 5
minute interval for 5000 devices. Never try to accept more than 250 devices at a
time.
721-0036-000_K.docx April 2020 17
Chapter 2: Installing the CMS Server
CMS software is a Spectralink appliance that uses Ubuntu as the core processing software and
VMWare to support the Spectralink CMS software on a server set up specifically for that
purpose. When setting up the CMS server, you will first install vSphere by VMWare on an
appliance already running Ubuntu. Then you will install CMS software according to VMWare
procedures.
Caution: Upgrade from Ubuntu 14.x to 16.x
CMS R2.6 requires Ubuntu version 16.x. If upgrading from 14.x, it is necessary to
spin up a new appliance and export/import the database from the 14.x version to
the 16.x version. Contact your Spectralink support representative for detailed steps
to a successful transition.
VM ESXi 5.x Server Installation Overview
For assistance on the installation of VM ESXi 5.x, please refer to VMWare installation video:
http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&exte
rnalId=2052439
Install vSphere to connect & manage your ESXi VM
CMS 2.0 Infrastructure Installation Instructions
Note
These instructions require the reader to be knowledgeable about using VMWare
vSphere. See VMWare’s website for more information.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 18
The CMS appliance is available from Spectralink.
1 Download the CMS zip file from the Spectralink support representative.
2 Unzip VM files onto a machine that can talk to your ESXi host server and that has a
compatible version of VMWare vSphere® Client installed.
3 Connect to your ESXi host server using vSphere.
4 Select File> Deploy OVF Template… from VSphere.
5 Browse to the OVF file inside the unzipped folder from step 2. Select Next.
6 Select Next again. Name the new machine something like "Spectralink CMS". Select
Next.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 19
7 Select the resource pool you want to run this VM on. (You may only have one ESXi
server to choose from).
8 Select the datastore that you want to deploy this VM onto. You may only have one
datastore. Click Next.
9 Select Thick Provision Lazy Zeroed for the disk format. Select Next.
10 Change the Network Mapping to a network that your devices have access to. Select
Next.
11 Leave Power on after deployment unchecked. Click Finish. You will see the OVF being
deployed to your server. When it is finished, go to the next step.
12 Right-click the new machine in the tree on the left of vSphere and select Power> Power
On.
13 Go to the console (in vSphere) for the CMS server VM and wait for the login prompt at
which you will login as cms2, password=cms2 (You will want to change this at some
time later).
Caution: Keep track of passwords!
If you change the root password and forget what it is, you cannot reset the system
and you will need to reinstall from the original VM image.
14 Switch to bash shell (optional but recommended) bash
15 Run the command cd bin
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 20
16 Run the command sudo python network_init.py
and follow the prompts to configure your network interfaces:
○ DHCP
Caution: Dynamic DHCP not supported
The IP address must remain static. Use “reserved” DHCP instead if supported by
your system.
○ address {your static IP address here or DNS, which should be a fully qualified and
registered domain name}
○ netmask {your static network mask here}
○ gateway {your default gateway here}
○ DNS nameserver
17 Run the command sudo python application_init.py
and follow the prompts.
○ address {your static IP address here or DNS which should be a fully qualified domain
name that was entered above}
Admin Tip: HTTPS and IP addressing
When configuring the device to connect to CMS using https, the URL must match
what is entered here (IP, short hostname, or fully qualified hostname). i.e. If the
CMS server is using IP number 10.20.30.40, and the hostname my-cms is used to
name the CMS host, only https://my-cms will work as the device's CMS URL.
https://my-cms.restofmydomain.com and https://10.20.30.40 will not work.
○ DNS or Hostname {your hostname here}
○ Administrator Name {your administrator name here}
○ Administrator Email {your administrator email here}
○ Country Code {your 2 digit country code}
○ State {your 2 digit state code}
○ City {your city}
○ Company {your company name}
○ Organization {your organization}
○ Enter desired postgres password {uppercase, lowercase, and numbers only}
18 Your CMS should now be initialized. This step installs the certificate.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 21
Caution
For the CMS update feature to work, a DNS server must be defined in step 19 that
can resolve to Internet domain names and the CMS server must have access to the
Internet.
At this point, you can browse to the CMS server.
https://spectralink-cms/cms/
Or (e.g.)
https://[10.225.15.200]/cms/
=========
Further customization steps (like changing server root login and web interface default
admin login) are covered in the relevant configuration guide for the device.
Backing up the VM
Good housekeeping means preparing your installation for computer anomalies and file
corruption events. You can create a snapshot of the VM by following this procedure:
Using the vSphere fat client, right-click the VM and select Snapshot>Take Snapshot. The VM
can be either running or powered off.
Using the Export/Import Function
You can maintain a backup of the CMS image by performing regular exports. You can restore a
backup using the Import command.
Export
From the console of CMS do the following:
1 Navigate to: cd bin
2 Enter the command: export.sh
3 From a web browser navigate to http://cmsIPaddress/backup
Note that this URL is HTTP instead of HTTPS
4 Click on the backup file with the newest time and date to download the backup file.
Caution: Store backup files in a different location
For security, backup files should be moved off the host and stored in a safe
location.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 22
Import
To import the file, do just the reverse:
1 Log into your CMS server and navigate to the About Us page.
2 Click on the Browse File button and select the backup file you generated earlier.
3 From the CMS console navigate to: cd bin
4 Enter the command: import.sh
Wait for CMS to finish the import at which point you will then have the database of
devices and configurations, IP Address, certificate and account key of the CMS
appliance you generated the backup from.
Creating your CMS Account and Logging in
Caution: CMS is limited to one password
CMS permits only one username and password. Only one active user may access
CMS at any given time. Attempting multiple users may render CMS inoperable.
1 Enter the IP address that you set up in your CMS in your browser. Only use the
Google™ Chrome™ browser. Use this format: [IP address or server name]/cms/.
If security warnings appear, click the Advanced link and proceed to the CMS login page.
2 Create a user account:
Caution: Password parameters
Passwords must contain:
• between 8-100 characters,
• at least 1 capital letter,
• at least 1 special character.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 23
3 Log in with your new credentials.
721-0036-000_K.docx April 2020 24
Chapter 3: Updating CMS Code: Installing
a Patch
Installing the update patch is a three-step procedure.
Step 1: In the CMS browser
1 Download the patch from the Spectralink support site.
2 Log into CMS and browse to About Us.
3 Click the Browse file button.
4 Find and select the patch zip file. A progress bar is shown as the file is uploaded. At the
end, a validation message lets you know that the upgrade is done. Another message
tells you to: Please run the upgrade script on your server, whenever you are ready.
5 Leave the browser open.
Step 2: On the host machine
You must install or already have installed the vSphere app that enables you to reach the
console of the VM hosting the CMS server. This step is covered in the initial installation
instructions, earlier in this document.
1 Open vSphere and log into the host.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 25
2 Enter the credentials for this CMS and click Login.
3 Expand the IP address to view the virtual machines that are present on the host.
For example:
4 Right-click the correct virtual machine and select Open Console from the dropdown.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 26
5 Login to the console with the username of cms2 and the password of cms2.
Type “cd bin”.
Type “sh upgrade.sh”.
The upgrade script issues messages as it is upgrading. No error messages are
displayed.
Step 3: Verify in the CMS browser
1 Close and reopen the browser to the CMS server being upgraded.
2 View the version in the CMS header. It should be the patch version.
721-0036-000_K.docx April 2020 27
Part II: Spectralink 84-Series Configuration Management
The Configuration Management System provides a GUI interface for an administrator to
configure and manage Spectralink 84-Series devices.
An administrator can “see” devices in the Device list. Each device provides information as part
of its heartbeat and this information enables an administrator to check on vital activity and
usage information. The system log setting can further assist the administrator in getting very
specific information from any device.
An administrator can configure any setting in CMS, most of which are also available on the
Admin menu of each handset. In CMS, settings can be configured at the Device, Group or
Enterprise level. These settings are picked up by the device when it heartbeats into CMS.
Caution: Menu conflicts between CMS and manual settings?
CMS is designed to be the exclusive configuration method for Admin menu options.
However, if handsets are configured manually through their Admin or User menus,
CMS will not “know” about these changes and any changes manually set in either
the User or Admin menus will persist in the 84-Series devices.
If the Restore defaults option has been used on the Admin menu, there is no way to recover
previous CMS settings. See Re-Deploying Devices for the method to re-deploy the device with
CMS.
Logging in to CMS
Once you have set up the CMS server with an IP address username and password, you are
ready to use it to manage your 84-Series phones.
Enter the IP address that you set up in your CMS in a Google™ Chrome™ browser window.
Only use the Google™ Chrome™ browser. Use this format:
[IP address or server name]/cms/.
If security warnings appear, click the Advanced link and proceed to the CMS log in page.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 28
Navigation
Once logged in, the banner displays the CMS username with a dropdown for Preferences and
Logging out. The navigation pane helps you find the page you need.
Banner
The right side of the banner displays the username and a settings icon where you can reset the
password, set the number of devices per page and logout.
Header
The header displays the title of the page.
Navigation pane
The navigation pane provides intuitive icons to direct you to administrative pages. It can be
expanded by clicking the right arrow.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 29
Devices
Device holding area Device list
Groups
Name, manage and assign devices to Groups
OTA Files
Upload and manage phone software
Certificates
Configure certificates
Configuration
Configure Logging, SIP Registration< Web App, Call Features
Custom Settings
Create and populate custom configuration files
Licenses
Load licenses, apply to devices
Batch Configuration
Upload configuration file for configuring many phone with basic settings at one time
Wireless Profiles
Configure the wireless profiles that can be used on the handsets.
Resource File
Upload files for CMS application
RMA
Moving a configuration from one phone to another so the source phone can be sent in for repair.
About Us
Info about CMS: version, account key, self-signed public key.
Log out
Exit the program
Condensed Expanded
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 30
Logout
Use the logout icon on the Nav bar to exit CMS software.
Deployment Sequence
The following steps form the foundation for the recommended deployment procedure when
using CMS. See Spectralink 84-Series Wireless Telephone Deployment Guide using CMS for
additional information.
This Sequence assumes that this is a new installation and all the handsets are physically in the
possession of the administrator.
Caution: Use the correct version of CMS!
CMS 2.x is designed to work with 84-Series R5.4 and above. Always check the
Release Notes to ensure that the code version you are running is compatible with
the code version of CMS and vice versa.
Spectralink recommends: Conduct a trial installation
Select a few phones for the initial configuration. Once you have verified the desired
functionality works on the subset of phones, then deploy the rest using those same
settings.
1 The QNC settings produce a wireless connection as shown by bars appearing in the status bar,
2 The phones can be accepted in CMS and the settings from the Batch file appear in the device settings,
3 The phones register with the call server and calls can be made and received,
4 Any advanced features (such as groups or PTT) can be configured and work as expected.
Basic Configuration
1 Infrastructure. Plan and deploy the infrastructure requirements. See Spectralink 84-
Series Deployment with CMS Guide for infrastructure information. Also see the VIEW
document for your access points for configuration information.
2 Use this document to install the Configuration Management Server.
3 Create the Batch .csv file for bulk configuration of basic handset parameters.
4 Bring up the CMS server and load the .csv file.
5 Obtain needed information from CMS:
○ The URL of the CMS server.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 31
○ If using HTTPS as your network protocol, you will need to enter the SSL certificate
from the CMS server.
6 Use QNC to configure handsets to associate with the wireless LAN. See Quick Network
Connect Administration Guide for complete information.
7 Upload the QNC wireless configuration into each phone. Connect each handset to QNC
for its initial provisioning. Each handset in turn will download the QNC parameters.
8 Unplug the phone from QNC. It will continue to provision itself. It will find CMS, update
its software as needed and park in the CMS holding area.
Admin Tip: Do QNC settings persist?
When configuring the parameters for wireless connectivity while also using CMS for
further configuration, realize that QNC settings will persist unless set otherwise by
CMS.
9 In CMS, accept the handsets in the holding area. Handsets are now listed in the Device
List.
10 Conditional: If you are deploying more than 10 Spectralink 84xxs, you will need to
purchase a CMS license for each phone over the first 10. Contact your service
representative for complete information.
Once the needed number of licenses are loaded, approve the rest of the handsets.
11 Once Spectralink 84xxs are listed in the Device List, they will download their unique
configuration at the next heartbeat. Wait for this to conclude.
12 Verify the settings for each phone in the Device list. Test handsets for basic telephony
functionality. Handsets should register with the call server and make and receive phone
calls. Correct any problems.
Advanced Configuration
Once you have determined that the handsets have basic functionality, you can continue to
advanced configuration. You will want to complete Enterprise settings in Spectralink 84-Series
Feature Configuration and may want to enter Feature Licenses, set up Groups or perform other
administrative tasks.
1 Complete Enterprise settings, as needed.
2 (Conditional) Set up any Groups and assign handsets to Groups. A handset can belong
to only one Group.
3 Use manual configuration to finish configuring any parameters that are unavailable in the
programs mentioned.
4 Perform a final test of the handsets.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 32
5 Deploy.
Admin Tip: Testing suggestion
When you are ready to test a major deployment, please follow a staged process
such as this method for the first 500 devices:
1 Test call functionality,
2 Configure Enterprise settings and test,
3 Configure Group settings and test, (add more devices to Groups as they are
deployed),
4 Configure Device settings as needed.
5 Use CMS to configure another 500 devices and repeat.
721-0036-000_K.docx April 2020 33
Chapter 4: About Us
The About Us page gives you information about the CMS software version, your unique
account key, and the CMS server certificate for https security. It also has a button for updating
the CMS software.
Admin Tip: Updating CMS software
For beta deployment, CMS will require a new installation with a completely new
version of software.
Admin Tip: Where does the CMS server certificate come from?
The certificate is generated by the application_init.py script during initial
configuration of the CMS server and can be copied by clicking the Copy to
clipboard button. Use the Paste method to paste the full certificate to QNC, a text
file or other document. When using HTTPS, the certificate must be pasted into
QNC.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 34
What is the Account Key?
The account key is used by QNC to authorize your use of CMS with 10 devices. Additional
device licenses must be purchased and those licenses are entered in the Licenses chapter.
What is the CMS Server Certificate?
Note: Use QNC to install the CMS server certificate
A certificate cannot easily be installed on the device by typing it in. We recommend
using QNC for this purpose
Spectralink 84-Series deployments require HTTPS for device-to-CMS server authentication.
With this type of deployment, the device uses a certificate to authenticate the CMS server. The
certificate has two elements – the “private” key that resides on the CMS and the “public” or
server key that must be loaded on every device, usually using QNC. The certificate is generated
within the CMS server during setup at which point it is available in the About Us page.
The public or server certificate is loaded into the device using QNC. When the device gets the
CMS server address which is prefaced with https:// and the certificate along with the SSID and
wireless security settings through QNC configuration, it is able to associate with the wireless
LAN and locate the CMS server using the IP address and then authenticates the CMS server
using the certificate.
The CMS server authenticates the device through the Spectralink device certificate loaded on
the device at manufacturing. With both the device and the CMS server able to authenticate each
other, a secure tunnel is established for information exchange.
Spectralink recommends: Learning about Wi-Fi security methods
Refer to the relevant configuration guide for the device for additional information about understanding and deploying Wi-Fi security methods.
Caution: Certificate expiration
The self-signed certificate that is generated by the application_init.py script during
initial configuration of the CMS server is a 3-year certificate measured from the
initial installation of the CMS server. A new certificate must be created and pushed
to the devices before this 3-year certificate expires.
721-0036-000_K.docx April 2020 35
Chapter 5: Licenses
Certain Spectralink products, including CMS, require a license to operate. When you
purchase a license, you receive a serial number and a key for each license. Enter this
information in the appropriate feature license fields.
Caution: Assigning licenses
Use Group or Device level to edit which devices have licenses applied to them.
CMS “expects” licenses will be applied to a select Group or number of Devices and
therefore the Enterprise level (tabs in the upper right corner) should NOT be used
when assigning licenses.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 36
CMS License
For CMS, if you need to approve more than 10 devices in the Device List, you will be required to
purchase a license to continue using CMS for additional devices. Contact your support
representative for further information.
Once you enter the Serial Number and Key, navigate to the Device Holding Area and CMS will
now allow you to approve additional devices. They will then display in the Device List.
Caution: Good housekeeping
It is good practice to take a snapshot of the virtual machine before adding licenses.
You can always revert to the snapshot if you lose track of your changes or
experience some unexpected problem.
721-0036-000_K.docx April 2020 37
Chapter 6: Spectralink 84-Series Batch
Configuration
Admin Tip: Spectralink 84-Series installation support
Please see the Spectralink 84-Series Wireless Telephone Deployment Guide using
CMS for additional information about batch configuration for the 84-Series
handsets. Specific deployment parameters are listed below.
Batch configuration is used by CMS to bulk provision SIP service requirements. Settings
loaded through the .csv file will override any enterprise/group level settings. The .csv template is
available from your Spectralink support representative.
The .csv file is designed to be used when deploying a number of new 84xx handsets in a new
installation or when expanding an existing installation. The CSV parser expects the format as
presented in the csv file template with the following rules:
• Field names may not be changed or altered.
• Any values supplied in this file will take precedence over values you've already entered
in CMS and on the 84xx handset. These values are set at the Device level.
• The .csv format is User,Type,Address,Port,Extension,UserID,Password,Display
Name,Line Label
Caution: All Batch file fields must be populated
Do not leave any cells empty in the Batch file. Use every column and populate it for
each phone.
SIP setup
The following settings may be configured when using a SIP telephony server. If using Microsoft
Skype for Business, see the next section. All fields are required. Provisioning all these fields
gives the most efficient installation and immediate registration when the phone is accepted by
CMS. These settings are all for Registration/Line 1. See detailed explanations of each field
below the table. If multiple lines are needed for each device, create 2 lines with identical mac
addresses but differing phone line information.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 38
Column (field) name Parameter being set Setting function
Mac or User The Mac address is the unique identifier of the phone hardware
Type Sets the telephony protocol to SIP telephony (telephony) or Microsoft Skype for Business (Lync)
Address reg.1.server.1.address The SIP server address and port are included in the Batch file so that the phone can register immediately upon being accepted in CMS. Port reg.1.server.1.port
Extension reg.1.address The SIP Address of Record. This field is required and must be populated to achieve successful SIP registration.
UserID reg.1.auth.userId Authentication credentials are included so that the phone is recognized by the server.
Password reg.1.auth.password
Display Name reg.1.displayName The display name is the Caller ID that displays for this phone if the PBX does not use its own procedures for this feature.
Line Label reg.1.label The text for Line 1 that displays on the screen. Usually a name and extension to identify the phone as belonging to a user.
Example
MAC address
The field name is User or Mac but at this time only the Mac address is supported. List the Mac
address of each Spectralink 84xx you will be deploying. The Mac address may be found on the
label in the battery compartment or by navigating to Settings> About phone> Status. Mac
addresses contain letters and numbers separated by colons.
Entry criteria
Type Text field. MAC addresses contain letters and numbers separated by colons. Case insensitive and colons are optional. E.g. 00:90:a3:c6:ef:ab or 00:90:AB:cd:DD:12
Default none
Unique? Yes. Every 84xx handset has a different Mac address
Required? Yes
Level Device
Notes: See above
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 39
Type
Spectralink software is available in two variants – Skype for Business and non-Skype for
Business (or open SIP/Generic). The Type column sets the telephony protocol. Enter telephony
if using SIP. See the next section if using Microsoft Skype for Business.
Type telephony
Default none
Unique? No. All phones use the same protocol. For SIP, enter “telephony”.
Required? Yes
Level Device
Notes: See above
Server address
The Address column: All devices using the same SIP server use the same entry in this field.
Two formats are recognized by the device:
Format A: domain
Accepts: IP address, DNS A-name record using a FQDN, or a DNS SRV record that can be
resolved to an IP address. The [domain] value should be resolvable to a server that accepts SIP
registrations.
Default value: none
Registration requests, SIP Invites, and other SIP requests will be composed in the form of
[extension]@[domain] and will be delivered to the IP address of [domain], whether obtained
through DNS lookup or provided by an IP address. If the SIP server requires requests in the
form of Extension@SIP_Domain_Name, and you wish to use this format, then you should
create a DNS SRV record with the SIP_Domain_Name pointing to the server’s address.
Format B: [domain]; [serverspec1]
Accepts: domain = SIP Domain Name; serverspec1 = a dotted-decimal IP address, a hostname,
or a SRV record that can be resolved to an IP address.
Registration requests, SIP Invites, and SIP messages will be sent in the form of
[extension]@[domain], and will be delivered to the IP address specified after the semicolon,
whether obtained through DNS lookup or provided by an IP address. If the SIP server requires
requests in the form of [extension]@[SIP_Domain_Name] and you wish to use this format, you
should specify the [SIP_Domain_Name], followed by a semicolon, and then the address,
hostname, or SRV record that can be resolved to the address to which you want SIP messages
delivered.
Entry criteria
Type See above for format type
Default None
Unique? No. Usually all phones in a system use the same server and port for the same line #.
Required? Yes, for telephony function
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 40
Level Enterprise
Notes: Included in the Batch file for immediate registration once the phone is accepted by CMS.
Server Port
The port value entered here must match the port used in the SIP server to accept connection
requests.
If utilizing a DNS SRV record, the SIP Server Port should be specified through the SRV record
and left blank in this field. If you specify a port number here, then the device will not attempt to
use SRV records at all to discover the SIP Server address and instead will only query for a DNS
A record.
Entry criteria
Type Numeric value. Accepts 0, 1 to 65535
Default 5060. Leaving this value blank will enter the default value.
Unique? No. Usually all phones in a system use the same server and port for the same line #.
Required? Yes, for telephony function
Level Enterprise
Notes: Included in the Batch file for immediate registration once the phone is accepted by CMS.
If utilizing a DNS SRV record, the SIP Server Port should be specified through the SRV record
and left blank in this field. If you specify a port number here, then the device will not attempt to
use SRV records at all to discover the SIP Server address and instead will only query for a DNS
A record.
Extension
The extension column establishes the SIP extension. This is the unique number assigned to
each 84xx handset. The user part of the SIP Address of Record (for example, 1002) or the user
and the host part of the registration SIP URI. (for example, [email protected]). This field is
Entry criteria
Type Text field.
Default none
Unique? Yes. Every 84xx handset has a different extension outside of test environments.
Required? Yes
Level Device
Notes: See above
UserID
SIP digest authentication User ID to be used for SIP registration. Also referred to as Username.
For many call servers, this will be the same as the Extension Number, though some call servers
offer the ability to have a Username that is unique from the Extension Number.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 41
Entry criteria
Type Text field.
Default none
Unique? Yes. Every phone has a different SIP username.
Required? Yes, for Batch file processing.
Level Device
Notes: See above
Display name
The Display Name is the default caller ID shown in the caller ID field of outgoing calls. Many
PBXs overwrite this info with proprietary methods for displaying the caller ID. Frequently a
phone number is displayed here but a name or other identifier is also used.
Entry criteria
Type Text field
Default none
Unique? Not necessarily
Required? Yes for Batch processing
Level Device
Notes: See above
Line Label
The text label that displays next to the line key for registration 1 and when line 1 is in use.
Frequently an abbreviated name and extension number are used here. It is an easy way to
identify the phone at a glance.
Entry criteria
Type Text field
Default none
Unique? Not necessarily
Required? Yes for Batch processing
Level Device
Notes: See above
Steps for setting up the .csv file
1 In Excel, create a spreadsheet following the guidelines and examples above.
2 Complete the rows per above for each handset.
3 Save as a .csv file.
4 Verify in the .csv file that the correct columns are present and properly populated. They
will appear as separated by commas in a text editor.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 42
Upload .csv to CMS
The Batch file for new phones is designed to be created and uploaded to CMS before the
phone(s) are configured through QNC. This way, when the phones are approved and move to
the device list, they pick up the Batch file configuration parameters at their first heartbeat. This
sequence gives you good predictability for verifying the success of the process.
Caution: Batch file upload will overwrite earlier uploads
Every time you upload a .csv Batch file to the server, any existing configuration for
the same phone will be overwritten. It is not an append process. Spectralink
recommends that you create a new .csv file when adding new phones.
1 Use Excel® to open the .csv file and ensure the format is correct and it is properly
populated. Save the file as a .csv file to a location where you can easily find it from CMS
software.
2 Log into CMS and navigate to > Batch configuration.
3 Click Browse Batch Files and browse to and open the .csv file you have created.
4 Click Submit.
CMS now has the configuration for the Mac addresses that will show up in the Device
Holding area when the devices find CMS after the QNC configuration.
5 Configure the new phones with QNC.
6 Check that the handset is listed in the Device Holding Area in CMS. Accept it into the
Device List.
7 The Batch file settings are picked up by 84xx handsets the next time the handset
heartbeats into CMS. This could occur on normal heartbeat interval, when an inactive
handset becomes active, or when a 84xx handset boots up.
8 Verify the settings are in the handset by selecting it on the Device List and selecting
Change config and then seeing the correct information is in SIP Registration>
Identification.
721-0036-000_K.docx April 2020 43
Chapter 7: Spectralink 84-Series Devices
The Device page lists devices in two areas: The Device Holding Area and the Device List.
Device Holding Area
The Device Holding Area lists devices that have associated with CMS but have not yet been
approved for inclusion in the Device List. Devices that have been manually configured or
configured with QNC appear here. Any device listed here must have the correct Account Key.
If you think a device should be listed but it is not, the first thing to check is whether the correct
account key has been loaded. Check the configuration downloaded into the phones through
QNC. See next section for instructions.
Admin Tip: Device not listed?
If your device is not listed, your first step should be to view the configuration file that
QNC downloaded to the device.
Open QNC and click download Configuration. The standard configuration
procedure occurs and you can find the file in your Downloads folder and review it in
an .xml editor. The account key is near the beginning of the file. Check it against
the account key displayed in CMS in the About Us page. If there is an error, change
it in QNC and rerun the download to the phones.
Approving Devices via Holding Area
Caution: More than 10 phones?
A CMS License required for a more than 10 Spectralink 84xx handset deployment.
If you do not have a license for additional devices, when you approve an additional
device, you will see a message to contact your service provider.
When Spectralink 84xx first finds CMS, it is listed in the Holding area
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 44
To approve or reject devices
1 Select the Spectralink 84xx(s) you want to approve (reject).
2 Select the action in the dropdown Select actions list.
Spectralink recommends: Approve devices in groups of maximum 500
To prevent the infrastructure from being overwhelmed by a large number of phones
trying to find CMS and download parameters at the same time, Spectralink
recommends approving devices in groups of 500 or fewer.
3 Approved devices restart and then appear in the Approved list and in the Device list.
Rejected devices appear in the Rejected list.
Caution: Approving devices after a change in wireless profiles
If the wireless profile has been changed on CMS at an enterprise level from the
profile configured by QNC, the device being approved will restart but will disconnect
from the network as it does not have the correct wireless settings. Simply reboot
the device to connect it.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 45
Device List
The Device List is a list of all 84xx devices that have been Approved by CMS. Once devices
appear in the device list, they can be configured/managed with CMS.
Admin Tip: When does the Device List show changed settings?
Settings sent to a device are shown in the Device List when the device has
received the settings and has sent a heartbeat back to CMS, indicating that it has
successfully received the settings. For a device that is currently powered on and
communicating to CMS, this should occur within two heartbeat intervals.
The displayed columns can be moved by clicking and dragging them. Columns can be hidden or
displayed by clicking the Change columns button:
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 46
Device List actions
Management actions are provided for remote management of individual devices. Select the
device(s) you wish to manage and then click the Select actions dropdown. Click the desired
action:
Action Purpose
Reboot Devices Remotely reboot a device or devices. You will need to do this when you want to activate an application that requires a reboot of the device after it has been installed.
Change Config Typically used when a single device needs unique configuration parameters. This action will open the Configuration page.
Apply Custom Config Used when a custom config file is applied to a single device.
Download Logs Download log files for
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 47
Action Purpose
Apply OTA Used to apply a software update to one or more handsets. This action will open the OTA page.
View Config Allows you to view and download the configuration currently on the device.
Export all devices Export all devices in the Holding area, Device List or in the Rejected List to a .csv file for further handling.
Re-Deploying Devices
CMS is designed to be the exclusive configuration method for Admin menu options. If the
Restore defaults option has been used on the Admin menu, Spectralink recommends re-
provisioning the 84xx handset per the steps below.
Admin Tip: Reconfiguring 84xx handsets
This re-deploying technique is a good way to remove Device or Group Settings
from an 84xx handset and reset it to the Enterprise settings.
To re-configure a device after restore defaults
1 Go to the Approved list in the Device Holding Area, select the 84xx handset and use
Select actions to move it to the Rejected list.
2 In the Rejected list, use Select action to Delete the device.
3 Restore the 84xx handset to defaults
4 Get the 84xx handset back onto the WLAN by using QNC to reconfigure it. The 84xx
handset will associate with CMS and show up in the Pending list.
5 Approve the 84xx handset. When it is re-approved, it will receive the Enterprise settings.
It now shows up in the Device list and can be configured.
721-0036-000_K.docx April 2020 48
Chapter 8: Spectralink 84-Series Groups
Being able to group devices and customize configurations for device groups gives you
tremendous flexibility in your deployment options. Use the Groups page to set up and manage
your groups.
On this page, you can set up groups, add devices to a group, edit groups and change a group’s
configuration.
Admin Tip: A device can belong to only one group
Note that any device can belong to only one group. Carefully analyze similarities of
usage and structure your Groups so they combine handsets that use features in
similar ways rather than by area, job description, or any other grouping plan that
may not be sufficiently unique.
When a device is added to a group, the Group settings are applied to it, overriding any
conflicting Enterprise settings.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 49
Group Name
The Group Name uses a field to identify the Group. This name can display on the Device List.
Type text
Default none
Unique? Yes. Each group should have a unique name
Required? Yes. Each group must have a name
Level Group
Notes: See above
Associate Devices
The Select Devices button opens the Device List allowing you to select the devices you want in
the named Group.
Type Select by checkbox from Device List
Default none
Unique? Yes. Each group is unique. A device can belong to only one group.
Required? Yes. Each group must have at least one associated device.
Level Group
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 50
Notes: See above
Example of one group with two associated devices selected
Manage Groups
When the selected devices are saved, the Group appears on the list of groups. The device
serial numbers identify the devices in the Group. The User Name is the login username when
the Group was created.
The actions that can be selected to manage a Group are:
Action Purpose
Delete group(s) Used to delete one or more Groups.
Edit group Change the name of the Group, add or delete associated devices.
Change Config Opens the Configuration Options pages for editing the settings.
Apply Custom Config Used when a custom config file is applied to a Group such as PTT or SAFE settings..
721-0036-000_K.docx April 2020 51
Chapter 9: Spectralink 84-Series Feature
Configuration
The Configuration pages contain the essential Spectralink 84xx configuration settings for
successful deployment. Some of these settings can be configured through the Batch
Deployment process.
Understanding Enterprise, Group and Device Levels
There are three ways to open the configuration pages and each different way allows you to view
and configure the device at one of the three different levels: Enterprise, Group, and Device.
When a field has been configured, a Level icon next to it indicates the value has been set at that
level. A next to the field means that the field retains its default value.
Enterprise settings
Enterprise settings are the most generic. They apply to every device unless overridden
by values set by Group or Device levels.
Enterprise level settings are configured at the Enterprise level when you browse directly to the
Configuration page, i.e. not going through the Group page or the Device List. The Configuration
banner displays the Enterprise tab:
At the enterprise level you would typically set everything except for the device specific SIP
settings such as those listed in the Identification and Authentication sections. Server settings
Server Address and Port are set in the Batch file for immediate access to the call server.
Transport and Expires settings can be set at the Enterprise level. Message Center values are
usually set at the Enterprise level.
Group settings
Group settings apply only to the specific Group selected from the Group page.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 52
Group level settings can be configured when you browse to the Group page, select a Group and
select Edit config from the action dropdown. Configuration opens and the banner displays the
Group tab.
Group settings override Enterprise settings. They apply only to the handsets that have been
assigned to that group.
Typically, group settings are used for Feature deployment such as PTT and SAFE.
A device can belong to only one group.
Device settings
Device level settings can be configured when you browse to the Device list, select a device or
devices and select Change config from the action dropdown. Configuration opens and the
banner displays the Device tab.
Several Device settings are configured through the Batch configuration option.
Device settings override both Group and Enterprise settings. They apply only to the specific
handset(s) that has been selected from the Device List. Therefore, only those settings that
pertain to specific handsets should be configured at the device level. Typically, the only settings
that are configured at the device level would be SIP extension settings.
When a device is selected in the Device List and the Change config action dropdown option is
chosen, each configured (non-default) setting displays an icon on the right side of the page to
indicate the level where the value has already been set -- Enterprise, Group or Device. Note
that some settings do not support the level icons.
Level icons
Enterprise: This setting is configured at the Enterprise level. Click the checkbox to clear the setting.
Group: This setting is configured at the Group level. Click the checkbox to clear the setting.
An Enterprise or Group setting has been cleared; Use the redo button to restore the cleared value.
The trash can clears the setting. If the setting cleared by clicking the trash can at the Device level, the setting will revert to the Group level if it has been set or to the
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 53
Enterprise level if no Group level exists. If no Enterprise level has been set, it will revert to the default.
Example: When you might single out a device for special configuration
Let’s say you want to isolate a particular handset that is behaving strangely. You can set that
handset to log at an Info level with an appropriate filter while all the other handsets remain at a
Warning level. This gives you a close-up of just one device without the unnecessary syslog
traffic that would occur if all devices were set to the Info level.
Understanding Default Settings
Right out of the box, handsets are preconfigured with default settings. Certain defaults will be
overridden when the handset is initially configured to associate with the wireless infrastructure
using QNC. Then when Batch configuration is used, additional settings are loaded and
additional defaults are overridden. After that, the remaining parameters are configured using the
Enterprise/Group/Device levels.
A default setting is indicated by “DEFAULT” next to the parameter. A blank field indicates the
parameter is null or not set.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 54
Config Manager
The Config Manager is where the heartbeat interval between the device and CMS is set.
The CMS heartbeat his is the time interval between “check-ins” between the handset and CMS.
This interval should be increased as more devices are added.
Caution: Change this setting if default has been changed in QNC
This setting can be configured in QNC. If the value has been increased in QNC, be
sure to also change it here.
Use the following scale to determine what interval is best for your installation.
Number of handsets Heartbeat interval
Up to 1000 handsets No more frequent than every 1 minute.
Between 1000 and 2000 handsets No more frequent than every 2 minutes.
Between 2000 and 3000 handsets, No more frequent than every 3 minutes.
Between 3000 and 4000 handsets No more frequent than every 4 minutes.
More than 5000 handsets No more frequent than every 5 minutes.
Label Description Parameter
Device Heartbeat Interval
The time interval between “check-ins” between the handset and CMS.
device.cms.heartbeat.timeoutSeconds
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 55
Logging
Log messages provide a window into the handset’s operation. These messages can assist you
in troubleshooting issues and understanding how the handset executes.
The handset produces logs which are stored temporarily in the handset. This log is uploaded to
the FTP partition of the CMS server every upload period or when the file size limit is reached,
whichever comes first. This file is added onto until the append size limit is reached and then the
file is erased and the cycle starts over.
Syslog settings can be set at the Enterprise, Group, or Device level. Additionally, Spectralink’s
log structure enables message filtering by severity. Messages may be further filtered through
module tag fields provided by the software.
Logs can be viewed in several ways:
• Select the device from the Device List and downloading the log from the action list,
• Download directly from the handset through the USB port,
• Navigate to the 8400 partition, log file and view or download the log.
Admin Tip: Setting up a syslog server
A custom syslog server can be set up by using the Custom Settings option.
Global Log settings
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 56
Label Description Parameter
Timestamp Format
Hour:Minutes:Seconds:Milliseconds = 011511.06 Year:Month:Day:Hour:Minute = 0210281716 Month:Day:Hour:Minutes:Seconds= 1028171642
log.render.type
Log File Size
Maximum size of flash memory for logs in Kbytes. When this size is about to be exceeded, the handset will upload all logs that have not yet been uploaded, and erase half of the logs on the handset.
log.render.file.size
Upload Period
Time in seconds between log file uploads to the provisioning server. The default is 86400 which is 24 hours. Note: The log file will not be uploaded if no new events have been logged since the last upload.
log.render.upload.period
Append Size Limit
Maximum log file size that can be stored on provisioning server in Kbytes.
log.render.upload.append.sizeLimit
Module Log Level Limits
Use log filter settings to obtain more detailed logging for a specific topic. The Module Log Level
Limits page lists commonly-used modules and allows you to set the detail limit for the filter. The
default is the lowest level. Setting one or more to a higher level permits you to see the detail you
need to accurately diagnose the issue.
Label Description Parameter
Global Log Level Limit
Sets the highest level of detail permitted for any single log level. The most detail is presented at the Debug level, the least detail is presented at the Fatal level. This setting should be configured for the highest level that any single module is set to.
log.render.level
Severity levels
Logging Level
Debug -- Produces the most messages.
High detail -- Not useful for monitoring except when used with a filter.
Moderate detail -- Normal operational messages - may be harvested for reporting, measuring throughput, etc. - no action required
Low detail – graceful recovery
Minor error – Indication that an error will occur if action is not taken. Graceful recovery possible if resolved within a given time.
Major error – Non-urgent failures which could eventually incapacitate the system.
Fatal error -- the system has stopped executing correctly and should be corrected immediately.
A “higher” level produces more messages and a “lower” level produces fewer messages. The
levels are cumulative; each level includes all the message types of the levels below them. For
example, the “Minor detail” setting also includes “Major” and “Fatal” messages. The lowest
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 57
setting—Fatal—shows only Fatal messages. The highest setting, “Debug” contains so many
messages it will likely crash your system. Use it only with a tag when filtering.
Log Modules
Use the modules as filters when you are analyzing specific functionality.
CMS label Parameter Log Module
Application log.level.change.app1 Applicationlogging
Browser log.level.change.brow Browserlogging
Call List log.level.change.clist Calllistlogging
Certificate log.level.change.cert Certificatelogging
Config log.level.change.cfg Configuration parsinglog
Copy Utils log.level.change.copy Copy utilities, FTP file transferlogging
DHCP Client log.level.change.dhcpc DHCP Clientlogging
DNS log.level.change.dns DNSlogging
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 58
CMS label Parameter Log Module
Dot1x log.level.change.dot1x Dot1xlogging
EFK log.level.change.efk EFKlogging
Handset Polling log.level.change.poll Handset pollinglog
HTTP Auth log.level.change.httpa HTTP Authenticationlogging
HTTP Server log.level.change.httpd HTTP Serverlogging
ICE log.level.change.ice ICE/STUN/TURNlogging
Key Observer log.level.change.key Key presslogging
LDAP log.level.change.ldap lDAPlogging
OAI log.level.change.oaip OAIlogging
Power Save log.level.change.pwrsv Power Savelogging
PPS log.level.change.pps Program processing (dialplan processing)log
Push log.level.change.ptt Push-To-Talklogging
Push-to-talk log.level.change.push Application pushlogging
Real Time Location log.level.change.srtp Secure RTPlogging
Secure RTP log.level.change.rtls Real-Timelocation Serviceslogging
Security log.level.change.sec Securitylogging
SIP log.level.change.sip SIPlogging
Support Obj log.level.change.so Support objectslogging
TLS log.level.change.tls Transportlayer Securitylogging
Utility Main log.level.change.utilm Utility Mainlogging
Wapp Mgr log.level.change.wmgr Wireless Managerlogging
Web Browser log.level.change.mb Microbrowserlogging
Web Ticket log.level.change.tickt Web Ticketlogging
WLAN log.level.change.wlan WirelesslANlogging
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 59
SIP Registration
Base Profile
The Base Profile is the protocol selection which is either Skype for Business or OpenSIP. 84-
Series software is offered in two versions as indicated by the final four digits of the version
number. For example, the complete version format for the 5.x.x GA (generally available) release
is 5.x.x.xyyy. The xyyy denotes the build ID. For Lync releases the x is set to 1. For non-Lync
(SIP) releases, the x is set to 2. For example:
• Lync: 5.3.7.1145
• SIP: 5.3.7.2145
The Base Profile is set in the Batch file. When using the Batch file, the “Type” column sets the
protocol. Use “telephony” for OpenSIP. Use “Lync” for Skype for Business. If not using a Batch
file, this parameter must be set at the Enterprise level.
Skype for Business (not available in R2.4)
Formerly known as Microsoft Lync, the Skype for Business checkbox must be checked if you
are using the Lync software. Checking the Skype for Business box sets the Base Profile to
Lync. Some options in the below fields change when the SfB protocol is deployed.
When using a Microsoft Lync/Skype for Business server, refer to Spectralink 84-Series Wireless
Telephone: Microsoft Skype for Business Interoperability Guide.
Admin Tip: Microsoft server reference
If using Microsoft Lync or Skype for Business, please refer to Spectralink 84-Series
Wireless Telephone: Microsoft Skype for Business Interoperability Guide.
Open SIP
The Session Initiation Protocol (SIP) is the Internet Engineering Task Force (IETF) standard for
multimedia communications over IP. It is the default protocol for the Spectralink 84-Series
handsets. Selecting OpenSIP sets the Base Profile to Generic.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 60
Label Description Parameter
Base Profile
Sets the protocol for the handsets’ software. Use “telephony” for OpenSIP. Use “Lync” for Skype for Business.
device.baseProfile
Audip DSCP
Specify the DSCP of packets. Permitted values are: Null, 0 to 63+
qos.ip.rtp.dscp
Call Control DSCP
Specify the DSCP of packets. Permitted values are: Null, 0 to 63 or EF or any of AF11,AF12, AF13,AF21, AF22,AF23, AF31,AF32, AF33,AF41, AF42,AF43
qos.ip.callControl.dscp
Registrations (Lines)
The SIP server accepts and manages the registrations for the phones. Formerly known as
“lines”, each registration can optionally be associated with a private array of servers for
completely segregated signaling. The Spectralink handsets support six registrations.
For the 84-Series phones, registration is synonymous with line. One line is typically used for
telephony call system and a second line can be configured for a paging-type call system or
some other application that is hosted on a separate server.
When using a Microsoft Lync/Skype for Business server, refer to Spectralink 84-Series Wireless
Telephone: Microsoft Skype for Business Interoperability Guide.
Identification
Identification options establish the end user’s identity. Identification options must be configured
at a device level. Usually this is done through Batch configuration.
Admin Tip: Device level settings
Device level settings are available when you browse to the Device list, select a
device or devices and select Change config from the Select actions dropdown. The
banner displays the Device tab.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 61
Batch file field What it does Parameter
Display Name Default Caller ID reg.X.displayName
Extension The UserID extension number (called Address in the CMS UI)
reg.X.address
Label The text label that displays next to the line key for registration x and on the Home screen when that line is in use.
reg.X.label
Authentication
SIP uses a User ID and Password for user authentication. These credentials are used by the
call server. For line 1, these fields are usually configured through Batch configuration.
Batch file field What it does Parameter
User ID User ID to be used for authentication challenges for this registration.
reg.X.auth.userId
Password The password to be used for authentication challenges for this registration.
reg.x.auth.password
Message Center
If you wish to configure voicemail, configure the Message Center settings.
These settings are generally made at an Enterprise level.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 62
Label What it does Parameter
One Touch VM If set to 1, the voicemail summary display is bypassed and voicemail is dialed directly (if subscription address is configured).
up.oneTouchVoiceMail
Subscription Address
The number the handset calls to subscribe to for messages. E.g. 6416 or [email protected]
msg.mwi.x.subscribe
Callback Contact The contact to call when retrieving messages if callback mode is set to contact. E.g. 6416 or [email protected]
msg.mwi.x.callBack
Callback Mode contact, registration, disabled
contact – a call is placed to the contact specified by the entry in the Callback Contact field above
registration – the registration places a call to itself (the handset calls itself).
disabled – message retrieval and message notification are disabled.
msg.mwi.x.callBackMode
Server Settings
Each registration can optionally be associated with a private array of servers for completely
segregated signaling. The Spectralink handsets support six registrations.
Server settings set the network information for the server that serves the line or registration tab
shown above. The SIP server address and port are specified in the Batch file so that the
handset can register to line 1 immediately upon receiving its configuration from CMS.
Batch file field What it does Parameter
Address The IP address or host name of a SIP server that accepts registrations.
reg.x.server.y.address
Port The port of the SIP server that specifies registrations. reg.x.server.y.port
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 63
Enterprise settings
Transport The transport method the handset uses to communicate with the SIP server.
Null or DNSnaptr – if reg.x.server.y.address is a hostname and reg.x.server.y.port is 0 or Null, do NAPTR then SRV look-ups to try to discover the transport, ports and servers, as per RFC 3263. If reg.x.server.y.address is an IP address, or a port is given, then UDP is used.
UDPOnly – only UDP will be used.
TCPOnly – only TCP will be used.
TCPpreferred – TCP is the preferred transport; UDP is used if TCP fails.
TLS – if TLS fails, transport fails. Leave port field empty (will default to 5061) or set to 5061.
reg.x.server.y.transport
Expires The handset’s requested registration period in seconds. Note: The period negotiated with the server may be different. The handset will attempt to re-register at the beginning of the overlap period. For example, if expires=”300” and overlap=”5”, the handset will re-register after 295 seconds (300–5). The overlap period is overruled by reg.x.server.y.expires values.
reg.x.server.y.expires
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 64
Web App
APP URL(s)
Web applications listed here are Web applications whose shortcuts are displayed in a widget
box. They are opened in the Spectralink Webview browser. Any URL available to the handset
can be entered. Twelve applications can be configured.
Group or Enterprise settings
Application URL (x) The URL of an application apps.x.url
Application Name (x) The descriptive text that displays in the Applications menu apps.x.label
Web Browser
The Web Browser settings control the home page, proxy and timeout to be used by the browser
when it is selected to provide services for a specific application.
Group or Enterprise settings
Home URL The URL of the browser's Home page. For example: http://www.example.com/xhtml/frontpage/home. If blank,
mb.main.home
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 65
Group or Enterprise settings
the browser will notify the user that a blank home-page was used.
Browser Proxy The address of the HTTP proxy to be used by the browser. If blank, normal unproxied HTTP is used by the browser.
mb.proxy
Main Browser Page Timeout (seconds)
The timeout, in seconds, for the interactive browser. If the interactive browser remains idle for the defined period of time, the handset returns to idle. If 0, there is no timeout.
mb.main.idleTimeout
Phone State Polling
Phone State Polling is used to control state polling events.
Group or Enterprise settings
Response Mode The mode of sending requested polled data. If Poll URL, requested polled data is sent to a configured URL. If Requester, the data is sent in the HTTP response.
apps.statePolling.responseMode
Poll URL The URL to which the phone sends call processing state/device/network information. The protocol used can be either HTTP or HTTPS. Note: To enable state polling, the parameters apps.statePolling.URL, apps.statePolling.username, and apps.statePolling.password must be set to non-null values.
apps.statePolling.URL
User Name Enter the user name that the phone requires to authenticate phone state polling.
apps.statePolling.username
Password Enter the password that the phone requires to authenticate phone state polling.
apps.statePolling.password
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 66
Push Request
Push Request fields are used to control push server controls.
Settings: Enabling Data URL Push
Both apps.push.username and apps.push.password must be set for Data URL
Push to be enabled.
Group or Enterprise settings
Push Message Type
Choose a priority level for push messages from the application server to the phone.
0: (None) Discard push messages 1: (Normal) Allows only normal push messages 2: (Important) Allows only important push messages 3: (High) Allows only priority push messages 4: (Critical) Allows only critical push messages 5: (All) Allows all push messages See Caution: Critical message conflict note after this table.
apps.push.messageType
Application Server Root URL
The URL of the application server you enter here is combined with the phone address and sent to the phone’s browser. For example, if the application server root URL is http://172.24.128.85:8080/sampleapps and the relative URL is /examples/sample.html, the URL that is sent to the web browser is http://172.24.128.85:8080/sampleapps/examples/sample.html. Can be either HTTP or HTTPS.
apps.push.serverRootURL
Username The user name to access the push server URL. Used with the password to respond to the HTTP Digest Challenge from the handset. Note: To enable the push functionality, the parameters apps.push.username and apps.push.password
must be set (not null).
apps.push.username
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 67
Group or Enterprise settings
Password The password to access the push server URL. Used with the username to respond to the HTTP Digest Challenge from the handset.
apps.push.password
In Call Volume Scaling
This parameter allows the administrator to attenuate the volume level of alert tones played in-ear when a user is in the call. Some alert tones may be perceived by users as being loud and this parameter allows an administrator to apply volume reduction to all tones played by the API when in call.
If 0, the volume of the push alert is the same as the call volume. Settings of -10, -20 and -36 get progressively quieter.
apps.push.play.incall.volume.scaling
Caution: Critical message conflict
Any new critical message overlays the previous one, but when 2 critical messages
come to the phone too close together and both require the phone to retrieve files,
the retrieval of the first file can be cut short by the retrieval of the second. This will
cause the first file to not be processed properly or not at all.
For instance, if the first critical message causes the phone to retrieve an html file
with javaScript in it to write text on the phone's display and the second critical
message causes the phone to retrieve a wav file to play a tune, the user may not
see the display on the phone but will just hear the tune.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 68
Telephony Notification
Label Description Parameter
Heartbeat timeout
0 – 65,535 Implements a "heartbeat" timer for telephony notifications that repeats the line registration notification on a periodic basis.
With a heartbeat set, if the phone goes out of range or is power cycled, notifications are not disrupted. The default value for this parameter is 0, where the timer does not start at all, so there is no change to the behavior unless this parameter is set to a non-zero value.
apps.telNotification.heartbeatTimeoutSeconds
Line Registration
If 0, line registration notification is disabled. If 1, notification is enabled.
apps.telNotification.lineRegistrationEvent
Application URLs
The first URL to which the phone sends notifications of specified events. Can be either HTTP or HTTPS.
apps.telNotification.URL
Application URLs
A subsequent URL to which the phone sends notifications of specified events, where x = 1 to 3. Can be either HTTP or HTTPS.
apps.telNotification.x.URL
Outgoing Call Event
The Outgoing Call Event can be used by an application to detect that the user of the phone is busy in a call.
apps.telNotification.outgoingEvent
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 69
Label Description Parameter
OnHook Event
The Onhook Event notifies an application that the user has ended a call. This can be used for call logging information, for example.
apps.telNotification.onhookEvent
In Charger Event
InCharger and OutCharger events control what alerts are sent to the device when in/out of the charger
apps.telNotification.InChargerEvent
Network Up Event
If 0, network up notification is disabled. If 1, notification is enabled.
apps.telNotification.networkUpEvent
User Login/Logout
If 0, user login/logout notification is disabled. If 1, notification is enabled.
apps.telNotification.userLogInOutEvent
Incoming Call Event
If 0, incoming call notification is disabled. If 1, notification is enabled.
apps.telNotification.incomingEvent
Alarm Event The Alarm event notifies an application that a (personal security) alarm condition has been detected or cleared on the phone.
apps.telNotification.alarmEvent
Offhook Event
If 0, off-hook notification is disabled. If 1, notification is enabled. apps.telNotification.offhookEvent
Out Charger Event
InCharger and OutCharger events control what alerts are sent to the device when in/out of the charger
apps.telNotification.OutChargerEvent
Un-initialization Event
If 0, line unregisteration notification is disabled. If 1, notification is enabled.
apps.telNotification.unInitializationEvent
Open Application Interface
The Spectralink handsets support communications using the Open Application Interface (OAI).
Label Description Parameter
IP Address The address of the OAI server. oai.gateway.address
User ID The lower four bytes of the six-byte OAI handset identifier in the OAI gateway.
If the value is null or invalid, the handset identifies itself to the OAI gateway using the Mac address of the handset; otherwise, the upper two bytes are zero and the lower four bytes are as specified.
oai.userId
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 70
Label Description Parameter
Key Repeat Acceleration
The default is enabled, which is the usual behavior where the key repeat accelerates to one keypress every 50ms. To prevent excessive messaging when the key is held down, set the parameter to “0” which reduces the key repeat rate to 500ms. This parameter only affects OAI calls.
oai.keyRepeatAcceleration.enabled
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 71
Feature Config
CMS provides you with fields to enable a few popular call features. For features not listed here,
see Custom Settings.
Call Handling
Label Description Parameter
Prefer Blind Transfer
If Blind is checked, the default softkey will be for blind transfer. If Consultative is checked, the default softkey will be for consultative transfer.
The other method is always available on the Features softkey menu when the handset is in call.
call.transfer.blindPreferred
Phone Lock
The Phone Lock feature allows you to add an option to the Features softkey menu to lock the
handset and require a password to unlock it.
Label Description Parameter
Phone Lock Enable
Use this field to enable Phone Lock. phoneLock.enabled
Enable DND If disabled, the handset can receive calls while it is locked. If enabled, the handset enters DND mode while it is locked. The user can enable DND even if it is disabled here. This will cause the handset to demonstrate the behavior described in the below table until the user disables DND.
phoneLock.dndWhenLocked
Idle Timeout 0 to 65535 phoneLock.idleTimeout
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 72
Label Description Parameter
The amount of time (in seconds) the handset can be idle before it automatically locks. If 0, automatic locking is disabled.
Admin Password
Controls access to the Admin menu. This parameter is also set in QNC.
device.auth.localAdminPassword
Tones
When a custom tone is needed, it is uploaded as a .wav file in the Resource File option. In
Tones the custom tone is mapped to a Ring type or Alert type “slot”. Slots make programmed
tones available in a dropdown selection list either on the Notification Profiles menus in the
handset or in Personal Alarms subsection Alarms and Warnings (for alerts and warnings only).
Ring Type Mapper
The Ring Type Mapper provides access to custom ring tones that have been uploaded through
Resource Files. These ring types are commonly provided to end users for unique facility
purposes. They appear on the handset’s Settings> Basic Settings> Notification Profiles>
Ringing menu and can be changed by the user.
Saf slots 1-10 are used for custom ring types that are labeled Custom 1 through Custom 10 on
the handset menu until they are populated with a custom .wav file at which time the filename is
displayed. Saf 1 is reserved for a custom welcome tone at Custom 1.
SAF # Sampled Audio File Number
Ring tone Menu slot #
1 (Welcome tone) 15
2 16
3 17
4 18
5 19
6 20
7 21
8 22
9 23
10 24
Alert Type Mapper
The Alert Type Mapper provides access to custom alert tones that have been uploaded through
Resource Files. They are commonly provided to end users for specific alerts, such as SAFE
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 73
warnings and alarms, only programmable in CMS. They also appear on the handset’s Settings>
Basic Settings> Notification Profiles> Alerts menu.
Alerts can be set for Personal Alarms in Configuration under Personal Alarms> Alarms and
Warnings page and if specified in CMS cannot be changed by the user.
Saf slots 12-21 are used for custom alert types. They are labeled Custom 1 through Custom 10
on the device Alerts menus. After they are loaded here on this Resource files page, they can be
mapped to alerts for the four notification profiles on the CMS Configuration> Personal Alarms>
Alerts and Warnings page.
SAF # Sampled Audio File Number
Alert tone Menu slot #
12 16
13 17
14 18
15 19
16 20
17 21
18 22
19 23
20 24
21 25
Personal Alarms
Workers can be at risk during security breaches or if personal incidents require immediate
attention. Spectralink 8441 and 8453 handsets offer personal monitoring and duress call
functionality, including “man down” alarms, “running” alarms and duress calls to an emergency
number. Coupled with a security alarm application program, real time location information from
the alarming handset can be displayed on security monitors and sent to other Spectralink
devices for mobile response. The existing functionality of Location Services allows an alarming
handset’s location to be pinpointed so that aid can be directed to the exact scene. When
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 74
deployed in conjunction with a security alarm application, Spectralink Personal Alarms provide
unparalleled support for isolated workers or other at-risk personnel in potentially threatening
situations.
Duress call alarms can also be deployed within the functionality of the 8440 and 8452 models.
The emergency dial feature can be programmed to sound a local alarm through the built-in
speakerphone when an emergency call is dialed. Coupled with a security alarm application, this
duress alarm can be used to identify the handset, the user and the location of the alarming
handset.
Warning
The reliability of the Spectralink Personal Alarms application depends on the
functionality and reliability of the greater infrastructure – the wireless LAN, the LAN,
the call server, the central provisioning server, the server hosting location services,
the central security system and its servers, the correct configuration of the
Spectralink 84-Series handsets, correct installation and central provisioning
server(s), and thorough training of personnel.
Motion events
The accelerometer in the 8441 and 8453 is used to detect movement that might indicate a
condition that requires an alert. The conditions are Running, Tilt and Still. The sensitivity can be
set appropriately to prevent false alarms while also providing effective protection.
• “Running” – the handset detects shaking in case a user runs for a configurable number
of seconds,
• Tilt – the handset is tilted (not vertical) for a configurable number of seconds (aka “man
down”),
• Still – the handset remains unmoved for a configurable number of seconds, potentially
indicating the user is no longer moving.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 75
Note that personal Alarms can be disabled by setting the sensitivity for all motion events to zero.
Emergency Dial is configured on the Duress Settings tab.
Label Description Parameter
Still Sensitivity 0 disable, 1 least sensitive, 7 most sensitive As the sensitivity increases the handset must be more stationary to trigger a no movement alarm. The specific sensitivity setting appropriate for a given application is site/user specific.
up.PersonalAlarm.still.sensitivity
Still Timeout The still condition must persist for this amount of time before a warning occurs.
up.PersonalAlarm.still.timeout
Tilt Sensitivity Indicates the degree of tilt from horizontal that triggers an alarm. This setting is modified by the timeout setting that determines the amount of time the position (or lower) is maintained before an alarm is triggered. In the most sensitive position setting “7”, a slightly leaning position will trigger the alarm.
up.PersonalAlarm.tilt.sensitivity
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 76
Label Description Parameter
In the least sensitive position setting, the body must be nearly horizontal before an alarm triggers. Experiment with these settings until you find the right sensitivity for your facility. Horizontal movement can interfere with the handset's ability to sense the tilt condition. If the tilt alarm is the only motion alarm configured, we recommend using a relatively high sensitivity setting.
Tilt Timeout The tilt condition must persist for this amount of time before a warning occurs.
up.PersonalAlarm.tilt.timeout
Running Sensitivity
As the sensitivity increases the handset requires less movement to trigger a running alarm. The specific sensitivity setting appropriate for a given application is site/user specific.
up.PersonalAlarm.running.sensitivity
Running Timeout
The running condition must persist for this amount of time before a warning occurs.
up.PersonalAlarm.running.timeout
Suspend Monitoring
If 0, no suspension of monitoring is allowed, otherwise duration in seconds of the amount of time during which motion event monitoring is disabled.
up.PersonalAlarm.suspendMonitoring
Motion Alarm Triggers Emergency Call
This parameter requires correct configuration of the Emergency Dial feature as detailed in the Spectralink 84-Series Administration Guide. This parameter is disabled by default. If enabled, an emergency call is automatically placed when a running/tilt/still alarm occurs. If disabled, and a running/tilt/still alarm occurs the emergency call will NOT be placed but the alarm state will be activated. Either way, the handset will transition into the alarm state and will generate an XML alarm notification if apps.telNotification.alarmEvent is also enabled.
up.PersonalAlarm.emergencyDialEnable
Emergency call activates speakerphone
Allows you to force the speakerphone on an emergency call. If enabled, the speakerphone is activated on an emergency. If not enabled, normal audio rules apply.
up.PersonalAlarm.emerDialForceSpeakerPhone
Alarms and Warnings
The Spectralink handsets support four profiles for notification alerts: Normal, Silent, Meeting,
and Custom1. You can customize each profile with unique tones for alarms and warnings for
Personal Alarms. If a consistent tone is desired during the warning or alarm period, no matter
the profile, the same tone must be set for each profile. Although a user can set a different tone
on the device, CMS will override any setting done locally by the user.
The handset has several tones available by default. Custom tones can be uploaded through the
Resource File option. Custom tones are then mapped to a slot in the handset’s menus by using
the Tones option. Once mapped, available tones can be selected for each profile.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 77
Label Description Parameter
Alarm Notification
Enables or disables local alarm notification (tone, vibrate, LED flash) on motion event detection in both warning and alarm states.
up.PersonalAlarm.notificationEnable
Warning Timeout
This is the number of seconds a user has to disable the warning on the handset before the warning automatically triggers an alarm.
up.PersonalAlarm.warningTimeout
Location Transmit Interval
Used in conjunction with Location Services server and the wifi.rtls.ekahau.txInterval parameter to control the interval with more precision. Generally, to enforce a shorter interval during an alarm state. RTLS must be enabled. Once the alarm is cleared, the txInterval setting will revert to its former value.
wifi.rtls.ekahau.txIntervalSeconds
Alarm tone pattern
Label Description Parameter
Tone Use the dropdown list to select the tone. np.xxx.alert.PersonalAlarm.tonepattern
Vibration Check the vibration box. np.xxx.alert.PersonalAlarm.vibration
Warning tone pattern
Label Description Parameter
Tone Use the dropdown list to select the tone. np.xxx.alert.PersonalWarning.tonepattern
Vibration Check the vibration box. np.xxx.alert.PersonalWarning.vibration
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 78
Duress Settings
The PTT talk button can be repurposed to emergency dial functionality as detailed next in the
Emergency Dial section. An emergency call can be placed automatically when a running/tilt/still
alarm occurs.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 79
Duress call alarms can also be deployed within the functionality of the 8440 and 8452 models.
The emergency dial feature can be programmed to sound a local alarm through the built-in
speakerphone when an emergency call is dialed. Coupled with a security alarm application, this
duress alarm can be used to identify the handset, the user and the location of the alarming
handset.
Label Description Parameter
Double Key Press
If enabled, an emergency call is automatically placed when a running/tilt/still alarm occurs. If disabled, and a running/tilt/still alarm occurs the emergency call will NOT be placed but the alarm state will be activated. Either way, the handset will transition into the alarm state and will generate an XML alarm notification if apps.telNotification.alarmEvent is enabled.
up.PersonalAlarm.emergencyDialEnable
Long Key Press
This parameter enables the long press method of activating the Emergency Dial function. It is disabled by default. When set (1), it overrides the default double press method (0).
ptt.emergencyDial.longKeypressEnable
Long Key Press Duration
If the long press method of activating the Emergency Dial function is enabled, this parameter sets the length of time in seconds that the key must be pressed for a call to be initiated.
ptt.emergencyDial.longKeypressDuration
Notification of Duress Call
If enabled, a local alarm notification (tone,vibrate,LED flash) will occur on manual duress button press (a duress or emergency dial call).
ptt.emergencyDial.notificationEnable
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 80
Emergency Dial
Emergency dial, is enabled by programming the PTT key on the left side of the handset to
function as a speed dial button programmed to call an emergency number. The Emergency Dial
feature will allow the user to place the emergency call without having to unlock the keypad or
unlock the handset. When the button is pressed twice within two seconds, a call is placed to the
programmed number. A pop-up window on the display will inform the user that this mode is
being activated.
If you enable Emergency Dial, PTT cannot be deployed. If both are enabled, Emergency Dial
will overrule and PTT will not work.
The Emergency Dial feature places the call on Line 1. Therefore the PBX that line 1 is assigned
to must be able to place a local emergency call. Any active call on line 1 will be preempted by
the emergency call.
This method uses a simple dial mode number. In order to make a complex call that uses a
macro as a dial string, see Custom Settings.
Label Description Parameter
Emergency Dial Description
This label appears in the To: line when the call is placed.
ptt.emergencyDial.description
Emergency Call Number
Enter the number to be dialed. ptt.emergencyDial.number
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 81
Label Description Parameter
Enable PTT Enables PTT. Disable PTT when using Emergency Dial.
ptt.pttMode.enable
Map PTT to Emergency Dial
When enabled, turns the PTT Talk button into a speed dial emergency call button.
key.20.function.prim="SpeedDial"
ptt.pttMode.enable="0"
Enhanced Feature Keys
Enhanced Feature Keys are customized line keys that display when the Features softkey is
pressed. When selected, they activate star code sequences (like *69) through a macro
configured in this section. You can define as many EFKs as you have available lines in the
Features menu.
Label Description Parameter
Enhanced Feature Keys
Enables EFKs feature.enhancedFeatureKeys.enabled
For each EFK
Enable Enables/Disables the EFK softkey.x.enable
EFK Label A text string to define the key. efk.efklist.x.label
Macro Action Enter a valid macro action. efk.efklist.x.action.string
Display EFK in Checked State(s)
Active Display in the active call state softkey.x.use.active
Alerting Display in the alerting state softkey.x.use.alerting
Dial Tone Display in the dial tone state softkey.x.use.dialtone
Hold Display in the hold state softkey.x.use.hold
Idle Display in the idle state softkey.x.use.idle
Proceeding Display in the proceeding state softkey.x.use.proceeding
Setup Display in the setup state softkey.x.use.setup
Push to Talk
The Push-to-talk (PTT) feature is a collaborative tool that enables users to exchange radio
broadcasts to other users subscribed to a PTT channel. In PTT mode, the handset behaves like
a walkie-talkie; users can broadcast audio to a PTT channel and recipients subscribed to that
channel can respond to your message. PTT broadcasts can be transmitted using the handset,
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 82
headset, or speakerphone. They can be rejected, placed on hold and ended at any time. PTT
broadcasts can be received on the speakerphone, handset, and headset.
Administrators must enable PTT before users can subscribe to a PTT channel. PTT has 25
channels you can enable.
General Settings
Label Description Parameter
Enable PTT If PTT is disabled, the other options will not appear. ptt.pttMode.enable
PTT Display Name
This display name is shown in the caller ID field of outgoing pages. If Null, the value from reg.1.displayName will be used. If the reg.1 display name is also Null, the handset’s MAC address will be used.
ptt.displayName
Multicast Address
The multicast IP address to send page audio to and receive page audio from.
ptt.address
Codec The audio codec to use for outgoing PTT broadcasts. Incoming PTT audio will be decoded according to the codec specified in the incoming message.
ptt.codec
Compatibility Mode
If 0, the PTT protocol behavior is not compatible with Spectralink handset models 8020/8030 or older. If 1, all PTT protocol behavior is compatible with the older Spectralink handsets, even if some configuration parameters are incompatible.
ptt.compatibilityMode
PTT Channels
PTT channels can be managed to allow different types of functionality per channel. Some of
these settings can be changed by the user.
The label is determined by the administrator and is the name used to identify the channel during
broadcasts.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 83
If Channel Available is disabled, the user cannot access the channel or subscribe to it and the
other channel parameters will be ignored. If enabled, the user can access the channel and may
choose to subscribe.
If Allow Transmit is disabled, the user cannot sent PTT broadcasts on the channel. If enabled,
the user may choose to send PTT broadcasts on the channel.
If Allow Receive is disabled, the user cannot receive PTT broadcasts on the channel. If enabled,
the user may choose to receive PTT broadcasts on the channel.
If Subscribe is disabled, the handset will not be subscribed to the channel. If enabled, the
handset will subscribe to the channel.
Label Description Parameter
Default Channel
The PTT channel used to transmit an outgoing page if the user does not explicitly specify a channel. This setting can be changed by the user.
ptt.defaultChannel
Channel Info Make the channel available to the user
Channel x The label to identify the channel ptt.channel.x.label
Channel Available
Make the channel available to the user ptt.channel.x.available
Subscribe Subscribe the handset to the channel ptt.channel.x.subscribed
Allow Transmit
Allow outgoing broadcasts on the channel ptt.channel.x.allowTransmit
Allow Receive
Allow incoming broadcasts on the channel ptt.channel.x.allowReceive
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 84
Wireless
Wireless profiles are configured in the Wireless Profiles page. The configured profiles are listed
here. This page configures the exact radio characteristics to be used by any selected profile.
When the profile is changed, these setting must be reconfigured.
The 84-Series handsets use only one profile at a time. If the handset goes out of the range of
that profile’s SSID, call registration will be lost until the handset comes back into range and the
registration can be regained. An out-of-range handset will show an “inactive” status.
For 2.4GHz the maximum transmit power level may be selected. See the Spectralink 84-Series
Wireless Telephone Deployment Guide for more information about power level settings.
For 5 GHz the maximum power level may be set for each of the four sub-bands. See the
Spectralink 84-Series Wireless Telephone Deployment Guide for more information about power
level settings.
The regulatory domain is specified in QNC for the initial wireless profile. Three regulatory
domains are offered by Spectralink 84-Series devices.
Domain Country
1 United States Canada
2 Europe (ETSI) New Zealand
10 Australia
The regulatory domain dictates the subband and power settings that are allowed. Since CMS
doesn’t “know” what regulatory domain is selected in CMS, you must set domains and the radio
frequency settings appropriately for the domain in CMS.
Configuring radio frequency settings
The Band/Frequency (2.4 GHz or 5 GHz) parameters can be configured for the desired 802.11
band on your WLAN network. If both bands are configured as active, the handsets’ band
roaming capabilities will choose the best signal available from both the 2.4 GHz and 5 GHz
options. To disable the band roaming mechanism, configure only the band that the Spectralink
84-Series handsets are to use (either 2.4 GHz or 5 GHz, not both).
You will need to set sub-bands for the 5 GHz frequency and transmit power for both
frequencies.
Subbands for the 5GHz Band
Regulatory authorities throughout the world subdivide the 5 GHz band into multiple sub-bands
according to the channel assignments in the country of use. After you select the regulatory
domain for your country, choose the channels used in your facility. Enable only the same bands
and sub-bands as are configured on your wireless infrastructure, otherwise the handsets will
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 85
waste time looking for a signal on the unused sub-bands and roaming performance will be
impaired.
Warning Do not enable all sub-bands
Do not enable all bands and sub bands in the WLAN or the phone. This will cause
the phone to have a very long channel scanning cycle which causes poor roaming
and poor audio. See Best Practices for Deploying Spectralink 84-Series Handsets
White Paper. The link is in the Spectralink References section.
Caution: Sub-bands
CMS will display all four 5GHz sub-bands but only those with channels shown in
the following tables are available in your domain.
Sub-bands that are not available are marked in the tables as not applicable. If a
band is not available and you select it anyway and that is the only selected sub-
band, the handset will not be able to associate with an AP and the error message
‘Invalid Regulatory Domain Setting’ displays on the handset. If this message
displays, check that the correct regulatory domain is selected, and then compare
the sub-bands that are enabled with the table for that regulatory domain shown
next. Enable only those sub-bands that are permitted for your regulatory domain
and available in the WLAN.
The following tables identify which channels are available in each domain.
For Regulatory Domain 1:
Sub-band for 5 GHz Band
Channel DFS (Yes/No)
1 36, 40, 44, 48 No
2 52, 56, 60, 64 Yes
3 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
Yes
4 149, 153, 157, 161, 165 No
For Regulatory Domain 2:
Sub-band for 5 GHz Band
Channel DFS (Yes/No)
1 36, 40, 44, 48 No
2 52, 56, 60, 64 Yes
3 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
Yes
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 86
Sub-band for 5 GHz Band
Channel DFS (Yes/No)
4 Not applicable Not applicable
For Regulatory Domain 10:
Sub-band for 5 GHz Band
Channel DFS (Yes/No)
1 36, 40, 44, 48 No
2 52, 56, 60, 64 Yes
3 100, 104, 108, 112, 116, 132, 136, 140
Yes
4 149, 153, 157, 161, 165 No
Label Description Parameter
Enable 2.4GHz Radio Enables/disables the 2.4GHz radio band
device.wifi.radio.band2_4GHz.enable
Power Level Sets the maximum power that the handset will use to transmit in the 2.4 GHz band. In general, this power should match the power setting at the access point so that the coverage radius of the handset matches that of the access point. “Auto” will use the maximum permitted power setting. Note that ESTI regulations limit the maximum setting in Europe. When domain 2 is selected, txPower will not go above 4.
device.wifi.radio.band2_4GHz.txPower
Enable 5GHz Radio Enables/disables the 5GHz radio band
device.wifi.radio.band5GHz.enable
Enable sub band x Enables/disables the 5GHz radio band subband
device.wifi.radio.band5GHz.subBandx.enable
Sub-band Power Level Sets the maximum power that the handset uses to transmit in the 5 GHz sub-band. Will use the maximum allowable power for that channel and data rate. If no maximum is set, the handset uses the P5 settings for each channel activated.
device.wifi.radio.band5GHz.subBandx.txPower
721-0036-000_K.docx April 2020 87
Chapter 10: Spectralink 84-Series
Custom Settings
Custom Settings allow you to configure parameters that are not included in the CMS UI.
These settings can be applied to single devices, Groups of devices or to all devices in a facility
at the Enterprise level.
The XML Config page allows you to import, create and assign .xml files to phones.
Import Configuration
If you have XML files that you have already created or prefer to create them outside of CMS,
they can be imported here. These files must be properly formed with no formatting errors.
Check them with a robust XML editor before uploading them as improperly formatted files will be
rejected.
Tip: Separate XML files by function
Do not group all custom settings into one file. Separate them by useful descriptive
filenames so that they can be easily managed and deployed according to
usefulness.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 88
To import a configuration
1 Create the file and save it as .xml in a place you can access from the CMS server.
Ensure it is properly formatted by checking it in an editor.
Example: You have created an .xml file so that you can get screen captures off test
devices. Only one parameter needs to be enabled. You have called it
CMSscreenCapture.xml. It looks like this:
2 Click the Import Configuration button and navigate to and select the desired file.
When you import it, the configured parameter(s) is displayed in the XML editor:
3 Enter a name for the Custom Settings file and press SAVE. (The RESET button allows
you to edit the name of the Custom Setting.) You cannot Save a file unless you have
named it. Our example file is called Screen Capture.
4 The custom file appears in the list of files. The file extension is added by CMS. The
name, the date and time it was created and whether it is applied to any device is
displayed.
Create Configuration
If you do not have a file already created, you can use Custom Settings to enter the needed
parameters.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 89
To create a Custom Settings file using CMS
1 Click the Create Configuration button and enter the Custom Settings name and the
needed parameters.
Example: Configure location services (ekahau)
2 Click SAVE. The custom file appears on the list:
Download and Edit Custom Settings Files
The Actions shown on the right side of the File Name allow you to download or edit the .xml file.
The download icon allows you to save or open the file in an XML editor for editing. To
change the settings in CMS you must import the configuration again thus overwriting the file in
CMS.
Apply Custom Settings File(s)
Custom Settings can be applied to one or more phones using the Device, Group, or Enterprise
level.
Apply Custom Setting to a Device
1 Open the Device List and select the device.
2 Click the Select actions dropdown list and select Apply Custom Config.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 90
3 The Custom Settings page opens. Select the file that you want to configure for the
selected device. Click OK.
4 The Custom Settings file now displays the serial number of the selected device in the
Applied to column.
Apply Custom Setting to a Group
When you want to apply Custom Settings to a limited number of handsets, you must use the
Group feature.
1 Establish a Group for this custom configuration.
2 Open the Manage Groups page and select the Group. Click the Select actions dropdown
list and select Apply Custom Config.
3 The Custom Settings page opens. Select the file that you want to configure for the
selected Group. Click OK.
4 The Custom Settings file now displays the serial numbers of the devices Group in the
Applied to column.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 91
Apply Custom Settings to the Enterprise
When you want to apply Custom Settings to the entire installation of Spectralink 84-Series
phones,
1 Open the Custom Settings page from the Nav bar on the left.
2 Select the Custom Setting file
3 Click the Select actions dropdown list and select Apply to Enterprise.
4 The Custom Settings are applied to the entire Enterprise as indicated in the Applied to
column.
721-0036-000_K.docx April 2020 92
Chapter 11: Spectralink 84-Series
Resource File
Spectralink 84-Series devices can use custom .wav files for ring tones and alerts. These
files are loaded on this page and stored on the CMS server.
Tones are downloaded to the device at startup and stored in volatile memory. Files will be
truncated to a maximum size of 300 kilobytes.
Two WAVE (.wav) file formats are supported:
• mono 8 kHz G.711 u-Law
• G.711 A-Law
See the Tones page under Configuration to list tones on notification profile menus. The
filename(s) of the files uploaded here will be listed in the available files dropdown list for both
ringtones and alerts.
721-0036-000_K.docx April 2020 93
Chapter 12: Spectralink 84-Series OTA
Files—Updating Spectralink 84xx Code
OTA provisioning allows the 84xx handset to obtain software updates over-the-air by using
CMS as your update server.
Software releases are periodically available for the 84xx handset.
Software releases are available at http://support.spectralink.com/products/wi-fi/spectralink-84-
series-wireless-telephone
Updating Spectralink 84xx handsets is a simple process:
1 Download the code from the Spectralink Support website.
2 Load the code into CMS.
3 Open the Device List and select the device(s) to be updated.
4 Click the Apply OTA action from the Select actions dropdown. This opens the OTA Files
page.
5 Select the OTA file to apply to the selected 84xx handset(s).
6 Click OK.
Caution: Updating 84xx handset code
CMS and 84xx handset code are designed to work together. Do not update 84xx
handset code to a code version that does not align with the version of code being
used by CMS. Consult the Release Notes that accompany the software for
compatible code versions.
Admin Tip: QNC/Device/CMS software compatibility
If your handset software version does not support new options that become
available in QNC or CMS code, the handset will simply ignore the setting.
Upload files
Up to three update files can be loaded and stored. The only version that can be used with
CMS2 is SIP: 5.3.7.2145
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 94
Upload files to CMS server: Files are downloaded from the Spectralink site and uploaded to
CMS.
Upload files from FTP server: Files are downloaded from an FTP site to CMS.
Go to the Device List to update code on handsets.
Manage files
Uploaded software files appear on this list. The only management action available from this
page is to delete any files that are no longer needed. Updating 84xx handset code is done
through the Device List page.
Admin Tip: What 84xx handsets can use CMS?
Only 84xx running R5.2 and above can be recognized by CMS. You must update
earlier handsets using the method described in Re-Deploying Devices.
721-0036-000_K.docx April 2020 95
Chapter 13: Spectralink 84-Series RMA--
Replace Device
When a 84xx handset needs to be repaired, you can quickly move the configuration over
to a temporary 84xx handset through the Quick RMA replacement option. Be advised that the
84xx handset being replaced will be removed from the CMS Device List when its configuration
is moved. Restore it to factory defaults before sending it to RMA.
Caution: RMA 84xx handsets should be restored to defaults
The replaced device will still contain its configuration information on the 84xx
handset itself. It is not “wiped”. We recommend that you do a restore defaults on
the replacement device to keep it from interfering with the new device.
If the Restore defaults option has been used on the Admin menu in the device,
there is no way to recover previous CMS settings. Use the RMA method to “save” a
configuration on a substitute phone.
Admin tip: Which settings are moved?
All CMS administrative settings are moved to the 84xx handset. User settings such
as Ring tone, volumes, etc. are stored by CMS and are also moved. Apps, People,
and various customizations that are stored on the source 84xx handset will not be
moved to the target 84xx handset and must be re-setup by the administrator and/or
user. The Lockscreen pin/password/pattern is not moved to the target 84xx
handset.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 96
The source device is the device being replaced. It should be decommissioned, i.e. restored to
factory defaults, after it is removed from the system and before being shipped to RMA.
The target device will receive the configuration. It should be newly configured with wireless
parameters and accepted into the active device list before it can replace the device being
decommissioned.
Caution: Both devices must be in the active device list
The replace device procedure asks you to pick the source device and target device
from the active device list. Therefore, the device that has been returned from RMA
must be configured first with QNC and accepted before it can be used as a target
device.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 97
Note: Not enough licenses?
You may encounter the situation where CMS is at the license limit and does not
have a spare license for a returned RMA device.
Follow these steps:
1 Select a device not involved in the transaction and move it to Rejected
status. This removes it from the active list and frees up a license for the
RMA device.
To reject a device: Go to the Approved list in the Device Holding Area,
select the device and use Select actions to move it to the Rejected list.
2 Use QNC to configure the RMA device. It should then become visible on the
Pending list. Approve it.
3 If a temporary device was being used while the RMA device was being
repaired, move the configuration from the temporary device to the RMA
device. This moves the temporary device to Rejected status. Then Delete
the temporary device. Deleting the temporary device removes all its files
from CMS.
4 After a temporary device has been Deleted, it is safe to restore the
temporary device to defaults. It can be redeployed as needed to stand in for
another device that is being RMA’d.
721-0036-000_K.docx April 2020 98
Chapter 14: Wireless Profiles
You will only use CMS configuration when the device is already associated and you
need to change the Wi-Fi profile or add a new one.
A device may be required to associate to several SSIDs. One SSID is configured during initial
deployment with QNC and one proxy server can be configured as well. Use the Wireless
Profiles page to configure additional SSIDs with or without proxy servers. Wireless profiles are
added to the device on the Configuration page, Wireless or Wireless / Networking section. Any
SSIDs entered here will appear on the Wireless Profiles list on that page.
Wireless Profiles can be assigned at the Enterprise, Group or Device level. Wi-Fi profile
configuration is usually done on an enterprise-wide level. If required, individual identities must
be configured at the device level.
Admin Tip: Roaming between SSIDs?
The device is not designed to roam between different networks. A different SSID usually means that the device will need a new IP address with different network conditions.
The device may need to be rebooted to change SSIDs. Do not expect continuous connectivity.
Installing multiple wireless profiles allows the device to associate to a new SSID when the device is turned on at a new site.
For a full discussion of various security methods, see the Spectralink White Papers at
http://www.spectralink.com/resources/white-papers.
Settings: Activating a Wi-Fi Profile
These instructions are for configuring a Wi-Fi profile. To add it to a device at the enterprise, group or device level, select your device model and navigate to Configuration> Wireless and select the new profile from the list.
Wireless Profile Security
Wi-Fi security prevents unauthorized over-the-air access to network components and the
sensitive data that resides there. For a full discussion of various security methods, see the
Spectralink White Papers at http://www.spectralink.com/resources/white-papers.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 99
Open Network
No security method is deployed when you select Open Network.
WEP
The WEP option uses a single password for the entire facility which is set in the AP. Spectralink
devices use only the first index key which is called either Key 1 or Key 0, depending on the
environment. The passphrase can be 10 or 26 hexidecimal characters or up to 63 ASCII
characters.
Admin Tip
Hex characters are 0-9 and a-f.
Note
Key rotation is not supported.
The device will accept either open or shared key.
Set up the password in the APs and enter it in CMS.
Entry criteria
Type Radio button
Default Disabled
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 100
Unique? No
Required? Yes for WEP security
Level Enterprise, usually but may be set at any level
Notes: See above
Also configure:
• WEP password: Enter 10 or 26 character key in the Password field. (Required)
WPA/WPA2 PSK
When you configure WPA/WPA2 PSK in the AP, you will determine the encryption algorithm to
be used and that determines if you are using WPA (TKIP) or WPA2 (AES).
Entry criteria
Type Radio button
Default Disabled
Unique? No
Required? Yes for WPA-PSK or WPA2-PSA security
Level Enterprise, usually but may be set at any level
Notes: See above
Also configure:
• WPA(2)-PSK: Select Passphrase or Hex key. (Required)
• Passphrase / Hex key: Enter Password field. (Required)
• The Passphrase is 8-63 characters
• The Hex Key option is 64 hex characters
802.1x EAP (WPA2 Enterprise) Set up
Three 802.1X EAP options are supported: PEAP, EAP-TLS and EAP-FAST (two methods).
Each method uses certificates in slightly different ways. PEAP and EAP-FAST validate user
credentials by using the username and password from the RADIUS server. EAP-TLS validates
the user through a user/device certificate.
Note
MSCHAPv2 is supported for PEAP and TLS when enabled on your infrastructure.
When using a RADIUS server for 84-Series devices, you will need to configure a fast handoff
method in the AP in order to assure audio quality. Spectralink devices use either of two fast-
handoff techniques as they roam among APs: CCKM or OKC. CCKM is used exclusively by
Cisco APs. OKC is used by most non-Cisco APs. Consult the VIEW guide for your AP model for
more information. CMS provides a configuration parameter for the Fast Roaming option:
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 101
PEAP
PEAP requires a username and password. Wi-Fi profile configuration is done on an enterprise-
wide level and therefore unique passwords and user certificates are not supported for PEAP. All
PEAP identities and passwords must be generic.
PEAP can use a CA (Certifying Authority) certificate but does not require it. Be aware that not
using a certificate for server authentication is much less secure.
Also configure:
• Certificate: From the Certificate Manager.
• Username: (Required)
• Password: (Required)
EAP-FAST
EAP-FAST is used by products of Cisco, its creator, and by a growing number of other WLAN
vendors.
It uses a PAC file, which is similar to a certificate. The PAC file is provided during configuration
(provided) or it is automatically loaded from the network (in-band provisioning).
• EAP-FAST with inband provisioning
• EAP-FAST with provided PAC file
Also configure:
• Username: (Required)
• Password: (Required)
EAP-TLS
EAP-TLS uses two types of certificates. A CA certificate initially validates the RADIUS server to
the device. A user/device certificate validates the device to the RADIUS server.
In order to deploy 802.11x EAP, you must provision a RADIUS server to provide the
username/password security handshake. The RADIUS server maintains the username and
password for each device or acquires this information from the LDAP server.
The EAP Identity field should be left blank when the device certificate provided with the devices
is used. This field will be populated by the MAC address of the device when the configuration is
downloaded to the device by CMS.
Spectralink CMS Administration Guide
721-0036-000_K.docx April 2020 102
Also configure:
• EAP Identity
• Certificate
Caution: Insecure setting
Using a generic identity for EAP-TLS is considerably less secure than accepting
and using the default MAC address as the identity. EAP-TLS is the most secure Wi-
Fi method when device authentication depends upon unique certificates and
identities for each device.
Managing Wireless Profiles
You can delete and edit wireless profiles from the Select actions dropdown.
721-0036-000_K.docx April 2020 103
Part III: Appendices
721-0036-000_K.docx April 2020 104
Appendix A: Open Source Information
OFFER for Source for GPL and LGPL Software
You may have received a Spectralink wireless telephone that contains—in part—free software
(software licensed in a way that allows you the freedom to run, copy, distribute, change, and
improve the software).
A complete list of all open source software included in Spectralink wireless telephones as well
as related license and copyright information, is available at http://support.spectralink.com.
You may also obtain the same information by contacting Spectralink by regular mail or email at
the addresses listed at the bottom of this notice.
For at least three (3) years from the date of distribution of the applicable product or software, we
will give to anyone who contacts us at the contact information provided below, for a charge of no
more than our cost of physically distributing, the items listed in “Spectralink OFFER of Source
for GPL and LGPL Software”, which is available at http://support.spectralink.com.
Contact Information for Requesting Source Code
Spectralink Open Source Manager
2560 55th Street
Boulder, CO 80301
721-0036-000_K.docx April 2020 105
Appendix B: Products Mentioned in this
Document
Microsoft and Active Directory are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries.
Ubuntu and Canonical are registered trademarks of Canonical Ltd.
****END OF DOCUMENT****