Cisco Location Appliance Configuration Guide

Cisco Location Appliance Configuration Guide
Cisco Location Appliance Configuration Guide
Release 3.0
July 2007
Last revised: April 13, 2009
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-12449-01
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn,
and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco
Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel,
EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard,
LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect,
RateMUX, ScriptShare, SlideCast, SMARTnet, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or
its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (0601R)
Cisco Location Appliance Configuration Guide
©2007 Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface
7
Objectives
Audience
7
7
Organization
7
Conventions
8
Related Publications
8
Obtaining Documentation 8
Cisco.com 8
Product Documentation DVD
Ordering Documentation 9
Documentation Feedback
9
9
Cisco Product Security Overview 9
Reporting Security Problems in Cisco Products
Obtaining Technical Assistance 11
Cisco Technical Support Website 11
Submitting a Service Request 11
Definitions of Service Request Severity
12
Obtaining Additional Publications and Information
CHAPTER
1
Overview
Event Notification
2
2
Maintenance Operations
3
WCS and Location Server Synchronization
Monitoring Capability
Compatibility Matrix
3
3
Configuration and Administration
2
12
1
Display of Location Data
CHAPTER
10
3
4
Adding and Deleting Location Servers
1
Adding a Location Server to Cisco WCS
2
Deleting Location Servers from the Cisco WCS Database
2
Cisco Location Appliance Configuration Guide
OL-12449-01
3
Contents
CHAPTER
3
Synchronizing Cisco WCS and Location Servers
1
Keeping Cisco WCS and Location Servers Synchronized 2
Synchronizing Network Designs and Location Servers 2
Synchronizing Controllers and Location Servers 3
Synchronizing Event Groups and Location Servers 4
Configuring Automatic Location Server Synchronization 4
Out-of-Sync Alarms 5
Viewing Synchronization Information 6
Viewing Location Server Synchronization Status 6
Viewing Location Server Synchronization History 6
CHAPTER
4
Editing Location Server Properties
Editing General Properties
2
Editing Polling Parameters
2
Editing History Parameters
4
Editing Advanced Parameters
Editing Location Parameters
Editing LOCP Parameters
CHAPTER
5
1
5
5
7
Managing Location Server Users and Groups
Managing Groups 2
Adding User Groups 2
Deleting User Groups 2
Changing User Group Permissions
Managing Users 3
Adding Users 3
Deleting Users 4
Changing User Properties 4
Viewing Active User Sessions
1
3
5
Managing Host Access 5
Adding Host Access 5
Deleting Host Access 6
Editing Host Access 7
CHAPTER
6
Configuring Event Notifications
1
Working with Event Groups 2
Adding Event Groups 2
Deleting Event Groups 2
Cisco Location Appliance Configuration Guide
4
OL-12449-01
Contents
Working with Event Definitions 2
Adding an Event Definition 3
Deleting an Event Definition 6
Testing Event Definitions 6
Viewing Event Notification Summary
Notifications Cleared
7
8
Configuring Notification Parameters
8
Notification Message Formats 9
Notification Formats in XML 9
Missing (Absence) Condition 10
In/Out (Containment) Condition 10
Distance Condition 11
Battery Level 11
Location Change 11
Chokepoint Condition 12
Emergency Condition 12
Notification Formats in Text 12
WCS as a Notification Listener 13
CHAPTER
7
Location Planning and Verification
1
Deployment Planning for Data, Voice, and Location
2
Inspecting Location Readiness and Quality 3
Inspecting Location Readiness Using Access Point Data
Inspecting Location Quality Using Calibration Data 3
Analyzing Element Location Accuracy Using Testpoints
4
Using Chokepoints to Enhance Tag Location Reporting 8
Adding Chokepoints to the WCS Database and Map 9
Removing Chokepoints from the WCS Database and Map
CHAPTER
8
Monitoring Location Servers and Site
15
1
Working with Alarms 2
Viewing Alarms 2
Assigning and Unassigning Alarms
Deleting and Clearing Alarms 3
Emailing Alarm Notifications 4
Working with Events
3
3
5
Working with Logs 6
Configuring Logging Options
6
Cisco Location Appliance Configuration Guide
OL-12449-01
5
Contents
Downloading Location Server Log Files
6
Generating Reports 7
Creating a Location Server Utilization Report 7
Viewing a Location Server Utilization Chart 9
Monitoring Location Server Status 10
Viewing Location Server Current Information
Monitoring Clients
11
Monitoring Tagged Assets 11
Enabling Tagged Asset Location Status
Querying of Tags 12
Overlapping Tags 16
CHAPTER
9
10
Performing Maintenance Operations
Recovering Lost Password
12
1
2
Backing Up and Restoring Location Server Data 2
Backing Up Location Server Historical Data 2
Restoring Location Server Historical Data 3
Enabling Automatic Location Server Backup 4
Downloading Software to Location Servers
Configuring an NTP Server
4
5
Defragmenting the Location Server Database
6
Running Java GC on the Location Server Memory
Rebooting the Location Server Hardware
7
Clearing Location Server Configurations
7
Importing and Exporting Asset Information
Importing Asset Information 8
Exporting Asset Information 8
6
8
INDEX
Cisco Location Appliance Configuration Guide
6
OL-12449-01
Preface
This section describes the objectives, audience, organization, and conventions of the Cisco Location
Appliance Configuration Guide.
Objectives
This publication explains the steps for using Cisco Wireless Control System (WCS) for configuring and
managing location servers.
Audience
This publication is for the person configuring and managing location services. The user should be
familiar with network structures, terms, and concepts.
Organization
This guide contains the following sections:
Chapter 1, “Overview,” describes the major features of location servers that you can configure using
Cisco WCS.
Chapter 2, “Adding and Deleting Location Servers,” describes how to add and delete location servers.
Chapter 3, “Synchronizing Cisco WCS and Location Servers,” describes how to synchronize Cisco WCS
and locations servers.
Chapter 4, “Editing Location Server Properties,” describes how to configure location server properties.
Chapter 5, “Managing Location Server Users and Groups,” describes how to configure and manage
users, groups, and hot access.
Chapter 6, “Configuring Event Notifications,” describes how to define events and event groups, and how
to configure event notification parameters. It also describes how to view event notification summaries.
Cisco Location Appliance Configuration Guide
OL-12449-01
7
Preface
Conventions
Chapter 7, “Location Planning and Verification,” describes how to monitor locations servers by
configuring and viewing alarms, events, and logs. It also describes how to view location server, client,
and asset tag status. Achieving optimum AP placement and coverage is also addressed.
Chapter 8, “Monitoring Location Servers and Site,” describes how to back up and restore location server
data and how to update the location server software. It also describes other maintenance operations.
Chapter 9, “Performing Maintenance Operations,” describes how to back up and restore location server
data and how to update the location server software. It also describes other maintenance operations.
Conventions
This publication uses the following conventions to convey instructions and information:
•
Note
Caution
Commands and keywords are in boldface type.
Means reader take note. Notes contain helpful suggestions or references to materials not contained in
this manual.
Means reader be careful. In this situation, you might do something that could result in equipment
damage or loss of data.
Related Publications
For more information about location appliances and related products, refer to the Cisco 2700 Series
Location Appliance Quick Start Guide, which describes how to set up location appliances. This
document is available on the Cisco CCO website at the following URL:
http://www.cisco.com/en/US/products/ps6386/prod_installation_guides_list.html
Obtaining Documentation
Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several
ways to obtain technical assistance and other technical resources. These sections explain how to obtain
technical information from Cisco Systems.
Cisco.com
You can access the most current Cisco documentation at this URL:
http://www.cisco.com/techsupport
You can access the Cisco website at this URL:
http://www.cisco.com
You can access international Cisco websites at this URL:
http://www.cisco.com/public/countries_languages.shtml
Cisco Location Appliance Configuration Guide
8
OL-12449-01
Preface
Documentation Feedback
Product Documentation DVD
The Product Documentation DVD is a comprehensive library of technical product documentation on a
portable medium. The DVD enables you to access multiple versions of installation, configuration, and
command guides for Cisco hardware and software products. With the DVD, you have access to the same
HTML documentation that is found on the Cisco website without being connected to the Internet.
Certain products also have .PDF versions of the documentation available.
The Product Documentation DVD is available as a single unit or as a subscription. Registered Cisco.com
users (Cisco direct customers) can order a Product Documentation DVD (product number
DOC-DOCDVD= or DOC-DOCDVD=SUB) from Cisco Marketplace at this URL:
http://www.cisco.com/go/marketplace/
Ordering Documentation
Registered Cisco.com users may order Cisco documentation at the Product Documentation Store in the
Cisco Marketplace at this URL:
http://www.cisco.com/go/marketplace/
•
Nonregistered Cisco.com users can order technical documentation from 8:00 a.m. to 5:00 p.m.
(0800 to 1700) PDT by calling 1 866 463-3487 in the United States and Canada, or elsewhere by
calling 011 408 519-5055. You can also order documentation by e-mail at
[email protected] or by fax at 1 408 519-5001 in the United States and
Canada, or elsewhere at 011 408 519-5001.
Documentation Feedback
You can rate and provide feedback about Cisco technical documents by completing the online feedback
form that appears with the technical documents on Cisco.com.
You can submit comments about Cisco documentation by using the response card (if present) behind the
front cover of your document or by writing to the following address:
Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883
We appreciate your comments.
Cisco Product Security Overview
Cisco provides a free online Security Vulnerability Policy portal at this URL:
http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html
From this site, you will find information about how to:
•
Report security vulnerabilities in Cisco products.
•
Obtain assistance with security incidents that involve Cisco products.
•
Register to receive security information from Cisco.
Cisco Location Appliance Configuration Guide
OL-12449-01
9
Preface
Cisco Product Security Overview
A current list of security advisories and notices for Cisco products is available at this URL:
http://www.cisco.com/go/psirt
To see security advisories, security notices, and security responses as they are updated in real time, you
can subscribe to the Product Security Incident Response Team Really Simple Syndication (PSIRT RSS)
feed. Information about how to subscribe to the PSIRT RSS feed is found at this URL:
http://www.cisco.com/en/US/products/products_psirt_rss_feed.html
Reporting Security Problems in Cisco Products
Cisco is committed to delivering secure products. We test our products internally before we release them,
and we strive to correct all vulnerabilities quickly. If you think that you might have identified a
vulnerability in a Cisco product, contact PSIRT:
•
For Emergencies only — [email protected]
An emergency is either a condition in which a system is under active attack or a condition for which
a severe and urgent security vulnerability should be reported. All other conditions are considered
nonemergencies.
•
For Nonemergencies — [email protected]
In an emergency, you can also reach PSIRT by telephone:
Tip
•
1 877 228-7302
•
1 408 525-6532
We encourage you to use Pretty Good Privacy (PGP) or a compatible product (for example, GnuPG) to
encrypt any sensitive information that you send to Cisco. PSIRT can work with information that has been
encrypted with PGP versions 2.x through 9.x.
Never use a revoked or an expired encryption key. The correct public key to use in your correspondence
with PSIRT is the one linked in the Contact Summary section of the Security Vulnerability Policy page
at this URL:
http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html
The link on this page has the current PGP key ID in use.
If you do not have or use PGP, contact PSIRT at the aforementioned e-mail addresses or phone numbers
before sending any sensitive material to find other means of encrypting the data.
In an emergency, you can also reach PSIRT by telephone:
•
1 877 228-7302
•
1 408 525-6532
Cisco Location Appliance Configuration Guide
10
OL-12449-01
Preface
Obtaining Technical Assistance
Obtaining Technical Assistance
Cisco Technical Support provides 24-hour-a-day award-winning technical assistance. The Cisco
Technical Support & Documentation website on Cisco.com features extensive online support resources.
In addition, if you have a valid Cisco service contract, Cisco Technical Assistance Center (TAC)
engineers provide telephone support. If you do not have a valid Cisco service contract, contact your
reseller.
Cisco Technical Support Website
The Cisco Technical Support Website provides online documents and tools for troubleshooting and
resolving technical issues with Cisco products and technologies. The website is available 24 hours a day,
365 days a year, at this URL:
http://www.cisco.com/techsupport
Access to all tools on the Cisco Technical Support Website requires a Cisco.com user ID and password.
If you have a valid service contract but do not have a user ID or password, you can register at this URL:
http://tools.cisco.com/RPF/register/register.do
Note
Use the Cisco Product Identification (CPI) tool to locate your product serial number before submitting
a web or phone request for service. You can access the CPI tool from the Cisco Technical Support
Website by clicking the Tools & Resources link under Documentation & Tools. Choose Cisco Product
Identification Tool from the Alphabetical Index drop-down list, or click the Cisco Product
Identification Tool link under Alerts & RMAs. The CPI tool offers three search options: by product ID
or model name; by tree view; or for certain products, by copying and pasting show command output.
Search results show an illustration of your product with the serial number label location highlighted.
Locate the serial number label on your product and record the information before placing a service call.
Submitting a Service Request
Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3
and S4 service requests are those in which your network is minimally impaired or for which you require
product information.) After you describe your situation, the TAC Service Request Tool provides
recommended solutions. If your issue is not resolved using the recommended resources, your service
request is assigned to a Cisco TAC engineer. The TAC Service Request Tool is located at this URL:
http://www.cisco.com/techsupport/servicerequest
For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone.
(S1 or S2 service requests are those in which your production network is down or severely degraded.)
Cisco TAC engineers are assigned immediately to S1 and S2 service requests to help keep your business
operations running smoothly.
To open a service request by telephone, use one of the following numbers:
Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553-2447
For a complete list of Cisco TAC contacts, go to this URL:
http://www.cisco.com/techsupport/contacts
Cisco Location Appliance Configuration Guide
OL-12449-01
11
Preface
Obtaining Additional Publications and Information
Definitions of Service Request Severity
To ensure that all service requests are reported in a standard format, Cisco has established severity
definitions.
Severity 1 (S1)—Your network is down, or there is a critical impact to your business operations. You
and Cisco will commit all necessary resources around the clock to resolve the situation.
Severity 2 (S2)—Operation of an existing network is severely degraded, or significant aspects of your
business operation are negatively affected by inadequate performance of Cisco products. You and Cisco
will commit full-time resources during normal business hours to resolve the situation.
Severity 3 (S3)—Operational performance of your network is impaired, but most business operations
remain functional. You and Cisco will commit resources during normal business hours to restore service
to satisfactory levels.
Severity 4 (S4)—You require information or assistance with Cisco product capabilities, installation, or
configuration. There is little or no effect on your business operations.
Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online
and printed sources.
•
The Cisco Product Quick Reference Guide is a handy, compact reference tool that includes brief
product overviews, key features, sample part numbers, and abbreviated technical specifications for
many Cisco products that are sold through channel partners. It is updated twice a year and includes
the latest Cisco offerings. To order and find out more about the Cisco Product Quick Reference
Guide, go to this URL:
http://www.cisco.com/go/guide
•
Cisco Marketplace provides a variety of Cisco books, reference guides, and logo merchandise. Visit
Cisco Marketplace, the company store, at this URL:
http://www.cisco.com/go/marketplace/
•
Cisco Press publishes a wide range of general networking, training and certification titles. Both new
and experienced users will benefit from these publications. For current Cisco Press titles and other
information, go to Cisco Press at this URL:
http://www.ciscopress.com
•
Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and
networking investments. Each quarter, Packet delivers coverage of the latest industry trends,
technology breakthroughs, and Cisco products and solutions, as well as network deployment and
troubleshooting tips, configuration examples, customer case studies, certification and training
information, and links to scores of in-depth online resources. You can access Packet magazine at
this URL:
http://www.cisco.com/packet
Cisco Location Appliance Configuration Guide
12
OL-12449-01
Preface
Obtaining Additional Publications and Information
•
iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies
learn how they can use technology to increase revenue, streamline their business, and expand
services. The publication identifies the challenges facing these companies and the technologies to
help solve them, using real-world case studies and business strategies to help readers make sound
technology investment decisions. You can access iQ Magazine at this URL:
http://www.cisco.com/go/iqmagazine
or view the digital edition at this URL:
http://ciscoiq.texterity.com/ciscoiq/sample/
•
Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering
professionals involved in designing, developing, and operating public and private internets and
intranets. You can access the Internet Protocol Journal at this URL:
http://www.cisco.com/ipj
•
Networking products offered by Cisco Systems, as well as customer support services, can be
obtained at this URL:
http://www.cisco.com/en/US/products/index.html
•
Networking Professionals Connection is an interactive website for networking professionals to
share questions, suggestions, and information about networking products and technologies with
Cisco experts and other networking professionals. Join a discussion at this URL:
http://www.cisco.com/discuss/networking
•
World-class networking training is available from Cisco. You can view current offerings at
this URL:
http://www.cisco.com/en/US/learning/index.html
Cisco Location Appliance Configuration Guide
OL-12449-01
13
Preface
Obtaining Additional Publications and Information
Cisco Location Appliance Configuration Guide
14
OL-12449-01
C H A P T E R
1
Overview
Cisco 2700 series location appliances operate within the Cisco Wireless LAN Solution infrastructure.
Location appliances compute, collect, and store historical location data using Cisco wireless LAN
controllers and access points to track the physical location of wireless devices. Up to 2,500 laptop
clients, palmtop clients, VoIP telephone clients, active Radio Frequency Identifier (RFID) asset tags,
rogue access points and clients can be tracked.
The collected location data can be viewed in GUI format in the Cisco Wireless Control System (WCS),
the centralized WLAN management platform.
However, before you can use Cisco WCS, initial configuration for the location server is required using
a command-line (CLI) console session. Details are described in the Quick Start Guide: Cisco 2700 Series
Location Appliance.
You can find the latest version of this manual online at:
http://www.cisco.com/en/US/products/ps6386/prod_installation_guides_list.html.
The following sections describe the main topics covered in this guide:
•
“Display of Location Data” section on page 1-2
•
“Event Notification” section on page 1-2
•
“Maintenance Operations” section on page 1-3
•
“WCS and Location Server Synchronization” section on page 1-3
•
“Monitoring Capability” section on page 1-3
•
“Configuration and Administration” section on page 1-3
•
“Compatibility Matrix” section on page 1-4
Cisco Location Appliance Configuration Guide
OL-12449-01
1-1
Chapter 1
Overview
Display of Location Data
Display of Location Data
After it is configured, each location server communicates directly with the Cisco wireless LAN
controllers to which it was assigned to collect operator-defined location data. You can then use the
associated Cisco WCS server to communicate with each location server to transfer and display selected
data.
You can configure location appliances to collect data for Cisco Wireless LAN Solution clients, rogue
access points, rogue clients, mobile stations, and RFID asset tags at separate intervals which you define.
Event Notification
Location servers provide the functionality for sending event notifications to registered listeners over the
following transport mechanisms:
Note
•
Simple Object Access Protocol (SOAP)
•
Simple Mail Transfer Protocol (SMTP) mail
•
Simple Network Management Protocol (SNMP)
•
SysLog
WCS can act as a listener receiving event notifications over SNMP.
Without event notification, Cisco WCS and third-party applications will need to periodically request
location information from location servers. (Figure 1-1).
Pull Communication Model
Service
subscriptions
Request
WCS
Data
Request
Third-party
applications
Mobility
Services
Engine
or Location
Appliance
Controller
Data
notifications
Data
146187
Figure 1-1
Network latency
The pull communication model, however, is not suitable for applications that require more real-time
updates to location information. For these applications, you can configure location servers to send event
notifications (push) when certain conditions are met by the registered listeners (Figure 1-2).
Cisco Location Appliance Configuration Guide
1-2
OL-12449-01
Chapter 1
Overview
Maintenance Operations
Push Communication Model
Request
WCS
Data
Notification
Request
Location
server
Data
Controller
Notification
146188
Figure 1-2
Third-party
applications
Maintenance Operations
You can use Cisco WCS to back up the location server to a predefined FTP folder on any Cisco WCS
server at defined intervals. You can also restore the location server data from that Cisco WCS Server.
Other location server maintenance operations that you can perform include downloading new
application code to all associated location server from any Cisco WCS server, defragmenting the Cisco
WCS database, restarting location servers, and clearing location server configurations.
WCS and Location Server Synchronization
To maintain accurate location information, you can use Cisco WCS to configure location servers so that
they are synchronized with network design, event group, and controller elements. Cisco WCS provides
you with two ways to synchronize these elements and locations servers: manual and automatic
(auto-sync).
Monitoring Capability
You can use Cisco WCS to monitor alarms and events generated by location servers. You can also
download log files and view location server status information.
Configuration and Administration
You use Cisco WCS to perform different configuration and administrative tasks, including adding and
removing location servers, configuring location server properties, managing users and groups and
importing and exporting asset location information.
Cisco Location Appliance Configuration Guide
OL-12449-01
1-3
Chapter 1
Overview
Compatibility Matrix
Compatibility Matrix
Table 1-1 describes compatibility between WCS and location server versions
Table 1-1
WCS \
Location
Server
WCS 3.0
WCS and Location Server Compatibility Matrix
LOC 1.1
LOC 1.2
Supported
Supported
2
WCS 3.1
Supported
WCS 3.2
Supported2, 3,
LOC 2.0
1
Supported
LOC 2.1
LOC 3.0
Not supported Not supported Not supported
Supported
from WCS
3.1.35.0
onward3
Supported
from WCS
3.1.35.0
onward3
Supported
from WCS
3.1.35.0
onward3,6,8
Supported3, 4, 5 Supported
Supported6
Supported6,8
Supported
Supported8
Supported9
Supported
4, 5
WCS 4.0
Supported2, 3, 4, Supported3, 4, 5, Supported7
5,6
WCS 4.1
7
Supported2,3,4, Supported3,4,5, Supported7,9
5,6,9
7, 9
1. Certain antenna attributes are ignored by WCS.
2. Certain antenna attributes are ignored by the location server.
3. Asynchronous notification features are ignored by the location server.
4. Backup and restore operations for the location server may time out.
5. Searching for elements by a specific MAC address or asset name will not work until the location server SW is
upgraded.
6. Battery level and location notification update features are ignored by the location server. Location smoothing parameters
and contributing access point debug options are ignored by the location server.
7. Battery level and location notification update features are ignored by Cisco WCS. Location smoothing parameters and
contributing access point debug options are ignored by Cisco WCS.
8. CCX tags, telemetry, chokepoint, and emergency capabilities are ignored by Cisco WCS.
9. CCX tags, telemetry, chokepoint, and emergency capabilities are ignored by the location server.
Cisco Location Appliance Configuration Guide
1-4
OL-12449-01
C H A P T E R
2
Adding and Deleting Location Servers
This chapter describes how to add and delete location servers.
This chapter contains the following sections:
•
“Adding a Location Server to Cisco WCS” section on page 2-2
•
“Deleting Location Servers from the Cisco WCS Database” section on page 2-2
Cisco Location Appliance Configuration Guide
OL-12449-01
2-1
Chapter 2
Adding and Deleting Location Servers
Adding a Location Server to Cisco WCS
Adding a Location Server to Cisco WCS
To add a location server to Cisco WCS, log into WCS and follow these steps:
Step 1
Verify that you can ping the location server that you want to add from the Cisco WCS server.
Step 2
Choose Location > Location Servers to display the All Location Servers window.
Step 3
From the drop-down menu (right-hand side), choose Add Server and click GO.
Step 4
In the Server Name field, enter a name for the location server.
Step 5
In the IP Address field, enter the location server’s IP address.
Step 6
(Optional) In the Contact Name filed, enter the name of the location server administrator.
Step 7
In the User Name and Password fields, enter the username and password for the location server.
The default username and password are both admin.
Step 8
In the Port field, enter the port number used by the location server.
The default port is 8001.
Step 9
Check the Enable check box to enable HTTPS. Uncheck the check box to disable HTTPS.
HTTPS is disabled by default.
Step 10
Click Save.
Cisco WCS searches for the location server and adds it to the Cisco WCS database.
Step 11
Go back to the All Location Servers window and click Refresh (top right). Verify that the location server
that you have just added appears in the window.
Note
Cisco WCS does not allow you to add a server that already exists in the WCS database.
Deleting Location Servers from the Cisco WCS Database
To delete location servers from the Cisco WCS database, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Select the server or servers to be deleted by checking the corresponding check box(es).
Step 3
From the drop-down menu (right-hand side), choose Delete Server(s) and click GO.
Step 4
Click OK to confirm that you want to delete the selected location server from the WCS database.
Step 5
Click Cancel to stop deletion.
Cisco Location Appliance Configuration Guide
2-2
OL-12449-01
C H A P T E R
3
Synchronizing Cisco WCS and Location
Servers
This chapter describes how to synchronize Cisco WCS and locations servers.
This chapter contains the following sections:
•
“Keeping Cisco WCS and Location Servers Synchronized” section on page 3-2
•
“Viewing Synchronization Information” section on page 3-6
Cisco Location Appliance Configuration Guide
OL-12449-01
3-1
Chapter 3
Synchronizing Cisco WCS and Location Servers
Keeping Cisco WCS and Location Servers Synchronized
Keeping Cisco WCS and Location Servers Synchronized
This section describes how to synchronize WCS and location servers manually and automatically.
Note
Be sure to verify software compatibility between WCS and the location server before performing
synchronization as summarized in the compatibility matrix in Section 1-4 of Chapter 1.
Synchronizing Network Designs and Location Servers
After adding a location server to the WCS database, you can add (synchronize) network designs
(campus, building, and outdoor maps) to the location server database. After the network designs are
stored in the Cisco WCS and location server databases, you can re-synchronize the two databases at any
time.
To synchronize WCS network designs with the location server, follow these steps:
Step 1
Choose Location > Location Servers to display the All Location Servers window.
Step 2
From the drop-down menu (right-hand side), choose Synchronize Servers and click GO.
Cisco WCS displays the Synchronize WCS and Location Servers window.
Step 3
From the Synchronize menu, choose Network Designs.
Step 4
To assign a network design to one or more location server, click its corresponding Assign link.
Step 5
In the “Assign to servers” dialog box that appears, check the box of each server that you want to assign
to the network design. Click OK when selection is complete.
A red asterisk (*) appears next to the Assign link. To undo assignments, click Reset. To go back to the
All Location Servers window without making any changes, click Cancel.
Note
Step 6
A network design might comprise a large campus with several buildings, each monitored by a
different location server. This is why you might need to assign a single network design to
multiple location servers.
Click Synchronize to update the Cisco WCS and location server databases.
When the Cisco WCS and location server databases are synchronized, a green two-arrow icon appears
in the Sync. Status column for each synchronized network design entry.
Note
To unassign a network design from a location server, uncheck the server’s check box in the “Assign to
servers” dialog box and click OK. Then, click Synchronize. A two-arrow icon with a red circle appears
in the Sync. Status column.
Cisco Location Appliance Configuration Guide
3-2
OL-12449-01
Chapter 3
Synchronizing Cisco WCS and Location Servers
Keeping Cisco WCS and Location Servers Synchronized
Synchronizing Controllers and Location Servers
Before a location server can collect any data, you must associate the server with a controller and
synchronize them using Cisco WCS. After the initial synchronization, you can resynchronize the
controllers and location servers at any time.
To synchronize a location server and a controller, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Cisco WCS displays the All Location Servers window.
Step 2
From the drop-down menu (right-hand side), choose Synchronize Servers and click GO.
Cisco WCS displays the Synchronize WCS and Location Servers window.
Step 3
From the Synchronize menu, choose Controllers.
Cisco WCS displays the Controllers summary window.
Step 4
To assign a location server to a controller, choose the server from the corresponding drop-down menu.
Step 5
Click Synchronize to synchronize the controller and location server databases.
When the Cisco WCS and location server databases are synchronized, a green two-arrow icon appears
in the Sync. Status column of every synchronized controller entry.
Note
Controller names must be unique for synchronizing with location servers. If you have two controllers
with the same name, only one will be synchronized.
Note
To remove a controller from a location server, choose -- Unassigned -- from the controller’s drop-down
menu and click Synchronize. A two-arrow icon with a red circle appears in the Sync. Status column.
Cisco Location Appliance Configuration Guide
OL-12449-01
3-3
Chapter 3
Synchronizing Cisco WCS and Location Servers
Keeping Cisco WCS and Location Servers Synchronized
Synchronizing Event Groups and Location Servers
To synchronize WCS event groups and location servers, follow these steps:
Step 1
Choose Location > Location Servers to display the All Location Servers window.
Step 2
From the drop-down menu (right-hand side), choose Synchronize Servers and click GO.
Cisco WCS displays the Synchronize WCS and Location Servers window.
Step 3
From the Synchronize menu, choose Event Groups.
Step 4
To assign one or more location servers to an event group, click its corresponding Assign link.
Step 5
In the Assign to servers dialog box, check the box of each server that you want to assign to the event
group. Click OK when selection is complete.
A red asterisk (*) appears next to the Assign link.
Step 6
Click Synchronize to update the Cisco WCS and location server databases.
When the Cisco WCS and location server databases are synchronized, a green two-arrow icon appears
in the Sync. Status column of every synchronized event group entry.
Note
To unassign an event group from a location server, uncheck the server’s check box in the “Assign to
servers” dialog box and click OK. Then, click Synchronize. A two-arrow icon with a red circle appears
in the Sync. Status column.
Configuring Automatic Location Server Synchronization
Manual synchronization of WCS and location servers provides immediate synchronization. However,
future deployment changes (such as making changes to maps and access point positions), can yield
incorrect location calculations and asset tracking until resynchronization reoccurs. To prevent
out-of-sync conditions, use Cisco WCS to enable automatic synchronization. This policy ensures that
synchronization between WCS and location servers is triggered periodically and any related alarms are
cleared.
To configure automatic synchronization, follow these steps:
Step 1
In Cisco WCS, choose Administration > Scheduled Tasks.
Step 2
Click Location Server Synchronization.
The Location Server Synchronization window lists the latest automatic synchronization operations and
displays automatic synchronization options that you can configure.
Step 3
To set the location server to send out-of-sync alerts, check the Enabled check box of the Out of Sync
Alerts field.
Step 4
To enable automatic synchronization, check the Auto Synchronization check box.
Cisco Location Appliance Configuration Guide
3-4
OL-12449-01
Chapter 3
Synchronizing Cisco WCS and Location Servers
Keeping Cisco WCS and Location Servers Synchronized
Note
Step 5
Automatic synchronization does not apply to elements (network designs, controllers, or event
groups) that have not yet been assigned to a location server. However, out-of-sync alarms will
still be generated for these unassigned elements. For automatic synchronization to apply to these
elements, you need to manually assign them to a location server.
Enter the time interval in days and the time of day that the automatic synchronization is to be performed.
Note
Time interval was represented in minutes prior to release 2.1.x.
By default, auto-sync is disabled.
Step 6
Click Submit.
Out-of-Sync Alarms
Out-of-sync alarms are of Minor severity (yellow), and are raised in response to the following
conditions:
•
Elements have been modified in Cisco WCS (the auto-sync policy will push these elements)
•
Elements have been modified in location servers (the auto-sync policy will pull these elements)
•
Elements except controllers exist in the location server but not in Cisco WCS (the auto-sync policy
will pull these elements)
•
Elements have not been assigned to any location server (the auto-sync policy doesn’t apply)
Out-of-sync alarms are cleared when the following occurs:
•
Location server is deleted
Note
Note
When you delete a location server, the out-of-sync alarms for that server are also deleted. In
addition, if you delete the last available location server, the alarms for “elements not
assigned to any location server” will also be deleted.
•
Elements are synchronized manually or automatically
•
User manually clears the alarms (although the alarms may reappear in the future when the scheduled
task is next executed)
By default, out-of-sync alarms are enabled. You can disable them in Cisco WCS by choosing
Administration > Scheduled Tasks, clicking Location Server Synchronization, unchecking the Auto
Synchronization check box, and clicking Submit.
Cisco Location Appliance Configuration Guide
OL-12449-01
3-5
Chapter 3
Synchronizing Cisco WCS and Location Servers
Viewing Synchronization Information
Viewing Synchronization Information
This section describes how to view location server synchronization status and history.
Viewing Location Server Synchronization Status
You can use the Synchronize Servers command in Cisco WCS to view the status of network design,
controller, and event group synchronization with location servers.
To view synchronization status, follow these steps:
Step 1
In Cisco WCS, choose Location > Synchronize Servers.
Step 2
From the Synchronize drop-down menu, choose Network Designs, Controllers, or Event Groups.
Depending on the command you have chosen, Cisco WCS displays a list of elements (network designs,
controllers, or event groups). In the list, the Sync. Status column shows the synchronization status. A
green two-arrow icon indicates that its corresponding element is synchronized with the specified
location server. A gray two-arrow icon with a red circle indicates that its corresponding item is not
synchronized with the location server.
Viewing Location Server Synchronization History
You can use the Synchronization History command in Cisco WCS to view the location server
synchronization history for the last 30 days. This is especially useful when automatic synchronization is
enabled as alarms are automatically cleared. Synchronization History provides a summary of those
cleared alarms.
To view synchronization history, follow these steps:
Step 1
In Cisco WCS, choose Location > Synchronization History.
Step 2
Click the column headers to sort the entries.
In the Synchronization History window, the Sync Direction column indicates whether information is
pushed into the location server or pulled by the location server. The Generated By column indicates
whether the synchronization was manual or automatic.
Cisco Location Appliance Configuration Guide
3-6
OL-12449-01
C H A P T E R
4
Editing Location Server Properties
This chapter describes how to configure location server properties.
This chapter contains the following sections:
•
“Editing General Properties” section on page 4-2
•
“Editing Polling Parameters” section on page 4-2
•
“Editing History Parameters” section on page 4-4
•
“Editing Advanced Parameters” section on page 4-5
•
“Editing Location Parameters” section on page 4-5
•
“Editing LOCP Parameters” section on page 4-7
Cisco Location Appliance Configuration Guide
OL-12449-01
4-1
Chapter 4
Editing Location Server Properties
Editing General Properties
Editing General Properties
You can use Cisco WCS to edit the general properties of location servers registered in the WCS database.
You can edit the following general properties: contact name, user name, password and HTTPS.
To edit the general properties of a location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers to display the All Location Servers window.
Step 2
Click the name of the location server you want to edit.
Step 3
Modify the parameters as appropriate. A description of each of the features and possible values is
summarized in Table 4-1.
Table 4-1
Step 4
General Properties
Parameter
Description
Contact Name
Enter a contact name for the location server.
User Name
Enter the login user name for the Cisco WCS server that manages the
location server.
Password
Enter the login password for the Cisco WCS server that manages the
location server.
Port
8001
HTTPS
Check the HTTPS enable check box to enable HTTPS.
Note
When you have a non-default port or HTTPS turned on, you
must pass the correct information along with the command. For
example, getserverinfo must include -port <<port>> -protocol
<<HTTP/HTTPS>>. Similarly, for stopping the server,
stoplocserver - port <<port>> -protocol <HTTP/HTTPS>>.
Click Save to update the Cisco WCS and location server databases.
Editing Polling Parameters
You can use Cisco WCS to modify the time periods (polling intervals) for polling client stations, rogue
access points, asset tags, and statistics of clients and asset tags. Additionally, you can turn off tracking
and reporting of ad hoc rogue clients.
The polling interval is the period of time between polling cycles. For example, if a polling cycle requires
30 seconds to complete, and the polling interval is 300 seconds, polling cycles start every 330 seconds,
as shown in Figure 4-1.
Polling Interval
Polling cycle
300
Polling interval
330
Polling cycle
630
660
Seconds
146189
Figure 4-1
Cisco Location Appliance Configuration Guide
4-2
OL-12449-01
Chapter 4
Editing Location Server Properties
Editing Polling Parameters
When configuring polling intervals, use shorter intervals to increase the granularity of data collection.
To decrease the granularity of data collection, use longer intervals.
Note
The polling intervals are independent of the number of times that WCS users request a data refresh from
the location server.
To configure polling parameters for a location appliance, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers. The All Servers window appears.
Step 2
Click the name of the location server whose properties you want to edit. The General Properties window
appears.
Step 3
From the Administration menu, choose Polling Parameters to display the administrative configuration
options.
Step 4
Modify the polling parameters as appropriate. Table 4-2 lists each parameter and its description.
Table 4-2
Polling Parameters:
Parameter
Description
Retry Count
Enter the number of times to retry a polling cycle. Default value is 3. Allowed
values are from 1 to 99999.
Timeout
Enter the number of seconds before a polling cycle times out. Default value is 5.
Allowed values are from 1 to 99999.
Client Stations
Check the Enable check box to enable client station polling and enter the polling
interval in seconds. Default value is 300. Allowed values are from 1 to 99999.
Asset Tags
Check the Enable check box to enable asset tag polling and enter the polling
interval in seconds. Default value is 600. Allowed values are from 1 to 99999.
Note
Before the location server can collect asset tag data from controllers, you
must enable the detection of active RFID tags using the CLI command
config rfid status enable on the controllers.
Statistics
Check the Enable check box to enable statistics polling for the location server, and
enter the polling interval in seconds. Default value is 900. Allowed values are from
1 to 99999.
Rogue Clients
and Access
Points
Check the Enable check box to enable rogue access point polling and enter the
polling interval in seconds. Default value is 600. Allowed values are from 1 to
99999.
Exclude Ad-Hoc Check the check box to turn off the tracking and reporting of ad hoc rogues in the
Rogues
network. As a result, ad hoc rogues are not displayed on WCS maps or its events
and alarms reported.
Step 5
Click Save to store the new settings in the location server database.
Cisco Location Appliance Configuration Guide
OL-12449-01
4-3
Chapter 4
Editing Location Server Properties
Editing History Parameters
Editing History Parameters
You can use Cisco WCS to specify how often to collect client station, rogue access point, and asset tag
histories from the controllers associated with a location server.
You can also program the location server to periodically prune (remove) duplicate data from its historical
files to reduce the amount of data stored on its hard drive.
To configure location server history settings, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server whose properties you want to edit.
Step 3
Click Administration (left-hand side) to display the administrative configuration options.
Step 4
Click History Parameters.
Step 5
Modify the following history parameters as appropriate. Table 4-3 lists each parameter and its
description.
Table 4-3
History Parameters:
Parameter
Description
Archive for
Enter the number of days for the location server to retain a history of each enabled
category. Default value is 30. Allowed values are from 1 to 99999.
Prune data
starting at
Enter the number of hours and minutes at which the location server starts data
pruning (between 0 and 23 hours, and between 1 and 59 minutes). Also enter the
interval in minutes after which data pruning starts again (between 0, which means
never, and 99900000). Default start time is 23 hours and 50 minutes, and the default
interval is 1440 minutes.
Client Stations
Check the Enable check box to turn historical data collection on, and enter the
number of minutes between data collection events. Default value is 120. Allowed
values are from 1 to 99999.
Asset Tags
Check the Enable check box to turn historical data collection on, and enter the
number of minutes between data collection events. Default value is 180. Allowed
values are from 1 to 99999.
Note
Rogue Clients
and Access
Points
Step 6
Before the location server can collect asset tag data from controllers, you
must enable the detection of RFID tags using the CLI command config rfid
status enable.
Check the Enable check box to turn historical data collection on (disabled by
default), and enter the number of minutes between data collection events. Default
value is 360. Allowed values are from 1 to 99999.
Click Save to store your selections in the location server database.
Cisco Location Appliance Configuration Guide
4-4
OL-12449-01
Chapter 4
Editing Location Server Properties
Editing Advanced Parameters
Editing Advanced Parameters
You can use Cisco WCS to modify troubleshooting parameters for a location appliance.
To edit location server advanced parameters, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server whose properties you want to edit.
Step 3
Click Advanced (left-hand side) to expand the advanced menu options.
Step 4
Click Advanced Parameters (left-hand side) and scroll to the bottom of that window to see the options
that can be modified.
Step 5
Modify the advanced parameters as necessary. Table 4-4 lists each parameter and its description.
Table 4-4
Advanced Parameters
Parameter
Description
Advanced Debug
Check the check box to enable advanced debugging. Uncheck the
check box to disable advanced debugging.
Caution
Step 6
Enable advanced debugging only under the guidance of
TAC personnel because advanced debugging slows the
location server down.
Number of Days to Keep
Events
Enter the number of days to keep logs. Change this value as required
for monitoring and troubleshooting.
Session Timeout
Enter the number of minutes before a session times out. Change this
value as required for monitoring and troubleshooting.
Absent Data cleanup interval
Interval in minutes for data cleanup.
Click Save to update the Cisco WCS and location server databases.
.
Editing Location Parameters
You can use Cisco WCS to specify whether the location server retains its calculation times and how soon
the location server deletes its collected Receiver Signal Strength Indicator (RSSI) measurement times.
You can also apply varying smoothing rates to manage location movement of an element.
To configure location parameters, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server whose properties you want to edit.
Step 3
Click Advanced (left-hand side) to expand the advanced menu options.
Step 4
Click Location Parameters.
Step 5
Modify the location parameters as appropriate. Table 4-5 lists each parameter and its description.
Cisco Location Appliance Configuration Guide
OL-12449-01
4-5
Chapter 4
Editing Location Server Properties
Editing Location Parameters
Table 4-5
Location Parameters:
Parameter
Description
Calculation time Check the corresponding check box to enable the calculation of the time required
to compute location.
Enable only under Cisco TAC personnel guidance because enabling this
parameter slows down overall location calculations.
Caution
OW Location
Check the corresponding check box to enable Outer Wall (OW) calculation as part
of location calculation.
Note
The OW Location parameter is ignored by the location server.
Relative discard Enter the number of minutes since the most recent RSSI sample after which RSSI
RSSI time
measurement should be considered stale and discarded. For example, if you set this
parameter to 3 minutes and the location server receives two samples at 10 and 12
minutes, it keeps both samples. An additional sample received at 15 minutes is
discarded. Default value is 3. Allowed values range from 0 to 99999. A value of less
than 3 is not recommended.
Absolute
discard RSSI
time
Enter the number of minutes after which RSSI measurement should be considered
stale and discarded, regardless of the most recent sample. Default value is 60.
Allowed values range from 0 to 99999. A value of less than 60 is not recommended.
RSSI Cutoff
Enter the RSSI cutoff value, in decibels (dBs) with respect to one (1) mW (dBm),
above which the location server will always use the access point measurement.
Default value is –75.
Note
When 3 or more measurements are available above the RSSI cutoff value,
the location server will discard any weaker values and use the 3 (or more)
strongest measurements for calculation; however, when only weak
measurements below the RSSI cutoff value are available, those values are
used for calculation.
Caution
Smooth
Location
Positions
Modify only under Cisco TAC personnel guidance. Modifying this value
can reduce the accuracy of location calculation.
Smoothing compares an elements prior location to its most recent reported location
by applying a weighted average calculation to determine its current location. The
specific weighted average calculation employed is tied to the given smoothing
option selected. Default value is More Smoothing.
Options:
•
None: Elements assumed to be in location indicated by most recent polling
•
Less: Prior location weighted at 25% and New location weighted at 75%
•
Average: Prior location weighted at 50% and New location weighted at 50%
•
More: Prior location weighted at 75% and New location weighted at 25%
•
Maximum: Prior location weighted at 90% and New location weighted at 10%
Cisco Location Appliance Configuration Guide
4-6
OL-12449-01
Chapter 4
Editing Location Server Properties
Editing LOCP Parameters
Step 6
Click Save to store your selections in the Cisco WCS and location server databases.
Editing LOCP Parameters
LOCP is the location protocol that manages communication between the location server and the
controller. Transport of telemetry, emergency and chokepoint information between the location server
and the controller is managed by this protocol.
Note
•
The LOCP parameter is only seen on location servers installed with release 3.0 and higher software.
Additionally, telemetry, emergency and chokepoint information is only seen on controllers and WCS
installed with release 4.1 and higher software and on location servers running release 3.0 and higher
software.
•
The TCP port (16113) that the controller and location server communicate over MUST be open (not
blocked) on any firewall that exists between the controller and location server for LOCP to function.
To configure LOCP parameters, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server whose properties you want to edit.
Step 3
Click Advanced (left-hand side) to expand the advanced menu options.
Step 4
Click LOCP Parameters.
Step 5
Modify the LOCP parameters as appropriate. Table 4-6 lists each parameter and its description.
Note
No change in the default parameter values is recommended unless network is experiencing slow
response or excessive latency.
Cisco Location Appliance Configuration Guide
OL-12449-01
4-7
Chapter 4
Editing Location Server Properties
Editing LOCP Parameters
Table 4-6
LOCP Parameters
Parameter
Description
Echo Interval
Defines how frequently an echo request is sent from a location
server to a controller. The default value is 15 seconds. Allowed
values range from 1 to 120 seconds.
Note
Neighbor Dead Interval
If a network is experiencing slow response, you can increase
the values of the echo interval, neighbor dead interval and
the response timeout values to limit the number of failed
echo acknowledgements.
The number of seconds that the location server waits for a
successful echo response from the controller before declaring the
neighbor dead. This timer begins when the echo request is sent.
The default values is 30 seconds. Allowed values range from 1 to
240 seconds.
Note
Step 6
This value must be at least two times the echo interval
value.
Response Timeout
Indicates how long the location server waits before considering the
pending request as timed out. The default value is 1 second.
Minimum value is one (1). There is no maximum value.
Retransmit Interval
Interval of time that the location server waits between notification
of a response time out and initiation of a request retransmission. The
default setting is 3 seconds. Allowed values range from 1 to 120
seconds.
Maximum Retransmits
Defines the maximum number of retransmits that are done in the
absence of a response to any request. The default setting is 5.
Allowed minimum value is zero (0). There is no maximum value.
Click Save to update the Cisco WCS and location server databases.
Cisco Location Appliance Configuration Guide
4-8
OL-12449-01
C H A P T E R
5
Managing Location Server Users and Groups
This chapter describes how to configure and manage users, groups, and hot access.
This chapter contains the following sections:
•
“Managing Groups” section on page 5-2
•
“Managing Users” section on page 5-3
•
“Managing Host Access” section on page 5-5
Cisco Location Appliance Configuration Guide
OL-12449-01
5-1
Chapter 5
Managing Location Server Users and Groups
Managing Groups
Managing Groups
This section describes how to add, delete, and edit user groups.
Adding User Groups
To add a user group to a location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to edit.
Step 3
Click Accounts (left).
Step 4
Click Groups.
Step 5
Choose Add Group from the drop-down menu (right-hand side) and click GO.
Step 6
Enter the name of the group in the Group Name field.
Step 7
Choose a permission level from the Permission drop-down menu.
There are three permissions levels to choose from:
Step 8
Caution
•
Read Access
•
Write Access
•
Full Access (required for Cisco WCS to access location servers)
Click Save to add the new group to the location server.
Group permissions override individual user permissions. For example, if you give a user full access
permission and add that user to a group with read access permission, that user will not be able to
configure location server settings.
Deleting User Groups
To delete user groups from a location servers, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to edit.
Step 3
Click Accounts (left).
Step 4
Click Groups.
Step 5
Check the check boxes of the groups that you want to delete.
Step 6
Choose Delete Group from the drop-down menu (right-hand side) and click GO.
Step 7
Click OK to confirm that you want to delete the selected groups.
Cisco Location Appliance Configuration Guide
5-2
OL-12449-01
Chapter 5
Managing Location Server Users and Groups
Managing Users
Changing User Group Permissions
To change user group permissions, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to edit.
Step 3
Click Accounts (left).
Step 4
Click Groups.
Step 5
Click the name of the group you want to edit.
Step 6
Choose a permission level from the Permission drop-down menu.
Step 7
Click Save to apply your change.
Caution
Group permissions override individual user permissions. For example, if you give a user full access
permission and add that user to a group with read access permission, that user will not be able to
configure location server settings.
Managing Users
This section describes how to add, delete, and edit users. It also describes how to view active user
sessions.
Adding Users
To add a users to a location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to edit.
Step 3
Click Accounts (left).
Step 4
Click Users.
Step 5
Choose Add User from the drop-down menu (right-hand side) and click GO.
Step 6
Enter the username in the Username field.
Step 7
Enter a password in the Password field.
Step 8
Enter the name of the group to which the user belongs in the Group Name field.
Cisco Location Appliance Configuration Guide
OL-12449-01
5-3
Chapter 5
Managing Location Server Users and Groups
Managing Users
Step 9
Choose a permission level from the Permission drop-down menu.
There are three permission levels to choose from: Read Access, Write Access, and Full Access
Caution
Step 10
Group permissions override individual user permissions. For example, if you give a user full access
permission and add that user to a group with read access permission, that user will not be able to
configure location server settings.
Click Save to add the new user to the location server.
Deleting Users
To delete a user from a location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to edit.
Step 3
Click Accounts (left).
Step 4
Click Users.
Step 5
Check the check boxes of the users that you want to delete.
Step 6
Choose Delete User from the drop-down menu (right-hand side) and click GO.
Step 7
Click OK to confirm that you want to delete the selected users.
Changing User Properties
To change user properties, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to edit.
Step 3
Click Accounts (left).
Step 4
Click Users.
Step 5
Click the name of the group that you want to edit.
Step 6
Make the required changes to the Password, Group Name, and Permission fields.
Step 7
Click Save to apply your change.
Cisco Location Appliance Configuration Guide
5-4
OL-12449-01
Chapter 5
Managing Location Server Users and Groups
Managing Host Access
Viewing Active User Sessions
To view active user sessions, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server.
Step 3
Click Administration (left) to display the administrative configuration options.
Step 4
Click Active Sessions.
Cisco WCS displays a list of active location server sessions. For every session, Cisco WCS displays the
following information:
•
Session identifier
•
IP address from which the location server is accessed
•
Username of the connected user
•
Date and time when the session started
•
Date and time when the location server was last accessed
•
How long the session was idle for since the last access
Managing Host Access
This section describes how to add, delete, and edit host access records.
Adding Host Access
You can use Cisco WCS to add host access records to the location server database. Using host access
records, you can control which hosts have access to the location server and when. You can also control
access preference by assigning priorities to host access.
To add a new host access record, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to configure.
Step 3
Click Accounts (left).
Step 4
Click Host Access.
Step 5
Choose Add Host Access from the drop-down menu (right-hand side) and click GO.
Cisco Location Appliance Configuration Guide
OL-12449-01
5-5
Chapter 5
Managing Location Server Users and Groups
Managing Host Access
Step 6
Enter the IP address and netmask of the host using the ddd.ddd.ddd.ddd./dd format.
Following are examples of IP address and netmask entries:
Step 7
IP Address/Netmask
Description
120.10.0.0/8
Specifies hosts on a class A subnet (120.x.x.x).
120.10.0.0/16
Specifies hosts on a class B subnet (120.10.x.x).
120.10.223.0/16
Specifies hosts on a class C subnet (120.10.223.x).
120.10.223.10/32
Specifies a single host (120.10.223.10).
To allow host access, check the Enable check box of the Permit field.
To deny host access, uncheck the Enable check box.
Step 8
Enter a priority number from 0 to 99999 in the Priority field.
Hosts with high priority have access preference over hosts with low priority.
Step 9
Enter the time of day when the host may access the location server in the Start Access field.
In the Hrs. field, enter a value from 0 to 23. In the Mins field, enter a value from 0 to 59.
Step 10
Enter the time of day when host access ends.
In the Hrs. field, enter a value from 0 to 23. In the Mins field, enter a value from 0 to 59.
Step 11
Click Save to add the new host access to the location server.
Deleting Host Access
To delete a host access record, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to configure.
Step 3
Click Accounts (left).
Step 4
Click Users.
Step 5
Check the check boxes of the host access records that you want to delete.
Step 6
Choose Delete Host Access from the drop-down menu (right-hand side) and click GO.
Step 7
Click OK to confirm that you want to delete the selected host access records.
Cisco Location Appliance Configuration Guide
5-6
OL-12449-01
Chapter 5
Managing Location Server Users and Groups
Managing Host Access
Editing Host Access
To edit a host access record, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to configure.
Step 3
Click Accounts (left).
Step 4
Click Host Access.
Step 5
Click the name of the host access that you want to configure.
Step 6
Make the required changes to the Permit, Priority, Start Access, and End Access fields.
Step 7
Click Save to apply your changes.
Cisco Location Appliance Configuration Guide
OL-12449-01
5-7
Chapter 5
Managing Location Server Users and Groups
Managing Host Access
Cisco Location Appliance Configuration Guide
5-8
OL-12449-01
C H A P T E R
6
Configuring Event Notifications
Event notification is a feature that enables you to define conditions that cause the location server to send
notifications to the listeners that you have specified in Cisco WCS. This chapter describes how to define
events and event groups, and how to configure event notification parameters. It also describes how to
view event notification summaries.
This chapter contains the following sections:
•
“Working with Event Groups” section on page 6-2
•
“Working with Event Definitions” section on page 6-2
•
“Viewing Event Notification Summary” section on page 6-7
•
“Configuring Notification Parameters” section on page 6-8
•
“Notification Message Formats” section on page 6-9
Cisco Location Appliance Configuration Guide
OL-12449-01
6-1
Chapter 6
Configuring Event Notifications
Working with Event Groups
Working with Event Groups
This section describes how to add and delete event groups.
Adding Event Groups
To manage events more efficiently, you can use Cisco WCS to create event groups. Event groups help
you organize your event definitions.
To add an event group, follow these steps:
Step 1
In Cisco WCS, choose Location > Notifications.
Step 2
From the drop-down menu (right-hand side), choose Add Event Group, and click Go.
Step 3
Enter the name of the group in the Group Name field.
Step 4
Click Save.
The new event group appears in the Event Settings window.
Deleting Event Groups
To delete an event group, follow these steps:
Step 1
In Cisco WCS, choose Location > Notifications.
Step 2
Select the event group to delete by checking its corresponding check box.
Step 3
From the drop-down menu (right-hand side), choose Delete Event Group(s), and click Go.
Step 4
Click Save.
Working with Event Definitions
An event definition contains information about the condition that caused the event, the assets to which
the event applies, and the event notification destinations. This section describes how to add, delete, and
test event definitions.
Cisco Location Appliance Configuration Guide
6-2
OL-12449-01
Chapter 6
Configuring Event Notifications
Working with Event Definitions
Adding an Event Definition
Cisco WCS enables you to add definitions on a per-group basis. Any new event definition must belong
to a particular group.
To add an event definition, follow these steps:
Step 1
In Cisco WCS, choose Location > Notifications.
Step 2
Click Settings (left).
Step 3
Click the name of the group to which you want to add the event.
Step 4
From the Select a command drop-down menu (right-hand side), choose Add Event Definition and click
Go.
Step 5
Enter the name of the event definition in the Event Definition Name field.
The event definition name must be unique within the event group.
Note
Step 6
Click Save.
Step 7
In the Conditions tab, add one or more conditions. For each condition you add, specify the rules for
triggering events notifications.
For example, to keep track of heart monitors in a hospital, you can add three rules to generate an event
notification if the heart monitor is missing for two hours, if the heart monitor moves out of the second
floor, or if the heart monitor enters a specific coverage area within a floor.
To add a condition, follow these steps:
a.
Click Add to add a condition that triggers this event.
b.
In the Add/Edit Condition dialog box, follow these steps:
1.
Choose a condition type from the Condition Type drop-down menu.
2.
In the Trigger If field, follow these steps:
If you chose Missing from the Condition Type drop-down menu, enter the number of minutes
after which a missing asset event is generated. For example, if you enter 10 in this field, the
location server generates a missing asset event if the location server has not located the asset
for more than 10 minutes. Proceed to Step c.
If you chose In/Out from the Condition Type drop-down menu, select Inside of or Outside of,
then click Select Area to select the area to monitor for assets going into it or out of it. In the
Select dialog box, choose the area to monitor, then click Select. The area to monitor could be
an entire campus, building within a campus, a floor in a building, or a coverage area (you can
define a coverage area using the map editor). For example, to monitor part of a floor in a
building, choose a campus from the Campus drop-down menu, choose a building from the
Building drop-down menu, and choose the area to monitor from the Floor Area drop-down
menu. Then click Select. Proceed to Step c.
If you chose Distance from the Condition Type drop-down menu, enter the distance in feet that
will trigger an event notification if the monitored asset moves beyond the specified distance
from a designated marker, then click Select Marker. In the Select dialog box, select the campus,
building, floor, and marker from the corresponding drop-down menus and click Select. For
example, if you add a marker to a floor plan and set the distance in the Trigger If field to 60 feet,
an event notification will be generated if the monitored asset moves 73 feet away from the
marker. Proceed to Step c.
Cisco Location Appliance Configuration Guide
OL-12449-01
6-3
Chapter 6
Configuring Event Notifications
Working with Event Definitions
Note
You can create markers and coverage areas using the Map Editor. When you create
marker names, make sure they are unique across the entire system.
If you chose Location Change from the Condition Type drop-down menu, proceed to Step c.
If you chose Battery Level from the Condition Type drop-down menu, check the box next to
the appropriate battery level (low, medium, normal) that will trigger an event. Proceed to Step c.
If you chose Emergency from the Condition Type drop-down menu, click the button next to the
appropriate emergency (any, panic button, tampering, detached, unknown) that will trigger an
event. Proceed to Step c.
If you chose Chokepoint from the Condition Type drop-down menu, proceed to Step c. There
is only one trigger condition and it is displayed by default. No configuration required.
c.
From the Apply To drop-down menu, choose the type of asset (Any, Clients, Tags, Rogue APs, or
Rogue Clients) for which an event will be generated if the trigger condition is met.
Note
d.
Emergency and chokepoint events are only applicable to tags (CCXv.1 compliant).
From the Match By drop-down menu, choose the matching criteria (Asset Name, Asset Group, Asset
Category or MAC Address), the operator (Equals or Like) from the drop-down menu, and enter the
relevant text for the selected Match By element.
Following are examples of asset matching criteria that you can specify:
– If you choose MAC Address from the Match By drop-down menu, choose Equals from the
Operator drop-down menu, and enter 12:12:12:12:12:12, the event condition applies to the
element whose MAC address is 12:12:12:12:12:12 (exact match).
– If you choose MAC Address from the Match By drop-down menu, choose Like from the
Operator drop-down menu, and enter 12:12, the event condition applies to elements whose
MAC address starts with 12:12.
e.
Note
Click Add to add the condition you have just defined.
For chokepoints you must select the chokepoint after you add the condition. To select a chokepoint, do
the following:
•
Click Select Chokepoint. An entry panel appears.
•
Select Campus, Building and Floor from the appropriate drop-down menus.
•
Select a Chokepoint from the menu that appears.
You are returned to the Add/Edit Condition panel and the location path (Campus > Building >
Floor) for the chokepoint auto-populates the field next to the Select Checkpoint button.
Step 8
Under the General tab, follow these steps:
a.
Enable event generation (disabled by default) by checking the Enabled check box for the Admin
Status field.
b.
Set the event priority by choosing a number from the Priority drop-down menu. Zero is highest.
Cisco Location Appliance Configuration Guide
6-4
OL-12449-01
Chapter 6
Configuring Event Notifications
Working with Event Definitions
Note
c.
Select the day(s) of the week you want to activate event notification by checking the box next to the
day(s).
Note
Step 9
An event definition with higher priority is serviced before event definitions with lower priority.
If you want to continuously report events, select the All the Time option. In this case, there is
no need to set start and end ranges for event notification. These options are not displayed.
d.
Select the time for starting the event notification by selecting the appropriate hour, minute and
AM/PM options from the Apply From heading.
e.
Select the time for ending the event notification by selecting the appropriate hour, minute and
AM/PM options from the Apply Until heading.
f.
Click Save.
In the Destination and Transport tab, follow these steps to add one or more destinations to receive event
notifications and configure the transport settings:
a.
To add a new destination, click Add New.
b.
Enter the IP address of the system that will receive event notifications, and click OK.
The recipient system must have an event listener running to process notifications. By default, when
you create an event definition, Cisco WCS adds its IP address as the a destination.
c.
To select a destination to send event notifications to, highlight one or more IP addresses in the box
on the right, and click Select to add the IP addresses to the box on the left.
d.
In the Message Format field, select XML or Plain Text to specify the message format.
If you select WCS as the destination of event notifications, you must select the XML format.
e.
Choose one of the following transport types from the Transport Type drop-down menu:
– SOAP—Specifies Simple Object Access Protocol, a simple XML protocol, as the transport type
for sending event notifications. Use SOAP to send notifications over HTTP/HTTPS and to be
processed by web services on the destination.
If you choose SOAP, specify whether to send notifications over HTTPS by checking its
corresponding check box. If you don’t, HTTP is used. Also, enter the destination port number
in the Port Number field.
– Mail—Use this option to send notifications via email.
If you choose Mail, you need to choose the protocol for sending the mail from the Mail Type
drop-down menu. You also need to enter the following information: username and password (if
Authentication is enabled), name of the sender, prefix to add to the subject line, email address
of recipient, and a port number if necessary.
– SNMP—Use Simple Network Management Protocol, a very common technology for network
monitoring used to send notifications to SNMP-capable devices.
If you choose SNMP, enter the SNMP community string in the SNMP Community field and the
port number to send notifications to in the Port Number field.
– SysLog—Specifies the system log on the destination system as the recipient of event
notifications.
If you choose SysLog, enter the notification priority in the Priority field, the name of the facility
in the Facility field, and the port number on the destination system in the Port Number field.
Cisco Location Appliance Configuration Guide
OL-12449-01
6-5
Chapter 6
Configuring Event Notifications
Working with Event Definitions
Step 10
f.
To enable HTTPS, check the Enable check box next to it.
g.
Port Number auto-populates when HTTPS is enabled.
h.
Click Add.
Verify that the new event definition is listed for the event group (Location > Notifications > Event >
Settings > Event Group Name).
Deleting an Event Definition
To delete one or more event definitions from WCS, follow these steps:
Step 1
In Cisco WCS, choose Location > Notifications.
Step 2
Click Settings (left).
Step 3
Click the name of the group from which you want to delete the event definitions.
Step 4
Select the event definition that you want to delete by checking its corresponding check box.
Step 5
From the Select a command drop-down menu (right-hand side), choose Delete Event Definition(s), and
click Go.
Step 6
Click OK to confirm that you want to delete the selected event definitions.
Note
Deleting event definitions as described above removes them from only WCS. You must also remove the
definitions from the location server.
To remove definitions from the location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Synchronize Servers.
Step 2
From the Synchronize drop-down menu, choose Event Groups.
Step 3
To remove an event definition, click Unassign for the event group to which the event belongs.
Step 4
Click Synchronize.
Testing Event Definitions
To verify that the location server is sending event definitions over the transport protocol you have
specified in the event definition, use Cisco WCS to test-fire event notifications. The location server
sends three fictitious event notifications (absence, containment, and distance) to the destinations you
have specified in the event definition. The messages contain dummy MAC addresses.
Note
Emergency and chokepoint event notifications are not test-fired.
Cisco Location Appliance Configuration Guide
6-6
OL-12449-01
Chapter 6
Configuring Event Notifications
Viewing Event Notification Summary
To test one or more event definitions, follow these steps:
Step 1
In Cisco WCS, choose Location > Notifications.
Step 2
Click Settings (left).
Step 3
Click the name of the group containing the event definitions that you want to test.
Step 4
Select the event definitions that you want to test by checking their corresponding check boxes.
Step 5
From the drop-down menu (right-hand side), choose Test-Fire Event Definition(s), and click GO.
Step 6
Click OK to confirm that you want to test-fire event notifications.
Step 7
Check to make sure that notifications were sent to the designated recipient.
Viewing Event Notification Summary
The location server sends event notifications and does not store them (fire and forget). However, if WCS
is a destination of notification events, it stores the notifications it receives and groups them into the
following seven categories:
•
Absence (Missing)—The location server generates absence events when the monitored assets go
missing. In other words, the location server cannot see the asset in the WLAN for the specified time.
•
In/Out Area (Containment)—The location server generates containment events when an asset is
moved inside or outside a designated area.
Note
Note
You define a containment area (campus, building, or floor) in the Maps section of Cisco
WCS (Monitor > Maps). You can define a coverage area using the Map Editor.
•
Movement from Marker (Movement/Distance)—The location server generates movement events
when an asset is moved beyond a specified distance from a designated marker you define on a map.
•
Location Changes—The location server generates location change events when client stations, asset
tags, rogue clients and rogue access points move from their previous location.
•
Battery Level—The location server generates battery level events for all tracked asset tags.
•
Emergency—The location server generates an emergency event for a CCX v.1 compliant asset tag
when the tag’s panic button is triggered or the tag becomes detached, tampered with, goes inactive
or reports an unknown state. This information is only reported and displayed for CCX v.1 compliant
tags.
•
Chokepoint Notifications—The location server generates an event when a tag is seen (stimulated)
by a chokepoint. This information is only reported and displayed for CCX v.1 compliant tags.
All element events are summarized hourly and daily.
Cisco Location Appliance Configuration Guide
OL-12449-01
6-7
Chapter 6
Configuring Event Notifications
Notifications Cleared
To view event notifications, follow these steps:
Step 1
In Cisco WCS, choose Location > Notifications.
Cisco WCS displays a summary of event notifications for each of the seven event notification categories.
Note
Step 2
Emergency and chokepoint notifications are only reported and displayed for CCX v.1 compliant
tags.
To view event notifications for a monitored asset, click one of its corresponding links.
For example, to view absence events for client stations generated in the last hour, click the link in the
Last Hour column for the Client Stations entry in the Absence (Missing) list.
Clicking one of these links searches for location notifications of all severities.
Notifications Cleared
A location server sends event notifications when it clears an event condition in one of the following
scenarios:
Note
•
Missing (Absence)—Elements reappear.
•
In/Out Area (Containment)—Elements move back in or out of the containment area.
•
Distance—Elements move back within the specified distance from a marker.
•
Location Changes—Clear state is not applicable to this condition.
•
Battery Level—Tags are detected again operating with Normal battery level.
In Cisco WCS, the Notifications Summary window reflects whether notifications for cleared event
conditions have been received.
Configuring Notification Parameters
Note
Tweak notification parameters only if you expect the location server to send a large number of
notifications or if notifications are not being received.
You can use Cisco WCS to configure location server event notification parameters.
To configure notification parameters, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server you want to configure.
Step 3
Click Administration (left) to display the administrative configuration options.
Step 4
Click Notification Parameters. the parameters and their definitions are listed in Table 6-1.
Cisco Location Appliance Configuration Guide
6-8
OL-12449-01
Chapter 6
Configuring Event Notifications
Notification Message Formats
Table 6-1
Notification Parameters:
Parameter
Description
Rate Limit
Enter the rate in milliseconds at which the location server will generate
notifications. A value of 0 (default) means that the server will generate event
notifications as fast as possible.
Queue Limit
The event queue limit for sending notifications. The server will drop any event
above this limit. Default value is 500.
Retry Limit
Enter the number of times to generate an event notification before the refresh time
expires. This value ensures, to some extent, that the events that the location server
generated will eventually reach WCS. Default value is 1.
Note
Step 5
The location server does not store events in its database. It just fires events
and forgets about them (fire and forget).
Refresh Time
Enter the wait time in minutes before restarting the event refresh cycle if an event
notification needs to be resent. For example, suppose you enter 30 in this field. If
a monitored element goes out of a specified area, the location server sends an event
notification. Then, until the event is cleared, the location server resends event
notifications every 30 minutes.
Notifications
Dropped
(Read only). The number of event notifications dropped from the queue since
startup.
Click Save to store your updates in the Cisco WCS and location server databases.
Notification Message Formats
This section describes the notification message formats.
Notification Formats in XML
This section describes the XML format of notification messages.
Note
The XML format is part of a supported API and Cisco will provide change notification as part of the
Location Server API program, whenever the API is updated in the future.
Cisco Location Appliance Configuration Guide
OL-12449-01
6-9
Chapter 6
Configuring Event Notifications
Notification Message Formats
Missing (Absence) Condition
Message format for element absence:
<AbsenceTrackEvent
missingFor="<time in secs entity has been missing>"
lastSeen="time last seen"
trackDefn="<name of track definition>"
entityType="Mobile Station | Tag | Rogue AP | Rogue Client"
entityID="<mac address"/>
Message format for the clear state:
<AbsenceTrackEvent
state="clear"
trackDefn="<name of track definition>"
entityType="Mobile Station | Tag | Rogue AP | Rogue Client"
entityID="<mac address"/>
Following are examples:
<AbsenceTrackEvent state="set" missingFor="34" lastSeen="15:00:20 28 May 2006"
trackDefn="absenceDef1" entityType="Mobile Station"
entityID="00:0c:f1:53:9e:c0"/>
<AbsenceTrackEvent state="clear" entityType="Tag"
trackDefn="absenceDef1" entityID="00:0c:cc:5b:fc:da"/>
In/Out (Containment) Condition
Message format for element containment:
<ContainmentTrackEvent
in="true | false"
trackDefn="<name of track definition>"
containerType="Floor | Area | Network Design | Building"
containerID="<fully quality name of container>"
entityType="Mobile Station | Tag | Rogue AP | Rogue Client"
entityID="<mac address"/>
Message format for the clear state:
<ContainmentTrackEvent
state="clear"
trackDefn="<name of track definition>"
entityType="Mobile Station | Tag | Rogue AP | Rogue Client"
entityID="<mac address"/>
Following are examples:
<ContainmentTrackEvent in="true" trackDefn="myContainerRule1"
containerType="Area"
containerID="wcsDevArea,4th Floor,Bldg-14,WNBU_Group,WNBU,"
entityType="Tag" entityID="00:0c:cc:5b:fa:44"/>
Note
The containerID string represents a coverage area called wcsDevArea, located in the floor 4th
floor of Bldg-14 of the campus WNBU.
<ContainmentTrackEvent state="clear" entityType="Tag"
trackDefn="myContainerRule1" entityID="00:0c:cc:5b:f8:ab"/>
Cisco Location Appliance Configuration Guide
6-10
OL-12449-01
Chapter 6
Configuring Event Notifications
Notification Message Formats
Distance Condition
Message format for elements in the same floor:
<MovementTrackEvent
distance="<distance in feet at which the
triggerDistance="<the distance specified
reference="<name of the marker specified
trackDefn="<name of event definition>"
entityType="Mobile Station | Tag | Rogue
entityID="<mac address"/>
element was located>"
on the condition"
on the condition>"
AP | Rogue Client"
Message format for elements located in a different floor:
<MovementTrackEvent optionMsg="has moved beyond original floor"
reference="<name of the marker specified on the condition>"
trackDefn="<name of event definition>"
entityType="Mobile Station | Tag | Rogue AP | Rogue Client"
entityID="<mac address"/>
Message format for clear state:
<MovementTrackEvent
state="clear"
trackDefn="<name of event definition>"
entityType="Mobile Station | Tag | Rogue AP | Rogue Client"
entityID="<mac address"/>
Following are examples:
<MovementTrackEvent distance="115.73819627990147" triggerDistance="60.0"
reference="marker2" trackDefn="distance2" entityType="Mobile Station"
entityID="00:0c:41:15:99:92"/>
<MovementTrackEvent optionMsg="has moved beyond original floor"
reference="marker2" entityType="Tag"
trackDefn="distance2"
entityID="00:0c:cc:5b:fa:4c"/>
<MovementTrackEvent state="clear" entityType="Tag"
Battery Level
An example:
<BatteryLifeTrackEvent lastSeen="10:28:52 23 May 2006" batteryStatus="medium"
trackDefn="defn1" entityType="Tag" entityID="00:01:02:03:04:06"/>
Location Change
An example:
<MovementTrackEvent distance="158.11388300841898" triggerDistance="5.0"
reference="marker1" referenceObjectID="1" trackDefn="defn1" entityType="Mobile Station"
entityID="00:01:02:03:04:05"/>
Cisco Location Appliance Configuration Guide
OL-12449-01
6-11
Chapter 6
Configuring Event Notifications
Notification Message Formats
Chokepoint Condition
Message format for element location.
An example:
<ChokepointTrackEvent
lastSeen="11:10:08 PST 18 Jan 2007"
chokepointMac=“00:0c:cc:60:13:a3”
chokepointName= “chokeA3”
trackDefn=“choke"
entityType="Tag"
entityID="00:12:b8:00:20:4f”/>
Message format for the clear state.
An example:
<ChokepointTrackEvent
state="clear"
entityType="Tag"
trackDefn="choke"
entityID=”00:12:b8:00:20:4f”/>
Emergency Condition
Message format for element location.
An example:
<ChokepointTrackEvent
lastSeen=”11:36:46 PST Jan 18 2007"
emergencyReason= “detached”
trackDefn="emer"
entityType="Tag"
entityID=”00:12:b8:00:20:50”/>
Note
Emergency events are never cleared by location based services.
Notification Formats in Text
When you specify that notification be sent in Text format, the location server uses a plain-text string to
indicate the condition. Following are examples:
Tag 00:02:02:03:03:04 is in Floor <floorName>
Tag 00:02:02:03:03:04 is outside Floor <floorName>
Client 00:02:02:03:09:09 is in Area <areaName>
RogueClient 00:02:02:08:08:08 is outside Building <buildingName>
Tag 00:02:02:03:03:06 has moved 105 feet where the trigger distance was 90 feet.
Tag 00:02:02:03:03:20 missing for 14 mins, last seen <timestamp>.
Note
Cisco maintains the right to modify the Text notification Format, without notice, at any time in the
future.
Cisco Location Appliance Configuration Guide
6-12
OL-12449-01
Chapter 6
Configuring Event Notifications
Notification Message Formats
Note
XML is the recommended format if systems need to parse or analyze the notification contents.
WCS as a Notification Listener
WCS acts as a notification listener. WCS receives the notifications from location servers in the form of
the trap locationNotifyTrap as part of the MIB file bsnwras.my. The location server stores the content
of the notification message in XML format in the variable locationNotifyContent (see “Notification
Formats in XML” section on page 6-9).
locationNotifyTrap NOTIFICATION-TYPE
OBJECTS { locationNotifyContent}
STATUS current
DESCRIPTION
"This trap will be generated by the location server
for notifications of location events."
::= { bsnTraps 89 }
locationNotifyContent OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(0..512))
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"This is the content of the notification."
::= { bsnTrapVariable 72 }
WCS translates the traps into UI alerts and displays them in the following formats:
•
Missing (Absence)
Absence of Tag with MAC 00:0c:cc:5b:e4:1b, last seen at 16:19:45 13 Oct 2005.
•
In/Out (Containment)
Tag with MAC 00:0c:cc:5b:fa:44 is In the Area 'WNBU > WNBU > 4th Floor > wcsDevArea'
•
Distance
Tag with MAC 00:0c:cc:5b:fa:47 has moved beyond the distance configured for the marker
'marker2'.
Tag with MAC 00:0c:cc:5b:f9:b9 has moved beyond 46.0 ft. of marker 'marker2', located
at a range of 136.74526528595058 ft.
•
Battery Level
Tag 00:01:02:03:04:06 has medium battery, last seen 11:06:01 23 May 2006
•
Location Change
Mobile Station 00:01:02:03:04:05 has moved
158.11388300841898ft, where the trigger distance was 5.0
Cisco Location Appliance Configuration Guide
OL-12449-01
6-13
Chapter 6
Configuring Event Notifications
Notification Message Formats
Cisco Location Appliance Configuration Guide
6-14
OL-12449-01
C H A P T E R
7
Location Planning and Verification
This chapter describes how to plan access point deployment based on applications employed.
You can check the ability of an existing access point deployment to estimate the true location of an
element within 10 meters at least 90% of the time using a location readiness calculation based on the
number and placement of access points.
Details on using calibration data to examine location quality, as an alternative to using the location
readiness calculation, are also described.
Additionally, details on analyzing the location accuracy of non-rogue and rogue clients and asset tags
using testpoints on an area or floor map; and, using chokepoints to enhance location accuracy for tags
are described.
This chapter contains the following sections:
•
“Deployment Planning for Data, Voice, and Location” section on page 7-2
•
“Inspecting Location Readiness and Quality” section on page 7-3
•
“Analyzing Element Location Accuracy Using Testpoints” section on page 7-4
•
“Using Chokepoints to Enhance Tag Location Reporting” section on page 7-8
Cisco Location Appliance Configuration Guide
OL-12449-01
7-1
Chapter 7
Location Planning and Verification
Deployment Planning for Data, Voice, and Location
Deployment Planning for Data, Voice, and Location
You can calculate the recommended number and location of access points based on whether data and/or
voice traffic and/or location will be active.
To calculate recommended number and placement of access points for a given deployment, follow these
steps:
Step 1
In Cisco WCS, choose Monitor > Maps.
Step 2
Click on the appropriate location link from the list that displays.
A map appears showing placement of all installed elements (access points, clients, tags) and their
relative signal strength.
Step 3
Select Planning Mode from the menu found at the top-right of the window. Click GO.
A color-coded map summarizing contributing access points appears.
Step 4
Click Add APs to open a window to enter data necessary to calculate the recommended number of access
points.
Step 5
In the window that appears, drag the dashed rectangle over the map location for which you want to
calculate the recommended access points.
Note
Step 6
Adjust the size or placement of the rectangle by selecting the edge of the rectangle and holding
down the Ctrl key. Move the mouse as necessary to outline the targeted location.
Check the check box next to the service that will be used on the floor. Options are Data/Coverage
(default), Voice and Location. Click Calculate.
The recommended number of access points given the services requested appears.
Step 7
Note
Each service option is inclusive of all services that are listed above it. For example, if you check
the Location box, the calculation will consider data/coverage, voice and location in determining
the optimum number of access points required.
Note
Recommended calculations assume the need for consistently strong signals. In some cases,
fewer access points may be required than recommended.
Click Apply to generate a map based on the recommendations to see recommended placement of the
access points in the selected area.
Note
Check the Location services option to ensure that the recommended access points will provide
the true location of an element within 10 meters at least 90% of the time.
Cisco Location Appliance Configuration Guide
7-2
OL-12449-01
Chapter 7
Location Planning and Verification
Inspecting Location Readiness and Quality
Note
If Cisco WCS is managing a controller, then all access points that join that controller should be mapped
by Cisco WCS. If not, data collected by the location appliance might not be accurate. To add access
points to maps, refer to the “Adding Access Points” and “Creating a Network Design” sections in
Chapter 5 of the Cisco Wireless Control System Configuration Guide, Release 4.0.
Inspecting Location Readiness and Quality
You can configure Cisco WCS to verify the ability of the existing access point deployment to estimate
the true location of an element within 10 meters at least 90% of the time. The location readiness
calculation is based on the number and placement of access points.
You can also check the location quality and the ability of a given location to meet the location
specification (10 m, 90%) based on data points gathered during a physical inspection and calibration.
Inspecting Location Readiness Using Access Point Data
To inspect location readiness using access point data, follow these steps:
Step 1
In Cisco WCS, choose Monitor > Maps.
Step 2
Click on the appropriate floor location link from the list that displays.
A map displays showing placement of all installed elements (access points, clients, tags) and their
relative signal strength.
Note
Step 3
If RSSI is not displayed, you can enable AP Heatmaps under the Layer menu (top-left).
Select Inspect Location Readiness from the Select a command menu found at the top-right of the
window. Click GO.
A color-coded map appears showing those areas that do (Yes) and do not (No) meet the 10 meter, 90%
location specification.
Inspecting Location Quality Using Calibration Data
After completing a calibration model based on data points generated during a physical tour of the area,
you can inspect the location quality of the access points. To inspect location quality based on calibration,
follow these steps:
Step 1
In Cisco WCS, choose Monitor > Maps.
Step 2
Choose RF Calibration Model from the menu found at the top-right of the window. Click GO.
A list of calibration models appears.
Step 3
Click the appropriate calibration model.
Cisco Location Appliance Configuration Guide
OL-12449-01
7-3
Chapter 7
Location Planning and Verification
Analyzing Element Location Accuracy Using Testpoints
Details on the calibration including date of last calibration, number of data points by signal type
(802.11a, 802.11 b/g) used in the calibration, location, and coverage are displayed.
Step 4
At the same window, click the Inspect Location Quality link found under the Calibration Floors
heading.
A color-coded map noting percentage of location errors appears.
Note
You can modify the distance selected to see the effect on the location errors.
Analyzing Element Location Accuracy Using Testpoints
You can analyze the location accuracy of non-rogue and rogue clients and asset tags by entering
testpoints on an area or floor map. You can use this feature to validate location information generated
either automatically by access points or manually by calibration.
Note
By checking for location accuracy, you are checking the ability of the existing access point deployment
to estimate the true location of an element within 10 meters at least 90% of the time.
Note
Before starting this process, be sure to have the MAC addresses and locations for all elements within the
area or floor to be analyzed. You need this information when placing the testpoints on the map. If
analyzing location after calibration, you should analyze the location accuracy of at least as many
elements entered during calibration.
Note
The Advanced Debug option must be enabled on both the location appliance and WCS to allow use of
the location accuracy testpoint feature.
To enable the advanced debug option and to assign testpoints to a floor map to check location accuracy,
follow these steps:
Step 1
Choose Location > Location Servers.
Step 2
Select a location server from the All Location Servers window that appears.
Step 3
Select Advanced Parameters from the Advanced menu of the Location Server General Properties
window (Figure 7-1).
Cisco Location Appliance Configuration Guide
7-4
OL-12449-01
Chapter 7
Location Planning and Verification
Analyzing Element Location Accuracy Using Testpoints
Figure 7-1
Step 4
At the window that appears, scroll down to the Advanced Parameters section (Figure 7-2).
Figure 7-2
Step 5
Location Server General Properties Window
Location Server > Advanced Parameters Window
Check the Advanced Debug box to enable the feature. Click Save.
Note
If the Advanced Debug check box is already checked, you do not need to do anything further.
Click Cancel.
You now must enable the Advanced debug level at the Maps level.
Cisco Location Appliance Configuration Guide
OL-12449-01
7-5
Chapter 7
Location Planning and Verification
Analyzing Element Location Accuracy Using Testpoints
Step 6
Choose Monitor > Maps (Figure 7-3)
Figure 7-3
Step 7
Monitor > Maps Window
Select Properties from the Select a command drop-down menu. Click GO.
The Maps > Properties window appears (Figure 7-4).
Figure 7-4
Step 8
Maps > Properties Window
Select Enable from the Advanced Debug drop-down menu. Click OK.
You are returned to the Maps summary window. You are now ready to assign testpoints to a selected area
or map.
Cisco Location Appliance Configuration Guide
7-6
OL-12449-01
Chapter 7
Location Planning and Verification
Analyzing Element Location Accuracy Using Testpoints
Step 9
Choose Monitor > Maps. Select the area or floor you want to analyze from the map summary that
appears.
The selected area or floor appears (Figure 7-5).
Figure 7-5
Step 10
Selected Area or Floor Map Chosen at Monitor > Maps Window
Select Position TestPoint from the Select a command drop-down menu (top-right). Click GO.
A blank map of the selected area or floor appears for testpoint assignment (Figure 7-6).
Cisco Location Appliance Configuration Guide
OL-12449-01
7-7
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Figure 7-6
Step 11
Move the red cross hair cursor (top-left) to the map location that corresponds to the element.
Note
Step 12
Position TestPoint Assignment Window
Instead of using the cursor, you can enter the horizontal (Horz) and vertical (Vert) coordinates
of the asset tag or client to mark its location.
Select the MAC Address (MAC Addr) associated with that element from the drop-down menu. Click
Preview to verify location. Click Save to finalize placement.
A pop up box appears confirming addition of the testpoint.
The red cross hair cursor returns to the upper left hand corner after placement is confirmed. You are
ready to mark additional testpoints.
Step 13
Repeat steps 11 and 12 for each client or asset tag testpoint you want to add to the map.
Step 14
Click Analyze to determine location accuracy of the entered testpoints.
A pop up window appears providing accuracy information.
Using Chokepoints to Enhance Tag Location Reporting
Installing chokepoints provides enhanced location information for active RFID tags. When an active
CCX version 1 compliant RFID tag enters the range of a chokepoint, it is stimulated by the chokepoint.
The MAC address of this chokepoint is then included in the next beacon sent by the stimulated tag. All
access points that detect this tag beacon then forward the information to the controller and location
appliance.
Cisco Location Appliance Configuration Guide
7-8
OL-12449-01
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Using chokepoints in conjunction with active CCX compliant tags provides immediate location
information on a tag and its asset. When a CCX tag moves out of the range of a chokepoint, its
subsequent beacon frames do not contain any identifying chokepoint information. Location
determination of the tag defaults to the standard calculation methods based on RSSIs reported by access
point associated with the tag.
Adding Chokepoints to the WCS Database and Map
Chokepoints are installed and configured as recommended by the Chokepoint vendor. When the
chokepoint is installed and operational, you can add the chokepoint to the location database and
positioned on a Cisco WCS map.
Note
Chokepoints are managed by the chokepoint vendor’s application.
To add a chokepoint to the WCS database and appropriate map, follow these steps:
Step 1
Choose Configure > Chokepoints from the main menu (top).
The All Chokepoints summary window appears (Figure 7-7).
Figure 7-7
Step 2
All Chokepoints Summary Window
Select Add Chokepoint from the Select a command menu (Figure 7-8). Click GO.
The Add Chokepoint entry screen appears.
Cisco Location Appliance Configuration Guide
OL-12449-01
7-9
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Figure 7-8
Step 3
Enter the MAC address, name, and coverage range for the chokepoint.
Note
Step 4
Add Chokepoint Window
The chokepoint range is product-specific and is supplied by the chokepoint vendor.
Click OK to save the chokepoint entry to the database.
The All Chokepoints summary window appears with the new chokepoint entry listed (Figure 7-9).
Figure 7-9
Note
Step 5
All Chokepoints Summary Window
After you add the chokepoint to the database, you can place the chokepoint on the appropriate
WCS floor map.
To add the chokepoint to a map, choose Monitor > Maps (Figure 7-10).
Cisco Location Appliance Configuration Guide
7-10
OL-12449-01
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Figure 7-10
Step 6
At the Maps window, select the link that corresponds to the floor location of the chokepoint. The floor
map appears (Figure 7-11).
Figure 7-11
Step 7
Monitor > Maps Window
Selected Floor Map
Select Add Chokepoints from the Select a command menu. Click GO.
The Add Chokepoints summary window appears (Figure 7-12).
Cisco Location Appliance Configuration Guide
OL-12449-01
7-11
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Note
The Add Chokepoints summary window lists all recently-added chokepoints that are in the
database but not yet mapped.
Figure 7-12
Step 8
Add Chokepoints Summary Window
Check the box next to the chokepoint to be added to the map. Click OK.
A map appears with a chokepoint icon located in the top-left hand corner (Figure 7-13). You are now
ready to place the chokepoint on the map.
Cisco Location Appliance Configuration Guide
7-12
OL-12449-01
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Figure 7-13
Step 9
Left click on the chokepoint icon and drag and place it in the proper location (Figure 7-14).
Figure 7-14
Note
Map for Positioning Chokepoint
Chokepoint Icon is Positioned on the Floor Map
The MAC address, name, and coverage range of the chokepoint appear in the left panel when you click
on the chokepoint icon for placement.
Cisco Location Appliance Configuration Guide
OL-12449-01
7-13
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Step 10
Click Save when icon is correctly placed on the map.
You are returned to the floor map and the added chokepoint appears on the map (Figure 7-15).
Note
The icon for the newly added chokepoint may or may not appear on the map depending on the
display settings for that floor. If the icon did not appear, proceed with Step 11.
Figure 7-15
Step 11
New Chokepoint Displayed on Floor Map
Note
The rings around the chokepoint icon indicate the coverage area. When a CCX tag and its asset
passes within the coverage area, location details are broadcast and the tag is automatically
mapped on the chokepoint coverage circle. When the tag moves out of the chokepoint range, its
location is calculated as before and it is no longer mapped on the chokepoint rings. In
Figure 7-15, the tag is currently out of range of the chokepoint.
Note
MAC address, name, and range of a chokepoint display when you pass a mouse over its map icon
If the chokepoint does not appear on the map, click Layers to collapse a selection menu of possible
elements to display on the map. Click the Chokepoints check box.
The chokepoint appears on the map (Figure 7-16).
Cisco Location Appliance Configuration Guide
7-14
OL-12449-01
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Figure 7-16
Step 12
Chokepoints Displayed on Map
Click X to close the Layers window.
Note
Do not select Save Settings unless you want to save this display criteria for all maps.
Removing Chokepoints from the WCS Database and Map
You can remove one or multiple chokepoints at a time.
Follow these steps to delete a chokepoint.
Step 1
Choose Configure > Chokepoints. The All Chokepoints window appears.
Step 2
Check the box(es) next to the chokepoint(s) to be deleted.
Step 3
Select Remove Chokepoints from the Select a command drop-down menu. Click GO (Figure 7-17).
Cisco Location Appliance Configuration Guide
OL-12449-01
7-15
Chapter 7
Location Planning and Verification
Using Chokepoints to Enhance Tag Location Reporting
Figure 7-17
Step 4
Removing a Chokepoint
To confirm chokepoint deletion, click OK in the pop-up window that appears.
You are returned to the All Chokepoints window. A message confirming deletion of the chokepoint
appears. The deleted chokepoint(s) is no longer listed in the window.
Cisco Location Appliance Configuration Guide
7-16
OL-12449-01
C H A P T E R
8
Monitoring Location Servers and Site
This chapter describes how to monitor location servers by configuring and viewing alarms, events, and
logs.
It also describes how to use Cisco WCS to view location server, client and asset tag status.
This chapter contains the following sections:
•
“Working with Alarms” section on page 8-2
•
“Working with Events” section on page 8-5
•
“Working with Logs” section on page 8-6
•
“Generating Reports” section on page 8-7
•
“Monitoring Location Server Status” section on page 8-10
•
“Monitoring Clients” section on page 8-11
•
“Monitoring Tagged Assets” section on page 8-11
Cisco Location Appliance Configuration Guide
OL-12449-01
8-1
Chapter 8
Monitoring Location Servers and Site
Working with Alarms
Working with Alarms
This section describes how to view, assign, and clear alarms and events on location servers using
Cisco WCS. Details on how to have email notifications for alarms sent to you is described as well as
how to define those types (all, critical, major, minor, warning) of alarm notifications that are sent to you.
Viewing Alarms
To view location server alarms, follow these steps:
Step 1
In Cisco WCS, choose Monitor > Alarms.
Step 2
Click New Search. A configurable search panel for alarms appears (Figure 8-1).
Figure 8-1
Search Alarm Panel
Step 3
Select the Severity of Alarms to display. Options are All Severities, Critical, Major, Minor or Warning.
Step 4
Select Location Servers from the Alarm Category.
Options are: All Types, Access Points, Controller, Coverage Holes, Location Notifications, Location
Servers, Interference, Mesh Links, Rogue AP, Security and WCS.
Step 5
Select the time frame for which you want to review alarms by selection the appropriate option from the
Time Period drop-down menu.
Options range from minutes (5, 15 and30) to hours (1and8) to days (1 and 7). To display all select Any
time.
Step 6
To save the search criteria for later use, check the Save Search box and enter a name for the search.
Step 7
Select the number of alarms to display on each window from the Items per Page drop-down menu
Step 8
Click GO. Alarms summary panel appears with search results.
Cisco Location Appliance Configuration Guide
8-2
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Working with Alarms
Note
Click the column headings (Severity, Failure Object, Owner, Date/Time and Message) to sort
alarms.
Assigning and Unassigning Alarms
To assign and unassign an alarm to yourself, follow these steps:
Step 1
Display the Alarms window as described in the “Viewing Alarms” section on page 8-2.
Step 2
Select the alarms that you want to assign to yourself by checking their corresponding check boxes.
Note
Step 3
To unassign an alarm assigned to you, uncheck the box next to the appropriate alarm. You cannot
unassign alarms assigned to others.
From the Select a command drop-down menu, choose Assign to Me (or Unassign) and click GO.
If you choose Assign to Me, your username appears in the Owner column. If you choose Unassign, the
username column becomes empty.
Deleting and Clearing Alarms
To delete or clear an alarm from a location appliance, follow these steps:
Step 1
Display the Alarms window as described in the “Viewing Alarms” section on page 8-2.
Step 2
Select the alarms that you want to delete or clear by checking their corresponding check boxes.
Note
Step 3
If you delete an alarm, Cisco WCS removes it from its database. If you clear an alarm, it remains
in the Cisco WCS database, but in the Clear state. You clear an alarm when the condition that
caused it no longer exists.
From the Select a command drop-down menu, choose Delete or Clear, and click Go.
Cisco Location Appliance Configuration Guide
OL-12449-01
8-3
Chapter 8
Monitoring Location Servers and Site
Working with Alarms
Emailing Alarm Notifications
Cisco WCS lets you send alarm notifications to a specific email address. Sending notifications through
email enables you to take prompt action when needed.
You can select the alarm severity types (critical, major, minor and warning) that are emailed to you.
To send alarm notifications, follow these steps:
Step 1
Display the Alarms window as described in the “Viewing Alarms” section on page 8-2.
Step 2
From the Select a commands drop-down menu, choose Email Notification, and click GO. The Email
Notification window appears.
Figure 8-2
Note
All Alarms > Email Notification Window
A SMTP Mail Server must be defined prior to entry of target email addresses for email
notification. Choose Administrator > Settings > Mail Server to enter the appropriate
information. You can also select the Administration > Mail Server link, if displayed, on the
Email Notification window noted above.
Step 3
Click the Enabled box next to the Location Servers.
Step 4
Click the Location Servers link. The panel for configuring the alarm severity types (critical, major,
minor and warning) that are reported for the location servers appears.
Step 5
Check box(es) next to all the alarm severity types for which you want email notifications sent.
Step 6
In the To field, enter the email address or addresses to which you want the email notifications sent. Each
email address should be separated by commas.
Cisco Location Appliance Configuration Guide
8-4
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Working with Events
Step 7
Click OK.
You are returned to the Alarms > Notification window. The changes to the reported alarm severity levels
and the recipient email address for email notifications are displayed.
Working with Events
You can use Cisco WCS to view location server and location notification events. You can search and
display events based on their severity (critical, major, minor, warning, clear, info) and event category.
You can search by the following event categories:
•
By network coverage: coverage holes and interference
•
By link: mesh links
•
By notifications: location notifications
•
By product type: access points (rogue and non-rogue), clients, controllers, and location servers
•
By security
Additionally, you can search for an element’s events by its IP address, MAC address or Name.
A successful event search displays the event severity, failure object, date and time of the event, and any
messages for each event.
To display events, follow these steps:
Step 1
In Cisco WCS, choose Monitor > Events.
Step 2
In the Events window:
Step 3
•
If you want to display the events for a specific element and you know its IP address, MAC address,
or Name, enter that value in the Quick Search field (left-side). Click GO.
•
To display events by severity and category, select the appropriate options from the Severity and
Event Category drop-down menus. Click Search.
If Cisco WCS finds events that match the search criteria, it displays a list of these events.
Note
For more information about an event, click the failure object associated with the event.
Additionally, you can sort the events summary by each of the column headings.
Cisco Location Appliance Configuration Guide
OL-12449-01
8-5
Chapter 8
Monitoring Location Servers and Site
Working with Logs
Working with Logs
This section describes how to configure logging options and how to download log files.
Configuring Logging Options
You can use Cisco WCS to specify the logging level and types of messages to log.
To configure logging options, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server that you want to configure.
Step 3
Click Advanced (left) to display the administrative configuration options.
Step 4
Click Advanced Parameters. the advanced parameters for the selected location server appears.
Step 5
Scroll down to the Logging Options section and choose the appropriate option from the Logging Level
drop-down menu.
There are four logging options: Off, Error, Information, and Trace.
Caution
Use Error and Trace only when directed to do so by Cisco Technical Assistance Center (TAC)
personnel.
Step 6
Check the Enabled check box next to each element listed in that section to begin logging of its events.
Step 7
Click Save to apply your changes.
Downloading Location Server Log Files
If you need to analyze location server log files, you can use Cisco WCS to download them into your
system. Cisco WCS downloads a zip file containing the log files.
To download a zip file containing the log files, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server to view its status.
Step 3
Click Logs (left).
Step 4
Click Download Logs.
Step 5
Follow the instructions in the File Download dialog box to save the zip file on your system.
Cisco Location Appliance Configuration Guide
8-6
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Generating Reports
Generating Reports
In Cisco WCS, you can generate a utilization report for a location server. By default, reports are stored
on the Cisco WCS server.
The location utilization report summarizes and charts the following information in two separate charts
for a prescribed period of time:
•
Chart 1 summarizes and graphs CPU and memory utilization
•
Chart 2 summarizes and graphs client count, tag count, rouge client count, rogue access point count,
and ad hoc rogue count
You can generate a utilization report for the location server. Once defined, the report can be saved for
future diagnostic use and run on either an ad hoc or scheduled basis.
You can define the following in a utilization report:
•
What location server or servers are monitored
•
How often the report is generated
•
How the data is graphed on the charts
•
Whether the report is emailed or exported to a file
Creating a Location Server Utilization Report
Step 1
In Cisco WCS, choose Reports > Performance Reports.
Step 2
Select Location Server Utilization from the listing under the Performance Reports heading.
The Location Server Utilization summary window appears.
Step 3
Select New from the Select a command drop-down menu. Click GO.
A tabbed panel appears (see Figure 8-3).
Figure 8-3
Step 4
Reports > Performance Reports > Location Server Utilization
Enter a Report Title.
Cisco Location Appliance Configuration Guide
OL-12449-01
8-7
Chapter 8
Monitoring Location Servers and Site
Generating Reports
Step 5
The Report By selection is always location server.
Step 6
Select either a specific location server or All Location Servers from the drop-down location server menu.
Step 7
Enter the reporting period for the report. You can define the report to collect data on either an hourly or
weekly basis or at a specific date and time.
Note
Step 8
The reporting period uses a 24-hour clock rather than a 12-hour basis. For example, select hour
13 for 1 PM.
To define how collected data is grouped and displayed (hourly, daily, weekly) on the report (x-axis), select an
option from the Aggregation Frequency drop-down menu. Select the Schedule tab when complete.
For example, if you want to graph data daily on your report, you select daily. Additionally, you must
select daily as the Recurrence value in the schedule tab.
Note
Step 9
The Recurrence parameter defines how often a report is generated.
At the Schedule window, check the Enable Schedule check box to enable the report.
Figure 8-4
Location Server Utilization > New > Schedule Tab
Step 10
Select the Export Format from the drop-down menu.
Step 11
Select either the Save To File or the Email To option.
– If you select the Save To File option, a destination path must first be defined at the
Administration > Settings > Report window. Enter the destination path for the files in the
Repository Path field.
– If you select the Email To option, an SMTP Mail Server must be defined prior to entry of target
email address. Choose Administrator > Settings > Mail Server to enter the appropriate
information.
Step 12
Enter a start date (MM:DD:YYYY) or click the calendar icon to select a date.
Cisco Location Appliance Configuration Guide
8-8
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Generating Reports
Step 13
Specify a start time using the hour and minute drop-down menus.
Step 14
Click one of Recurrence buttons to select how often the report is run.
Note
Step 15
The days of the week only display on the screen when the weekly option is chosen.
When complete do one of the following:
•
Click Save to save edits.
•
Click Save and Run to save the changes and run the report now. The report is run and the results
are either emailed or saved to a designated file as defined in the Schedule tab. The report runs again
at the scheduled time.
•
Click Run if you want to run the report immediately and review the results in the WCS window. The
report runs regardless of any scheduled time associated with the report. If the report is too large to
display in the WCS window, you are referred to the history tab to download the file for viewing.
Click Save if you want to save the report scenario you entered.
Note
You can also use the Run command to check a report scenario before saving it or to run reports
as necessary.
Viewing a Location Server Utilization Chart
To view results of a defined report, do the following:
Step 1
In Cisco WCS, choose Reports > Performance Reports.
Step 2
Select Location Server Utilization from the listing under the Performance Reports heading.
The Location Server Utilization summary window appears. Any pre-defined reports, previously created
and saved, are listed.
Note
You can select one of the listed reports or you can define a new report. For details on creating a
new report, see the “Creating a Location Server Utilization Report” section on page 8-7.
Step 3
Select a listed report.
Step 4
Review or modify the report parameters on the General tab window. When complete, select the Schedule
tab.
Step 5
Check the Enable Schedule check box to enable the report.
Step 6
Review and edit other parameters, as necessary. When you are complete with your review or edit, do one
of the following:
•
Click Save to save edits.
•
Click Save and Run to save the changes and run the report now. The report is run and the results
are either mailed or saved to a designated file as defined in the Schedule tab. The report runs again
at the scheduled time.
Cisco Location Appliance Configuration Guide
OL-12449-01
8-9
Chapter 8
Monitoring Location Servers and Site
Monitoring Location Server Status
•
Click Run if you want to run the report immediately and review the results in the WCS window. The
report runs regardless of any scheduled time associated with the report. If the report is too large to
display in the WCS window, you are referred to the history tab to download the file for viewing.
Click Save if you want to save the report scenario you entered.
Note
You can also use the Run command to check a report scenario before saving it or to run reports
as necessary.
Monitoring Location Server Status
This section describes how to view location server status and how to enable status information polling.
Viewing Location Server Current Information
To view the current status of a location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of a location server to view its status.
Step 3
Click Advanced to display the administrative configuration options.
Step 4
Click Advanced Parameters.
Information for the selected location server found on the Advanced Parameters window is summarized
in Table 8-1.
Table 8-1
Advanced Parameters for Location Servers:
Page Heading
Description
General Information
Product name, version, time server started operation, time zone,
hardware restarts, active sessions, number of tracked elements and
tracked element limit.
Note
A major alert appears on the Advanced Parameter window if
the tracked elements limit of 2,500 for the location server is
reached.
Cisco UDI
Product identifier, version identifier, and serial number.
Logging Options
Types of occurrences and activity levels being logged.
Memory Information
Memory allocation and usage. Database memory levels. Command:
Run Java GC.
Advanced Parameters
Number of days to keep events, Session Time out, Interval between
data cleanup and enabled/disable status of Advanced Bug operation.
Advanced Commands
Commands: Reboot Hardware, Clear Configuration and Defragment
Database.
Cisco Location Appliance Configuration Guide
8-10
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Monitoring Clients
Monitoring Clients
You can configure Cisco WCS to display the name of the access point that generated the signal for a
client, its strength of signal and how often the location information for that client is updated. This
information is display by simply passing the cursor over the client icon on the map. Additionally, you
can click on the icon to open the Client Properties window.
To provide this functionality, you must first enable location status for the client.
To enable client location status for a specific client, follow these steps:
Step 1
In Cisco WCS, choose Monitor > Clients
The Clients Summary window displays.
Step 2
Click the Total Clients link for the appropriate location server listed under Clients Detected by Location
Servers.
A summary of all clients for the chosen location server displays noting its MAC address, Asset Name,
Asset Category, Asset Group, Vendor, Location, Controller, Battery Status, and Map location.
Note
To search for a client by a specific parameter such as by MAC address or controller, click New
Search and select the appropriate search criteria. If you searched for the client by its MAC
address, only one entry is listed.
Step 3
Click on the appropriate client.
Step 4
Click the Location tab.
Step 5
Check the Enabled check box for Location Debug under Asset Info.
Step 6
Click Update and close the window.
Step 7
At the map, click Refresh Heatmap to activate the feature on the map.
Note
At the Monitor > Maps window, both the Refresh Heatmaps and Clients check boxes must be
checked for the RSSI and client icons to display on the map.
Monitoring Tagged Assets
You can configure WCS to display the name of the access point that generated the signal for a tagged
asset, its strength of signal and when the location information was last updated for the asset. This
information is display by simply passing the cursor over the asset tag icon on the map. Additionally, you
can click on the icon to open the Tag Properties window.
To provide this functionality, you must first enable location status for the tagged asset.
Cisco Location Appliance Configuration Guide
OL-12449-01
8-11
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Enabling Tagged Asset Location Status
To enable tag location status, follow these steps:
Step 1
In Cisco WCS, choose Monitor > Tags.
The Tags Summary window appears.
Step 2
Click New Search to open a search window.
Step 3
Click the Total Tags link for the appropriate location server.
A summary of all tags for the chosen location server displays noting MAC address, Asset Name, Asset
Category, Asset Group, Vendor, Location, Controller, Battery Status, and Map location for each of the
tags.
Note
You can also search for a specific tag by criteria such as MAC address, controller, or Tag Vendor.
See the “Querying of Tags” section on page 8-12 for more details.
Step 4
Click the appropriate tag. The Tag Properties window appears.
Step 5
Check the Enabled check box for Location Debug under Asset Info
Step 6
Click Update and close the window.
Step 7
At the map, click Refresh Heatmap to activate the feature on the map.
Note
At the Monitor > Maps window, both the Refresh Heatmaps and 802.11 Tags check boxes must
be checked for the RSSI and tag icons to display on the map.
Querying of Tags
You can query tags by asset type (name, category and group), by MAC address, by system (controller or
location appliance), and by area (floor area and outdoor area).
You can further refine your search by tag vendor and type (telemetry) and save the search criteria for
future use. Saved search criteria can be retrieved from the Saved Searches drop-down menu on the Tag
Summary window (Monitor > Tags).
The following details are displayed on the Tag Properties window for each tag:
•
Tag vendor
•
Controller to which tag is associated
•
Battery Life
•
Asset Information (Name, Category, Group)
•
Statistics (bytes and packets received)
•
Location (Floor, Last Located, Location Server)
•
Location Notifications
•
Telemetry Data (CCX v1 compliant tags only)
Cisco Location Appliance Configuration Guide
8-12
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Note
•
Telemetry data displayed is vendor-specific; however, some commonly reported details are GPS
location, battery extended information, pressure, temperature, humidity, motion, status, and
emergency code.
Emergency Data (CCX v1 compliant tags only)
To query tags, follow these steps:
Step 1
Choose Monitor > Tags. The Tag Summary window appears.
Step 2
To initiate a search for tags, click New Search (side panel) to open the tag search window (Figure 8-5).
Figure 8-5
Step 3
Search Tags Panel
Select the appropriate search criteria. Table 8-2 lists search criteria and their possible values.
Cisco Location Appliance Configuration Guide
OL-12449-01
8-13
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Table 8-2
Search Criteria
Tag Search Criteria and Values
Variable Search Criteria
Possible Values
Search for tags by (Tier 1
search criteria)
—
All Tags; Asset Name, Asset Category or
Asset Group; MAC Address; Controller
or Location Server; Floor Area or
Outdoor Area.
Search In (Tier 2 search
criteria)
—
WCS Controllers or Location Server.
Last detected within
—
Variable search criteria.
(Tier 3 search criteria)
Note
Possible search
criteria driven by
the Search for tabs
by (Tier 1 search)
value.
Show Telemetry Tags only
Tag Vendor
Note
WCS Controller option indicates
that the search for controllers is
done within WCS.
Options are from 5 minutes to 24 hours.
If Search for tags by value is:
1.
Asset Name, then enter Tag Asset Name.
2.
Asset Category, then enter Tag Asset Category.
3.
Asset Group, then enter Tag Asset Group.
4.
MAC Address, then enter Tag MAC Address.
5.
Controller, then select Controller IP address from drop-down
menu.
6.
Location Server, then choose a Location Server IP address from
drop-down menu.
7.
Floor Area, then choose Campus, Building and Floor Area.
8.
Outdoor Area, then choose Campus and Outdoor Area.
—
—
Check box to display telemetry tags.
Leaving option unchecked displays all
tags.
Note
Option only seen when Location
Server, Floor Area or Outdoor
Area are selected as the Search
for tags by option.
Note
Only those vendor tags that
support telemetry appear.
Check box to select tag vendor from
drop-down menu.
Note
Option does not display when
Asset Name, Asset Category,
Asset Group or MAC Address are
the search criteria for tags.
Save Search
—
Check box to name and save search
criteria. Once saved, entry appears under
Saved Searches heading (left-panel).
Items Per Page
—
Select the number of tags to display per
search request. Values range from 10 to
500.
Cisco Location Appliance Configuration Guide
8-14
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Step 4
Click Go when all search criteria are selected. A listing of all tags that match the search criteria appears
(Figure 8-6).
Note
If no tags are located based on the selected search criteria, a message displays noting this as well
as reasons why the search was unsuccessful and possible actions.
Figure 8-6
Step 5
Tag Search Results
Select a MAC Address link to display details for a specific tag. The Tag Properties window appears
(Figure 8-7).
Figure 8-7
Tag Properties Window (top)
Cisco Location Appliance Configuration Guide
OL-12449-01
8-15
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Note
Scroll down to the bottom of the window to see Telemetry and Emergency details for the tag
(Figure 8-8).
Figure 8-8
Tag Properties Window (bottom)
Overlapping Tags
When multiple tags are within close proximity of one another a summary tag is used to represent their
location on a WCS map (Monitor > Maps). The summary tag is labeled with the number of tags at that
location.
When you move the mouse over the overlapping tag on the map, a panel appears with summary
information for the overlapping tags (see Figure 8-9).
Select the Prev and Next links to move between the individual tag summary panels. To see detailed
information on a specific tag, select the Details link while viewing the tag’s summary information.
Note
•
Summary information for tags includes: Tag MAC address, Asset Name, Asset Group, Asset
Category, Vendor (Type), Battery life and Last Located data (date and time). If the tag is CCX v.1
compliant, telemetry information also displays.
•
Detailed information for tags includes this additional information: IP address of associated
controller, statistics, location notifications, location history and whether the location debug feature
is enabled.
– To view location history for a tag, select that option from the Select a command drop-down
menu and click GO.
– To return to the details screen from the location history window, select the Tag Detail option
and click GO.
Cisco Location Appliance Configuration Guide
8-16
OL-12449-01
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Figure 8-9
Overlapping Tags Window
Cisco Location Appliance Configuration Guide
OL-12449-01
8-17
Chapter 8
Monitoring Location Servers and Site
Monitoring Tagged Assets
Cisco Location Appliance Configuration Guide
8-18
OL-12449-01
C H A P T E R
9
Performing Maintenance Operations
This chapter describes how to back up and restore location server data and how to update the location
server software. It also describes other maintenance operations.
This chapter contains the following sections:
•
“Recovering Lost Password” section on page 9-2
•
“Backing Up and Restoring Location Server Data” section on page 9-2
•
“Downloading Software to Location Servers” section on page 9-4
•
“Configuring an NTP Server” section on page 9-5
•
“Defragmenting the Location Server Database” section on page 9-6
•
“Running Java GC on the Location Server Memory” section on page 9-6
•
“Rebooting the Location Server Hardware” section on page 9-7
•
“Clearing Location Server Configurations” section on page 9-7
•
“Importing and Exporting Asset Information” section on page 9-8
Cisco Location Appliance Configuration Guide
OL-12449-01
9-1
Chapter 9
Performing Maintenance Operations
Recovering Lost Password
Recovering Lost Password
If you lose or forget the root password for the location appliance, you can recover the password by doing
the following:
Step 1
Once the GRUB screen comes up, press Esc to enter the boot menu.
Step 2
Press e to edit.
Step 3
Navigate to the line beginning with "kernel," and press e.
At the end of the line put a space, followed by the number one (1). Press Enter to save this change.
Step 4
Press b to begin boot.
The boot sequence will commence and at the end the user will be given a shell prompt.
Step 5
The user may change the root password by invoking the passwd command.
Step 6
Enter and confirm the new password.
Step 7
Reboot the machine.
Backing Up and Restoring Location Server Data
This information describes how to back up and restore location server data. It also describes how to
enable automatic backup.
Backing Up Location Server Historical Data
Cisco WCS includes functionality for backing up location server data.
To back up location server data, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the server that you want to back up.
Step 3
Click Maintenance (left).
Step 4
Click Backup.
Step 5
Enter the name of the backup.
Step 6
Enter the time in seconds after which the backup times out.
Note
For location servers versions 2.1 or later, the timeout value is not required.
Note
For location server versions 2.0 or later, the timeout indicates how long the full operation will
take. The default value is1800 seconds. For pre-2.0 versions of the location server, the timeout
parameter refers only to the connection timeout value and a smaller value should be entered (120
seconds by default).
Cisco Location Appliance Configuration Guide
9-2
OL-12449-01
Chapter 9
Performing Maintenance Operations
Backing Up and Restoring Location Server Data
Step 7
Click Submit to back up the historical data to the hard drive of the server running Cisco WCS.
Status of the backup can be seen on the screen while the backup is in process. Three items will display
on the screen during the backup process: (1) Last Status field provides messages noting the status of the
backup; (2) Progress field shows what percentage of the backup is complete; and (3) Started at field
shows when the backup began noting date and time.
Note
You can run the backup process in the background while working on other location server
operations in other WCS windows.
Note
Backups are stored in the FTP directory you specify during the Cisco WCS installation.
Restoring Location Server Historical Data
You can use Cisco WCS to restore backed-up historical data.
To restore location server data, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the server that you want to restore.
Step 3
Click Maintenance (left).
Step 4
Click Restore.
Step 5
Choose the file to restore from the drop-down menu.
Step 6
Enter the time in seconds after which restoration times out.
Note
For location servers versions 2.1 or later, the timeout value is not required.
Note
For location server versions 2.0 or later, the timeout represents how long the full operation will
take (by default, the user interface suggest 1800 seconds). For older location servers, the timeout
represents the connection timeout and you should use a small value (120 seconds by default).
Step 7
Click Submit to start the restoration process.
Step 8
Click OK to confirm that you want to restore location server data from the Cisco WCS Server hard drive.
When restoration is completed, Cisco WCS displays a message to that effect.
Note
You can run the restore process in the background while working on other location server
operations in other WCS windows.
Cisco Location Appliance Configuration Guide
OL-12449-01
9-3
Chapter 9
Performing Maintenance Operations
Downloading Software to Location Servers
Enabling Automatic Location Server Backup
You can configure Cisco WCS to perform automatic backups of location server data on a regular basis.
To enable automatic location server data backup, follow these steps:
Step 1
In Cisco WCS, choose Administration > Background Tasks.
Step 2
Check the Location Server Backup check box.
Step 3
Select Enable Task from the Select a command drop-down menu. Click GO.
The backups are stored in the FTP directory you specified during the Cisco WCS installation.
Downloading Software to Location Servers
To download software to a location server, follow these steps:
Step 1
Verify that you can ping the location server from the Cisco WCS Server or an external FTP server,
whichever you are going to use for the application code download.
Step 2
In Cisco WCS, choose Location > Location Servers.
Step 3
Click the name of the server that you want to download the software to.
Step 4
Click Maintenance (left).
Step 5
Click Download Software.
Step 6
To download software, do one of the following:
•
To download software listed in the WCS directory, select Select from uploaded images to transfer
into the Location Server. Then, choose a binary image from the drop-down menu.
Cisco WCS downloads the binary images listed in the drop-down menu into the FTP server
directory you have specified during the Cisco WCS installation.
•
Note
If upgrading a location server installed with a pre-2.0 version, you must first download and
decompress the file (gzip -d imageFilename) before installing the image. After
decompressing the file, run the resulting *.bin installer file.
Note
If you have a 2.0 or later version of the location server image already installed, the software
image automatically decompresses during its download from WCS.
To use downloaded software available locally or over the network, select the Browse a new
software image to transfer into the Location Server and click Browse. Locate the file and click
Open.
Step 7
Enter the time in seconds (between 1 and1800) after which software download times out.
Step 8
Click Download to send the software to the /opt/locserver/installers directory on the location server.
Cisco Location Appliance Configuration Guide
9-4
OL-12449-01
Chapter 9
Performing Maintenance Operations
Configuring an NTP Server
Note
After the image has been transferred to the location server, follow the instructions on the screen.
Log in to the location server’s CLI, stop the server, and run the installer image from the
/opt/locserver/installers directory.
Configuring an NTP Server
You can configure NTP servers to set up the time and date of the 2700 and 2710 location appliances.
Note
You are automatically prompted to enable NTP and enter NTP server IP addresses as part of the
automatic installation script. For more details on the automatic installation script, refer to the Cisco 2700
Series Wireless Location Appliance Installation and Configuration Guide at the following link:
http://www.cisco.com/en/US/products/ps6386/prod_installation_guides_list.html
The /etc/ntp.conf file is the main configuration file in which you place the IP addresses or DNS names
of the NTP servers you want to use (see the following example).
server ntp.mydomain.com # my corporate NTP
server 192.168.2.5 # my second NTP
To get NTP configured to start at bootup, enter the following:
[[email protected]]# chkconfig ntpd on
To start, stop, and restart NTP after booting, follow these examples:
[[email protected]]# service ntpd start
[[email protected]]# service ntpd stop
[[email protected]]# service ntpd restart
After configuring and starting NTP, make sure it is working properly. To test whether the NTP process
is running, use the following command:
[[email protected]]# pgrep ntpd
You should get a response of plain old process ID numbers.
Enter the ntpdate -u<serverIP> command to force your server to become instantly synchronized with
its NTP servers before starting the NTP daemon for the first time (see the following example).
[[email protected]]# service ntpd stop
[[email protected]] ntpdate -u 192.168.1.100
Looking for host 192.168.1.100 and service ntp
host found: ntpl.my-site.com
12 Aug 08:03:38 ntpdate[2472]: step time server 192.168.1.100 offset 28993.084943 sec
[[email protected] tmp]# service ntpd start
Note
For more information on the NTP configuration, consult the Linux configuration guides.
Cisco Location Appliance Configuration Guide
OL-12449-01
9-5
Chapter 9
Performing Maintenance Operations
Defragmenting the Location Server Database
Defragmenting the Location Server Database
Over time, the location server’s database might get fragmented, which might lead to a decrease in the
server’s performance. To fix this problem, use Cisco WCS to defragment the database.
To defragment the location server database, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server that you want to defragment its database.
Step 3
Click Advanced (left) to display its menu options.
Step 4
Click Advanced Parameters.
Step 5
Click Defragment Database.
Step 6
Click OK to confirm that you want to defragment the location server’s database.
Running Java GC on the Location Server Memory
Cisco WCS enables you to run a Java General Cleanup (Java GC) program to free up memory on a
location server.
To run the Java GC on a location server, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server whose database you want to defragment.
Step 3
Click Advanced (left) to display its menu options.
Step 4
Click Advanced Parameters.
Step 5
In the Memory Information section, click Run Java GC.
Cisco Location Appliance Configuration Guide
9-6
OL-12449-01
Chapter 9
Performing Maintenance Operations
Rebooting the Location Server Hardware
Rebooting the Location Server Hardware
If you need to restart the location appliance, use Cisco WCS to reboot the hardware on which the location
server is running.
To reboot the location server hardware, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the location server that you want to reboot.
Step 3
Click Advanced to display its menu options.
Step 4
Click Advanced Parameters.
Step 5
In the Advanced Commands section (bottom right), click Reboot Hardware.
Step 6
Click OK to confirm that you want to reboot the location server hardware.
The rebooting process takes a few minutes to complete.
Clearing Location Server Configurations
To clear the location server configuration and restore the factory defaults using Cisco WCS, follow these
steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
Step 2
Click the name of the server you want to configure.
Step 3
Click Advanced (left) to display its menu options.
Step 4
Click Advanced Parameters.
Step 5
In the Advanced Commands section, click Clear Configuration.
Note
Step 6
Using this command also clears the server’s database.
Click OK to clear the location server configurations.
Cisco Location Appliance Configuration Guide
OL-12449-01
9-7
Chapter 9
Performing Maintenance Operations
Importing and Exporting Asset Information
Importing and Exporting Asset Information
This section describes how to import and export asset information stored in a flat text file to minimize
manual entry.
Importing Asset Information
To import asset information for the location server using Cisco WCS, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
The All Location Servers summary window appears.
Step 2
Click the name of the server for which you want to import asset information.
Step 3
Click Administration (left) to display the administrative configuration options.
Step 4
Click Import Asset Information.
Step 5
Enter the name of the text file or browse for the file name.
Information stored in the imported file should be in the following format:
a. tag format: #tag, 00:00:00:00:00:00, categoryname, groupname, assetname
b. station format: #station, 00:00:00:00:00:00, categoryname, groupname, assetname
Step 6
Click Import.
Exporting Asset Information
To export asset information from the location server to a file using Cisco WCS, follow these steps:
Step 1
In Cisco WCS, choose Location > Location Servers.
The All Location Servers summary window appears.
Step 2
Click the name of the server from which you want export asset information.
Step 3
Click Administration (left) to display the administrative configuration options.
Step 4
Click Export Asset Information.
Step 5
Click Export.
You are prompted to Open (display to screen) or Save (to external PC or server) the asset file or to
Cancel the request.
Note
If you select Save, you are asked to select the asset file destination and name. The file is named
“assets.out” by default. Click Close from the dialog box when download is complete.
Cisco Location Appliance Configuration Guide
9-8
OL-12449-01
INDEX
documentation
A
conventions
active user sessions
5
8
related publications
8
advanced parameters
editing
5
E
alarm notifications
emailing
4
event definition
alarms
adding
assigning
3
clearing
3
deleting
3
deleting
testing
6
6
event groups
unassigning
viewing
3
3
adding
2
2
deleting
assets
2
synchronize
battery level
audience
11, 12
4
event notifications
7
summary
automatic synchronization
4
7
events
viewing
5
C
caution
G
8
Cisco UDI
10
general properties
client
editing
location debug
Compatibility
11, 12
groups
4
adding
controllers
synchronize
2
2
deleting
3
conventions, document
2
permissions
3
8
H
D
history parameters
Database
defragment
editing
6
4
host access
Cisco Location Appliance Configuration Guide
OL-12449-01
IN-1
Index
adding
network designs
5
deleting
Notifications
6
editing
2
8
NTP Server
7
Configuring
5
J
Java GC
O
6
Java General Cleanup
obtaining documentation
6
out-of-sync
8
5
L
P
location parameters
editing
Password
5
location readiness
recovering lost
3
location server
planning mode
automatic backup
compatibility matrix
editing
2
pull
4
configuration clearing
7
push
2
2
2
10
defragment database
reboot hardware
6
7
restore historical data
software download
synchronize
2
polling parameters
4
backup historical data
current status
2
3
4
related publications
RFID Asset Tags
8
2
rogue access points
2
location smoothing
R
2
5
log files
S
download
6
scheduled tasks
Log options
configuring
6
4
Simple Mail Transfer Protocol
2
Simple Network Management Protocol
M
Monitoring
11
SMTP
2
SNMP
2
SOAP
2
Specifies Simple Object Access Protocol
Synchronization
N
synchronize
synchronization status
2
SysLog
2
6
synchronization history
network design
2
6
6
2
Cisco Location Appliance Configuration Guide
IN-2
OL-12449-01
Index
T
Tagged
12
tagged asset
location status
Testpoints
12
4
U
users
active user sessions
adding
5
3
deleting
properties
4
4
Cisco Location Appliance Configuration Guide
OL-12449-01
IN-3
Index
Cisco Location Appliance Configuration Guide
IN-4
OL-12449-01
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement