1. No category

Cisco RAN Management System Administration Guide, Release 5.0
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: January 7, 2015
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.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned 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. (1110R)
© 2015
Cisco Systems, Inc. All rights reserved.
CONTENTS
CHAPTER 1
Preface 1
Preface 1
Objectives 1
Audience 1
Conventions 2
Related Documentation 2
Obtaining Documentation and Submitting a Service Request 2
CHAPTER 2
Cisco RAN Management System Overview 5
Cisco RMS Solution Overview 5
Cisco RMS Solution Components 6
Provisioning Management Gateway 6
Broadband Access Center 7
Device Provisioning Engine 8
Regional Data Unit 8
Device Command and Control 8
DCC UI 8
Ops Tools 9
Prime Access Registrar 9
Prime Network Registrar 9
Upload Server 9
Upload Server Directory Maintenance 10
Upload Server Southbound Interface 10
Upload Server Northbound Interface 11
Femtocell Access Point Process Flow 27
Cisco RMS High-Level Provisioning Flow 28
Cisco RMS Interfaces 29
Service Provider OSS 30
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
iii
Contents
Provisioning Management Gateway 30
Provisioning and Management Gateway DB 30
Broadband Access Center 30
Access Point 31
Cisco Radio Access Network 31
Cisco RMS Software Architecture 31
Central RMS Node 32
Serving RMS Node 33
Upload RMS Node 34
Cisco RMS Physical and Virtual Architecture 35
All-in-One RMS Node 35
Distributed RMS Node 36
CHAPTER 3
Device Command and Control 37
DCC Overview 37
DCC UI Requirements 37
Device Manager User Roles and Permissions 38
Information About the DCC UI 39
Logging In to the DCC-UI 40
Configuring DCC Dialog Boxes 41
Dynamic Screen Configuration Files 44
Adding or Updating Fields in the Group Dialog Box 45
Configuring the DCC Dashboard 46
CHAPTER 4
Baseline Configuration 53
Configuring BAC 53
Location Aware Custom Properties 53
Firmware Upgrade Custom Properties 55
RF Profiles Custom Properties 55
ubi-config-X.Y.Z Custom Properties 56
Modified UMTS Provisioning Flow 56
Delayed GPS Location Verification 56
Benchmark Update on DNM Location Verification Status 56
Enhanced REM Based Location Verification 57
Cisco RAN Management System Administration Guide, Release 5.0
iv
January 7, 2015
Contents
CHAPTER 5
Device Manager 59
Device Provisioning 59
Preparing to Register a Device 59
Registering a Device in Enterprise Mode 61
Registering a Device in Residential Mode 63
Register a Device with a New Group 64
Assigning a Device to a New Site 64
Reassign a Site to a Different Area 65
Updating a Device 66
Clearing a Tampered Device 67
Enabling Location Verification 67
Global Positioning System 68
Expected Detected Neighbor 70
Detected Neighbor Location 72
Detected Neighbor MCC/MNC 74
IP Address Subnet Match 76
Chained Intra Grid (CIG) 77
Detected Neighbor Benchmark (DNB) 79
Chained Intra Chassis 81
Providing IPv6 Support on HeNBGW 81
Migrating Devices from IPv4 to IPv6 82
Changing IPv4 Support to IPv6 on HeNBGW or LTESecGateway Post Installation 83
Configuring IPv6 Support for New Femto Access Points 83
Log Uploads and Triggers 84
Uploading a Log 84
Setting Triggers to Upload the Logs 84
View Information about a Device 85
Displaying the Device Dashboard 85
Displaying The Neighbor List in Use 86
Device Operations 86
Configuring Static Neighbors 86
Adding or Updating Static Neighbors 87
Updating Static Neighbor Filtering 88
Deleting Static Neighbors 88
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
v
Contents
Replacing a Device 89
Requesting a Connection to a Device 90
Rebooting a Device 90
Resetting a Device 91
View and Update Live Data 91
Displaying Live Data 91
Updating Live Data for a Device 92
Updating Modified Live Data 93
Shutting Down a Device 93
Device Manager Status Messages 94
Registering a Device: Status Messages 94
Activating a Device: Messages 94
Displaying the Device Dashboard: Messages 95
Uploading a Log: Messages 96
Updating Log Upload Triggers: Messages 97
Connection Request: Messages 98
Rebooting a Device: Messages 98
Resetting a Device: Messages 98
Shutting Down a Device: Messages 99
Display Live Data: Messages 99
Updating Live Data: Messages 99
Updating Modified Live Data: Messages 100
CHAPTER 6
Upgrade Monitoring Tool 101
Performing a Bulk Upgrade 102
Upgrading a Firmware 103
Monitoring a Firmware Upgrade 104
Upgrade Monitor History 106
Displaying Upgrade Monitor Errors 106
Upgrade Monitor Success 106
Reconciling a Monitor Upgrade Job 107
Adding a Firmware Type to the UMT 107
Adding a Firmware Version to the UMT 108
CHAPTER 7
Managing Groups and ID Pools 111
Cisco RAN Management System Administration Guide, Release 5.0
vi
January 7, 2015
Contents
Overview of Managing Groups and ID Pools 111
Recommended Order for Working with Pools and Groups 112
Managing Group Types 113
Alarm Groups 114
Area Groups 114
Enterprise Groups 114
FemtoGateway Groups 115
HENB Gateway Group 115
LTE Security Gateway Group 115
Region Groups 115
RF Profile Groups 116
Site Groups 116
Subsite Groups 116
Managing Groups 117
Managing ID Pool Types 117
SAI Pools 118
CELL Pools 119
LTE Cell Pools 120
Managing ID Pools 121
Making Changes to a Group Type, Group Instance, ID Pool Type or IP Pool Instance 121
Adding a Group Type 121
Adding a Group Instance 122
Adding a Device to New Group 122
Adding ID Pool Types 123
Adding an ID Pool Instance 123
Updating a Group Type, Group Instance, ID Pool Type, or ID Pool Instance 124
Deleting a Group Type, Group Instance, ID Pool Type, or ID Pool Instance 124
Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance 125
Importing the Exported Pools and Groups from the Previous Build to the New Build 126
Exporting ID Pool or Group Types 127
Exporting Information about a Group or ID Pool Instance 127
Groups and IP Pools: Messages 128
Adding a Group Type: Messages 128
Updating a Group Type: Messages 129
Import Group Type, Group Instance, ID Pool Type and ID Pool Instance: Messages 129
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
vii
Contents
Export Group Type: Messages 130
Adding or Updating a Group Instance: Messages 130
Deleting a Group Instance: Messages 131
Exporting Information about a Group Instance: Messages 131
Adding an ID Pool: Messages 131
Deleting an ID Pool Type: Messages 132
Exporting ID Pool Type: Messages 132
Export an ID Pool: Messages 133
Updating an ID Pool Instance: Messages 133
Updating an ID Pool Type: Messages 134
CHAPTER 8
Global Configuration of Devices in BAC RDU 135
Configuring DN Prefix Format 135
Adding CWMP Defaults 137
Updating CWMP Defaults 138
Deleting CWMP Defaults 138
CHAPTER 9
Administering Users and Roles 141
PAM Authentication 142
User Roles and Access Permissions 142
Managing Roles 143
Adding a Role 143
Editing a Role 143
Deleting a Role 144
Managing Users 144
Adding a User 144
Editing a User 145
Deleting a User 145
User Administration: Messages 146
CHAPTER 10
Operational Tools 147
Operational Tools 147
How to Use Ops Tools 148
massCr.sh 149
massReboot.sh 152
Cisco RAN Management System Administration Guide, Release 5.0
viii
January 7, 2015
Contents
getDeviceData.sh 154
encryptPassword.sh 158
searchAndExport.sh 159
reassignDevices 160
resync.sh 162
massFactoryRestore.sh 163
bulkimportexport.sh 166
bulkStatusReport.sh 167
Status Summary Reports 169
Status Exception Reports 169
Device Status Report 170
Firmware Reports 173
Report Structure Example 174
gpsExportData.sh 174
Configuring Crons 176
Setting up the getDeviceData Cron 176
Setting up the bulkStatusReport Cron 180
Setting up gpsExportData cron 180
Operational Tools for PMGDB 181
comparePolygons.sh 181
updatePolygons.sh 183
getAreaChangeDtls.sh 184
getAreas.sh 185
loadRevision.bat 186
updatePolygonsInPmg.sh 188
CHAPTER 11
Performance Counters 191
PMG Counters 191
Performance Periodic Statistics 195
Performance Message Statistics 197
Performance Gateway Periodic Counters 197
Upload Server Counters 198
RMS KPIs and Counters 201
CHAPTER 12
INSEE Management 207
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
ix
Contents
INSEE Management 207
Enhanced SAC Management 207
Configuring INSEE 207
Creating an INSEE SAC CSV File 209
Verifying the Mapping Files 210
CHAPTER 13
Cisco Provisioning Management Gateway (PMG) 213
PMG Overview 213
PMG Message Flow 215
PMG Northbound Interface for LTE 215
LUS Organized Directory Structure for AP PM Files 218
PMG Event Subscription 219
RMS Alarm Handler 220
AP Reachability Alarm 220
AP Location Verification Alarm 221
Managing the PMG 222
PMG Logging 222
PMG Performance Logs 223
Individual Performance Log File 224
Periodic Performance Log File 225
PMG Alarm Logs 226
PMG Syslogs 227
PMG Message Logs 227
PMG Troubleshooting 227
Alarm Messages 228
PMG Profiles 229
Parameter Definitions 230
CHAPTER 14
Troubleshooting 233
Troubleshooting the Device Command and Control UI 233
Operational Tools Troubleshooting 234
Using the Logs for Troubleshooting 235
APPENDIX A
Additional Location Verification Tasks 237
Creating Neighbor ID for EDN and DNL 237
Cisco RAN Management System Administration Guide, Release 5.0
x
January 7, 2015
Contents
Creating Frequency Signature for DNB 238
Adding Files for DNL and ISM from BAC 239
Adding Various LV Related Properties from BAC UI 239
Configuring and Testing Syslog 240
Glossary 243
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
xi
Contents
Cisco RAN Management System Administration Guide, Release 5.0
xii
January 7, 2015
CHAPTER
1
Preface
• Preface, page 1
• Objectives, page 1
• Audience, page 1
• Conventions, page 2
• Related Documentation, page 2
• Obtaining Documentation and Submitting a Service Request, page 2
Preface
This section describes the objectives, audience, organization, conventions, and related documentation of the
Cisco RAN Management System (RMS) Administration Guide, Release 4.x.
Objectives
This guide provides a brief overview of the Cisco RAN Management System (RMS) system and covers all
the administration information and tasks needed to manage and operate Cisco RMS.
Audience
The primary audience for this guide includes network operations personnel and system administrators. This
guide assumes that you are familiar with the following products and topics:
• Basic internetworking terminology and concepts
• Network topology and protocols
• Microsoft Windows 2000, Windows XP, Windows Vista, and Windows 7
• Linux administration
• RedHat Enterprise Linux 6.1
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
1
Preface
Conventions
• VMWare vSphere 5.1.0
Conventions
This document uses the following conventions:
Convention
Description
bold font
Commands and keywords and user-entered text appear in bold font.
Italic font
Document titles, new or emphasized terms, and arguments for which you
supply values are in italic font.
Courier font
Terminal sessions and information the system displays appear in courier
font.
Bold Courier font
Bold Courier font indicates text that the user must enter.
[x]
Elements in square brackets are optional.
string
A nonquoted set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
<>
Nonprinting characters such as passwords are in angle brackets.
[]
Default responses to system prompts are in square brackets.
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line
of code indicates a comment line.
Related Documentation
For additional information about the Cisco RAN Management Systems, refer to the following documents:
• Cisco RAN Management System Installation Guide
• Cisco RAN Management System API Guide
• Cisco RAN Management System SNMP/MIB Guide
• Cisco RAN Management System Release Notes
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service
request, and gathering additional information, see What's New in Cisco Product Documentation, at: http://
www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Cisco RAN Management System Administration Guide, Release 5.0
2
January 7, 2015
Preface
Obtaining Documentation and Submitting a Service Request
Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical
documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The
RSS feeds are a free service.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
3
Preface
Obtaining Documentation and Submitting a Service Request
Cisco RAN Management System Administration Guide, Release 5.0
4
January 7, 2015
CHAPTER
2
Cisco RAN Management System Overview
This chapter provides a functional overview of the Small Cell Solution (SCS), Cisco RAN Management
System (RMS), and explains how to use it to manage your network.
• Cisco RMS Solution Overview, page 5
• Femtocell Access Point Process Flow, page 27
• Cisco RMS High-Level Provisioning Flow, page 28
• Cisco RMS Interfaces, page 29
• Cisco RMS Software Architecture, page 31
• Cisco RMS Physical and Virtual Architecture, page 35
Cisco RMS Solution Overview
The Cisco RAN Management System provides different workflows and services to support enhanced
provisioning and managing capabilities for both, 3G and LTE Femtocells. These services include provisioning
and management functions such as, device configuration, status monitoring, firmware upgrade, data retrieval,
and troubleshooting.
The following are a few key functionalists of the Cisco RMS solution:
• Device activation and configuration
• Software upgrade and status monitoring of devices
• Performance monitoring through Key Performance Indicator (KPI) data uploaded by devices
• Enhanced access to the device alarm data
• Troubleshooting of devices
• Remote Authentication Dial In User Service (RADIUS) for device authorization on Home NodeB
Gateway (HNB-GW) including per device whitelist support
• Dynamic Host Configuration Protocol (DHCP) service for allocating IPSec addresses
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
5
Cisco RAN Management System Overview
Cisco RMS Solution Components
The Small Cell RMS solution integrates with the Cisco Broadband Access Center (BAC) for Telecom and
Wireless, as well as the Cisco ASR 5000 Gateway that plays the HNB-GW and Security Gateway (SeGW)
roles.
Cisco RMS Solution Components
The Cisco RMS solution comprises of the following components that provide end-to-support in provisioning,
managing, and maintaining the Femtocell access points (FAPs or APs, used interchangeably in this guide):
Provisioning Management Gateway
The Provisioning Management Gateway (PMG) provides a programmatic integration interface, Northbound
interface (NBI) API, to the service provider Operating Support Systems (OSS) or Business Support Systems
(BSS) for provisioning and managing access points (APs).
The PMG supports the following functions:
• Integration of API with OSS / BSS to enable:
◦Subscriber portal to communicate with the PMG to perform a device registration, update the
whitelist, and so on.
◦Mobile systems to compute and configure SAI, e911 location data on the FAP.
◦Care interface to access live data. For example, admin status, operator status, and so on.
• Provision of XML/HTTP API for requests and notifications
• Generation of KPIs (which PMG generates) in CSV (format) for PM files
• Installation on Cisco UCS x86 hardware with RedHat Linux OS
• Implementation of critical algorithm that automatically assigns:
◦AP
◦Regional SeGW, HNB-GW
◦Unique SAI
◦Unique Cell ID (so that Femtocell can be optimized or work efficiently)
◦RF and Management Groups
• Facilitation of Whitelist management: it interfaces with the HNB GW like RADIUS interface apart from
interacting with the BAC so that it can directly update the IMSI to the HNB GW.
• Facilitation of Plan-Activate Flow; this enables the operator to register the AP separately, activate
separately, or group the registration and activation.
PMG provides the following interfaces for provisioning and CSR requests, and notifications:
• Provisioning Requests
◦Register
◦Activate / Deactivate
Cisco RAN Management System Administration Guide, Release 5.0
6
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
◦Update
◦Update IMSI
◦Block / Unblock
◦Shutdown
◦Delete
• CSR Requests
◦Get Stored Data
◦Get Live Data
◦Reboot
◦Reset to Defaults
• Notifications (from PMG to the SP OSS or subscriber)
◦Assigned Data
◦Location Status
◦Service Operational
◦Service Error
The PMG workflow facilitates zero-touch activation flows by integrating with the Femtocell RAN Manager
(FRM) and Broadband Access Center (BAC). On Femtocell registration, PMG communicates with FRM in
order to assign unique RF parameters. For example, FRM can assign a unique SAI for the Femtocell and PMG
can set this data on the Femtocell via BAC as well as notify the SP OSS about the assignment.
PMG utilizes FRM to select the appropriate provisioning, SeGW, and HNB-GW nodes for the Femtocell and
determine location-specific RF scan configuration for the Femtocell. This location-groups data is provided
to the BAC, which instructs the Femtocell to perform a radio scan on specific bands and frequencies that are
relevant in the area. After completing the radio scan and location check, BAC can notify PMG, which can,
in turn, notify SP OSS.
The PMG is usually co-located with BAC on the same HW node.
Broadband Access Center
The Broadband Access Center (BAC) is a versatile TR-069 (support TR-169, v1 and v2) management system
that provides all essential Femtocell management functions whether it is AP configuration, firmware, data
retrieval (like get parameter value), troubleshooting (logs), and so on.
BAC supports the following functions:
• Maintenance of AP inventory in the RDU
• Implementation of policy-based configuration and firmware (FW) for APs— When the AP is contacting
the BAC for the first time, BAC pushes a specific configuration. When the AP contacts the BAC
subsequently, it pushes specific parameters, when the device is sending Network Listen (NWL) scan.
• Implementation of TR-069 standards. BAC also implements download service.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
7
Cisco RAN Management System Overview
Cisco RMS Solution Components
• Implementation of Femtocell activation logic, which is on the Device Provisioning Engine (DPE). PMG
does not play any role on the Femtocell activation logic, although PMG provides the configuration values
as part of the registration to the BAC. Therefore it is BAC that pushes all the information to the FAP as
part of the provisioning flow.
• Implementation of Oracle Berkeley database to store all the AP database information.
• Installation on Cisco UCS x86 hardware with Red Hat Linux OS.
Cisco RMS uses BAC as the TR-069 Auto Configuration Server (ACS), which contains the Regional Data
Unit (RDU) and DPE. The RDU is a central database of registration and RF data. The DPE provides TLS
secured TR-069 services and HTTPS download service for firmware and other files (e.g. AGPS). The TR-069
extensions in DPE perform small cell activation flows including location verification.
In a small deployment, RDU and DPE servers can be deployed on the same hardware node.
For more information about the DPE, see Device Provisioning Engine, on page 8.
For more information about the RDU, see Regional Data Unit, on page 8.
Device Provisioning Engine
The DPE is part of Cisco Broadband Access Center. It acts as a Auto Configuration Server. It provides essential
functionality for remote management of 3G APs, such as discovery, registration, activation, configuration,
live operations (get live data, factory reset, etc), service shutdown, and HTTPs Download support.
There are two kinds of DPEs: start-up DPE and home DPE. The ACS URL of the start-up DPEs is stored in
the 3G AP by the CloudBase. When it comes up for the first time, the 3G AP contacts the start-up DPE. This
DPE then redirects the 3G AP to the home DPE based on geographical location of the 3G AP. On subsequent
reboot, the 3G AP directly contacts the home DPE. The home DPE pushes new software/firmware,
configuration, and performs location check.
Regional Data Unit
The RDU is also part of Cisco Broadband Access Center. It is the central part of the RMS and has a persistent
database. It stores the information related to 3G AP parameters such as: expected software/firmware image,
expected location, network listen status, PLMN, LAC, SAC, Cell, CSG, RNC ID, SeGW, and HNB GW IP
address, and network listen information.
The RDU receives all this data from the DCC UI, Ops Tools, and IT portal via the PMG (Provisioning and
Management Gateway). The RDU provides this data to the startup and home DPEs, on request. The DPE and
RDU are distributed in the network.
Device Command and Control
The Device Command and Control (DCC) provides the following UI and CLI tool that can be used to manage
Cisco RMS and devices for device activation, administration, and troubleshooting.
DCC UI
The DCC UI provides the framework within which all the user interface applications reside. The following
application solutions are provided within the DCC UI:
Cisco RAN Management System Administration Guide, Release 5.0
8
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
• Enhanced Groups & IDs Management—Provides the ability to manage, edit, import, and export group
types and instances and ID pool types and instances.
• Device Manager—Provides device management capabilities based on user permissions (Read only /
Read & Write / Read & Write Advanced).
Ops Tools
The Ops Tools are a set of CLIs that enables the following functions:
• Bulk device management (e.g. connection requests, reboots)
• Device searches (based on group, etc)
• Device data retrieval
• Device property setting
• Re-balance of group and ID assignments
• BFST
• GPS Data Export
• Factory restore
In addition, the Ops Tools can be used in a workflow to perform group operations such as upgrades or moving
devices from default provisioning groups.
Prime Access Registrar
The Prime Access Registrar (PAR) is used for AAA authentication. It provides AP authentication on the
HNB-GW and delivers AP whitelists to HNB-GW via RADIUS.
Prime Network Registrar
The Prime Network Registrar (PNR), also called the DHCP server, is used to allocate IPSec addresses for
SeGW via DHCP. The lease database can then be queried to discover the current IP address of an AP.
Upload Server
The Upload Server (ULS) provides a high scale service for receiving and processing file uploads from the
Femtocells. All the logs from the FAP are uploaded to the Upload Server.
The Upload Server supports the following functionality:
• Supports only HTTPS.
• Uploads AP system logs, PM file uploads, and performance data.
• Bundles files for distribution to the SP OSS.
• Exposes the HTTP and SFTP interface towards the SP OSS.
• Purges old files.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
9
Cisco RAN Management System Overview
Cisco RMS Solution Components
• Provides detailed KPIs in the CSV PM files.
• Runs on UCS x86 on the Red Hat Linux.
• Accepts logs uploaded by APs and stores it on the disk.
• Provides access to uploaded logs on the server via access-restricted HTTP.
• Keeps the original uploaded log files in the upload partition.
• Creates simultaneously a compressed version of the same log file and keeps it in the archived partition
• Purges the uploaded logs periodically as per the configured settings.
• Purges the archive logs when the disk space usage exceeds a configured threshold.
• Reports average and peak load (uploads/hour) for every hour in the daily and weekly PM log files.
• Causes the watchdog process to automatically restart the Log Upload service if it goes down for any
reason.
• Configures Log Upload service to automatically start when the OS boot ups.
Upload Server Directory Maintenance
• Writes files in raw and compressed format in /opt/CSCOuls/files/uploads and /opt/CSCOuls/files/archives
directory respectively as they are uploaded.
• For raw partition,
◦Periodically (default 1 hr.) purges files uploaded within the last interval.
The periodicity and interval is defined by
[UploadServer.server.filemanager.taskscheduler.raw.dirmaint.interval.minutes] property. For
example, If the above property is set to 1 hr. the Upload Sever purges the files every one hour,
uploaded within last the one hour interval , thereby keeping files uploaded within the running hour,
intact.
• For archives partition,
◦ULS checks periodically (defined by
UploadServer.server.filemanager.taskscheduler.archive.dirmaint.interval.minutes property) the
disk utilization against the threshold value (defined by
UploadServer.files.upload.<file_type>.disk.alloc.upload.archives.thresh.pct property ).
◦If the disk utilization for a particular file type is above the threshold, the oldest files in the archive
directory of size equal to percentage (defined by
UploadServer.files.upload.<file_type>.pctoftotaldiskspacetofree property) plus the difference
between the current percent disk utilization and threshold percentage are deleted.
Upload Server Southbound Interface
The Upload Server Southbound interface (SBI) is used to upload the AP log files. It listens on port 443
(HTTPS).
Cisco RAN Management System Administration Guide, Release 5.0
10
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
Uploads received by the Upload Server are buffered in memory until written to the disk. When the rate of
incoming data exceeds the rate that ULS can process, the server no longer accepts new uploads and responds
to new upload requests with a standard HTTP response code 503, for service not available.
ULS sorts uploaded files based on filename patterns into stat and on-demand folders. The files that do not
match any of the two patterns go into an unknown directory.
ULS creates the subdirectories based on the timestamp in the filename and keeps the archive files there. This
is applicable only for archive files to avoid too many files in a single directory. The date regex pattern to
extract date from filename is configurable in the properties file. If the timestamp in filename doe not match
with the configured pattern then it keeps the file in the parent directory and not in the date-wise subdirectories.
For example, the upload file has the following URLs:
<IP>:8080/area1/A20140801.0442+0400-0442+0400_-110_001B67-357539019562681.xml
<IP>:8080/A20140801.0442+0400-0442+0400_-110_001B67-357539019562681.xml
Therefore it creates the following directory structure under the archive directory and places the file under the
date-wise subdirectory:
/stat
|-area1
|
|-20140801
|
|-20140801
Logs
• The Upload Server provides information on the average and peak loads (uploads/hour) for every hour
in the daily PM log files. The file-naming convention for these daily PM files is as follows:
upload-perf-periodic-YYYY-MM-DD.csv
• In addition, every seven days, a weekly PM file is rolled up and zipped up from the most recent, seven
daily PM files in the /opt/CSCOuls/server-perf-archives directory
Upload Server Northbound Interface
The Upload Server Northbound interface (NBI) is used to download the AP log files for analysis and report
generation. Such applications can download the PM/Stat or on-demand files over the Northbound interface.
The default port used is 8082.
For security, digest authentication mechanism is used. The default username/passwords are as follows:
File Type
Username
Password
PM/stat files
statadmin
Value of RMS_App_Password
Property defined in OVA
descriptor
(default Rmsuser@1)
PED/on-demand files
demandadmin
Value of RMS_App_Password
Property defined in OVA
descriptor
(default Rmsuser@1)
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
11
Cisco RAN Management System Overview
Cisco RMS Solution Components
Unknown files
unknownadmin
Value of RMS_App_Password
Property defined in OVA
descriptor
(default Rmsuser@1)
Important configurations and their meanings in Upload Server:
Property Name
Type
Description
Change
Affective
config.scantimems
Integer
Indicates time, in
milliseconds, between
checking if the
configuration file has
changed. If changed, the
configuration is reloaded.
Default is 50000 (50
seconds).
Configuration
reload and
next
configuration
lookup
UploadServer.config.bool
Boolean
Indicates the setting to
enable checking the
configuration file for
changes periodically.
Default is true.
Configuration
reload and
next
configuration
lookup
UploadServer.disk.alloc.global.maxgb
Integer
Sets a maximum for the
total number of gigabytes to
be used. If this value
exceeds the total number of
gigabytes available, the total
number of gigabytes for the
partition is used. The value
to be set is the maximum of
the number of gigabytes for
the upload and archive
partition. Default is 500.
Configuration
reload and
next
configuration
lookup
UploadServer.disk.alloc.global.threshold.info Integer
Defines the percentage at
which the watchdog process
logs an informational
message regarding the level
at which the server disk
space is full. Default is 70.
Configuration
reload and
next
configuration
lookup
Cisco RAN Management System Administration Guide, Release 5.0
12
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.disk.alloc.global.threshold.warning Integer
Defines the percentage at
which the watchdog process
logs a warning message
regarding the level at which
the server disk space is full.
Default is 80.
Configuration
reload and
next
configuration
lookup
UploadServer.disk.alloc.global.threshold.critical Integer
Defines the percentage at
which the watchdog process
logs a critical message
regarding the level at which
the server disk space is full.
Default is 90.
Configuration
reload and
next
configuration
lookup
UploadServer.files.homedir
String
UploadServer.files.upload.stat.deviceid.pattern String
Indicates the "Root"
Restart
directory for all Upload
Server files (absolute path).
Default /opt/CSCOlog/files.
Indicates the regular
expression pattern used to
extract the DeviceID from
the filename for stat file
type.
Configuration
reload and
next
configuration
lookup
Default
[0-9A-F]{6}-[0-9A-Z]{1,64}
UploadServer.files.upload.demand.deviceid.pattern String
Indicates the regular
expression pattern used to
extract the DeviceID from
the filename for demand file
type.
Configuration
reload and
next
configuration
lookup
Default
[0-9A-F]{6}-[0-9A-Z]{1,64}
UploadServer.files.upload.stat.archive.delete.threshexceeded Boolean
Indicates whether or not the
archive files of the stat file
should be deleted when the
disk space threshold is
exceeded
(UploadServerf.ilesu.pload<
. fileType>d.iska.locu.ploada.rchivest.hreshp.ct).
Default is true.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.archive.delete.threshexceeded Boolean
Indicates whether or not the
archive files of the demand
file type should be deleted
when the disk space
threshold is exceeded
(UploadServerf.ilesu.ploadd.emandd.iska.locu.ploada.rchivest.hreshp.ct).
Default is true.
Configuration
reload and
next
configuration
lookup
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
13
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.unknown.archive.delete.threshexceeded Boolean
Indicates whether or not the
archive files of the unknown
file type should be deleted
when the disk space
threshold is exceeded
(UploadServerf.ilesu.ploadu.nkownd.iska.locu.ploada.rchivest.hreshp.ct).
Default is true.
Configuration
reload and
next
configuration
lookup
String
Indicates the directory that
contains the archived files
of the stat file type (relative
path from
UploadServer.files.homedir).
Default is archives/stat.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.archive.path String
Indicates the directory that
contains the archived files
of the file type (relative path
from
UploadServer.files.homedir).
Default is
archives/on-demand.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.unknown.archive.path String
Indicates the directory that
contains the archived files
of the unknown file type
(relative path from
UploadServer.files.homedir).
Default is
archives/unknown.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.archiving.compression.enabled Boolean
Indicates whether or not the
stat archived TARballs
should be compressed.
Default is false.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.archive.path
Note
UploadServer.files.upload.demand.archiving.compression.enabled Boolean
This property is
deprecated and
must not be set to
true.
Indicates whether or not the
demand archived TARballs
should be compressed.
Default is false.
Note
This property is
deprecated and
must not be set to
true.
Configuration
reload and
next
configuration
lookup
Cisco RAN Management System Administration Guide, Release 5.0
14
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.unknown.archiving.compression.enabled Boolean
Indicates whether or not the
unknown archived TARballs
should be compressed.
Default is false.
Note
UploadServer.files.upload.stat.archiving.filename.prefix String
Indicates the beginning of
the filename that is used to
verify the correct file type.
Default is stat.
Note
UploadServer.files.upload.demand.archiving.filename.prefix String
This property is
deprecated.
Indicates the remainder of
the filename (excluding the
prefix) that can be
disregarded as the prefix
that is used to verify the file
type. Default is
yyyy-MM-dd-HH-mm-ss.
Note
UploadServer.files.upload.demand.archiving.filename.suffix.dateformat String
This property is
deprecated.
Indicates the beginning of
the filename that is used to
verify the correct file type.
Default is unknown.
Note
UploadServer.files.upload.stat.archiving.filename.suffix.dateformat String
This property is
deprecated.
Indicates the beginning of
the filename that is used to
verify the correct file type.
Default is on-demand.
Note
UploadServer.files.upload.unknown.archiving.filename.prefix String
This property is
deprecated and
must not be set to
true.
Configuration
reload and
next
configuration
lookup
Configuration
reload and
next
configuration
lookup
Configuration
reload and
next
configuration
lookup
Configuration
reload and
next
configuration
lookup
This property is
deprecated.
Indicates the remainder of
the filename (excluding the
prefix) that can be
disregarded as the prefix is
used to verify the file type.
Default is
yyyy-MM-dd-HH-mm-ss.
Note
Configuration
reload and
next
configuration
lookup
Configuration
reload and
next
configuration
lookup
This property is
deprecated.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
15
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.unknown.archiving.filename.suffix.dateformat String
Indicates the remainder of
the filename (excluding the
prefix) that can be
disregarded as the prefix is
used to verify the file type.
Default is
yyyy-MM-dd-HH-mm-ss.
Note
Configuration
reload and
next
configuration
lookup
This property is
deprecated.
UploadServer.files.upload.stat.archiverawfiles.interval.minutes Integer
Indicates the frequency at
which the raw/uploaded
files of the stat file type
should be archived into zip
files (in minutes). Default is
1440.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.archiverawfiles.interval.minutes Integer
Indicates the frequency at
which the raw / uploaded
files of the demand file type
should be archived into zip
files (in minutes). Default is
1440.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.unknown.archiverawfiles.interval.minutes Integer
Indicates the frequency at
which the raw / uploaded
files of the lowmem file
type should be archived into
zip files (in minutes).
Default is 1440.
Configuration
reload and
next
configuration
lookup
Integer
Indicates the frequency at
which the raw / uploaded
files of the lowmem file
type should be archived into
zip files (in minutes).
Default is 1440.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.disk.alloc.upload.archives.thresh.pct Integer
Defines the percentage of
the entire disk space
allocated for archives of stat
file type. Default is 60.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.disk.alloc.upload.archives.thresh.pct Integer
Defines the percentage of
the entire disk space
allocated for archives of
demand file type. Default is
10.
Configuration
reload and
next
configuration
lookup
Cisco RAN Management System Administration Guide, Release 5.0
16
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.unknown.disk.alloc.upload.archives.thresh.pct Integer
Defines the percentage of
the entire disk space
allocated for archives of this
file type. Default is 1.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.pctoftotaldiskspacetofree Integer
Defines the file
type-specific percentage (in
addition to the difference
between current utilization
and threshold percentage) of
the disk space to remove
after the
UploadServer.files.upload.stat.disk.aloc.upload.raw.thresh.pct
is reached. Default is 15.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.pctoftotaldiskspacetofree Integer
Defines the file
type-specific percentage (in
addition to the difference
between current utilization
and threshold percentage) of
the disk space to remove
after the
UploadServer.files.upload.demand.disk.aloc.upload.raw.thresh.pct
is reached. Default is 5.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.unknown.pctoftotaldiskspacetofree Integer
Defines the file
type-specific percentage (in
addition to the difference
between current utilization
and threshold percentage) of
the disk space to remove
after the
UploadServer.files.upload.unkown.disk.aloc.upload.raw.thresh.pct
is reached. Default is 100.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.raw.delete.afterarchived Boolean
Defines whether or not the
files used to create the
archives should be removed
after they are zipped.
Default is false.
Configuration
reload and
next
configuration
lookup
Note
It is recommended
that this property
should not be
modified.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
17
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.demand.raw.delete.afterarchived Boolean
Defines whether or not the
files used to create the
archives should be removed
after they are archived into
TARballs. Default is false.
Note
UploadServer.files.upload.unknown.raw.delete.afterarchived Boolean
It is recommended
that this property
should not be
modified.
Defines whether or not the
files used to create the
archives should be removed
after they are archived into
TARballs. Default is true.
Note
Configuration
reload and
next
configuration
lookup
Configuration
reload and
next
configuration
lookup
It is recommended
that this property
should not be
modified.
UploadServer.files.upload.stat.raw.delete.threshexceeded Boolean
Defines whether or not raw
/ uploaded files for this file
type should be deleted when
the threshold is exceeded
(UploadServer.files.upload.stat.disk.aloc.upload.raw.thresh.pct).
Default is true
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.raw.delete.threshexceeded Boolean
Defines whether or not raw
/ uploaded files for this file
type should be deleted when
the threshold is exceeded
(UploadServer.files.upload.demand.disk.aloc.upload.raw.thresh.pct).
Default is true.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.unknown.raw.delete.threshexceeded Boolean
Defines whether or not raw
/ uploaded files for this file
type should be deleted when
the threshold is exceeded
(UploadServerf.ilesu.ploadu.nknownd.iska.locu.ploadr.awt.hreshp.ct).
Default is true.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.archiving.enabled Boolean
Indicates whether or not
Configuration
archiving for stat file type is reload and
enabled. Default is true.
next
configuration
Note
This property is
lookup
deprecated and
must not be set to
true.
Cisco RAN Management System Administration Guide, Release 5.0
18
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.demand.archiving.enabled Boolean
Indicates whether or not
archiving for demand file
type is enabled. The default
is true.
Note
UploadServer.files.upload.unknown.archiving.enabled Boolean
This property is
deprecated and
must not be set to
true.
Indicates whether or not
archiving for unknown file
type is enabled. Default is
true.
Note
This property is
deprecated and
must not be set to
true.
Configuration
reload and
next
configuration
lookup
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.stat.raw.path
String
Refers to the directory that
contains the uploaded files
(relative path from
UploadServer.files.homedir)
of the stat file type. Default
is uploads/stat.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.demand.raw.path
String
Refers to the directory that
contains the uploaded files
(relative path from
UploadServer.files.homedir)
of the demand file type.
Default is
uploads/on-demand.
Configuration
reload and
next
configuration
lookup
UploadServer.files.upload.unknown.raw.path String
Refers to the directory that
contains the uploaded files
(relative path from
UploadServer.files.homedir)
of the unkown file type.
Default is uploads/unknown.
Configuration
reload and
next
configuration
lookup
UploadServer.sb.interface
String
Refers to the network
interface that bind on for
South-bound connections.
Default is 0.0.0.0.
Restart
UploadServer.sb.port
Integer
Refers to the port number
that the Southbound
interface is bound to.
Default is 8080.
Restart
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
19
Cisco RAN Management System Overview
Cisco RMS Solution Components
perf.summary.intervalMS
Integer
Indicates interval, in
Restart
milliseconds, between
summary statistics (that are
for the last interval) are
logged. Default is 3600000
(1 hour).
UploadServer.sb.uri.regex
String
Refers to the regex for
Restart
filtering the request URI;
currently it accepts
everything but could be
updated to exclude patterns
or characters if desired in
the future. Default (.*).
UploadServer.server.archive.filecount.max
Integer
Refers to the safety feature
that considers the ulimit for
the ciscorms user, which
specifies the maximum
number of open files at any
given time. Default is
200000.
Note
Configuration
reload and
next
configuration
lookup
This property is
deprecated and no
longer used.
UploadServer.server.filemanager.taskscheduler.archive.dirmaint.initialdelay.minutes Integer
Defines the initial delay in Restart
the server maintaining the
archive directory structure
(in minutes). Default is 10.
UploadServer.server.filemanager.taskscheduler.archive.dirmaint.interval.minutes Integer
Defines the frequency at
Restart
which the server maintains
the archive directory
structure (in minutes).
Default is 10.
UploadServer.server.filemanager.taskscheduler.raw.dirmaint.initialdelay.minutes Integer
Defines the initial delay in
the server maintaining the
raw directory structure (in
minutes). Default is 60.
UploadServer.server.filemanager.taskscheduler.raw.dirmaint.interval.minutes Integer
Defines the frequency at
Restart
which the server maintains
the raw directory structure
(in minutes). Default is 60.
UploadServer.server.filemanager.taskscheduler.poolsize Integer
Specifies the number of
Restart
threads to use for the
scheduled DirectoryMonitor
process. Default is 1.
Restart
Cisco RAN Management System Administration Guide, Release 5.0
20
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.nb.channel.maxidlems
Integer
Indicates the maximum idle Restart
time for Northbound
channel in milliseconds.
Default is 300000.
UploadServer.nb.interface
String
Refers to the network
interface that bind on for
Northbound connections.
Default is 0.0.0.0.
Restart
UploadServer.nb.port
Integer
Refers to the port number
that the Northbound
interface is bound to.
Default is 8082.
Restart
UploadServer.nb.auth.enabled
Boolean
Confirms if HTTP digest
authentication (RFC 2617)
is enabled (true) or not
(false). If enabled, the
values for
UploadServer.files.upload.<FileType>.nb.auth.username
and
UploadServerf.ilesu.pload<
. FileType>n.ba.uthp.asswords.tatadmin
must be specified. Only the
first request for a connection
is required for
authentication. Default is
true.
UploadServer.nb.auth.maxattempts
Integer
Configures the maximum
number of failed
authentication attempts on
a connection before it is
closed. Default is 5.
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
Configures the default
username for HTTP digest
authentication for the NBA
client. Default is rmsapp.
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
UploadServer.files.upload.demand.nb.auth.username String
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
21
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.files.upload.unknown.nb.auth.username String
Configures the default
username for HTTP digest
authentication for the NBA
client. Default is rmsapp.
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
UploadServer.files.upload.unknown.nb.auth.username String
Configures the default
username for HTTP digest
authentication for the NBA
client. Default is rmsapp.
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
UploadServer.files.upload.stat.nb.auth.password.username String
Configures the valid
password for HTTP digest
authentication for the user
identified by username.
Encrypted. For example, for
the user statadmin, the
property would be
UploadServer.files.upload.stat.nb.auth.password.statadmin.
Default for user rmsapp is
Onk7AeUn7vQSaiyB2GreKw==
(rmsapp).
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
Configures the realm field
as specified by RFC 2617.
Default is UploadServer.
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
UploadServer.nb.channel.digest.realm
String
Cisco RAN Management System Administration Guide, Release 5.0
22
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.nb.auth.domain
String
Configures the domain field
as specified by RFC 2617.
Because all paths require
authentication, a default of
/ is used. Default is /.
Active on
next
connection
after
configuration
reload.
Existing
connections
are not
affected.
alarms.snmp.mhsmib.prefix
String
Configures the top level
OID prefix to use. Default
is 1.3.6.1.4.9.9.9999.
Configuration
reload on
next alarm or
clear.
alarms.sb.snmp.nummanagers
Integer
Configures the number of
destination SNMP managers
that are configured. Default
is 0.
Configuration
reload on
next alarm or
clear.
alarms.snmp.manager.address.1
String
Refers to the prefix on
which an index is added that
is used to configure the IP
address of a destination
SNMP manager. The index
must be 1 or greater and less
than or equal to the number
of managers. For example,
alarms.snmp.manager.address.1=127.0.0.1.
Default is empty.
Configuration
reload on
next alarm or
clear.
alarms.snmp.manager.port.1
Integer
Refers to the prefix on
which an index is added that
is used to configure the port
of a destination SNMP
manager. The index must be
1 or greater and less than or
equal to the number of
managers. For example:
alarms.snmp.manager.port.1=162.
Default is 162.
Configuration
reload on
next alarm or
clear.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
23
Cisco RAN Management System Overview
Cisco RMS Solution Components
alarms.snmp.manager.community.1
String
Refers to the prefix on
which an index is added that
is used to configure the
community string of a
destination SNMP manager.
The index must be 1 or
greater and less than or
equal to the number of
managers. For example:
alarms.snmp.manager.community.1=public.
Default is public.
Configuration
reload on
next alarm or
clear.
alarms.snmp.manager.version.1
String
Indicates the SNMP version Configuration
to use. Default is v1.
reload on
next alarm or
clear.
alarms.diskutilization.warning.enabled
String
Indicates whether alarm
should be raised when the
information disk utilization
is reached. Info level
depends on
UploadServer.disk.alloc.global.threshold.info.
Default is true.
Configuration
reload and
next
configuration
lookup.
alarms.diskutilization.info.enabled
String
Indicates whether alarm
should be raised when info
disk utilization is reached.
Info level depends on
UploadServer.disk.alloc.global.threshold.info.
Default is true.
Configuration
reload and
next
configuration
lookup.
UploadServer.filetypes
String
A comma delimited string Restart
of values defining each file
type supported by the
server.
UploadServer.sb.limit.enabled
Boolean
Refers to the true false flag Configuration
to indicate if the server
reload and
should use load limiting.
next
configuration
lookup.
UploadServer.sb.connection.limit.max
Integer
Indicates the limit on
maximum number of
southbound connections.
Configuration
reload and
next
configuration
lookup.
Cisco RAN Management System Administration Guide, Release 5.0
24
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Solution Components
Integer
Refers to the limit at which
a warning is raised when the
number of SB connections
reach this value.
Configuration
reload and
next
configuration
lookup.
UploadServer.sb.limit.maxConcurrentUploads Integer
Indicates the maximum
number of uploaded files
that can be buffered in raw
format by the server. Any
uploads breeching this
threshold triggers a 503
response.
Configuration
reload and
next
configuration
lookup.
UploadServer.sb.limit.maxConcurrentArchiveUploads Integer
Indicates the maximum
number of uploaded files
which can be buffered in the
compressed format by the
server. Any uploads
breeching this threshold
triggers a 503 response.
Configuration
reload and
next
configuration
lookup.
UploadServer.server.filemanager.taskscheduler.alarmthreshold.initialdelay.minutes Integer
Indicates the initial delay in Restart
minutes for the alarm
scheduler to wait before
running.
UploadServer.server.filemanager.taskscheduler.alarmthreshold.interval.minutes Integer
Indicates the number of
Restart
minutes between each alarm
threshold test.
UploadServer.server.filemanager.taskscheduler.duplicatedeviceidcleanup.initialdelay.minutes Integer
Indicates the initial delay in Restart
minutes for the duplicate
device ID cleanup process
to wait before running.
UploadServer.server.filemanager.taskscheduler.duplicatedeviceidcleanup.interval.minutes Integer
Indicates the number of
Restart
minutes between each
duplicate device ID cleanup
process.
Integer
Indicates the initial number Restart
of threads to use for the raw
FileWriter thread pool.
UploadServer.sb.connection.warn.threshold
UploadServer.fw.coresize
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
25
Cisco RAN Management System Overview
Cisco RMS Solution Components
UploadServer.fw.maxpool
Integer
Indicates the maximum
Restart
number
of
threads
the
raw
Indicates
the number FileWriter thread pool uses.
of seconds
to keep the
raw
FileWriter
threads
alive when
idle.
UploadServer.fw.keepalive.seconds
Integer
Indicates the number of
seconds to keep the raw
FileWriter threads alive
when idle.
UploadServer.fw.debug.sleep.milliseconds
Integer
Strictly used for debugging Restart
purposes. This value should
always be zero unless there
is a need to introduce a
delay for each FileWriter
task. Value is in
milliseconds.
UploadServer.archive.fw.coresize
Integer
Indicates the initial number Restart
of threads to use for the
archive FileWriter thread
pool.
UploadServer.archive.fw.maxpool
Integer
Indicates the maximum
number of threads the
archive FileWriter thread
pool uses.
UploadServer.archive.fw.keepalive.seconds
Integer
Indicates the number of
Restart
seconds to keep the archive
FileWriter threads alive
when idle.
UploadServer.files.upload.*.filename.pattern String
Restart
Restart
Indicates the filename
Restart
pattern for each filetype.
This regex is used to match
a filename to a given
filetype known by the
server.
Cisco RAN Management System Administration Guide, Release 5.0
26
January 7, 2015
Cisco RAN Management System Overview
Femtocell Access Point Process Flow
UploadServer.files.upload.*.postprocessor
String
Indicates the postprocessor Restart
for each filetype. Defines
the name of the
PostProcessor
implementation to use for
this filetype.
UploadServer.files.upload.*.duplicatedeviceidcleanup.enabled Boolean
Indicates the duplicate
Restart
device ID cleanup for each
filetype. Defines if duplicate
device ID cleanup process
should be used for this
filetype.
UploadServer.files.upload.unknown.enableUpload Boolean
Restricts unknown file type
uploads. Default value is
true, that is, it allows
unknown file uploading to
the server.
Configuration
reload and
next
configuration
lookup.
Femtocell Access Point Process Flow
The following describes the life cycle of a small cell access point (AP) from procurement to service
commissioning:
Procedure
Step 1
When an AP is manufactured, there are two processes that occur:
• The AP manufacturing information is fed in to the production system (server). This includes serial
number of AP, basic certificate, and so on.
• The AP is dispatched to the Central Warehouse (factory) along with the AP manufacturing information
that was fed into the production server.
Step 2
The information from the production system is fed into the Cloudbase Activation Server (CAS), which is
specific to the Ubiquisys AP. The information would include the serial number of the AP, basic certificate,
service provider information, and so on.
Note
USC 8000 series access points are pre-provisioned with Management Server (HeMS) FQDN/IP,
certificates, NTP and AP software. Currently there is no cloudbase support for these access points.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
27
Cisco RAN Management System Overview
Cisco RMS High-Level Provisioning Flow
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
Now a subscriber requests for the AP service through a retailer, customer care, or via a web interface. The
subscriber provides all the information like, location, authorized user list, and other subscription details.
The subscription details are fed into the OSS system. OSS internally calls the Cisco RMS component to
basically register the device.
On completion of the subscription details, a small cell (AP) is delivered to the subscriber from the Central
Warehouse.
After the AP gets delivered, the subscriber connects the device and powers it up.
When the AP powers up for the first time, it goes to the CAS and downloads the appropriate image (when
the information is fed into the CAS, the service provider mapping, which is the serial number meant for a
specific service provider to identify the appropriate firmware to be downloaded).
The AP activation occurs after the particular FW gets pushed to the AP.
RMS provisioning follows next. This is final automated, zero-touch plug and play activation that occurs.
(from step 7 to 10)
All auto-configurations, like different parameters for RAN, RF parameter, and so on, get configured.
Step 9
Step 10 After the auto-configuration is complete, that is administration, radio access network, and operations services
are up, the service is provided to the subscriber.
Cisco RMS High-Level Provisioning Flow
A high-level workflow of the Cisco RMS and the various components is described as follows:
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
To register an AP, the SP OSS calls the register message from the PMG for the parameters like, EID (entity
ID or serial number of the device). The operator can provide the whitelist (if it is a closed mode support) and
location information (for example, some service providers provide latitude and longitude, while other service
providers may not provide the location) or associate the device with the area group based on which area it
belongs to.
When the register message comes to the PMG, the PMG goes to the BAC and adds that device entry and
updates the whitelist.
Next, when the FAP comes up for the first time, it sends a BootStrap to the BAC. Then a HTTP establishment
occurs between the BAC and FAP: certificate based authentication occurs, and at the end, an Inform Response
is sent by the RMS.
After the Inform Response is done, BAC pushes the baseline configuration to the FAP. Part of the baseline
configuration is the baseline parameters like NWL scan, HNB GW IP add, and scan on boot=true.
The FAP performs the NWL scan, and it sends that information by indicating whether the scan is completed
or not.
When the NWL scan is completed, BAC gets the NWL data from the FAP. The NWL data is the TR-069 data
model attribute that the BAC fetches from the FAP.
After receiving the NWL data, the BAC performs a location verification; after location verification is passed,
the BAC sends the location verification status to the PMG and the SP OSS. If the OSS operator wants to
activate the FAP, the operator will activate the device.
Cisco RMS provides the following activation support:
Cisco RAN Management System Administration Guide, Release 5.0
28
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Interfaces
• At the registration stage, the operator can set the AP to activate at the end of the registration
• Activation can be performed explicitly. That is, whenever the activation happens, the operator can
perform an Admin Up to the FAP, then the FAP starts IPSec tunnel establishment with the HNB GW,
authentication takes place, FAP gets the IPSec address from the CNR, then it goes basically for the HNB
GW registration request; in the HNB GW Registration request, the RADIUS Access Request comes to
the CAR, the CAR verifies whether i is a valid FAP or not. The CAR checks if it has the EID of the
FAP, whether the proper IP address is configured, and validates it. After all checks are complete and
authenticated, the FAP comes to the operational state.
Cisco RMS Interfaces
The following figure illustrates the various Cisco RMS interfaces and interactions.
Figure 1: RMS Interfaces and Interactions
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
29
Cisco RAN Management System Overview
Service Provider OSS
Cisco RMS interacts with the various interfaces as follows:
Service Provider OSS
Cisco RMS exposes programmatic APIs, which use XML over HTTP, to interact with the SP OSS. Cisco
RMS exposes a kind of XSD schema that the OSS uses to communicate to RMS.
There are several APIs that are used for signatures, AP registration, and activation that the SP OSS uses to
communicate with the Cisco RMS.
Provisioning Management Gateway
PMG is a generic provisioning and management application that provides the necessary workflow component
between the Service Provider (SP) IT/OSS applications (for example, service management and customer care)
and the Cisco provisioning system, Broadband Access Center (BAC). It exposes the NBI API, which is XML
over HTTP, to enable the SP OSS to communicate with the PMG. The PMG in turn sends a set of notifications
to the SP OSS. For example, PMG assigns the LAC and Cell ID for a particular registered device. This
information is passed back to the SP OSS.
Provisioning and Management Gateway DB
Provisioning and Management Gateway (PMG) DB provides a geo-spatial lookup service for PMG (read-only).
It takes a location, defined by latitude and longitude, and returns the name of a group (for example, polygon).
PMG then uses this group for automatic assignments. PMG DB operates on Oracle and is shipped as installation
scripts, schema files, and stored procedures. It is expected that the operator provides the Oracle license and
maintenance.
Broadband Access Center
Cisco RMS and FAP-related alarm are logged on the BAC. All component-related alarms, for example, alarms
that PMG raises and so on, are sent directly to the Prime Suite, which is the Network Management System
(NMS) interface.
Cisco RMS has three categories of alarms:
• Device or AP Alarms—A set of alarms that is received from the AP. For example, unable to connect to
the HNB GW, or some sector has gone down, or radio status is not up. All these alarms come to the
BAC and from BAC, it goes to the Prime Suite (Network Management System [NMS]). Therefore the
alarm is converted to TR-069 to the SNMP and the alarm is sent to the Prime Suite. This is called the
device alarm or AP alarm.
• Component-specific Alarm—All component specific alarms are sent to the BAC. For example, PMG
is not able to get some resource, does not have enough memory. Those specific alarms raised by the
component are sent directly to the NMS or Element Management System (EMS).
• System-specific Resource Alarm—Cisco RMS does not participate in resource-specific alarms like CPU,
I/O, disk, memory, and so on. The Prime Suite and VMware vCenter that are running on the Cisco UCS
hardware, monitor and track the utilization and convert the alarms and sends them back to the Prime
Suite.
Cisco RAN Management System Administration Guide, Release 5.0
30
January 7, 2015
Cisco RAN Management System Overview
Access Point
Access Point
The Remote management module (RMM) is the TR69 client interface between the Cisco RMS and the AP
that uses the TR-69 data model or TR-196 data model to manage object and perform actions like get parameter
value, set parameter value, and so on.
The Ubiquisys FAP supports a Cloudbase Activation Server (CAS), which is not supported on IPA or Juni
FAPs.
When a registered AP is on for the first time, it contacts the CAS. The CAS has information about what
firmware to push to the AP, Cisco RMS IP address, and SeGW IP address. This information comes from the
CAS and the AP gets booted with that particular image which it has got fm the CAS. Now the AP knows the
Cisco RMS IP address or the fully qualified domain names (FQDNs) and the SeGW FQDN so the AP starts
communicating with the RAN server.
Therefore, when the AP comes up, it contacts the Cisco RMS, which in turn configures a set of parameters
back to the AP. Then the AP contacts the SeGW and HNB GW via the luCS and luPS on the RAN server and
then proceeds to contact the Cisco RMS to get the AAA. When the authentication is complete, the AP goes
to the SP MSC or SP GGSN, etc.
Cisco Radio Access Network
The Cisco Radio Access Network (RAN) interacts and interfaces with the Cisco RMS. Though RAN is not
a Cisco RMS component, the Prime Access Registrar component of the Cisco RMS interacts with the RAN
for authentication whenever an AP contacts the Cisco RMS.
The Cisco RMS interacts with the RAN to configure the AAA/RADIUS whitelist on the HNB GW to get the
system up and running.
The Prime Network Registrar, which is the DHCP server interacts with the RAN because it is responsible for
assigning the IP address to a given AP.
Cisco RMS Software Architecture
The following figure illustrates the Cisco RMS software architecture.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
31
Cisco RAN Management System Overview
Central RMS Node
Cisco RMS architecture is divided into three logical components:
Central RMS Node
In the Central RMS node, the DCC UI, PMG, and BAC RDU components of the Cisco RMS are installed on
a separate node.
Cisco RAN Management System Administration Guide, Release 5.0
32
January 7, 2015
Cisco RAN Management System Overview
Serving RMS Node
The Central node can be paired with any number of serving nodes.
Figure 2: Central RMS Node
In any of the Cisco RMS deployments, it is mandatory to have at least one Central node.
To deploy the Central node, it is mandatory to procure and install VMware with one VMware vCenter per
deployment. For more information, see the Cisco RAN Management Systems Installation Guide, Release 4.0.
Serving RMS Node
In the Serving RMS node, the BAC DPE, PNR, and PAR components of the Cisco RMS are provided on a
separate node.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
33
Cisco RAN Management System Overview
Upload RMS Node
The Serving node must be combined with the Central node. To add additional Serving nodes, the properties
of the additional Serving nodes must be configured on the Central node.
Figure 3: Serving RMS Node
The Serving node can be scaled horizontally, which means that there can be multiple Serving nodes with one
Central node depending on how many APs need to be supported.
The AP (HNB) always interacts with the Serving node. APs use the Serving node IP address to reach the
Cisco RMS. The IP address or FQDN of the Cisco RMS that is configured on the AP is part of the Serving
node and not the Central node, which is hidden from the AP.
For example, if a customer has around 1 million devices up and running, and they have 16 different Serving
nodes, each of the devices will be configured to interact with specific Serving nodes. That is how a Serving
node can be scaled horizontally.
Upload RMS Node
In the Upload RMS node, the Upload Sever is provided on a separate node.
Cisco RAN Management System Administration Guide, Release 5.0
34
January 7, 2015
Cisco RAN Management System Overview
Cisco RMS Physical and Virtual Architecture
The Upload RMS node must be combined with the Serving node.
Figure 4: Upload RMS Node
For more information about the Upload Server, see Upload Server , on page 9.
Cisco RMS Physical and Virtual Architecture
This section lists the physical and virtual architecture of the Cisco RMS.
The Cisco RMS can be deployed in one of these modes:
All-in-One RMS Node
In the All-in-One RMS node, all the components of the Cisco RMS solution is provided on a single host.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
35
Cisco RAN Management System Overview
Distributed RMS Node
The physical hardware has one virtual machine running a central node and one serving node.
Figure 5: All-in-One RMS Node
In an All-In-One RMS node, the Serving Node comprises of the Upload Sever VM and the VM combining
the BAC DPE, PNR, and PAR components; the Central Node comprises of the VM combining the DCC UI,
PMG, and BAC RDU VM components.
To deploy the All-in-One node, it is mandatory to procure and install VMware with one VMware vCenter
per deployment. For more information, see the Cisco RAN Management Systems Installation Guide, Release
4.0.
Distributed RMS Node
In a Distributed RMS deployment mode, the following nodes are deployed:
• Central RMS Node, on page 32
• Serving RMS Node, on page 33
• Upload RMS Node, on page 34
In a Distributed deployment mode, up to 250,000 APs are supported.
Cisco RAN Management System Administration Guide, Release 5.0
36
January 7, 2015
CHAPTER
3
Device Command and Control
• DCC Overview, page 37
• DCC UI Requirements, page 37
• Device Manager User Roles and Permissions, page 38
• Information About the DCC UI, page 39
• Logging In to the DCC-UI, page 40
• Configuring DCC Dialog Boxes, page 41
• Configuring the DCC Dashboard, page 46
DCC Overview
The Device Command and Control (DCC) application is the user interface within the Cisco Remote Management
System (RMS) that provides operation, administration and management of 3G access points. It is a collection
of tools and contains both a graphic user interface (GUI) and a command line interface (CLI). It enables the
following functions:
• Device data export
• Upgrade monitoring
• Device group management
• Single device management for troubleshooting
• Mass connection request and reboot
• SAI pool management
DCC UI Requirements
The DCC UI is supported on the following browser:
• Latest released version of Mozilla Firefox.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
37
Device Command and Control
Device Manager User Roles and Permissions
Device Manager User Roles and Permissions
To access the various device manager operations you must have the correct permission. Your permissions
determine which functionality you have within the system.
Table 1: Device Manager Functionality According to User Permissions
Functionality
Operation
User Permission Allows Functionality
Read-only
View
Provision
Perform
Read-write Basic Read-write Advanced
Dashboard
Yes
Yes
Yes
Live Data
—
—
Yes
Neighbor List in Use
Yes
Yes
Yes
Update
—
Yes
Yes
Log Upload Triggers
—
Yes
Yes
Upload Configurations
—
—
Yes
Shutdown
—
—
Yes
Static Neighbors
—
Yes
Yes
Device Replacement
—
Yes
Yes
Connection Request
—
Yes
Yes
On-Demand Log Upload
—
Yes
Yes
Reboot
—
Yes
Yes
Factory Recovery/Reset
—
Yes
Yes
Set Live Data
—
—
Yes
Set Modified Live Data
—
—
Yes
Register a Device
—
Yes
Yes
Provision Chassis
Register
The three access levels restrict basic users to access advanced operations that require knowledge of device
parameters. The levels of access are:
• Read Only: Allows access to operations listed under ‘View’ button (currently only Dashboard) only.
This is meant for a user with very basic knowledge.
• Read Write Basic: Allows access to operations that require basic knowledge such as Registration,
Updation, Reboot, Shutdown, Reset, Static neighbours, CR, On demand log upload and so on in addition
to the Read Only operations.
Cisco RAN Management System Administration Guide, Release 5.0
38
January 7, 2015
Device Command and Control
Information About the DCC UI
• Read Write Advanced: Allows access to advanced operations such as View/Set Live Data, Modified
Live Data, Log upload triggers and so on in addition to the Read Write Basic operations. This is meant
for a user with advanced knowledge.
Information About the DCC UI
The DCC UI presentation framework has a generic design and layout. All the applications hosted on this
framework use this layer for display. The common elements like the header, application navigation, and
primary navigation are available to all the applications installed on this framework. The application navigation
is displayed below the header. All the installed and enabled applications that are approved are displayed in
this screen.
Figure 6: DCC UI Main Screen - Application Presentation Page
The DCC UI includes the following components:
Device Manager
The Device Manager consolidates the individual CPE management functions and provides the ability to
easily navigate through the device data model and view values.
Some of the components of the device manager are located on the same machine, and the communication
with the CPE occurs through Provisioning Management Gateway (PMG), and Broadband Access Center
Regional Distribution Unit (BAC RDU).
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
39
Device Command and Control
Logging In to the DCC-UI
Upgrade Monitor
The Upgrade Monitoring Tool (UMT) is a web based tool that supports multiple users concurrently viewing
a single monitoring job or executing multiple monitoring jobs. The tool is able to efficiently scale by receiving
real time events from BAC instead of polling the devices.
Groups and IDs
Groups and IDs allows you to manage the group types, groups, pool types and pools on the BAC.
Configuration
Configuration allows you to manage global level configuration of devices in BAC RDU for properties such
as DN Prefix Format. This tab is disabled by default and can be enabled by updating 'superuser' role from
Admin tab->Roles.
Admin
Admin allows you to manage Users and Roles without having to access the DCC UI Admin User Interface
directly.
Logging In to the DCC-UI
The DCC UI login and authentication system verifies the login credentials and authentication details.
DCC UI Password Policy:
As part of security measures, the password policy is implemented for DCC UI. Ensure that you adhere to the
password policy. The new password must be minimum 8-127 characters long and alphanumeric, should be
mixed case, should contain one of the special characters(*,@,#) and no spaces.
Procedure
Step 1
Step 2
Step 3
Navigate to the DCC-UI application URL. Below is a sample url:
https://central node eth1 IP address/dcc_ui/admin/Login.do
Enter a valid Username and Password in the appropriate text boxes and click Log In.
The credentials are verified by the Login and Authentication system. A new user is logged in with the default
password and is prompted to enter a new password.
Note
For the new user changing the password is a must to log in to the DCC UI application. With the
default password user cannot log in to the application.
Enter the existing and new password as requested and click Save. After entering the new password the
application redirects you to the log in page to log in to the DCC UI application with the new password.
Password changed successfully pop up box appears on Save if the new password provided adheres to the
password policy.
Cisco RAN Management System Administration Guide, Release 5.0
40
January 7, 2015
Device Command and Control
Configuring DCC Dialog Boxes
A popup is displayed that requests the user for which you are changing the password. This is a browser feature
and not triggered through the DCC UI.
Figure 7: Confirm Password Change Dialog
In order to disable this popup, the password history needs to be disabled for the browser through the browser
options.
Note
If you are an application administrator for a specific application, the specific application page displays
on successful login.
If the login credentials fail to authenticate, you are returned to the login page with a failure message.
DCC UI Session expiry: The session times out if the period of inactivity exceeds the time limit set for the
DCC UI. If you try to access the page after the session has expired, then you are navigated back to the login
page. The session timeout period is 45 minutes.
DCC UI Input Validation: As part of security feature XSS implementation, invalid data such as script tags
or html tags are not allowed.
Step 4
When you are finished, click Log Out at the top right corner to exit from the current session.
Configuring DCC Dialog Boxes
The dialog boxes of the Device Command and Control user interface can be customized according to your
needs. Each of the dialog boxes is controlled via an xml file contained in the /rms/app/rms/conf directory.
For example, the xml files for the dialog boxes for registering a device are as follows:
• UMTS Residential Mode: sdm-register-UMTS-residential-screen-setup.xml
• UMTS Enterprise Mode: sdm-register-UMTS-enterprise-screen-setup.xml
• LTE Residential Mode: sdm-register-LTE-residential-screen-setup.xml
• LTE Enterprise Mode: sdm-register-LTE-enterprise-screen-setup.xml
You can open these files in an xml or text editor and change them as necessary to customize the dialog box
for your needs. The xml file for the update screen for registering a device in Residential mode is named as
sdm-update-residential-screen-setup.xml, and for Enterprise mode is named
assdm-update-enterprise-screen-setup.xml.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
41
Device Command and Control
Configuring DCC Dialog Boxes
This is an example of the sdm-register-UMTS-residential-screen-setup.xml file:
<?xml version="1.0" encoding="UTF-8"?>
<!-This file is the confidential information and proprietary trade secret
of Cisco Systems, Inc. Possessions and use of this program must conform
strictly to the license agreement between the user and Cisco Systems,
Inc., and receipt or possession does not convey any rights to divulge,
reproduce, or allow others to use this program without specific written
authorization of Cisco Systems, Inc.
Copyright 2012 Cisco Systems, Inc. All rights reserved.
-->
<ScreenElements xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.cisco.com/rms/screen-setup.xsd"
xsi:schemaLocation="http://www.cisco.com/rms/screen-setup.xsd">
<ScreenElement>
<Id>area</Id>
<Required>true</Required>
<Label>Area</Label>
<LabelWidth>99px</LabelWidth>
<FilteringSelect>
<FieldWidth>198px</FieldWidth>
<ValueUrl>/sdm/handleService.do?action=Get
Groups&amp;additionalInfo=Area</ValueUrl>
</FilteringSelect>
<ToolTip>Select the area of the device.</ToolTip>
<StoredKey>Area</StoredKey>
<StoredSection>groups</StoredSection>
<StoredType>string</StoredType>
</ScreenElement>
<ScreenElement>
<Id>rfProfile</Id>
<Required>false</Required>
<Label>RF Profile</Label>
<LabelWidth>99px</LabelWidth>
<FilteringSelect>
<FieldWidth>198px</FieldWidth>
<ValueUrl>/sdm/handleService.do?action=Get
Groups&amp;additionalInfo=RFProfile</ValueUrl>
</FilteringSelect>
<ToolTip>Select an optional RF Profile to be used.</ToolTip>
<StoredKey>RFProfile</StoredKey>
<StoredSection>groups</StoredSection>
<StoredType>string</StoredType>
</ScreenElement>
<!-<ScreenElement>
<Id>activated</Id>
<Required>false</Required>
<Label>Activated</Label>
<LabelWidth>100px</LabelWidth>
<CheckBox>
<DisableOnChecked>
<Id>ID2</Id>
<Id>ID3</Id>
</DisableOnChecked>
</CheckBox>
<ToolTip>Controls if the device is allowed to activate its radio or not.</ToolTip>
<StoredKey>Activated</StoredKey>
<StoredSection>element</StoredSection>
<StoredType>boolean</StoredType>
</ScreenElement>
<ScreenElement>
<Id>dnmStatus</Id>
<Required>true</Required>
<Label>DNM Status</Label>
Cisco RAN Management System Administration Guide, Release 5.0
42
January 7, 2015
Device Command and Control
Configuring DCC Dialog Boxes
<LabelWidth>100px</LabelWidth>
<TextBox>
<FieldWidth>200px</FieldWidth>
<ValidationRegex>.+</ValidationRegex>
</TextBox>
<ToolTip>Updates the DNM status.</ToolTip>
<StoredKey>FC-DNM-STATUS</StoredKey>
<StoredSection>parameters</StoredSection>
<StoredType>string</StoredType>
</ScreenElement>
<ScreenElement>
<Id>dnmList</Id>
<Required>false</Required>
<Label>DNM List</Label>
<LabelWidth>95px</LabelWidth>
<TransferEntryBox>
<InputFieldType>mcc_or_mccmnc</InputFieldType>
<InputLabel>Add MCC or MCC/MNC</InputLabel>
<InputFieldWidth>200px</InputFieldWidth>
<TransferLabel>DNM List</TransferLabel>
<TransferFieldHeight>50px</TransferFieldHeight>
<AcceptDuplicates>false</AcceptDuplicates>
</TransferEntryBox>
<ToolTip>Updates the DNM list. MCC may be 3 digits long, MCC/MNC must be 5 to 6
digits long.</ToolTip>
<StoredKey>DNMIDList</StoredKey>
<StoredSection>expected_location</StoredSection>
<StoredType>mcc_or_mccmnc_list</StoredType>
</ScreenElement>
<ScreenElement>
<Id>ednList</Id>
<Required>false</Required>
<Label>EDN List</Label>
<LabelWidth>95px</LabelWidth>
<TransferEntryBox>
<InputFieldType>radio_neighbor_id</InputFieldType>
<InputLabel>Add MCC or MCC/MNC</InputLabel>
<InputFieldWidth>200px</InputFieldWidth>
<TransferLabel>EDN List</TransferLabel>
<TransferFieldHeight>50px</TransferFieldHeight>
<AcceptDuplicates>false</AcceptDuplicates>
</TransferEntryBox>
<ToolTip>Updates the EDN list.</ToolTip>
<StoredKey>EDNIDList</StoredKey>
<StoredSection>expected_location</StoredSection>
<StoredType>radio_neighbor_id_list</StoredType>
</ScreenElement>
<ScreenElement>
<Id>sai</Id>
<Required>true</Required>
<Label>SAI</Label>
<LabelWidth>100px</LabelWidth>
<SaiBox>
<FieldWidth>200px</FieldWidth>
</SaiBox>
<ToolTip>Sets the SAI.</ToolTip>
<StoredKey>SAI</StoredKey>
<StoredSection>element</StoredSection>
<StoredType>sai</StoredType>
</ScreenElement>
<ScreenElement>
<Id>accessMode</Id>
<Required>false</Required>
<Label>Closed Mode</Label>
<LabelWidth>100px</LabelWidth>
<CheckBox>
<CheckedValue>closed</CheckedValue>
<UncheckedValue>open</UncheckedValue>
<EnableOnChecked>
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
43
Device Command and Control
Dynamic Screen Configuration Files
<Id>acl</Id>
</EnableOnChecked>
</CheckBox>
<ToolTip>Controls the access mode is closed (checked) or open (unchecked).</ToolTip>
<StoredKey>AccessMode</StoredKey>
<StoredSection>access_control</StoredSection>
<StoredType>access_mode</StoredType>
</ScreenElement>
<ScreenElement>
<Id>acl</Id>
<Required>false</Required>
<Label>White List</Label>
<LabelWidth>95px</LabelWidth>
<TransferEntryBox>
<InputFieldType>text</InputFieldType>
<InputLabel>Add IMSI</InputLabel>
<InputFieldWidth>150px</InputFieldWidth>
<InputValidationRegex>\d{14}$|\d{15}$</InputValidationRegex>
<TransferLabel>ACL</TransferLabel>
<TransferFieldHeight>50px</TransferFieldHeight>
<AcceptDuplicates>false</AcceptDuplicates>
</TransferEntryBox>
<ToolTip>Updates the ACL list.</ToolTip>
<StoredKey>AccessControlList</StoredKey>
<StoredSection>access_control</StoredSection>
<StoredType>string_list</StoredType>
</ScreenElement>
-->
</ScreenElements>
Note
The DCC UI exposes xml files which the customer can modify to build their user interface.
Dynamic Screen Configuration Files
This table lists the xml files that are used to customize the associated DCC UI screens with additional
parameters. The complete list of configurable parameters that can be used is provided in the RMS Configurable
Parameters for Release 4.0 document.
DCC UI Dialog Box
DCC UI Area
XML Filename
Folder Path
Device
Registration—UMTS
Enterprise
Device Manager sdm-register-UMTS-enterprise-screen-setup.xml rms/app/rms/conf
Device
Registration—LTE
Enterprise
Device Manager sdm-register-LTE-enterprise-screen-setup.xml rms/app/rms/conf
Device
Registration—UMTS
Residential
Device Manager sdm-register-UMTS-residential-screen-setup.xml rms/app/rms/conf
Device
Registration—LTE
Residential
Device Manager sdm-register-LTE-residential-screen-setup.xml rms/app/rms/conf
Cisco RAN Management System Administration Guide, Release 5.0
44
January 7, 2015
Device Command and Control
Adding or Updating Fields in the Group Dialog Box
DCC UI Dialog Box
DCC UI Area
XML Filename
Folder Path
Update Device
Device Manager sdm-update-enterprise-screen-setup.xml rms/app/rms/conf
Registration—Enterprise
Update Device
Device Manager sdm-update-residential-screen-setup.xml rms/app/rms/conf
Registration—Residential
Inter-Frequency
Neighbors
Device Manager sdm-inter-freq-static-neighbors.xml
rms/app/rms/conf
Inter-RAT Neighbors
Device Manager sdm-inter-rat-static-neighbors.xml
rms/app/rms/conf
Update Static Neighbors Device Manager sdm-static-neighbors-filter-screen-setup.xml rms/app/rms/conf
Filter
Add Firmware Type
Upgrade
Monitor
umt-setup.xml
rms/app/rms/conf
Add Firmware Version
Upgrade
Monitor
umt-config.xml
rms/app/rms/conf
Log Uploads and
Triggers
Device Manager uploadServers.xml
rms/app/rms/conf
Dashboard Display
Device Manager deviceParamsDisplayConfig.xml
Copy the xml file to
/rms/app/rms/conf
directory from
/rms/app/rms/doc/config/sample
directory and make
appropriate
changes.
Add Area Instance
Groups and IDs bgmt-add-group-screen-setup-Area.xml
rms/app/rms/conf
Add Enterprise Instance Groups and IDs bgmt-add-group-screen-setup-Enterprise.xml rms/app/rms/conf
Add FemtoGateway
Instance
Groups and IDs bgmt-add-group-screen-setup-FemtoGateway.xml rms/app/rms/conf
Add RF Profile Instance Groups and IDs bgmt-add-group-screen-setup-RFProfile.xml rms/app/rms/conf
Add Site Instance
Groups and IDs bgmt-add-group-screen-setup-Site.xml
rms/app/rms/conf
Add SAI-POOL Instance Groups and IDs bgmt-add-group-screen-setup-SAI-POOL.xml rms/app/rms/conf
Add CELL-POOL
Instance
Groups and IDs bgmt-add-group-screen-setup-CELL-POOL.xml rms/app/rms/conf
Adding or Updating Fields in the Group Dialog Box
Use this task to make fields available in the Add/Update group dialog box.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
45
Device Command and Control
Configuring the DCC Dashboard
Procedure
Step 1
Step 2
Create a file named 'bgmt-add-group-screen-setup-<groupTypeName>.xml' in the /rms/app/rms/conf directory.
Enter an appropriate screen element configuration for each BAC property that is applicable to groups of this
group type, in the xml. This xml should validate against screen-setup.xsd, which is available in
/rms/app/rms/doc/config/xsd for reference.
Step 3
Sample files should be referred to while preparing the configuration file. bgmt-add-group-screen-setup-Area.xml
and bgmt-add-group-screen-setup-FemtoGateway.xml are available in /rms/app/rms/doc/config/sample for
reference.
Use appropriate screen elements for each of the properties and save the file. Make screen elements 'Required'
as needed. Follow the convention used in sample xml files. Set readable label names and appropriate tooltip
messages. Values for each field can be validated by setting a regular expression on textbox value.
/etc/init.d/bprAgent restart tomcat
Restarts the DCC UI application, so that it can pick up the new configuration file. Further changes made to
this file are automatically reloaded by the DCC UI after one minute.
Step 4
Step 5
Step 6
Step 7
Open the add/update group screen. The screen should contain dynamically added input elements for all the
configured properties as per the xml. If it does not, check for file loading/validation errors in DCC UI debug
log. Also the headers in the grid inside Groups main page should show labels configured inside XML instead
of property names.
If you get an 'Unknown Parameter' error while adding/updating group with property values, make sure it is
configured in pmg-profile.xml so that PMG can recognize them. The sample PMG files (configs, xmls, and
xsds) are available in /rms/app/rms/doc/pmg for reference.
Usually all the properties needed to be set on a group should be configured in XML file, otherwise the PMG
maintains only properties submitted in the add or update group request in FRM.
Group dialog boxes can be configured with Reserved mode or LAC ID.
Configuring the DCC Dashboard
The Dashboard (combined view) can be configured dynamically with the help of a sample XML file present
in RMS. The sample file deviceParamsDisplayConfig.xml contains the default contents of the Dashboard
screen and is located at
/rms/app/rms/doc/config/sample/deviceParamsDisplayConfig.xml.
Dashboard can be customized by copying this sample file to /rms/app/rms/conf directory of central
node and adding/removing <parameter> tags to any of its sections, for example,<AssignedList> or
<LiveParameterList>, in accordance with xsd located at
/rms/app/rms/doc/config/xsd/deviceParamsDisplayConfig.xsd.
You can open the xml file using VI editor and change it as necessary to customize the dashboard for your
needs.
This is an example of the deviceParamsDisplayConfig.xml file:
<?xml version="1.0" encoding="UTF-8"?>
<!-$Id$
***************************************************************************
* CISCO CONFIDENTIAL
Cisco RAN Management System Administration Guide, Release 5.0
46
January 7, 2015
Device Command and Control
Configuring the DCC Dashboard
* Copyright (c) 2012, Cisco Systems, Inc.
***************************************************************************
-->
<ParameterConfiguration xmlns="deviceParametersConfig"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="deviceParametersConfig deviceParamsDisplayConfig.xsd">
<AssignedList>
<parameter>
<source>groups</source>
<key>FemtoGateway</key>
<displayName>HNB-GW</displayName>
</parameter>
<parameter>
<source>group_parameter</source>
<key>FemtoGateway:FC-MCC</key>
<displayName>MCC</displayName>
</parameter>
<parameter>
<source>group_parameter</source>
<key>FemtoGateway:FC-MNC</key>
<displayName>MNC</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-LAC-ID</key>
<displayName>LAC ID</displayName>
</parameter>
<parameter>
<source>group_parameter</source>
<key>FemtoGateway:FC-RNC-ID</key>
<displayName>RNC ID</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-SAC-ID</key>
<displayName>SAC ID</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>CELL-CONFIG-RAN-CELL-ID</key>
<displayName>Cell ID</displayName>
</parameter>
<parameter>
<source>access_control</source>
<key>AccessMode</key>
<displayName>AccessMode</displayName>
</parameter>
<!-- <parameter>
<source>access_control</source>
<key>AccessControlList</key>
<displayName>AccessControlList</displayName>
<format>commaseparated_to_linebreak</format>
</parameter> -->
<!-- <parameter>
<source>parameters</source>
<key>/provisioning/provGroup</key>
<displayName>Provisioning Group</displayName>
</parameter> -->
<parameter>
<source>group_parameter</source>
<key>FemtoGateway:FC-PROV-GRP-NAME</key>
<displayName>Provisioning Group</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/provisioning/classOfService/selected</key>
<displayName>Class of Service</displayName>
</parameter>
</AssignedList>
<ActivatedList>
<parameter>
<source>element</source>
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
47
Device Command and Control
Configuring the DCC Dashboard
<key>ServiceStatus</key>
<displayName>Service Provisioning Status</displayName>
<defaultValue>Pre-requisites not met: AP not yet
bootstrapped</defaultValue>
</parameter>
<parameter>
<source>element</source>
<key>ServiceStatusTS</key>
<displayName>Service Provisioning Status Timestamp</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-FIRST-RADIO-ON</key>
<displayName>First Radio On</displayName>
</parameter>
<parameter>
<source>element</source>
<key>LocationValid</key>
<displayName>Location Valid</displayName>
<defaultValue>false</defaultValue>
</parameter>
<parameter>
<source>element</source>
<key>LocationValidTS</key>
<displayName>Location Valid Timestamp</displayName>
</parameter>
<parameter>
<source>location_status</source>
<key>DNMStatus</key>
<displayName>DNM Location Status</displayName>
</parameter>
<parameter>
<source>location_status</source>
<key>DNMStatusTS</key>
<displayName>DNM Location Status Timestamp</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-EDN-STATUS</key>
<displayName>Detected Neighbors Status</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>REPORTED-BANDS-SUPPORTED</key>
<displayName>Bands Supported</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>REPORTED-MAX-TX-POWER</key>
<displayName>Max Transmission Power</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>REPORTED-GPS-CAPABILITY</key>
<displayName>GPS Capability</displayName>
<format>int_to_boolean</format>
</parameter>
<parameter>
<source>element</source>
<key>BLOCKED</key>
<displayName>Blocked</displayName>
<!-- <format>int_to_boolean</format> -->
</parameter>
<parameter>
<source>parameters</source>
<key>FC-CSON-STATUS-HANR</key>
<displayName>QSS optimization status for HANR</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-CSON-STATUS-HSCO-M2F</key>
<displayName>QSS optimization status for HSCO M2F</displayName>
</parameter>
Cisco RAN Management System Administration Guide, Release 5.0
48
January 7, 2015
Device Command and Control
Configuring the DCC Dashboard
<parameter>
<source>parameters</source>
<key>FC-CSON-STATUS-HSCO-INNER</key>
<displayName>QSS optimization status for HSCO Inner</displayName>
</parameter>
</ActivatedList>
<DiscoveredList>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/Inform.DeviceId.Manufacturer</key>
<displayName>Manufacturer</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/Inform.DeviceId.ManufacturerOUI</key>
<displayName>Manufacturer OUI</displayName>
</parameter>
<!-- UMTS params -->
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.ModelName</key>
<displayName>Model Name</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.HardwareVersion</key>
<displayName>Hardware Version</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.SoftwareVersion</key>
<displayName>Software Version</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.X_00000C_3GModuleVersion</key>
<displayName>3G Module Version</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.X_00000C_RouterModuleVersion</key>
<displayName>Router Module Version</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>/cwmp/discovered/InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.MACAddress</key>
<displayName>MAC Address</displayName>
</parameter>
</DiscoveredList>
<RegisteredList>
<parameter>
<source>groups</source>
<key>Enterprise</key>
<displayName>Enterprise</displayName>
</parameter>
<parameter>
<source>groups</source>
<key>Site</key>
<displayName>Site</displayName>
</parameter>
<parameter>
<source>groups</source>
<key>Area</key>
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
49
Device Command and Control
Configuring the DCC Dashboard
<displayName>Area</displayName>
</parameter>
<parameter>
<source>groups</source>
<key>RFProfile</key>
<displayName>RF Profile</displayName>
</parameter>
<parameter>
<source>element</source>
<key>Activated</key>
<displayName>Activated</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-LOG-PERIODIC-UPLOAD-ENABLE</key>
<displayName>Periodic Log Upload Enabled</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-LOG-PERIODIC-UPLOAD-INTERVAL</key>
<displayName>Periodic Log Upload Interval</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-AP-ROLE</key>
<displayName>Role</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-AP-PURPOSE</key>
<displayName>Purpose</displayName>
</parameter>
<parameter>
<source>parameters</source>
<key>FC-RESERVED-MODE</key>
<displayName>Reserved Mode</displayName>
</parameter>
<parameter>
<source>element</source>
<key>REGISTEREDON</key>
<displayName>Registered On</displayName>
</parameter>
</RegisteredList>
<LiveParameterList>
<parameter>
<key>Alias.FAPService.FAPControl.AdminState</key>
<format>int_to_boolean</format>
</parameter>
<parameter>
<key>Alias.FAPService.FAPControl.OpState</key>
<format>int_to_boolean</format>
</parameter>
<parameter>
<key>Alias.FAPService.FAPControl.RFTxStatus</key>
<format>int_to_boolean</format>
</parameter>
<parameter>
<key>Alias.DeviceInfo.HardwareVersion</key>
</parameter>
<parameter>
<key>Alias.DeviceInfo.SoftwareVersion</key>
</parameter>
<!-- <parameter>
<key>Alias.DeviceInfo.X_00000C_3GModuleVersion</key>
</parameter>
<parameter>
<key>Alias.DeviceInfo.X_00000C_RouterModuleVersion</key>
</parameter>
<parameter>
<key>Alias.FAPService.FAPControl.EnclosureTamperingDetected</key>
<format>int_to_boolean</format>
Cisco RAN Management System Administration Guide, Release 5.0
50
January 7, 2015
Device Command and Control
Configuring the DCC Dashboard
</parameter> -->
</LiveParameterList>
Following is an example explaining how to add a new parameter, "JOB ID" to the "Assigned Data" section
in the Dashboard:
1 Log in to central node as a root user.
2 Copy the deviceParamsDisplayConfig.xml file to /rms/app/rms/conf folder.
3 Open the file using VI editor and edit the parameters as shown in the example below:
<parameter>
<source>parameters</source>
<key>FC-JOB-ID</key>
<displayName>JOB ID</displayName>
</parameter>
4 Save the changes using the command: :wq!
5 Log in to DCC UI, and verify whether the newly added parameter JOB ID has been updated in the Assigned
Data section of the device dashboard.
Note
If a configured parameter is not set for a particular device, it will not be visible in the Dashboard.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
51
Device Command and Control
Configuring the DCC Dashboard
Cisco RAN Management System Administration Guide, Release 5.0
52
January 7, 2015
CHAPTER
4
Baseline Configuration
The Small Cell RMS solution supports provisioning of devices by configuring RMS components based on
the baseline configuration. The baseline configuration defines the BAC custom properties using a defined
template, depending on the software version and the device model. The baseline configuration defines a
number of scripts, templates, extensions, and images that are executed from the command line or using the
UIs to configure various components.
• Configuring BAC, page 53
• Modified UMTS Provisioning Flow , page 56
• Enhanced REM Based Location Verification, page 57
Configuring BAC
The devices in the Small Cell RMS solution are managed through a larger set of TR-196 extension parameters
to provide additional enhanced functionalities. These standard TR-196 extension parameters are used for
retrieving device status information and for managing configuration through XML profiles (BAC templates).
The BAC configuration of the Small Cell RMS solution includes the following BAC custom properties that
are defined in the configuration template:
• Device Activation Custom Properties
• Location Aware Custom Properties
• RF Profiles Custom Properties
• Firmware Upgrade Custom properties
• ubi-config-vX.Y.Z Custom Properties
Location Aware Custom Properties
The below table lists the Location Aware Custom properties that are defined in the BAC configuration template.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
53
Baseline Configuration
Location Aware Custom Properties
Property Name
Property Type Description
FC-LOCATION-VALID
Boolean
This custom property is set by the activation flow logic on the
device record in the RDU once the location verification method
is completed. If the property is set to "true", the location is valid.
Else, if the property is set to "false" or is non-existent, the
location is not valid.
FC-LOCATION-VALID-TS DateTime
This custom property indicates the last time the
FC-LOCATION-VALID property was set. The property is
set by the activation flow logic on the device record in the RDU
as per TR-069 protocol and must be in the Co-ordinated
Universal Time (UTC) standard with a trailing 'Z'.
FC-NO-LV
Boolean
This custom property is set by RMS as a result of "Register" or
"Update" messages on the device record in the RDU. The
property is set by the activation flow logic to determine if the
location verification methods must be executed. If the location
verification is set to "true", all location methods are skipped
and the flow removes all location verification statuses and sets
FC-LOCATION-VALID to "true".
FC-DNM-STATUS
String
This custom property indicates the DNM location verification
method status and is set by the activation flow logic on the
device record in the RDU. The valid values are: Missing valid
MCC/MNCs Error: <cause> Wrong location Valid location If
the property is not present, then DNM location verification has
not yet occurred or is disabled.
FC-DNM-STATUS-TS
DateTime
This custom property is set by the activation flow logic on the
device record in the RDU and indicates the last time the
FC-DNM-STATUS property is set. The format is as per TR-069
protocol and must be in the Co-ordinated Universal Time (UTC)
standard with a trailing 'Z'.
FC-DNM-LIST
String
This custom property is a comma separated list of valid MCC
or MCC/MNCs and is configured upon initial setup of BAC.
The property is set by the RMS as a result of the "Register" or
"Update" messages on the device record in the RDU. The
property is used by the activation flow logic and compares
against the detected neighbors (from NWL) to determine if the
device location is valid or not.
FC-EDN-TOLERANCE
Integer
This custom property value indicates the minimum number of
expected neighbors that must be matched against the detected
neighbors (from REM). If the value is not present, the BAC
activation flow logic uses a default value of "1" (indicating a
single neighbor must be matched).
Cisco RAN Management System Administration Guide, Release 5.0
54
January 7, 2015
Baseline Configuration
Firmware Upgrade Custom Properties
Firmware Upgrade Custom Properties
The below table lists the Firmware Upgrade Custom properties that are defined in the BAC configuration
template.
Property Name
Property Type Description
FIRMWARE-UPGRADE-ENABLE
BOOLEAN
Conditional that defines if firmware upgrades
or downgrades are enabled or disabled for the
UBI access points.
FIRMWARE-UPGRADE-VERSION
STRING
ASCII textual string to define the explicit
firmware and software version for the UBI
access points.
FIRMWARE-UPGRADE-IMAGE
STRING
ASCII textual string to define the explicit name
of the firmware/software image for the UBI
access points.
FIRMWARE-UPGRADE-LTE-ENABLE BOOLEAN
Conditional that defines if firmware upgrades
or downgrades are enabled or disabled for the
LTE access points.
FIRMWARE-UPGRADE-LTE-VERSION STRING
ASCII textual string to define the explicit
firmware and software version for the LTE
Access Points.
FIRMWARE-UPGRADE-LTE-IMAGE
ASCII textual string to define the explicit name
of the firmware/software image for the LTE
access points.
STRING
FIRMWARE-UPGRADE-JUNI-LTE-ENABLE BOOLEAN
Conditional that defines if chipset firmware
upgrades or downgrades are enabled or disabled
for USC 5437 and USC 3437 LTE access points.
FIRMWARE-UPGRADE-JUNI-LTE-VERSION STRING
ASCII textual string to define the explicit
firmware and software version for USC 5437
and USC 3437 LTE access points
FIRMWARE-UPGRADE-JUNI-LTE-IMAGE STRING
ASCII textual string to define the explicit name
of the firmware/software image for USC 5437
and USC 3437 LTE access points
RF Profiles Custom Properties
Refer to RMS Configurable Properties for a list of RF profiles custom properties.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
55
Baseline Configuration
ubi-config-X.Y.Z Custom Properties
ubi-config-X.Y.Z Custom Properties
Refer to RMS Configurable Parameters for a list of the ubi-config-v3.4.2 Custom properties that are defined
in the BAC configuration template.
Modified UMTS Provisioning Flow
UMTS provisioning flow is modified for GPS location verification and benchmark update on DNM location
verification status.
Delayed GPS Location Verification
During the initial boot, the GPS may take longer time to acquire the GPS lock compared to the NWL scan.
The UMTS provisioning flow is modified for initial boot by ensuring GPS location verification check is the
very first location verification check. The NWL location verification check is performed only after receiving
the GPS scan status as success or time-out during the initial boot.
The configurable parameter for GPS scan timeout is available in the DCCUI Group. This can be modified as
follows to set the GPS scan timeout.
Custom Property
Parameter
Type
FC-GPS-TIME-OUT Integer
Description
Specifies the time-out value in seconds when the scan started and when
it times out. A timed out scan is reported as Error_TIMEOUT with
error details indicating "Timed out". The default value is 1200
(seconds).
Benchmark Update on DNM Location Verification Status
This feature introduces DNB benchmark update based on DNM Location verification success status.
Configurable parameter for this feature in DCCUI group is
Custom Property
Parameter Description
Type
DNB Location Verification
Methods List
String
This property refers to the location verification method
that is used in the DNB flow. This property can have
comma separated list of methods, for example,
GPS,EDN,DNL,DNM,ISM,CIG.
Cisco RAN Management System Administration Guide, Release 5.0
56
January 7, 2015
Baseline Configuration
Enhanced REM Based Location Verification
FC-DNM-BENCHMARK-UPDATE Boolean
This property is used to identify whether the benchmark
must be updated on success of DNM LV method or not.
The benchmark is updated if DNM LV is successful. The
valid values are "true" and "false"; the default value is
'true'.
To revert to RMS 4.0 flow, configure the
'FC-DNM-BENCHMARK-UPDATE' as "false", that is,
do not update benchmark on DNM LV success.
FC-DNB-FAIL-ACTION
String
This property is used to check if the DNB LV method
fails. If the value is "unknown", set the LV method status
as "Unknown"; else set the LV method status as 'Failure'.
The valid values for this property are "Unknown" or
"Error". The default value is "Unknown".
To revert to RMS 4.0 flow, configure the
'FC-DNB-FAIL-ACTION' as "Error".
Enhanced REM Based Location Verification
An enhancement in NWL benchmark computation is introduced to improve the existing radio environment
measurement (REM)-based location verification mechanism. This ensures that more number of benchmarks
ares stored, neighbors are compared using GUID rather than frequency, and 3G received signal strength
indicator (RSSI)-based transmission power is used for tolerance check.
The enhanced REM based location verification capabilities include:
• Storing a configurable number of neighbors in NWL benchmark.
• Storing RSSI information in NWL benchmark.
• Using RSSI for 3G neighbor power comparison for BAC location check.
• Using the property FC-DNB-FREQ-MATCH to decide comparison of neighbor identities using GUID
regardless of frequency signature.
• Configuring ‘periodic NWL scan’ duration.
Configure the enhanced REM based location verification properties as follows:
Property Name
Property Type
Description
FC-DNB-CONFIG-NWL
-LIST-COUNT
Integer
This custom property configures the number of
neighbors in NWL benchmark. The default value is
12.
FC-DNB-FREQ-MATCH
Boolean
This custom property is used to decide the power
comparison using GUID or frequency. The valid
values are "true" or "false"; default is "false".
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
57
Baseline Configuration
Enhanced REM Based Location Verification
FC-PERIODIC-NWL
-SCAN-INTERVAL
Integer
This custom property is configured by BAC during
runtime based on the NWL location verification
results. If GPS is out of tolerance, this property is
not affected. The default is 20 minutes for a failed
NWL scan interval and 24 hours for a successful
NWL scan interval.
Cisco RAN Management System Administration Guide, Release 5.0
58
January 7, 2015
CHAPTER
5
Device Manager
You access the device manager by clicking the Device Manager tab in the DCC UI. The device manager
provides a consolidated interface to perform various tasks on an individual Customer Premises Equipment
(CPE). Specifically it allows you to perform the functions:
• Device Provisioning, page 59
• Log Uploads and Triggers , page 84
• View Information about a Device, page 85
• Device Operations, page 86
• Device Manager Status Messages, page 94
Device Provisioning
You can register and activate a new device at a time using the Register screen in the DCC UI. Alternatively,
you can activate an already registered device using update button in the DCC UI.
Preparing to Register a Device
Use this task to choose a device to register.
Note
By default, it is assumed that deployment is UMTS only. You can change this to be a mixed 3G and LTE
or LTE only deployment after installation using the configure_deploymentmode.sh utility.
Before You Begin
Before registering a device you should verify the following:
• Latest version of RMS is installed.
• Appropriate network connectivity is established between the RDU and the DPE, and between the DPE
and the FAPs.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
59
Device Manager
Preparing to Register a Device
• The PMGDB is up and running.
• You can create groups from the DCC-UI Groups and IDs tab.
• The register button is activated when you enter in an identifier for a device in the Device Manager.
Note
After the post-installation steps are complete, do not use default Groups and Pools. Add the new Groups
and Pools.
Before registering an Enterprise device, you must create all of the following:
• Area group
• FemtoGateway group
• UMTSSecGateway group
• LTESecGateway group
• HeNBGW group
• Region group
• Site group
• Sub-Site group
• Enterprise group
• SAI pool
• CELL pool
• LTE-CEL pool
• (Optional) Alarms profile
Before registering a Residential device, you must create all of the following:
• Area group
• Femto gateway group
• HeNBGW group
• UMTSSecGateway group
• LTESecGateway group
• Region group
• Cell pool
• SAI pool
• LTE-CELL pool
Cisco RAN Management System Administration Guide, Release 5.0
60
January 7, 2015
Device Manager
Registering a Device in Enterprise Mode
Procedure
Step 1
Log in to the DCC UI with valid credentials.
The Device Command and Control screen is displayed.
Step 2
Step 3
Select the Device Manager tab.
Enter a new device ID in the Select Device text box.
The device ID is a combination of the manufacturer Organizationally Unique Identifier (OUI) number (for
example, 001B67), and the 15 digit serial number which is the International Mobile Equipment Identity (IMEI)
number of the FAP (for example, 357539019690151). The OUI for USC 5437 and USC 3437 APs is 64A837.
As you type the first few characters of the device ID, the Device Manager does an automatic lookup to find
all device IDs beginning with that string instead of having to scroll down the entire list to find the device ID
that you are looking for.
Also, as you start typing a new device ID, a tooltip is displayed indicating that the device is not registered
and the Register button is enabled to allow for registering the device.
Step 4
Click Register.
The Device Registration screen is displayed with the Device ID populated in the Device ID text box.
By default, the registration screen for UMTS is displayed. For LTE FAPs, select LTE.
By default, the registration screen for Enterprise deployment is displayed. For Residential FAP registration,
check the Residential Deployment check box.
Note
The content of this dialog box is based on the dynamic screen configuration files. Refer to Configuring
DCC Dialog Boxes, on page 41 for information on customizing the dialog boxes.
Registering a Device in Enterprise Mode
Use this task to register a device in Enterprise mode after the Device Registration screen is displayed.
Note
Only open mode is supported for enterprise devices. This means that no whitelist is supported and all
access control is determined at the HNB-GW.
Before You Begin
You should have completed all prerequisites for registering an Enterprise device, including creating any
required groups and pools. Refer to Preparing to Register a Device, on page 59.
While registering an enterprise inner device, multicell active entry device or multicell idle entry device, the
grid should be enabled for the selected site.
The grid should be disabled for standalone active entry and idle entry devices.
Note
The grid parameter for the corresponding site should be disabled.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
61
Device Manager
Registering a Device in Enterprise Mode
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
If you are registering an LTE device, verify that the LTE radio button is checked.
Uncheck the Residential mode check box.
Optionally, add the Subscriber ID and Secondary ID to be associated with the device.
Select the Enterprise to be assigned to the device from the Enterprise drop-down list.
Select the Site to be used from the Site drop-down list.
If you are registering an LTE device, select the LTE provisioning group.
Optionally select the group name from the RF Profile drop-down list.
RF profile is used for RF tuning and configuration (power settings, handover rules, and so on). The number
of profiles existing by default is five. CurreA number of RF profiles are applicable, for example:
Multicell_Open_20dBm, Multicell_Open_24dBm, Standalone_Open_13dBm, Standalone_Open_20dBm,
Standalone_Open_24dBm.
Step 8
Select the AP role to be assigned to the device from the AP Role drop-down list.
The drop-down list provides you with these three options:
• Active Entry AP—AP in this role offers full idle and connected mode mobility on par with macrocell
to macrocell handover. The number of APs is strictly limited by macro constraints (32 Inter RAT and
Inter Frequency neighbors total), because it requires configuration of unique AP primary scrambling
code (PSC) and Cell ID in macro neighbor list.
• Inner AP—AP in this role does not offer active macrocell to femtocell mobility in idle or connected
mode, and has constrained or disabled femtocell to macrocell mobility. This concept is unique to multicell
deployments. The APs in this role support mobility with other APs in the multicell grid. The advantage
of this role over Idle Entry AP is that Inner APs can use a larger set of PSCs that are unknown to the
macrocell, thereby reducing PSC conflicts among those APs. Disable Inner AP role for Standalone
Enterprise AP.
• Idle Entry AP—AP in this role offers full mobility with macrocell in idle and connected mode, with the
exception of macrocell to femtocell handover which is disabled in macrocell. The advantage of such
deployment is high scaling because of the reuse of AP PSCs in the macro neighbor list. Primarily,
residential APs are deployed in this role due to large quantities.
The AP usage role is assigned by the
administrator.
Select the AP Purpose for the device: Coverage or Capacity.
APs are classified by their intended purpose to provide capacity or coverage.
Note
Selecting Coverage or Capacity purpose has no functional effect if the AP being registered is an
Inner AP. This field can be left as is.
• Coverage—provides network connectivity at all desired locations.
Note
Step 9
• Capacity—provides sufficient bandwidth to satisfy the communication requirements of the client. APs
classified for capacity are assumed to be deployed in areas of sufficient macro coverage.
The default AP Purpose is
Coverage.
Step 10 Check the Activated check box.
Note
Cisco RAN Management System Administration Guide, Release 5.0
62
January 7, 2015
Device Manager
Registering a Device in Residential Mode
This option controls whether the device is allowed to activate its radio. If you do not select the Activated
check box while registering the device, you can activate the registered device later by clicking Provision and
selecting Update.
Step 11 Click Register in the Device Registration dialog box.
After registering the device, the successfully registered device message is displayed at the top left corner of
the screen along with the dashboard.
Registering a Device in Residential Mode
Use this task to register a device in Residential mode after the Device Registration screen is displayed.
Note
UMTS residential devices can be registered in either closed or open mode. Once the device is operational
you can verify whether it is in open or closed mode by using this command from the HNB gateway: show
hnbgw sessions full
LTE residential devices can be registered in open mode only.
Before You Begin
You should have completed all prerequisites for registering an Enterprise device, including creating any
required groups and pools. Refer to Preparing to Register a Device, on page 59.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
If you are registering an LTE device, verify that the LTE radio button is checked.
Check the Residential Deployment check box. The Residential mode check box is checked by default.
Optionally, add the Subscriber ID and Secondary ID to be associated with the device.
Check the Select Area Manually check box, to manually enter the area, then select the area to be assigned
to the device from the Area drop-down list box.
Alternatively, uncheck the Select Area Manually check box, and specify the Latitude and Longitude value
to get the area. To do this configure the PMG DB and connect it to the Central Node. Refer to the RMS
Installation Guide, Configuration of PMGDB with Central Node for more details.
Optionally select the group name from the RF Profile drop-down list.
RF profile is used for RF tuning and configuration (power settings, handover rules, and so on). The number
of profiles existing by default is five. However, only one can be assigned to the device.
Check the Activated check box.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
63
Device Manager
Register a Device with a New Group
The Activated check box is checked by default. This option controls whether the device is allowed to activate
its radio. If you do not select the Activated check box while registering the device, you can activate the
registered device later by clicking Provision and selecting Update.
Step 8 Select the Closed mode check box to register a device in closed mode access.
Step 9 Update the details such as White list, ACL. ACL is the access control list which holds IMSI of the UE of 14
to 15 digits.
Step 10 Click Remove selected to remove the added White lists/ ACL.
Step 11 If you are registering an LTE device, specify the tracking area code (TAC) ID that corresponds with the
FC-TAC-ID property.
Step 12 Optionally, click the Assign INSEE checkbox and add the INSEE Code or add the IU SAC ID to be associated
with the device.
Step 13 Click Register in the Device Registration dialog box.
After registering the device, the successfully registered device message is displayed at the top left corner of
the screen along with the dashboard.
Register a Device with a New Group
If a device is registered to an existing group, and you need to associate it with a new group, follow this
procedure to change the group with which the device is registered.
Procedure
Step 1
Select the device that you need to provision with the new group from the Select Device drop-down list in the
Device Manager screen.
Step 2
Select Shutdown from the Provision drop-down list.
Refer to Shutting Down a Device, on page 93 for more information.
Step 3
Enter a the device ID in the Select Device text box in the Device Manager screen and click Register.
Step 4
Select the new group for which the device needs to be provisioned and register the device as described in
Preparing to Register a Device, on page 59, Registering a Device in Enterprise Mode, on page 61, and
Registering a Device in Residential Mode, on page 63.
Note
For enterprise registration a direct group association with the device is not possible. Therefore, pair
the site associated with the device and the new group.
Assigning a Device to a New Site
Use this task to associate a device with a different site than the site used when the device was originally
provisioned.
Cisco RAN Management System Administration Guide, Release 5.0
64
January 7, 2015
Device Manager
Reassign a Site to a Different Area
Procedure
Step 1
From the Group and ID tab in the DCC UI, select Groups from the left navigation pane.
Step 2
Step 3
Click the Site tab and click Add.
Refer to Adding a Group Instance, on page 122 to add a new site group using the same enterprise that was
previously associated with the site.
Select a device that needs to be reassigned using the device identifier fields at the top of the Device Manager
screen.
Select Update from the Provision drop-down list.
Change the Site to be the new site to which you are registering the device. Refer to Adding a Group Instance,
on page 122.
Step 4
Step 5
Step 6
Note
You can perform the above steps by using the HTTP client, or poster (OSS) via update the device XML
files by providing a different site.
Reassign a Site to a Different Area
Use this task to assign a site to a different area.
Procedure
Step 1
From the Group and ID tab in the DCC UI, select Groups from the left navigation pane.
Step 2
Step 3
Step 4
Click the Site tab and select an existing site.
Click Update.
Do one of these:
• Click Area Association and change the Area to which the site or device needs to be associated.
• Unclick Area Association and specify the latitude and longitude coordinates of the area.
Note
You can perform these steps by using the HTTP client or poster (OSS) via the update device XML files
by providing a different area.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
65
Device Manager
Updating a Device
Updating a Device
Use this task to activate a registered device or to manipulate the values such as RF Profile, AP Role, AP
Purpose (for Enterprise mode) and white list, ACL (for Residential mode) specified during registration.
The dialog box displayed for updating a device depends on whether the device is registered in Residential or
Enterprise mode. If the device is associated with an Enterprise and Site group, the Enterprise update screen
is displayed, otherwise the Residential update screen is displayed.
You can customize the Enterprise and Residential update dialog boxes using dynamic configurations. Refer
to Configuring DCC Dialog Boxes, on page 41.
Procedure
Step 1
Step 2
Select a registered Device ID from the Select Device drop-down list box in the Device Manager screen.
The latest ten AP EIDs are displayed in the drop down configuration. Providing the first few characters of
the device EID displays all the relevant EIDs.
Select the Provision tab, and select Update from the drop-down list.
The Update Device Registration dialog box is displayed with the selected Device ID value automatically
populated in the Device ID text box. The dialog box displayed for updating a device depends on whether the
device is registered in Residential or Enterprise mode.
Step 3
Select Activated.
Note
Select this option only if the device was not activated during registration.
Step 4
(Optional) Update the required information regarding the device. For more information regarding the specific
fields, refer to Registering a Device in Residential Mode, on page 63 or Registering a Device in Enterprise
Mode.
You have an option to clear in the tampered state of the device in case the device reports as, tampered.
Step 5
Click Update to activate the registered device.
After updating a device, the dashboard is displayed together with the successfully updated message at the top
left corner of the screen.
(Optional) Select the Provision tab, and select Upload Configurations from the drop-down list.
Specifies the trace configuration for the device.
Step 6
The Current Trace Profile setting allows the default behavior of choosing a different trace profile to be
overridden until the next reboot. Values can be:
• -1—the FAP is allowed to choose its own local trace levels.
• 0—the FAP must use low levels of trace [Applicable to UMTS devices only.]
• 1—the FAP must use medium levels of trace [Applicable to UMTS devices only.]
• 2 means that the FAP must use high levels of trace
Note
Step 7
High levels of trace will impact call capacity and should only be used in controlled circumstances!
Click Update to update the trace parameters.
After updating a device, the dashboard is displayed together with the successfully updated message at the top
left corner of the screen.
Cisco RAN Management System Administration Guide, Release 5.0
66
January 7, 2015
Device Manager
Clearing a Tampered Device
Clearing a Tampered Device
The Anti-Tamper feature allows you to clear a tampered device. The device can only report its Tampered
status as 'true' and cannot be cleared automatically. To clear a tampered device, follow this procedure.
Procedure
Step 1
Step 2
Step 3
Log in to the DCC UI.
In the Device Manager tab, select the Device ID from the Device Search drop-down list.
Check if the device is tampered. To do this, select the tampered device from the Select Device drop-down
list. For example, 001B67-357539017729001.
Step 4
Click View > Dashboard to view the details of the device displayed on the screen. The Activation Status
section of the dashboard will display the Tampered status as "true".
To clear tampering, perform this step if no chassis ID is associated with the device. Else, proceed with Step
6.
a) Go to Provision > Update to open the Update Device Registration window.
b) In the Update Device Registration window, check the Clear Tampering? check box to clear the tampering
on the device.
c) Click Update. The device tampering is cleared.
Step 5
Step 6
Perform this step if a chassis ID is associated with the device. The chassis ID for the device is displayed in
the Chassis Information section of the dashboard.
a) Click the Chassis ID link to enable the Provision Chassis option.
b) Click Provision Chassis > Clear Tampering On Chassis. Click Confirm in the Confirmation dialog
box, which is displayed, to clear the tampering on the device.
Step 7
Verify if the tampering is cleared. Repeat steps 2 to 4. The Tampered status should be displayed as "false".
This confirms that the device tampering is cleared.
Enabling Location Verification
Location Verification (LV) is part of provisioning flow in which before unlocking the HNB for Radio On, its
location is verified to ensure that the HNB is still in the same location where it was registered.
RMS supports the following types of Location Verification:
• Global Positioning System (GPS)
• Expected Detected Neighbors (EDN)
• Detected Neighbor Location (DNL)
• Detected Neighbor MCC/MNC (DNM)
• IP address Subnet Match (ISM)
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
67
Device Manager
Enabling Location Verification
• Chained Intra Grid (CIG)
• Detected Neighbor Benchmark (DNB)
• Chained Intra Chassis (CIC)
All the above LV methods are configurable from the RMS. By default, DNM and DNB LV methods are
enabled as part of RMS installation. For enabling other LV methods, the properties need to be set manually
from the BAC UI either at the group or device level as per the requirement.
Note
Location Verification can be skipped by setting the property present at the Area group level, FC-NO-LV
to true and proceed with the AP registration with the HNB GW.
Global Positioning System
Global Positioning System (GPS) location verification (LV) verifies the location of the HNB based on the
comparison between Reported Latitude/Longitude by HNB during GPS scan and the expected latitude/longitude
of the HNB provided during HNB Registration. If the distance between Expected Latitude/Longitude and
Reported Latitude/Longitude is within the GPS tolerance, then the GPS LV will pass.
Note
• If the PMG DB is installed in the RMS system with Area to Latitude/Longitude mapping, then create
the Area with the unique identifier that defines the mapping of the Area key with the
Latitude/Longitude stored in the PMG DB.
• After creating the Area, then create the Site group by selecting Latitude/Longitude instead of Area,
so that the Area is automatically selected from the mapped Latitude/Longitude from PMG DB.
• After creating the Site, select the Latitude/Longitude when registering the Residential FAP and
similarly, select the Site when registering the Enterprise FAP.
• All the created and registered Area, Site, and Residential FAP with Latitude/Longitude, these
Latitude/Longitude will be treated as the Expected Latitude/Longitude for the FAP. In this case,
there is no need to define the Expected Lat/Long for GPS LV.
• In case PMG DB does not exist and there is no mapping of Latitude/Longitude to the Area, then
after registering the AP (Residential or Enterprise), select the Custom property (FC-EXP-LAT and
FC-EXP-LONG) from BAC UI and provide the Expected Latitude/Longitude of the AP at the Device
or Group level for GPS LV.
Property
Format
Expected Value
Comments
FC-GPS-ENABLED
Boolean
true or false
Enables the GPS LV
methods during the
provisioning flow
Cisco RAN Management System Administration Guide, Release 5.0
68
January 7, 2015
Device Manager
Enabling Location Verification
FC-EXP-LAT
Decimal format if
configured from the DCC
UI with six decimal
places; integer format if
configured from the BAC
UI.
-90.000000 to 90.000000
if configured from the
DCC UI; -90000000 to
90000000 if configured
from the BAC UI.
Expected latitude of the
HNB. Refer to Note
section to understand
more on this parameter
and for the input of this
parameter.
FC-EXP-LONG
Decimal format if
configured from the DCC
UI with six decimal
places; integer format if
configured from the BAC
UI.
-180.000000 to
180.000000 if configured
from the DCC UI;
-180000000 to
180000000 if configured
from the BAC UI
Expected longitude of the
HNB. Refer to previous
Note section to
understand more on this
parameter and for the
input of this parameter.
FC-GPS-TOLERANCE
Integer value in meters
GPS Tolerance in meters The distance between the
expected latitude or
longitude and the reported
latitude or longitude is
calculated using the
Haversine formula and is
then compared with the
GPS tolerance. If the
actual distance is less than
or equal to the GPS
tolerance then the GPS
passes, otherwise the GPS
fails.
FC-GPS-LAT
Actual/Reported GPS
Latitude
Actual/Reported GPS
Latitude
Read-only parameter and
should not be configured.
Once the HNB completes
the GPS scan, it reports
the actual latitude which
is populated automatically
at the device level.
FC-GPS-LONG
Actual/Reported GPS
Longitude
Actual/Reported GPS
Longitude
Read-only parameter and
should not be configured.
Once the HNB completes
the GPS scan, it reports
the actual longitude which
is populated automatically
at the device level.
Once the LV method is verified, then at device level, below two properties will automatically get configured
displaying the GPS status.
• FC-GPS-STATUS= This will be either Valid Location, Wrong Location, Missing expected location,
or Error: <cause>
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
69
Device Manager
Enabling Location Verification
• FC-GPS-STATUS-TS =This is a timestamp when the above state of the GPS status is changed.
GPS Status
Comments
Valid Location
GPS Success
Wrong Location
GPS Failure
Missing Expected
Location
Expected Latitude and Longitude are missing
Error: <cause>
There is some issue in GPS scan or GPS scan could not locate the satellite and got
timed Out
Expected Detected Neighbor
Expected Detected Neighbor (EDN) location verification (LV) verifies the neighbors based on reported
neighbors discovered during 2G and 3G REM scan.
Following are the properties required for enabling and configuring EDN LV.
Property
Format
Expected Value
Comments
FC-EDN-ENABLED
Boolean
True or false
Enables the verification of EDN
LV methods during the
provisioning flow
FC-EDN-LIST
Comma separated
value where each
value defines the
neighbor ID
Neighbor ID For
List of expected neighbors. If the
example,
list is not provided then the LV
3G3100110016935527, returns the status as unknown.
2G3100110016935527
FC-EDN-TOLERANCE
Single value
integer
Integer
This property defines the
tolerance, or threshold to pass the
LV. The default value is 1. If the
value is not configured then by
default, the tolerance will be
considered as 1.
For example, if the value of this
property is 3 then a minimum of
three neighbors are expected to
match to pass EDN LV, else the
result of the LV methods is
decided based on the next 2
properties
(FC-EDN-NO-MATCH-STATUS
and
FC-EDN-NO-NEIGHBOR-STATUS).
Cisco RAN Management System Administration Guide, Release 5.0
70
January 7, 2015
Device Manager
Enabling Location Verification
FC-EDN-NO-MATCH-STATUS String
"unknown"/ "failure"
If none of the valid neighbors
match and the detected neighbor
count is not zero then the result of
the method is determined by the
configured value, either
"unknown" or "failure."
The default value is "unknown".
Hence if the property is not
defined, then LV returns
"unknown."
FC-EDN-NO-NEIGHBOR-STATUS String
"unknown"/ "failure"
If none of the valid neighbors
match and the detected neighbor
count is zero, the result of the
method is determined by the
configured value, either
"unknown" or "failure".
The default value is "unknown."
Hence if the property is not
defined, then LV returns
"unknown."
Once the LV method is verified then at the device level, below two properties will automatically get configured
displaying the EDN status.
• FC-EDN-STATUS = This is either “Valid Location”, “Wrong Location”, “Ignoring Wrong Location”,
“Missing expected neighbors” or “Error: <cause>”.
• FC-EDN-STATUS-TS = This is a timestamp when the above state of the EDN status is changed.
See Additional Location Verification Tasks, on page 237 for more information on how to configure the
Neighbor ID.
Below is the status and description of all the EDN:
EDN Status
Description
Valid Location
EDN Success
Wrong Location
EDN Failure
Ignoring Wrong Location
No matching neighbor, or no neighbors detected and "unknown" is returned
Missing expected neighbors EDN List is missing or not configured and "unknown" is returned
Error: <cause>
There is some issue in 2G or 3G REM scan
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
71
Device Manager
Enabling Location Verification
Detected Neighbor Location
Detected Neighbor Location (DNL) location verification (LV) verifies the detected neighbor's ID and then
compares the location configured in the file with that reported by the HNB. If the distance between
latitude/longitude of the HNB and that configured in file is within the tolerance then the LV method passes.
Following are the properties required for enabling and configuring the DNL LV:
Property
Format
Expected Value
Comments
FC-DNL-ENABLED
Boolean
True or false
Enables the verification of
DNL LV methods during
the provisioning flow
Filename
Filename which contains
the expected neighbor ID
along with the latitude and
longitude for location
verification. The file is
added to RDU through
BAC.
FC-CELL-LOC-FILE
See Additional Location
Verification Tasks for
more details on this
process.
FC-EXP-LAT
Decimal format
if configured
from the DCC
UI with six
decimal places;
integer format if
configured from
the BAC UI.
-90.000000 to
90.000000 if
configured from the
DCC UI; -90000000 to
90000000 if
configured from the
BAC UI.
FC-EXP-LONG
Decimal format
if configured
from the DCC
UI with six
decimal places;
integer format if
configured from
the BAC UI.
-180.000000 to
180.000000 if
configured from the
DCC UI; -180000000
to 180000000 if
configured from the
BAC UI
FC-DNL-TOLERANCE
Integer
Great Circle Distance Defines the tolerance or
(GCD) (in meters)
threshold value in distance
to pass the LV. The
default value is 5000 m.
Cisco RAN Management System Administration Guide, Release 5.0
72
January 7, 2015
Device Manager
Enabling Location Verification
FC-DNL-NO-MATCH-STATUS
String
"unknown"/ "failure"
Used only when macro is
detected and the macro
matches the cell ID
configured in DNL file.
The result of out of
tolerance when a neighbor
is matched is decided by
this property. Either
unknown or failure.
Default value is failure. so
if this property is not
defined, by default the
flow considers it as
failure.
FC-DNL-NO-NEIGHBOR-STATUS String
"unknown"/ "failure"
If none of the valid
neighbors match and the
detected neighbor count is
zero, then the result of the
method is determined by
the configured value,
either unknown or failure.
The default value is
unknown. Hence if the
property is not defined,
then LV will return
unknown.
The file entry for the DNL is as follows:
The cell location file is a text file comprised one entry per line. Each entry is comma separated and consists
of: <neighbor identifier>, <neighbor latitude>, <neighbor longitude>.
Where,
• <neighbor identifier> is as per mentioned in REM Neighbor Identifier
• <neighbor latitude> is the latitude of the neighbor
• <neighbor longitude> is the longitude of the neighbor
For example:
• 2G3104101201015722,22142550,-80169470
3G3104101035010922,52142522,-80545470
Once the LV method is verified then at device level below two properties will automatically get configured
displaying the DNL status.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
73
Device Manager
Enabling Location Verification
• FC-DNL-STATUS= this will be either “Valid Location”, “Wrong Location”, “Ignoring Wrong Location”,
“Missing cell location file”, “Detected neighbors missing from cell location file”, “Missing expected
location” or “Error: <cause>”
• FC-DNL-STATUS-TS= The timestamp when the above state of the DNL status is changed.
Refer to the Additional Location Verification Tasks to understand how to configure the Neighbor ID.
Below is the status and description of the DNL:
DNL Status
Description
Valid Location
DNL Success
Wrong Location
DNL Failure
Ignoring Wrong Location
Detected macros that are part of the DNL file but are out of
tolerance and FC-DNL-NO-MATCH-STATUS is configured
as "Unknown."
No neighbors are detected and
FC-DNL-NO-NEIGHBOR-STATUS is configured as
"Unknown."
Missing cell location file
DNL expected neighbor file is missing and "Unknown" is
returned.
Detected neighbors missing from cell
location file
File does not have expected latitude or longitude or neighbor
ID, or detected macro is not present in file
Missing expected location
HNB latitude or longitude is not configured
Error: <cause>
Issue in 2G or 3G REM scan
Detected Neighbor MCC/MNC
Detected Neighbor Mobile Country Code (MCC) or Mobile Network Code (MNC) [DNM] location verification
(LV) verifies the location by the location of the HNB by validating the reported Public Land Mobile Network
Identifier (PLMN ID) of the detected neighbor. The PLMNID is comprised of the MCC and the MNC.
Following are the properties required for enabling and configuring this LV method.
Property
Format
Expected Value
Comments
FC-DNM-ENABLED
Boolean
True or false
Enables the verification of
DNM LV methods during the
provisioning flow
Cisco RAN Management System Administration Guide, Release 5.0
74
January 7, 2015
Device Manager
Enabling Location Verification
FC-DNM-LIST
Comma separated
value where each
value defines the
MCC or PLMNID
of the neighbor
FC-DNM-NO-MATCH-STATUS String
MCC and MNC of
the expected
neighbor. E.g
116113, where 116
= MCC and 113 =
MNC
List of expected neighbors. If
the list is not provided then
the LV returns the status as
unknown.
"unknown" or
"failure"
If none of the valid neighbors
are matching and the detected
neighbor count is not zero,
then the result of the method
is determined by the
configured value, either
unknown or failure.
The default value is
"unknown," hence if the
property is not defined, then
LV returns "unknown".
FC-DNM-NO-NEIGHBOR-STATUS String
"unknown" or
"failure"
If none of the valid neighbors
match and the detected
neighbor count is zero, then
the result of the method is
determined by the configured
value, either unknown or
failure.
The default value is
"unknown," hence if the
property is not defined, then
LV will return unknown.
Note
The LV method is enabled by default as part of RMS installation. The DNM list can be configured through
DCC_UI in Area group.
Once the LV method is verified then at device level, below two properties will automatically get configured
displaying the DNM status.
• FC-DNM-STATUS = This is either “Valid Location”, “Wrong Location”, “Ignoring Wrong Location”
and “Missing valid MCC/MNCs”
• FC-DNM-STATUS-TS = This is a timestamp when the above state of the DNM status is changed.
See Additional Location Verification Tasks, on page 237 for more information on how to configure the
Neighbor ID.
Below is the status and description of all the DNM:
DNM Status
Comments
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
75
Device Manager
Enabling Location Verification
Valid Location
DNM Success
Wrong Location
DNM Failure
Ignoring Wrong Location
No Matching neighbor or no neighbors detected and "unknown"
is returned
Missing valid MCC/MNCs
DNM List is missing or not configured and "unknown" is returned.
Error: <cause>
There is some issue in 2G or 3G REM scan
IP Address Subnet Match
The IP Address Subnet Match (ISM) location verification (LV) method uses the source IP address subnet
match defined in CIDR format of the sessions to verify if the HNB is communicating with the allowed subnet.
Following are the properties required for enabling and configuring the ISM LV.
Property
Format
Expected Value Comments
FC-ISM-ENABLED
Boolean
True or false
FC-ISM-File
Filename Filename
Filename which contains the allowed
IPv4 address subnets
FC-ISM-REJECT-UNKNOWN
Boolean
If the property is true or not present
or not configured, and the HNB IP
address does not match the configured
IP address in the file, then the LV
method returns "Failure". If the
parameter is False and HNB IP
address does not match with the IP
address configured in the File then the
LV method returns "Unknown" and
logs the correct subnet as a warning
message in the troubleshooting logs
for you to configure the correct value
in the file, if required.
True or false
Enables the verification of ISM LV
methods during the provisioning flow
The IP address subnet match (DNL) file is a text file comprised of one entry per line. Each entry is a IPv4
subnet defined as CIDR notation (<network address>/<mask bits>). For example, 192.168.0.0/24, 10.10.10.0/24.
Save the file with some name, for example ISM.txt and give the same name for the property FC-ISM-FILE.
Once the LV method is verified then at device level, below two properties will automatically get configured
displaying the ISM status.
• FC-ISM-STATUS = This is either “Valid Location”, “Wrong Location”, “Missing ISM file” or “Unknown
subnet”
• FC-ISM-STATUS-TS = This is a timestamp when the above state of the ISM status is changed.
Cisco RAN Management System Administration Guide, Release 5.0
76
January 7, 2015
Device Manager
Enabling Location Verification
See Additional Location Verification Tasks, on page 237 for more information on how to configure the
Neighbor ID.
Below is the status and description of all the ISM:
ISM Status
Comments
Valid Location
ISM Success
Wrong Location
ISM Failure
Missing ISM file
When the file is missing
Unknown subnet
If <FC-ISM-REJECT-UNKNOWN> is False, and
HNB IP does not match with the one's configured in
the File, then the LV method returns Unknown and
logs the correct subnet as warning message for the
operator to configure the correct value in the file, if
required.
Chained Intra Grid (CIG)
The Chained Intra Grid (CIG) LV method is used for enterprise deployment for a grid concept. For example,
if there are three APs in the Grid with two APs located inside the premises and one AP is planned outside or
edge of premises, since one of the APs (edge AP/Active entry AP) get GPS lock, the LV for other APs will
be passed since they are part of the same grid even though the two inner APs did not get GPS satellite lock
or macro neighbors during NWL.
Below are the properties relevant for CIG LV:
Property
Format
Expected Value
Comments
FC-CIG-ENABLED
Boolean
true or false
This property enables the
CIG LV methods during
Provisioning Flow .
Group Type name (Site,
Area, FemtoGateway)
The value of this property
states that on which group
the details of anchor AP
has to be populated after
the Anchor AP is formed.
For enterprise
Deployment, the
suggested value is Site
group type.
Only one group type
name has to be given as
input for this parameter.
FC-CIG-GROUP-TYPE Single Value String
Only the group type name
has to be entered, not the
group name.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
77
Device Manager
Enabling Location Verification
FC-CIG-LV-METHOD-LIST String
GPS
FC-CIG-TOLERANCE
CIG Tolerance in meters The Anchor AP details
(Latitude/Longitude) for
a grid will be updated
only if the (actual GPS
distance reported by
anchor AP) >
(FC-CIG-TOLERANCE
+
FC-CIG-GPS-DISTANCE)
Integer value in meters
FC-ANCHOR-AP-LV-LIST String
GPS
This parameter states
which all LV methods
need to be considered for
passing the CIG LV. Only
GPS is supported, hence
GPS is the only value
supported for this
parameter.
This parameter state
which all LV methods
need to be considered for
creating an anchor AP.
Only GPS is supported,
hence GPS is the only
value supported for this
parameter.
The above mentioned properties are for the configuration of CIG.
Below are the properties which are used by CIG for the CIG verification. The below mentioned properties
gets automatically populated on the required Group type (as defined in the property (FC-CIG-GROUP-TYPE).
The user do not need to configure any of the below properties as they are configured automatically once the
GPS scan is completed for any one of the AP in the grid.
Property
Format
Expected Value
Comments
FC-CIG-ANCHOR-AP-EID string
EID of Anchor AP
First AP in a grid passing
GPS becomes anchor AP
and its details will be
populated at group level
for other APs to do CIG
LV
FC-CIG-GPS-LAT
Latitude
Latitude of Anchor AP
Latitude of Anchor AP
FC-CIG-GPS-LONG
Longitude
Longitude of the AP
Longitude of the AP
Distance in meters
GPS distance reported
between expect and actual
co-ordinates of the anchor
AP
FC-CIG-GPS-DISTANCE Integer
Cisco RAN Management System Administration Guide, Release 5.0
78
January 7, 2015
Device Manager
Enabling Location Verification
The CIG status can be either Valid Location (if CIG is passed) or Unknown (if CIG is failed).
Detected Neighbor Benchmark (DNB)
Detected Neighbor Benchmark (DNB) location verification (LV) stores the benchmark when there is a first
successful LV and after which it verifies the benchmark on the subsequent flow. If the benchmark fails, but
other LV methods configured for DNB passes, then the DNB updates its benchmark. This method is enabled
by default as part of RMS installation.
Following are the properties defined for DNB LV:
Property
Format
Expected Value
Comments
FC-DNB-ENABLED
Boolean
true or false
Enables the verification
of DNB LV methods
during the provisioning
flow
FC-DNB
Comma separated
Value where each
value is a
combination of
Neighbor
ID|Frequency
Signature|Power
<NeighborID>|<Frequency
signature>|power for
example,
3G11911900000012341|0712130-|86.0
List of benchmark
entries for DNB. The list
is automatically
populated once any one
of the LV methods
(configured in
FC-DNB-LV-METHOD-LIST)
passes and none fails.
FC-DNB-FREQ-MATCH
Boolean
true or false
Defines whether to
match the frequency
signature of the
neighboring HNB, or to
skip the verification of
frequency signature.
FC-DNB-LV-METHOD-LIST
String
GPS, CIG, EDN,
DNL, ISM
Defines which of the LV
methods should be used
for DNB list population
or DNB verification in
case DNB is not passed.
If the configured LV
method is enabled then
that is used to
populate/update the
DNB. This is a comma
separated value.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
79
Device Manager
Enabling Location Verification
FC-DNB-POWER-TOLERANCE
Power in dBm
integer
FC-DNB-TX-POWER-THRESHOLD Power in dBm
Defines the threshold for
matching the power of
neighboring HNB's to
the power of defined
HNB in the DNB list. If
power is within this
tolerance, then the
neighbor is valid for
DNB.
Defines the threshold for
the detected 3G
neighbors to be
considered for valid 3G
neighbor which is used
for DNB verification. If
the power of detected 3G
neighbor is below this
threshold, then that
detected neighbor is
ignored and is not
considered for
verification.
Once the LV method is verified then at device level, below two properties will automatically get configured
displaying the DNB status.
• FC-DNB-STATUS = This will be either "Valid Location", "Wrong Location", "Not executed, no
verification methods configured", "Not Running, Not ready", or it will not be updated if the DNB LV
is "Unknown" .
• FC-DNB-STATUS-TS = This will be a timestamp when the above state of the DNB status is changed.
See Additional Location Verification Tasks, on page 237 for more information.
Below is the status and description of the DNB:
DNB Status
Description
Valid Location
DNB Success
Wrong Location
DNB Failure
Not executed, no verification
methods configured
Indicates that the DNB LV is enabled but "FC-DNB-LV-METHOD-LIST"
property is not configured with any LV methods
Not Running, Not ready
Indicates that the DNB LV is enabled but none of the LV methods defined
in "FC-DNB-LV-METHOD-LIST" is enabled
Additionally, if the DNB list is not present in the device, then it will get populated if the DNB LV is passed.
Cisco RAN Management System Administration Guide, Release 5.0
80
January 7, 2015
Device Manager
Providing IPv6 Support on HeNBGW
Chained Intra Chassis
Chained intra chassis (CIC) location verification allows you to skip location verification on a technology type
(either 2G, 3G or 4G) within the same chassis, if another technology type in the chassis has already completed
the location verification process. This is applicable to GPS and REM location verification methods.
This properties are applicable to CIC LV:
Property
Format
Expected Value
Comments
FC-CIC-ENABLED
Boolean
true or false
This property enables the
CIC LV methods during
Provisioning Flow .
The remaining properties are automatically updated at the device level if CIC is enabled and LV passes for
any technology AP on the chassis.
FC-CIC-ANCHOR-AP-EID String
EID of Anchor AP
When
FC-CIC-ENABLED set
as true and location
verification is passed for
the first AP from a chassis
then mark EID of that AP
(Either 3G or 4G)
FC-CIC-STATUS
String
Status of the CIC LV
Property gets updated to
show the status of CIC
LV
FC-CIC-STATUS-TS
String
Time stamp of the CIC
LV update
Time stamp at which the
CIC LV has got updated
FC-CHASSIS-ID
String
Chassis ID of the AP
This property gives the
chassis ID on which both
technology AP’s are
mapped
FC-PEER-RAT-ID
String
Peer RAT ID of the AP
This property gives the
device EID of the other
RAT in the
FC-CHASSIS-ID
Providing IPv6 Support on HeNBGW
Cisco RMS provides IPv6 support on LTE devices.
During OVA installation, the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property on the HeNBGW is
set to IPv4 by default. To ensure IPv6 support, change this property to IPv6 during OVA installation.
Similarly, by default the FC-IPSEC-IP-TYPE property on the LTESecGateway is set to IPv4. However, during
registration, the device selects the IPv6 or IPv4 address on the LTESecGateway based on the value set for the
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
81
Device Manager
Providing IPv6 Support on HeNBGW
FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property on the HeNBGW. This behavior is depicted as
follows:
Scenario 1: Device that gets registered to the HeNBGW1 gets associated with the LTESecGateway 1
Scenario 2: Device that get registered to HeNBGW1 gets associated with LTESecGateway2
The FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property on the HeNBGW can be changed at the time
of installation, that is, change default value IPv4 to IPv6, or post-installation using the DCCUI. To do this,
see, Changing IPv4 Support to IPv6 on HeNBGW or LTESecGateway Post Installation, on page 83.
To migrate devices registered as IPv4 devices to IPv6, see Migrating Devices from IPv4 to IPv6, on page
82.
Migrating Devices from IPv4 to IPv6
Use this procedure to change the HeNBGW and LTESecGateway to support IPv6. The procedure configures
the HeNBGW and LTESecGateway to automatically use IPv6 for new devices as well as migrating existing
devices to IPv6.
Cisco RAN Management System Administration Guide, Release 5.0
82
January 7, 2015
Device Manager
Providing IPv6 Support on HeNBGW
Procedure
Step 1
Step 2
Step 3
Modify the FC-IPSEC-IP-TYPE property in the LTESecGateway to be "IPv6."
Modify the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property in the HeNBGW to be "IPv6."
Execute the reassignDevices.sh script on an input file containing the list of all LTE FAP EIDs that need to
be migrated, as detailed here:
a) Log in to the Central node.
b) Switch to a user who is a member of ciscorms group.
c) Create a file in the home directory with the name secgateway containing a list of the LTESecGateway
names that you want to reassign. The names should be listed on separate lines in the file.
d) Run this command:
reassignDevices.sh -idfile secgateway -type LTESecGateway
What to Do Next
For more information, see Changing IPv4 Support to IPv6 on HeNBGW or LTESecGateway Post Installation,
on page 83.
Changing IPv4 Support to IPv6 on HeNBGW or LTESecGateway Post Installation
To change the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property on the HeNBGW or LTESecGateway
post-installation, follow these steps.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Log in to DCCUI.
Go to the Group and ID interface, select Groups from the left navigation pane and select the HeNBGW or
LTESecGateway tab.
From the list of available objects in the right display pane, select the object that you want to change to support
IPv6 and click Update. For example, HeNBGW-1.
Note
The edit options, Add, Update, Delete, and Import are visible only if you have dccadmin privileges.
Scroll down to the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property and select IPv6 from the drop-down
list.
Click Update. The updated value is displayed in the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE column
for the selected HeNBGW or LTESecGateway.
Configuring IPv6 Support for New Femto Access Points
Use this procedure to provide support for IPv6 for all new femto access points:
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
83
Device Manager
Log Uploads and Triggers
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Create an LTESecGateway group with the FC-IPSEC-IP-TYPE property set to "IPv6"
Create an HeNBGW group with the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE property set to "IPv6"
Associate this LTESecGateway group with the HeNBGW group.
Create a Region group with an LTE-CELL-POOL association
Create and Area and associate the Region and HeNBGW created here
Register the FAP in LTE mode and associate it to the Area here
Log Uploads and Triggers
You can configure log uploads depending on event triggers. You can also request an on-demand log upload.
Uploading a Log
Use this task to upload of a log file on-demand from a device. This is in addition to any logs that are uploaded
according to configured triggers.
Procedure
Step 1
Step 2
Select a Device ID from the Select Device drop-down list in the Device Manager screen.
Click Perform and select On-Demand Log Upload from the drop-down list.
After the device acknowledges the upload request, you are prompted to select the destination server to which
to upload the log.
Step 3
Step 4
Select a valid destination server from the Server drop-down list.
Select the appropriate Log Type, if available, and click Submit.
If the devices support more than one type of on-demand log uploads, for example, an Ubiquisys device
supporting both Diagnostic and Performance logs, the screen is configurable to include multiple log types.
Refer to Configuring DCC Dialog Boxes, on page 41 for more information.
The result of the upload is displayed as a page message with the appropriate icon and the URL to the uploaded
file is also displayed.
To access the link from the machine, there should be a static route added for the network of the
machines with a gateway pointing to the core router.
If the request to upload the file fails, the data manager displays an error message.
Note
Setting Triggers to Upload the Logs
Use this task to specify triggers to cause a log to be uploaded to the Log Upload Server (LUS).
Cisco RAN Management System Administration Guide, Release 5.0
84
January 7, 2015
Device Manager
View Information about a Device
Procedure
Step 1
Select a Device ID from the Select Device ID drop-down list in the Device Manager screen.
Step 2
Click Provision and select Log Upload Triggers from the drop-down list.
After the device has acknowledged the request, the Update Log Upload Triggers screen is displayed with
the various triggers that can be selected.
Step 3
By default, Triggers managed by RMS is selected. To upload the logs periodically, uncheck the Triggers
managed by RMS option . A tooltip is displayed to describe each trigger.
Click Update to update the triggers.
After the update process is complete, a message is displayed.
Step 4
View Information about a Device
The device manager provides a device dashboard where you can view varied detailed information about the
device.
Displaying the Device Dashboard
The Device Dashboard displays device details in a combined view. The data displayed are fetched from the
Regional Distribution Unit (RDU) when the operation is performed. The exact fields displayed depend on
whether the device supports UMTS or LTE.
The RDU data is divided into these parts:
• Chassis information—Provides both LTE and 3G device identifiers where applicable, as well a chassis
identifier.
• Registration Data—Displays the device registered area and activation status.
• Assigned Data—Displays the HNB GW info and MCC.MNC, LAC, RNC & SAC ID values.
• Activation Status—Displays the device service and location valid status with Timestamp values, and
tampered status of the device.
• Discovered Data—Displays the manufacturer information.
• Live Data—Displays details regarding the device admin, operational, RFTx status and firmware version.
Procedure
Step 1
Step 2
Select a device identifier type in the Device Search drop-down list.
For Device ID and Secondary ID:
a) Select the device identifier from the Select Device drop-down list, or type in your device identifier if your
device does not appear in the list.
b) Click View and select Dashboard from the drop-down list.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
85
Device Manager
Displaying The Neighbor List in Use
The device data is displayed.
Step 3
For device types other than Device ID and Secondary ID:
a) Type your device identifier into the Search field and click Search.
b) Click the device identifier link in Identifier pane.
The device data is displayed on the dashboard.
Displaying The Neighbor List in Use
Within the Device Manager you can view the neighbors for a device.
For LTE devices, these categories of neighbors are displayed:
• LTE Inter-RAT GSM Neighbors
• LTE Inter-RAT UMTS Neighbors
• LTE Cell Neighbors
For UMTS devices, these categories of neighbors are displayed:
• Inter-Frequency Neighbors
• Intra-Frequency Neighbors
Procedure
Step 1
Step 2
Step 3
Select Device ID in the Device Search drop-down list.
Select the device identifier from the Select Device drop-down list, or type in your device identifier if your
device does not appear in the list.
Click View and select Neighbor List in Use from the drop-down list.
The neighbor data for the device is displayed.
Device Operations
You can request to connect to a device. Alternatively, you can reboot, factory reset or shutdown a device.
You can also configure any static neighbors for the device.
Configuring Static Neighbors
Use these tasks to add, update, or delete the static neighbors for a particular device post device registration
from DCC UI.
Cisco RAN Management System Administration Guide, Release 5.0
86
January 7, 2015
Device Manager
Configuring Static Neighbors
Adding or Updating Static Neighbors
Use this task to add or update static neighbors for a device from the DCC UI.
Procedure
Step 1
Select a device from the Select Device drop-down list in the Device Manager screen.
Step 2
Step 3
Select Static Neighbors from the Provision drop-down list.
Select one of the Static Neighbor tabs and click either Add or Update to add or update a static neighbor of
that type.
Based on the selection of Static Neighbor type, one of two possible dialog boxes are displayed to add or update
static neighbors.
Note
The content of these dialog boxes are based on the dynamic screen configuration
files:
• sdm-inter-rat-static-neighbors.xml
• sdm-inter-freq-static-neighbors.xml
• lte-inter-rat-gsm-static-neighbors.xml
• lte-inter-rat-umts-static-neighbors.xml
• lte-cell-static-neighbors.xml
The USC 5437 and USC 3437 access points support lte-cell-static-neighbor
only.
Refer to Configuring DCC Dialog Boxes, on page 41 for information on customizing these files.
Note
Step 4
Step 5
Step 6
Enter valid values in all the fields according to the tooltips provided.
Note
The Save and Submit buttons are enabled only after entering appropriate values in all
fields.
Click Save.
The update operation is recorded locally, and the Submit Saved Changes button is enabled with a warning.
Click Submit.
The values are submitted for processing.
Note
If you add a static neighbor with the primary key value the same as an already existing static neighbor,
then an error message is displayed. The primary key for Inter-RAT is the BCCH-ARFCN parameter.
For Inter-Frequency, the primary key is a combination of the UARFCNDL and Primary Scrambling
Code parameters.
For LTE, the Primary keys are as follows for each LTE object:
LTE Object
Primary Keys
Device.Services.FAPService.1.CellConfig.LTE.RAN.NeighborList.LTECell PLMNID, CID
Device.Services.FAPService.1.CellConfig.LTE.RAN.NeighborList.InterRATCell.UMTS PLMNID, CID
Device.Services.FAPService.1.CellConfig.LTE.RAN.NeighborList.InterRATCell.GSM PLMNID, LAC, CI
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
87
Device Manager
Configuring Static Neighbors
Step 7
Click Cancel to cancel the request.
Updating Static Neighbor Filtering
Select Update Static Neighbor Filtering to edit additional settings related to static neighbors for the respective
device from DCC UI.
Note
This feature is not available for LTE FAPs.
Procedure
Step 1
Select a device using the device identifier fields at the top of the Device Manager screen.
Step 2
Step 3
Select Static Neighbors from the Provision drop-down list.
Click Update Static Neighbor Filtering.
The Update Static Neighbor Filter dialog box opens.
Check the desired option:
Step 4
• FEMTO-NEIGHBORING-FILTERING-ENABLE—enables automatic Femto neighbor filtering.
• STATIC-NEIGHBORING-FILTERING-ENABLE—enables the classification of static neighbors.
Step 5
Do one of these:
• Click Submit to submit the request immediately.
• Click Cancel to cancel the request.
Deleting Static Neighbors
Use this task to delete static neighbors for a Device from the DCC UI.
Procedure
Step 1
Select a Device using the device identifier fields at the top of the Device Manager screen.
Step 2
Step 3
Select Static Neighbors from the Provision drop-down list.
A Static Neighbor provisioning tab is displayed for each available static neighbor type.
Select the desired Static Neighbor tab and click Delete.
Based on the selection of Static Neighbor type, a delete Static Neighbor confirmation box for a single instance
is displayed.
Step 4
Click Save.
Cisco RAN Management System Administration Guide, Release 5.0
88
January 7, 2015
Device Manager
Replacing a Device
The delete operation is recorded locally, and the Submit Saved Changes button is enabled with a warning.
• Click Submit to send a request to the BAC to delete the selected Static Neighbor.
• Click Cancel to close the dialog box without doing anything.
Replacing a Device
Use this task to replace a faulty 3G or LTE device from DCC UI.
Note
An operational device cannot be replaced. You can replace a device if the device is a misbehaving device
that cannot be corrected by software/firmware upgrade, or if the device has malfunctioning hardware.
Note
Device replacement can replace devices of different flavors of AP. For example, USC 5310 for wifi+3G,
USC 7330 for Enterprise, USC 3331 for Residential.
Procedure
Step 1
Select a Device ID from the Select Device drop-down list in the Device Manager screen.
Step 2
Select Device Replacement from the Provision drop-down list.
A Device Replacement screen is displayed with two fields:
• Old Device ID - Populated with the existing EID with the text box disabled.
• New Device ID - To enter the new valid EID as validated in PMG to replace the existing ID.
Figure 8: Device Replacement Screen for New Device ID
Note
Step 3
The Replace button will be enabled only after a valid New Device ID is entered.
To replace the device, enter the new device ID and select Replace.
The successful device replacement message is displayed with an appropriate page error message depending
on the PMG response.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
89
Device Manager
Requesting a Connection to a Device
After successful device replacement, the drop-down list gets updated with the new device id specified
.
If the device replacement fails, the SDM list of EIDs is unaffected.
You will be forwarded to the dashboard of old Device ID. The old device ID configuration will be unaffected.
Note
Step 4
Requesting a Connection to a Device
Use this task to send a connection request to a device.
Procedure
Step 1
Step 2
Select a Device ID from the Select Device drop-down list.
Click Perform, and select Connection Request from the drop-down list.
A confirmation dialog box is displayed.
Step 3
Click Confirm to confirm the connection request.
If the connection request to the device is successful, the successful message is displayed. If the request fails,
the data manager displays an error message.
Rebooting a Device
Use this task to reboot on a device.
Procedure
Step 1
Step 2
Select a Device ID from the Select Device ID drop-down list in the Device Manager screen.
Click Perform and select Reboot from the drop-down list.
The Select Reboot Option dialog box is displayed.
Step 3
Specify the Reboot Option.
If Reboot is selected, a Reboot TR-069 message is sent to the device. Only this option is availble for UMTS
devices and LTE only access points.
If Forced, Immediate or Delayed are selected, the parameter
Device.Services.FAPService.1.FAPControl.LTE.X_CISCO_COM.RebootMethod is set accordingly and a
Reboot TR-069 message is sent to the device.
A confirmation dialog box is displayed.
Step 4
Click Confirm to continue to reboot the device. Click Cancel to cancel the reboot operation.
Cisco RAN Management System Administration Guide, Release 5.0
90
January 7, 2015
Device Manager
Resetting a Device
Resetting a Device
Use this task to perform a factory recovery on a device.
Note
Factory recovery is not available on LTE only devices.
These recovery options are available for supported devices:
• No Recovery
• Immediate recovery
• Recovery in least busy hour
• Recovery on next power up
• Factory Reset
The default option is Factory Reset. When chosen, a FactoryReset TR-069 message is set to the device.
Procedure
Step 1
Select a Device ID from the Select Device ID drop-down list in the Device Manger screen.
Step 2
Click Perform and select Factory Reset from the drop-down list.
A Select Recovery Option dialog box is displayed.
Step 3
Select the desired recovery option.
Only the Factory Reset option is available for LTE only devices.
Step 4
A confirmation dialog box is displayed.
Click Confirm.
The success/failure message of the operation is displayed.
View and Update Live Data
The device manager provides you the ability to view and update live data from a device. Additionally, you
can modify previously updated live data.
Displaying Live Data
The live data view of the device allows you to navigate through the data model (by object), querying the
device for its values on demand.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
91
Device Manager
View and Update Live Data
Procedure
Step 1
Step 2
Select a registered Device ID from the Select Device drop-down list in the Device Manager screen.
Click View and select Live Data from the drop-down list.
After the device acknowledges the request, the object name of the specified device is displayed.
Step 3
You can navigate through the data model (by object). Check any of the check boxes and click Load/Refresh
Selected Objects to refresh the view. A list of parameters set for the particular object and the device data is
displayed,
Updating Live Data for a Device
Use this task to update the live data for a device. These parameters are values that are configured on the BAC
and updated using the Data Manager user interface.
Note
Do not use this functionality for adding new instances in case of multi instance tables.
Procedure
Step 1
Select a Device ID from the Select Device drop-down list in the Data Manager screen.
Step 2
Click Perform and select Set Live Data from the drop-down list.
After the device has acknowledged the request, the live device details are displayed.
Figure 9: Set Live Data Display
Step 3
Select the desired properties check boxes and click Load/Refresh Selected Objects.
Cisco RAN Management System Administration Guide, Release 5.0
92
January 7, 2015
Device Manager
Shutting Down a Device
Any selected properties are refreshed and a list of parameters set for the particular object and the device data
is displayed.
Alternatively, you can expand the tree structure to view the device
data.
Make any desired changes. Only fields that are not grayed out can be edited.
Click Submit to make the requested changes. The Submit button is enabled only after editing the parameters.
After the updated values are validated in the data model, a confirmation dialog box is displayed.
Click OK to confirm the changes.
The parameters are updated with the new values and a successful message is displayed. The Parameters are
set on the device on the next contact.
Note
Step 4
Step 5
Step 6
Updating Modified Live Data
The Set Modified Live Data feature allows you to write values and set the live data for a specified device.
Specifically, this includes all the live parameters that have been modified previously.
Procedure
Step 1
Select a Device ID from the Select Device drop-down list in the Device Manager screen.
Step 2
Click Perform and select Set Modified Live Data from the drop-down list.
After the device has acknowledged the request, the modified live data details are displayed.
You can now navigate through previously modified live data.
Step 3
Step 4
Step 5
Step 6
Check the check boxes in front of Restore to Default to restore individual parameter values.
Click Submit. The Submit button is enabled only after checking a check box.
Alternatively, click on Restore All to Default to restore all parameter values at once.
After clicking on either of these buttons, a confirmation page is displayed to confirm the request to submit
these live data changes.
Click OK, to continue with the live data modification. The success message should be displayed.
Shutting Down a Device
Use this task to terminate the operation of a device.
Procedure
Step 1
Select a Device ID from the Select Device drop-down list in the Device Manager screen.
Step 2
Click Provision and select Shutdown from the drop-down list.
A confirmation dialog box is displayed.
Click Confirm to shutdown the device.
The successful shut down message is displayed.
Step 3
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
93
Device Manager
Device Manager Status Messages
Note
Once the shutdown complete, the device is permanently deleted in the
BAC.
Device Manager Status Messages
The device manager can display a variety of status messages depending on the operation being performed
and the result of the operation.
Registering a Device: Status Messages
This table lists the status messages that can be displayed while registering a device:
UI Message
Description
Failed to register device '<eid>'.
<specific-error>
In case of known error codes, this message wll be
displayed with specific-error message as returned by
PMG.
Known error conditions are:
NO_AREA_FOUND_FOR_EXPECTED_LOCATION:
ASSIGNMENT_EXCEPTION:
MISSING_REQUIRED_ELEMENT:
EXCLUDED_ELEMENT_FOUND:
UNKNOWN_PARAMETER_NAME:
INVALID_PARAMETER_VALUE:
RDU_UNAVAILABLE:
UNKNOWN_GROUP
Failed to register device '<eid>'.
Operation error occurred. Please try
again. If the problem persists please
contact your system administrator.
This is a generic error message that is displayed if an
unknown error is propagated.
Successfully registered device '<eid>'.
Device was successfully registered with RMS.
The ui_debug.log file should be examined for the exact
error.
Activating a Device: Messages
This table lists status messages that can be displayed while updating a device.
Cisco RAN Management System Administration Guide, Release 5.0
94
January 7, 2015
Device Manager
Displaying the Device Dashboard: Messages
UI Message
Icon
Reason
Failed to update '<eid>'. Operation
error occurred. Please try again. If
the problem persists please contact
your system administrator.
Error
Device could not be updated in RMS.
Failed to update '<eid>'.
<specific-error>.
Error
In case of known error codes, this message wll be
displayed with specific-error message as returned
by PMG.
Known error conditions are:
NO_AREA_FOUND_FOR_EXPECTED_LOCATION:
ASSIGNMENT_EXCEPTION:
MISSING_REQUIRED_ELEMENT:
EXCLUDED_ELEMENT_FOUND:
UNKNOWN_PARAMETER_NAME:
INVALID_PARAMETER_VALUE:
RDU_UNAVAILABLE:
UNKNOWN_GROUP
UNKNOWN_CPE:
UNKNOWN_SUBSCRIBER_ID:
DELETE_NOT_PERMITTED_FOR_PARAMETER:
UPDATE_NOT_PERMITTED_FOR_PARAMETER:
Device '<eid>' did not require
updating.
Information
The UPDATE button was selected by the user but
no change to already-existing.
Successfully updated '<eid>'.
Success
Device was successfully updated in RMS.
Failed to load update data for '<eid>'. Error
Operation error occurred. Please try
again. If the problem persists please
contact your system administrator.
Failed to load the update data for the device. Could
be caused by failing to retrieve the data from PMG.
Failed to load update data for '<eid>'. Error
Unknown device.
Failed to load the update data for the device as it
is unknown.
Displaying the Device Dashboard: Messages
These success and error messages can be displayed when requesting to display the dashboard:
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
95
Device Manager
Uploading a Log: Messages
UI Message
Description
Failed to request dashboard for '<eid>'. Operation
error occurred. Please try again. If the problem
persists please contact your system administrator.
The deviceParamsDisplayConfig.xml file is
invalid or not present.
Failed to retrieve dashboard stored data for '<eid>'. Failed to communicate with BAC or PMG to
Operation error occurred. Please try again. If the
retrieve the stored data.
problem persists please contact your system
administrator.
Failed to retrieve dashboard stored data for '<eid>'. Device has been deleted and was not found
Unknown device.
while retrieving data from PMG.
Failed to retrieve dashboard live data for '<eid>'.
Operation error occurred. Please try again. If the
problem persists please contact your system
administrator.
Failed to retrieve live data from the device.
Does not include the device being offline.
Failed to retrieve dashboard live data for '<eid>'.
Unknown device.
Device has been deleted and was not found
while retrieving live data.
Uploading a Log: Messages
The following status messages can be displayed while performing an on-demand log upload of a file:
UI Message
Description
Failed to retrieved log upload servers.
The upload server XML file is invalid or empty.
Please try again. If the problem persists
please contact your system administrator.
Log upload for '<eid>' has not completed. While waiting for the upload to finish, the user has
File upload was Targeted at '<northbound selected the Cancel button in the Progress dialog box.
upload URL>'.
Log upload for '<eid>' has not completed When the number of polling attempts have ben exceeded
within required time period. Target
and the file upload is still not complete, the polling
uploaded file can be found at
operation times out.
'<northbound upload URL>' upon
completion.
Unable to request log upload for '<eid>' When attempting to submit the log upload request, an
to '<server name>'. <cause>.
error occurred on the UI side.
Failed to wait for log upload for '<eid>'. Generic error when polling request for the upload
File upload was targeted at '<northbound completes but no status message was returned.
upload URL>'.
Cisco RAN Management System Administration Guide, Release 5.0
96
January 7, 2015
Device Manager
Updating Log Upload Triggers: Messages
UI Message
Description
Unable to wait for log upload for '<eid>'. When attempting to submit the poll request for the
File upload was targeted at '<northbound upload to complete, an error occurred on the UI side.
upload URL>'. <cause>.
Failed to request log upload for '<eid>' to When attempting to submit log upload request, the server
'<server>'. Server not found.
is unable to find the requested upload server details.
Failed to request log upload for '<eid>' to When attempting to submit a log upload request, the
'<server>'. Server offline.
target server is offline.
Failed to request log upload for '<eid>' to Generic error when unable to submit log upload request
'<server name>'. Operation error
to device.
occurred. Please try again. If the problem
persists please contact your system
administrator.
Log upload for '<eid>' was success.
Uploaded file is '<northbound upload
URL>'.
Log upload was successfully requested and has
completed.
Failed to request log upload for '<eid>' to Failed to request log upload because device is offline.
'<server>'. Device offline.
Failed to request log upload for '<eid>' to Failed to request log upload because device has been
'<server>'. Unknown device.
deleted.
Updating Log Upload Triggers: Messages
This table lists the status messages that can be displayed while updating the triggers for the log upload.
UI Message
Description
Successfully updated log upload triggers The request to update the device log upload triggers was
for '<eid>'
successfully sent.
Failed to update log upload triggers for The UI was unable to successfully update the log upload
'<eid>'. Operation error occurred. Please triggers.
try again. If the problem persists please
contact your system administrator.
Device '<eid>' did not require updating.
The request didn't change the log upload triggers so no
action was performed.
Failed to update log upload triggers
'<eid>'. Unknown device.
The request to update the log uploads triggers failed
because the device no longer exists.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
97
Device Manager
Connection Request: Messages
Connection Request: Messages
The following status messages can be displayed when a connection request is sent:
UI Message
Description
Successfully performed connection
request for '<eid>'.
Connection request is successful.
Failed to perform connection request for Device is not reachable. Includes device offline and
'<eid>'. Device offline.
unable to generate connection request URL using Lease
Query. See the PMG and the DCC-UI debug logs for
details.
Failed to perform connection request for Unknown error occurred. See the debug log for details.
'<eid>'. Operation error occurred. Please
try again. If the problem persists please
contact your system administrator.
Failed to perform connection request for Device does not exist because it has been deleted.
'<eid>'. Unknown device.
Rebooting a Device: Messages
This table lists the status messages that can be displayed while rebooting the device.
UI Message
Description
Successfully requested reboot for '<eid>'. Request for reboot of device was successful.
Failed to request reboot for '<eid>'.
Device offline.
RMS tried to reboot the device but device is off-line and
not reachable so could not reboot.
Failed to request reboot for '<eid>'.
Operation error occurred. Please try
again. If the problem persists please
contact your system administrator.
RMS had encountered an unknown error and the device
could not be rebooted. To understand the reason for the
error, see ui-debug.log.
Failed to request reboot for '<eid>'.
Unknown device.
The device has been deleted from the RMS.
Resetting a Device: Messages
This table lists the status messages that can be displayed while requesting a factory reset of a device.
Cisco RAN Management System Administration Guide, Release 5.0
98
January 7, 2015
Device Manager
Shutting Down a Device: Messages
UI Message
Description
Successfully requested factory reset for
'<eid>'.
Request for factory reset of device was successful.
Failed to request factory reset for '<eid>'. RMS tried to factory reset the device but the device is
Device offline.
off-line and not reachable so the factory reset was not
performed.
Failed to request factory reset for '<eid>'. RMS encountered an unknown error and the device could
Operation error occurred. Please try
not perform the factory reset. To understand the reason
again. If the problem persists please
for the error, look in the ui-debug.log.
contact your system administrator.
Shutting Down a Device: Messages
This table lists the status messages that can be displayed while shutting down a device.
UI Message
Description
Failed to shutdown device '<eid>'. Operation
Error occurred during shutdown process.
error occurred. Please try again. If the problem
persists please contact your system
administrator.
Successfully shutdown device '<eid>'.
Device was successfully shutdown.
Failed to shutdown device '<eid>'. Unknown
device.
Device is unknown and shutdown failed.
Display Live Data: Messages
This table lists the status message that can be displayed when displaying live data.
UI Message
Description
Failed to retrieve live data for 'eid'. The device is
offline.
When requesting to view the device's live
data, it is found to be offline.
Updating Live Data: Messages
This table lists the status messages that can be displayed while setting the live data for a specified device.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
99
Device Manager
Updating Modified Live Data: Messages
UI Message
Description
Successfully set live data for '<eid>'.
The requested live data parameters have been
successfully set.
Failed to retrieve live data for '<eid>'. The The device is offline, therefore the live data cannot be
device is offline.
set.
Updating Modified Live Data: Messages
This table lists the status messages that can be displayed while updating the previously modified live data for
a device.
UI Message
Description
Successfully set live data for '<eid>'.
The requested live data parameters have been
successfully set.
There have been no modifications to the The live data of the device was not modified previously.
device's default live data.
Cisco RAN Management System Administration Guide, Release 5.0
100
January 7, 2015
CHAPTER
6
Upgrade Monitoring Tool
The Upgrade Monitoring Tool (UMT) is a web-based application accessed from the Device Command and
Control User Interface (DCC UI). The UMT application facilitates monitoring of firmware upgrades of
CPEs and provides insight into recently completed firmware upgrades. The UMT application is useful for
determining firmware and other upgrade issues in the upgrade procedure.
Following are the key assumptions when monitoring an upgrade using the UMT:
• Upgrade of CPEs occurs based on HNB-GW and Management group memberships.
• · All CPEs of a selected hardware type and Management group have their firmware upgraded during
maintenance.
The UMT monitors the upgrade primarily through Broadband Access Center (BAC) TR-069 events. The
application monitors BAC TR-069 events for active jobs only. The target devices are the devices that are
connected and online during the pre-upgrade snapshot and currently report that they do not have the target
firmware.
A monitoring job for the required gateway or management group can be started by selecting the hardware
platform and the target firmware.
The UMT provides the following support:
• Capacity of up to 20,000 devices simultaneously
• Maximum of 15 concurrent monitoring jobs
• Concurrent view of the same monitoring job by multiple users
• View of historical data of the completed monitoring jobs (latest monitoring jobs and a maximum of
25) at any one point in time
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
101
Upgrade Monitoring Tool
Performing a Bulk Upgrade
• Breadcrumb navigation with the context in page hierarchy, facilitating easy navigation to previous
pages
Figure 10: UMT Workflow
• Performing a Bulk Upgrade, page 102
• Upgrading a Firmware, page 103
• Monitoring a Firmware Upgrade, page 104
Performing a Bulk Upgrade
Bulk upgrade is performed over a period of five days. To perform a bulk upgrade, divide the number of APs
into four sets.
Day 1 upgrade is performed for APs that are sending PeriodicInform during the Upgrade Maintenance Window.
On Day 2 to Day 4 trigger massCr.sh each day for the divided set of APs (Day 2- Set 1, Day 3--Set 2, Day
4--Set 3, and Day 5-- Set 4).
Procedure
Step 1
Perform these steps on Day 1:
a) Upgrade maintenance.
b) Set “FIRMWARE-UPGRADE-ENABLE” to True.
c) Set “FIRMWARE-UPGRADE-IMAGE” to the latest image; for example, BV3.5.9.18_SCF.xml.
d) Set “FIRMWARE-UPGRADE-VERSION” to the latest version; for example BV3.5.9.18.
Cisco RAN Management System Administration Guide, Release 5.0
102
January 7, 2015
Upgrade Monitoring Tool
Upgrading a Firmware
e) At the end of maintenance, set “FIRMWARE-UPGRADE-ENABLE’ to False.
Step 2
Perform these steps on Day 2:
a) Set “FIRMWARE-UPGRADE-ENABLE” to True.
b) Trigger massCr.sh for Set 2 APs.
c) Set “FIRMWARE-UPGRADE-ENABLE’ to False at the end of maintenance.
d) Repeat Day 2 activities on Day 3, Day 4, and Day 5.
Note
Do not set "FIRMWARE-UPGRADE-ENABLE” to False after Maintenance Window of Day
5.
Upgrading a Firmware
Follow the below steps to upgrade the Firmware:
Procedure
Step 1
Step 2
Navigate to the link http://internaldl.dev.ubiquisys.local/ and select the latest firmware folder. For example
BV3.5.2.16.
Click and save/download the files to your desktop. Add prefix to the filenames as BV3.5.2.16 while saving.
Note
Download these five files to
proceed:
• SCF.sig
• SCF.xml
• rootfs.bin
• standard-kernel.bin
• ubiqfs.bin
Step 3
Step 4
Log in to the BAC UI. Click on the configuration and then select the files.
ClickAdd and then browse each file from the desktop and fill the file name with suffix in other fields.
Step 5
Click Submit.
Step 6
Change these properties in the BAC to upgrade one or more FAPs. Change the properties at any group level
to perform a bulk upgrade, or at the AP level to upgrade a single FAP.
• Set “FIRMWARE-UPGRADE-ENABLE” to True.
• Set “FIRMWARE-UPGRADE-IMAGE” to the latest image. For example, BV3.5.9.18_SCF.xml.
• Set “FIRMWARE-UPGRADE-VERSION” to the latest version. For example, BV3.5.9.18.
Step 7
Reboot the AP.
Note
Check the firmware version on discovered data and live data in the dashboard after reboot.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
103
Upgrade Monitoring Tool
Monitoring a Firmware Upgrade
Monitoring a Firmware Upgrade
Use this task to start monitoring a firmware upgrade.
Procedure
Step 1
Log in to the DCC UI using your valid credentials.
The Device Command and Control screen is displayed.
Step 2
Select the Upgrade Monitor tab.
The Monitoring Job Management screen is displayed.
This screen has three sections:
• In Progress—Display of the Upgrade Monitoring jobs that are in progress
• Start Monitoring an Upgrade—Interface used to start a new monitoring job
• History—Display of all completed monitoring jobs
Step 3
In the Start Monitoring an Upgrade section, select the required Group Type, Group Name, Hardware
Platform, Firmware Type, and Firmware Version from the corresponding drop-down lists.
Note
You have the option to add new firmware types and firmware versions by clicking the Add buttons
next to the Firmware Type and Firmware Version drop-down list.
By Default, the Firmware types available for monitoring IPA and Ubiquisys platforms are:
• IPA: 3G, Router
• Ubiquisys: 3G-Ubiquisys
For more information, refer to Adding a Firmware Type to the UMT, on page 107 and Adding a
Firmware Version to the UMT, on page 108.
Each Firmware type is associated with specific Firmware versions. Once a specific group is selected for
monitoring, the job is moved to the In Progress state. The same firmware type cannot be selected for monitoring
the same group and hardware platform.
Step 4
Click Start Pre-Upgrade Snapshot to begin the Monitor Upgrade process.
As soon as the monitoring job starts, the job is listed in the In Progress section of the Monitoring Job
Management screen with its associated status.
Step 5
Click the hyperlink of the monitor job under the Started On column in the In Progress section of the
Monitoring Job Management screen.
The firmware upgrade statistics are displayed in the Upgrade Monitoring screen.
This screen has four sections:
• Target—displays the upgrade target group and the targeted upgrade images.
• Pre-upgrade Snapshot—includes information regarding the device firmware before the upgrade:
◦The statistics break down of the devices to display how many are connected through 3G and/or
Wire-line, the number of Radio On devices, the number of offline devices, and a total per image
version.
Cisco RAN Management System Administration Guide, Release 5.0
104
January 7, 2015
Upgrade Monitoring Tool
Monitoring a Firmware Upgrade
◦A total of each category at the bottom of the table with the hyperlink that navigates to the Success
Details screen.
◦The Connected and Radio On hyperlink that navigates to the Success Details screen.
◦The Offline hyperlink that navigates to the Error Summary screen to provide the number and
details of offline devices.
◦The Export Target Device IDs option for exporting and saving target Device IDs.
• Results—displays the current upgrade results:
◦Each row in the upgrade results section displays the results including Upgrade Completed, Online
Pending Activation, Faults, Offline, and Online.
◦The Faults and Offline hyperlinks are linked to the Error Summary screen.
◦The results column include time related statistics for upgrade status of devices from when the tool
started executing, the current five minute interval, and the previous five minute interval.
• The bottom of the Upgrade Monitoring screen contains these buttons:
◦View Results History — navigates to the Interval History screen.
◦Reconcile — starts the Reconcile process.
◦Stop Monitoring — closes the monitoring task.
◦Export Remaining Device IDs — supports exporting or saving the remaining device IDs as a text
file.
◦Delete from History — deletes a monitoring job from the History display. This button is enabled
only when the job is finished (stopped or complete). This removes all traces of the job and it will
no longer appear in the history section of the management page
A progress bar is displayed at the bottom of the screen and provides a quick visual status of the monitoring
job in progress.
• When the UMT application monitors an upgrade, the upgrade related statistics are updated every five
minutes on the web page. You can monitor the progress and determine the status of the upgrade using
these updates.
• If you have navigated away from the UMT while monitoring a job, the application allows you to resume
monitoring after a while. The application also allows you to resume monitoring, even after logging off
from UMT and logging in. To join a monitoring job, click on the job in the Started On column of the
In Progress area of the Monitoring Job Management screen
• You can stop the monitoring firmware upgrade job by clicking the Stop Monitoring button at the bottom
of the Upgrade Monitor screen.
You can use the pre-upgrade snapshot as a reference to determine the number and status of devices targeted
for upgrade.
If you start a new pre-upgrade when there is a job already in pre-upgrade or reconcile state, the job is added
to the queue that is common for new pre-upgrade as well as new reconcile tasks. Any number of jobs can be
added up to the maximum limit of In-progress jobs to the queue. The maximum limit for In-progress jobs can
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
105
Upgrade Monitoring Tool
Upgrade Monitor History
be configured to the required number. The default value is 15. The jobs in queue are processed using the 'first
in, first out' principle.
Related Topics
Adding a Firmware Type to the UMT, on page 107
Adding a Firmware Version to the UMT, on page 108
Upgrade Monitor History
You can view the history of all monitoring jobs from the History section of the Monitoring Job Management
page. The details of the last 25 monitoring jobs (maximum of 25) are displayed in this section. The start date
hyperlink of each job displays the job details.
Displaying Upgrade Monitor Errors
To view any errors from a pre-upgrade snapshot, click the Offline hyperlinked total value in the Pre-upgrade
Snapshot area of the Upgrade Monitoring screen.
To view any errors from a completed Upgrade Monitor process, click the Faults or Offline hyperlinked Status
options in the Results area of the Upgrade Monitoring screen.
The Error Summary screen lists the unique errors for each error category from when the upgrade began, the
current five minute interval and the previous five minute interval. Use the hyperlinks in the Error Summary
screen to navigate to the Error Details screen.
The Error Details screen provides the device IDs and the time the error occurred. The last status of the device
ismaintained and displayed. Entries are listed according to the time of occurrence, with the most recent
occurrence at the top of the list. Click the Device ID or Time column headers to sort the entries in ascending
or descending order.
To save these results locally, click Export Details and choose Export as CSV from the Error Details screen.
Upgrade Monitor Success
To view the success of a pre-upgrade snapshot, click the Connected, Radio On or Total hyperlinked total
values.
To view the success of an Upgrade Monitor process, click the Connected or Radio On hyperlinked Status
options.
The total number of devices for which the upgrade monitoring job was started or completed is displayed. To
save these results locally, click Export Details and choose Export as CSV.
Cisco RAN Management System Administration Guide, Release 5.0
106
January 7, 2015
Upgrade Monitoring Tool
Reconciling a Monitor Upgrade Job
Reconciling a Monitor Upgrade Job
Use this task to refresh a monitor firmware upgrade job in the event that you notice that the results are not
accurate. The reconsile process needs to be initiated for each monitoring job separately. The reconcile process
is sometimes necessary when:
• The upgrade was restarted due to recurring faults and the Upgrade Monitoring data needs to be updated.
• The RDU server goes down and the upgrade is restarted, then Upgrade Monitoring data needs to be
updated.
Procedure
Step 1
Click Reconcile at the bottom of the Upgrade Monitoring screen.
The page status is updated to indicate that a reconcile is in progress. The Reconcile button is disabled and the
device status is collected directly from the live data from AP.
When the reconcile process is complete, the device status is updated in the Results section of the Upgrade
Monitoring screen.
Step 2
You can start a reconcile process for a new monitoring job when the reconcile process or pre-upgrade for
another monitoring job is already in progress.
In this case, the new job is queued and a confirmation dialog box is displayed.
If you click Confirm, the job is moved to the pre-reconcile state and added to the queue. This queue is common
for both new pre-upgrade tasks as well as reconcile tasks. If you click Cancel, the job is not queued.
The queued job is in pre-reconcile state and moves to reconcile when all older jobs are completed.
Any number of jobs can be added to the queue, up to the maximum limit of the in-progress jobs configured
in the application. The default maximum limit of in-progress jobs is 15. Jobs are processed using the 'first in,
first out' principle.
Adding a Firmware Type to the UMT
Use this task to add new firmware types to the UMT tool without manually editing the XML file
(/rms/app/rms/conf/umt-setup.xml) on your disk.
Before You Begin
This task is performed in the UMT tool that is accessed by clicking the Upgrade Monitor tab in the DCC-UI.
Procedure
Step 1
From the Monitoring Job Management screen, click Add next to the Firmware Type drop-down list.
The Add Firmware Type dialog box is displayed.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
107
Upgrade Monitoring Tool
Adding a Firmware Version to the UMT
Step 2
Step 3
Enter the name of the new firmware type.
Enter the discovered version parameters such as Key and Value Regular Expression and click Add.
Discovered version parameters are sets of Key-Value pairs. Keys are discovered parameter names that contain
firmware version information. Values are corresponding regular expressions used to pull the firmware version
information from the discovered parameter value.
Step 4
Enter the Live Version Parameter name.
The live version parameter is the name of a live parameter that contains version information.
Step 5
Optionally enter the Transfer Complete Command Key Regular Expression. This value is used to match the
firmware type in a Transfer Complete event.
Optionally enter the Live Error Parameter name. This value is used to download error.
Optionally click Add to add the Discovered Downloaded Version Parameter.
Discovered Downloaded Version Parameters are sets of Key-Value pairs. Keys are discovered parameter
names that contain downloaded firmware version information. Values are corresponding regular expressions
used to pull the firmware version information from discovered downloaded parameter value.
Step 6
Step 7
Step 8
Step 9
Optionally enter the Live Downloaded Version Parameter. This value is used for the downloaded state.
After all the required and valid information is entered, click Add to add the new firmware type into the
umt-setup.xml file.
After the firmware type is successfully added, it is listed in the Add Firmware Type drop-down list in the
Add Firmware Version screen where you can map it to a Hardware Platform and enter a new firmware
version of this type.
Adding a Firmware Version to the UMT
Use this task to add new firmware versions to the UMT tool without manually editing the XML file
(/rms/app/rms/conf/umt-config.xml) on your disk.
Before You Begin
This task is performed in the UMT tool that is accessed by clicking the Upgrade Monitor tab in the DCC-UI.
Procedure
Step 1
From the Monitoring Job Management screen, click Add next to Firmware Version drop-down list box.
The Add Firmware Version dialog box is displayed.
Step 2
Step 3
Step 4
Enter the Hardware Platform that is applicable to the firmware version.
Enter the Firmware Type that is applicable to the firmware version.
Enter the Firmware Version.
Note
The version should match the regular expressions provided for version parameters, while adding the
firmware type.
After entering all the required and valid information, click Add to add the new firmware version into the
umt-config.xml file.
Step 5
Cisco RAN Management System Administration Guide, Release 5.0
108
January 7, 2015
Upgrade Monitoring Tool
Adding a Firmware Version to the UMT
After the firmware version is successfully added, it is listed in the Firmware Version drop-down list box in
the UMT screen and the firmware type will get associated with the selected Hardware Platform.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
109
Upgrade Monitoring Tool
Adding a Firmware Version to the UMT
Cisco RAN Management System Administration Guide, Release 5.0
110
January 7, 2015
CHAPTER
7
Managing Groups and ID Pools
• Overview of Managing Groups and ID Pools, page 111
• Managing Group Types, page 113
• Managing Groups, page 117
• Managing ID Pool Types, page 117
• Managing ID Pools, page 121
• Making Changes to a Group Type, Group Instance, ID Pool Type or IP Pool Instance, page 121
• Groups and IP Pools: Messages, page 128
Overview of Managing Groups and ID Pools
You can manage your groups and ID pools from the Device Command and Control User Interface (DCC-UI).
Click Groups and IDs to access the interface. You can view, add, update or delete groups, group types, ID
pools and ID pool types. You can use the export option to view all defined parameters for your groups in one
CSV file. You can use the import option to import parameters for multiple groups within a group type, using
one CSV file.
The RMS manages devices according to their groupings. You can create any number of group types in the
RMS. Devices can be assigned to one or multiple groups automatically during registration.
The significance of groups is the ability to set configuration or system operational parameters on group objects
that are applied to all devices belonging to a group. The Femto Gateway groups determine the public IP
address of the SeGW and private IP address of the HNB-GW. Area groups may determine settings that are
specific to a country or other areas such as target frequencies, PLMN, etc.
The RMS supports the concept of automatic assignment of unique IDs for devices from a pool or range of
available values. This feature can be used to assign unique Cell ID, SAC, CGI, Broadcast SAI, etc. A unique
value is assigned from a pool and stored as a property in the RMS. This property is then referenced in
configuration templates in order to configure devices. Until the device is de-commissioned, the assigned value
remains reserved for this device.
You must have read-write permission to perform these operations. If you have read-only permission, you can
export or view the information, only.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
111
Managing Groups and ID Pools
Recommended Order for Working with Pools and Groups
Recommended Order for Working with Pools and Groups
This task outlines the recommended procedure for working with pools and groups for 3G and LTE deployments:
Procedure
Step 1
Create an SAI pool:
a) In the Groups and IDs interface, click ID Pools in the left navigation bar.
b) Click the SAI-POOL tab.
c) Click Add and refer to: Adding an ID Pool Instance, on page 123.
Step 2
Create a Cell pool:
a) Click the CELL-POOL tab.
b) Click Add and refer to: Adding an ID Pool Instance, on page 123.
Step 3
For 3G deployments, create a UMTS Security Gateway group:
a) In the Groups and IDs interface, click Groups in the left navigation bar.
b) Click the UMTSSecGateway tab.
c) Click Add and refer to: Adding a Group Instance, on page 122.
Step 4
For 3G deployments, create a Femto Gateway group:
a) Click the FemtoGateway tab.
b) Click Add and refer to: Adding a Group Instance, on page 122.
c) Select the Cell ID pool to be associated with the Femto Gateway group.
Step 5
For LTE deployments: create an LTE Cell pool:
a) Click the LTE-CELL-POOL tab.
b) Click Add and refer to: Adding an ID Pool Instance, on page 123.
Step 6
For LTE deployments, create an LTE Security Gateway group:
a) Click the LTESecGateway tab.
b) Click Add and refer to: Adding a Group Instance, on page 122.
Step 7
For LTE deployments, create a HeNB Gateway group:
a) Click the HeNBGW tab.
b) Click Add and refer to: Adding a Group Instance, on page 122.
c) Select the LTE Cell ID pool to be associated with the HeNB Gateway group.
Step 8
Create a Region group:
a) Click the Region tab.
b) Click Add and refer to: Adding a Group Instance, on page 122.
c) Select the LTE Cell ID pool to be associated with the Region group.
Step 9
Create an Area group:
a) Click the Area tab.
b) Click Add and refer to: Adding a Group Instance, on page 122.
c) Select the Region group to be associated with the Area.
d) For 3G deployments: select the Femto Gateway group to be associated with the Area.
e) For LTE deployments: select the HeNB Gateway group to be associated with the Area.
Cisco RAN Management System Administration Guide, Release 5.0
112
January 7, 2015
Managing Groups and ID Pools
Managing Group Types
f) For 3G deployments, select the SAI pool to be associated with the Area.
Step 10 Create an Enterprise group:
a) In the Groups and IDs interface, click Groups in the left navigation bar.
b) Click the Enterprise tab.
c) Click Add and refer to: Adding a Group Instance, on page 122 and skip Step 4, on page 122 and Step 5,
on page 122
Step 11 Create a Site group:
a) In the Groups and IDs interface, click Groups in the left navigation bar.
b) Click the Site tab.
c) Click Add and refer to: Adding a Group Instance, on page 122.
Step 12 Assign the Area and Enterprise to the site group:
a) In the Add Site Instance dialog box, select the Area and Enterprise pool to be associated with the Site
group.
b) If you already closed this dialog box, select the Site group and click Update to change this value.
Step 13 As required, create Sub Sites
a) In the Groups and IDs interface, click Groups in the left navigation bar.
b) Click the SubSite tab.
c) Click Add and refer to: Adding a Group Instance, on page 122.
What to Do Next
Note
By default, it is assumed that deployment is 3G only. You can change this to be a mixed 3G and LTE or
LTE only deployment after installation using the configure_deploymentmode.sh utility.
Managing Group Types
To manage group types, click the Group Types tab in the left navigation pane of the Group and ID Pools
interface. Any defined group types are displayed and you can add, update, delete, import or export group
types using the buttons at the bottom of the display.
Groups are defined within the context of a group type, so you must have group types defined before you can
create groups. These group types are created by default during the RMS installation:
• Area
• Enterprise
• FemtoGateway—Applicable for 3G devices only
• HENB Gateway—Applicable for LTE devices only
• LTESecGateway—Applicable for LTE devices only
• UMTSSecGateway—Applicable for 3G devices only
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
113
Managing Groups and ID Pools
Alarm Groups
• RF Profile
• Site
• SubSite
• Region
These pool types and group types are associated by default:
• The Area group type is associated with the SAI-POOL type.
• The FemtoGateway group type is associated with the CELL-POOL type.
• The Region Group type is associated with the LTE-CELL-POOL type.
In addition, note these guidelines:
• The RF Profile group type should not be associated with any group type or ID pool type.
• The Enterprise group type can be associated with the Site group type; it should not be associated with
any pool type.
Alarm Groups
The Alarm Profile group is used for associating alarms with devices. An Alarm Profile group can be associated
with an Area, in which case, all devices belonging to the Area have the same alarm profile.
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
field. Refer to RMS Configurable Parameters for a list of all the properties that can be specified for Alarm
groups in the CSV file used with the Import option.
Area Groups
An Area group determines the settings that are specific to a country or other areas such as target frequencies,
PLMN, etc. A device is registered with an Area group and other groups such as FemtoGateway. CELL-POOL
and SAI-POOL association is done by the RMS.
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
field. Refer to RMS Configurable Parameters for a list of all the properties that can be specified for Area
groups in the CSV file used with the Import option.
Note
The Area cannot support more than 65535 devices. This is because two Pools having the same range
cannot be assigned to the Area Group.
Enterprise Groups
An Enterprise group type is created by default during the RMS installation. Enterprise is a top level group
type for the RMS 4.0. An Enterprise group type is linked to an Enterprise ID Pool that is responsible for
assigning a unique ID to enterprise groups within the solution.
Cisco RAN Management System Administration Guide, Release 5.0
114
January 7, 2015
Managing Groups and ID Pools
FemtoGateway Groups
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
parameter. Refer to RMS Configurable Parameters for a list of all the parameters that can be specified for
Enterprise groups in the CSV file used with the Import option.
FemtoGateway Groups
The Femto Gateway groups determine the public IP address of the Security Gateway (SecGW) and the private
IP address of the Home Node Base Station Gateway (HNB-GW).
Note
By default, the Femto Gateway group type is associated with the CELL pool type.
By default, the Area group type is associated with the Femto Gateway group type.
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
field. Refer to RMS Configurable Parameters for a list of all the parameters that can be specified for Femto
Gateway groups in the CSV file.
HENB Gateway Group
HeNB gateway groups determine the public IP address of the Security Gateway (SecGW) and the MME. If
a device is going to use IPv6 addressing, verify that the FC-DEPLOYMENT-IPSEC-ADDRESS-TYPE field
is set to IPv6 and that the IPv6 address is specified in the FC-LTE-SIG-LINK-SERVER field. These fields
can be found in the Add or Edit dialog box for the HENB Gateway group.
Note
An area should be associated with an HeNBGW group type.
LTE Security Gateway Group
If a device is going to use IPv6 addressing, verify that the FC-FC-IPSEC-IP-TYPE field is set to IPv6 in the
Add or Edit dialog box for the appropriate LTE Security Gateway group.
Region Groups
The region group defines common properties across a deployment. The region group must exist before a new
area can be created.
The LTE-CELL-POOL must exist before a region group can be created. This is for allocation of the LTE
CELL-ID. The LTE-Cell-Pool needs to be associated with new region groups when they are created. A region
group must be associated with an area when it is created.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
115
Managing Groups and ID Pools
RF Profile Groups
RF Profile Groups
The RF profile is used to determine the RF tuning and configuration (power settings, handover rules, and so
on). The number of profiles existing by default is one. By default, the RF profile is installed through the BAC
configuration. However, the DCC UI provides the functionality to modify the RF profile group instance
properties. See Updating a Group Type, Group Instance, ID Pool Type, or ID Pool Instance, on page 124 for
more details.
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
parameter. Refer to RF Profile Configurable Parameters for a list of the RF Profile group parameters that can
be defined using a CSV file and the Import option. All of these properties are persistent. And none of these
properties require a reboot.
Site Groups
A Site group is a middle-tier group. An Enterprise can have 16777215 sites . However, a site can connect to
only one enterprise. A Site group type is linked to a Site ID Pool that is responsible for assigning a unique ID
to site groups within the Enterprise.
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
parameter. Refer to RMS Configurable Parameters for a list of all the parameters that can be specified for
Site groups in the CSV file used with the Import option.
Subsite Groups
Subsite groups are created within site groups. A maximum of 20 subsites can be created under a single site.
The use of subsites is useful if a site is large with multiple entrances, for example, a shopping mall.
Subsites are supported on UMTS enterprise access points. To use subsite groups, the following requirements
must be met:
• The Enterprise group type must be created.
• The Site group type must be created with these attributes defined.
◦Latitude and Longitude coordinates set.
◦Grid Enabled is set.
◦CIG Enabled is set.
For more information, refer to Adding a Group Instance, on page 122.
• A subsite group must be created in the Groups and ID Pools interface.
• The subsite group needs to be associated with an existing site.
• In the associated Region group type, these attributes must be set:
◦CIG Location Verification Methods List must be set to GPS.
◦FC-ANCHOR_AP-LV-LIST must be set to GPS.
◦FC-GPS-TIME-OUT must be set to 180 (in other words, 3 minutes).
Cisco RAN Management System Administration Guide, Release 5.0
116
January 7, 2015
Managing Groups and ID Pools
Managing Groups
• On the BAC, under Group Area, configure these parameters:
◦FC-GPS-ENABLE must be set to True.
◦FC-GPS-TOLERANCE must be set to 10000000.
Managing Groups
To manage groups, select the Groups tab in the left navigation bar of the Groups and ID Pools interface.
You can view, add, update, import, export or delete a group instance with read-write permission.
Note
The default Area group should not be used for Device Registration.
Groups are created within the framework of a group type which defines the parameters that the groups can
have. Each pre-defined group type has one default group created during installation. Use the default group as
a template to create additional groups within the same group type. To create a new group:
• Click Add in the Groups tab and provide all requested parameter values.
• Create a CSV file containing the same parameters as the default group, and then click Import in the
Groups tab. This option can be used to import multiple groups in one CSV file.
Tip
The easiest way to create a group CSV file is to click Export in the Groups tab and
export the default group. The CSV file is downloaded to your local drive where you can
open it and edit as required. Save this file and then use it in the Import operation. For
more information, refer to Importing a Group Type, Group Instance, ID Pool Type or
ID Pool Instance, on page 125.
Managing ID Pool Types
To manage ID pool types, click the ID Pool Types tab in the left navigation pane of the Group and ID Pools
interface. Information regarding the defined ID pool types is displayed and you can add, update, delete, import
or export ID pool types using the buttons at the bottom of the display.
The main difference between the adding of ID pool types and that of adding group types is the association to
group or ID pools, respectively. Where group types can have multiple associations with ID pool types, ID
pool types can have only one association with group types.
The following pool types are pre-configured during the RMS installation:
• SAI-POOL
• CELL-POOL
• CELL-ID-POOL—Required for LTE devices and associated with a region group
• LTE-CELL-POOL
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
117
Managing Groups and ID Pools
SAI Pools
Note
• If the SAI-POOL or CELL-POOL are in the Active state, they cannot be deleted.
• If the SAI-POOL or CELL-POOL are in the Deactive or Planned state, they can be deleted only if
devices are not associated with the pool.
• If devices are associated with the SAI-POOL or CELL-POOL, run the Reassign script to move the
devices to other pools and then delete the pools.
SAI Pools
Service Area Identifier (SAI)-POOL is used to uniquely track APs, especially for billing purposes. It contains
a Location Area Code (LAC). Specifically, the SAI is equal to the PLMN + LAC + Service Area Code (SAC).
There is a distinction in the solution between the Over-The-Air (OTA) LAC and the SAI LAC. The SAI LAC
is used in the SAI contained in Radio Access Network Application Part (RANAP) messages. The OTA-LAC
is used by the FAP on the Air Interface.
The SAI-POOL gives a unique SAC-ID of SAI for every new device during registration. The RMS maps the
SAC-ID selected to the below Ubiquisys data model:
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.CN.SAC
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
parameter. This table describes all the properties that can be specified for SAI pools in the CSV file used with
the Import option.
Table 2: Default SAI Pool Properties
Property
Required Description
id Pool Type
Yes
Name of the pool type: SAI-POOL.
Pool Name
Yes
Name of the SAI pool should be unique. Name should not contain
underscore (_) and hyphen(-) other than alphanumeric characters. The
DEFAULT-SAI-POOL is created during the RMS installation.
State
Yes
Active— RMS selects only those SAI-POOL's for SAC-ID assignment
which are in the Active state1
Planned— RMS does not select SAI pools which are in the Planned state
for SAC-ID Assignment. SAI pools are created in this state and if Active
pools are exhausted then SAI pools in this State are made Active.2
Deactive— RMS does not select SAI pools which are in the Deactive
State for SAC-ID assignment. SAI pools are moved to this state before
they can be deleted. 3
SAI pools must be in the Deactive state before they can be
deleted.
This SAC value is used if device is not associated with any INSEE or
there is no SAC mapping for this INSEE or 2G\3G macro cell IDs are
not detected.
Note
FC-IUSAC-DEFAULT-ID Yes
Cisco RAN Management System Administration Guide, Release 5.0
118
January 7, 2015
Managing Groups and ID Pools
CELL Pools
Property
Required Description
Range
Yes
Represents the SAC-ID of the SAI. Values should be 1..65535. The format
for a range is x..y, for example 1..100. The format for a set of single
values is x,y, for example 1,2,3. Both range and a set of single values can
be given, for example 1..100,101,102.
Groups
Yes
For SAI-POOL the options show the list of Area groups to which this
pool can be associated. The format is {name :AreaGroupName, type
:Area},{name : AreaGroupName, type :Area}
FC-LAC-ID
Yes
SAI LAC value. The SAI LAC is used in SAI contained in RANAP
messages. This LAC is used by the core network, so it has to be obtained
from core network configuration.
1 A SAI pool in the Active State cannot be Deleted.
2 This is a guideline for clean assignment of SAC-IDs within a SAI pool. You can create SAI pools in the Active State.
3 This is a guidelines only. You can even delete a SAI pool which is in the Planned State. The RMS does not allow deletion of Deactive or Planned SAI pools
if devices are associated with the pool. You should run the Reassign script to move devices to another SAI pool.
An example CSV file is shown here:
Table 3: ID Pool Instance CSV File
ID Pool
Type
Pool Name
STATE
RANGE
GROUPS
FC-LAC-ID
SAI-POOL
CHILE-SAI-POOL-2 Planned
500..600
{name :Band_1, 1023
type :Area},{name
:Band_2_5, type
:Area}
CELL Pools
For Ubiquisys, the UC-Id and RNC-Id are used in the configuration which is applied via TR-069 to the HNB.
Cell-POOL gives the C-ID needed for the UC-Id calculation.
The UC-Id is equal to the Concatenation[Hex(RNCID), Hex(C-ID)]. The RMS maps the UC-Id to this
Ubiquisys data model parameter: InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.
CellID.
If you use the DCC user interface, tool tips are provided so that you know what values to provide for each
parameter. This table describes all the properties that can be specified for CELL pools in the CSV file used
with the Import option.
Table 4: Default CELL Pool Properties
Property
Required
Description
id Pool Type
Yes
Name of the pool type: CELL-POOL.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
119
Managing Groups and ID Pools
LTE Cell Pools
Property
Required
Description
Pool Name
Yes
Name of the CELL pool should be unique. Name should not contain
underscore (_) and hyphen(-) other than alphanumeric characters. The
DEFAULT-CELL-POOL is created during the RMS installation.
State
Yes
Active—RMS selects only those CELL pools for C-ID Assignment which
are in this State.4
Planned—RMS does not select CELL pools which are in Planned state
for C-ID assignment. CELL pools are created in this state and if Active
pools are exhausted then a CELL pool in this State are made Active. 5
Deactive—RMS does not select CELL pools which are in the Deactive
State for C-ID assignment. The CELL pools are moved to this state before
deleting the CELL pool. 6
CELL pools must be in the Deactive state before they can be
deleted.
Represents the C-ID of the UC-Id. Values should be 1..65535. The format
for a range is x..y, for example 1..100. The format for a set of single
values is x,y, for example 1,2,3. Both range and a set of single values
can be given, for example 1..100,101,102.
Note
Range
Yes
Groups
Yes
For CELL-POOL the options show the list of FemtoGateway groups to
which this pool can be associated. The format is {name
:FemtoGroupName, type :FemtoGateway},{name : FemtoGroupName,
type :FemtoGateway}
4 Cell pools in the Active State cannot be deleted.
5 This is only a guideline for clean assignment of the C-ID within a Cell pool. You can still create a Cell pool in the Active State.
6 This is again a guideline. You can even delete a Cell pool in the Planned state. RMS does not allow deletion of Deactive or Planned Cell pools if devices are
associated with this Cell pool. You should run the Reassign script to move devices to another Cell pool.
An example CSV file is shown here:
Table 5: CELL Pool CVS File
ID Pool Type
Pool Name
STATE
CELL-POOL
CHILE-CELL-POOL-2 Planned
RANGE
GROUPS
500..600
{name :Band_1, type
:Area},{name :Band_2_5, type
:Area}
LTE Cell Pools
For LTE deployments you must have an LTE cell pool. This is the ECGI-ID-POOL. It is associated with the
HeNB gateway. An LTE cell pool must be created before you create a region group so that you can associate
it with the region.
Cisco RAN Management System Administration Guide, Release 5.0
120
January 7, 2015
Managing Groups and ID Pools
Managing ID Pools
Managing ID Pools
You can create ID pool instances in the Group and ID Pool interface. Click on the ID Pools tab in the left
navigation bar of the interface. All existing ID pools are displayed in the right pane of the display.
To add, update or delete an ID pool, you must have read-write permissions.
You must associate each SAI pool with at least one Area group and each CELL pool with at least one
FemtoGateway group. Initially associate the SAI pool with the default Area and the CELL pool with the
default FemtoGateway as no other groups would initially be created. When a new Area instance is created
and associated with the SAI pool, automatic assignment of the SAI pool happens. So the SAI pool created
above has two associations: one with the default Area and another with the newly created Area. You can
update the SAI pool to remove the association with the default Area after the new Area association is completed.
The LTE-CELL-POOL must be associated with a Region.
Note
The default Area group should not be used for Device Registration.
Making Changes to a Group Type, Group Instance, ID Pool Type
or IP Pool Instance
You can change groups and group types or ID pools and pool types using the DCC-UI graphic interface, or
using the XML interface.
Adding a Group Type
Procedure
Step 1
In the left navigation pane of the Group and ID interface, select Group Types and click Add.
Step 2
Enter the name of the new group type.
Note
The name must be unique. If you try to give the name which is already existing but in different case
(upper case or lower case), you will get an error message.
Step 3
Step 4
Step 5
Step 6
Step 7
Only the alphanumeric characters and other characters such as underscore (_) and hyphen (-) are
allowed.
In the Group Type screen, enter a priority for the group type.
Values can range from 1 to 100.
Check the Reassignable check box if you want to reassign the device in this group type to other group types.
Specify the number of devices that can be assigned to this Group type.
Specifying no value here defaults to '0', which indicates an unlimited number of devices.
Select the ID Pool types that are to be associated with this Group type. For example, SAI-POOL and
CELL-POOL. This field is optional.
Select Group Types that are to be associated with the existing Group type.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
121
Managing Groups and ID Pools
Adding a Group Instance
The Area group type should be associated with the FemtoGateway group type for registering a device
and relating a device from one group to another group of the same group type.
Click Add to add the group type.
Note
The Add button is enabled only when you specify all the required details.
Note
Step 8
What to Do Next
After you add a group type, you need to define the parameters that you want to be available for groups of this
type. To do this, refer to Configuring DCC Dialog Boxes, on page 41. This customizes the interface to include
the parameters that you specify in all groups of this type.
Adding a Group Instance
There are two ways to add a group. You can use this task to add the group using the DCC UI screens. You
need to provide all of the required information in the Add dialog box. Alternatively, you can use the Import
option to import a previously created CSV file with one or more groups defined. For more information
regarding the import option, refer to Importing a Group Type, Group Instance, ID Pool Type or ID Pool
Instance, on page 125.
Procedure
Step 1
From the Group and ID interface, select Groups from the left navigation pane and click Add.
The Add Group Instance dialog box for Site group is displayed by default. You can select the required group
from Groups screen.
Step 2
Enter the name of the new group.
Note
The name must be unique. If you try to give the name which is already existing but in different case
(upper case or lower case), you will get an error message.
Step 3
Only alphanumeric characters and other characters such as underscore (_) and hyphen (-) are allowed.
Enter the state of the group.
A group can be in any of Planned, Active, or Deactive states.
Note
Step 4
Step 5
Step 6
Groups and Pools must be moved to Deactive state before deletion.
Select any ID Pools that are to be associated with this Group.
Select any Groups that are to be associated with the existing Group.
Note
The Group Instance of Area has to be associated with the Group Instance of FemtoGateway for
registering a device and relating a device within the Group Type.
Click Add to add the group instance.
Adding a Device to New Group
A device can be added to a newly created group in three ways:
Cisco RAN Management System Administration Guide, Release 5.0
122
January 7, 2015
Managing Groups and ID Pools
Adding ID Pool Types
1 Using the ops-tools reassign script (reassignDevices.sh). For more details refer to reassignDevices, on
page 160
2 Re-registering the AP with the newly created group. For more details refer to Absolete: Re-registering the
Device with a New Group
3 Reassigning a device to a new group by using the DCC_UI import operation. To perform this export the
group with export type as related EIDs and change the group name to the newly added group. Then import
the .csv file by following steps inImporting a Group Type, Group Instance, ID Pool Type or ID Pool
Instance, on page 125.
Adding ID Pool Types
Use this task to create a new ID pool type.
Procedure
Step 1
From the Group and ID interface, select ID Pool Types from the left navigation pane and click Add.
The Add ID Pool Type dialog box is displayed.
Step 2
Enter the name of the new ID Pool type.
Note
The name must be unique. If you try to give a name which already exists in different case (upper
case or lower case), you receive an error message.
Only the alphanumeric characters and other characters such as underscore (_) and hyphen (-) are
allowed.
Step 3
Step 4
Step 5
Step 6
Enter the pool type priority. This value can range from 1 to 100 and corresponds to this pool type’s priority.
Select the Group Type to be associated with this ID pool type.
Select the Property name to be associated with this ID pool type.
Click Add to add the ID pool type.
Adding an ID Pool Instance
Procedure
Step 1
Step 2
In the left navigation pane of the Group and ID interface, select ID Pools and click Add.
The Add ID Pool Instance dialog box for SAI-POOL is displayed by default. You can select the required ID
Pool from ID Pools screen.
Enter the name of the new pool instance.
Note
The name must be unique. If you try to give the name which is already existing but in different case
(upper case or lower case), you will get an error message.
Step 3
Only alphanumeric characters and other characters such as underscore (_) and hyphen (-) are allowed.
Enter the state of the pool.
A pool can be in any of the Planned, Active, Deactive states.
Step 4
Enter the Range of IDs this Pool can be assigned to.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
123
Managing Groups and ID Pools
Updating a Group Type, Group Instance, ID Pool Type, or ID Pool Instance
Range consists of a single number or two numbers separated by two periods or a combination of both each
being separated by a comma. For example: [1,2..10,300..400].
Step 5
Step 6
Select the Groups that are to be associated with this ID Pool.
Click Add to add the ID Pool.
Note
The Add button is enabled only when you specify all required details.
Updating a Group Type, Group Instance, ID Pool Type, or ID Pool Instance
Use this task to edit a group type, group instance, ID pool type or ID pool instance that you have previously
created.
Procedure
Step 1
Step 2
In the left navigation pane of the Group and ID Pools interface, select the tab for the object type that you
want to update. Values are Group Type, Groups (for group instance), ID Pool Types or ID Pools (for ID pool
instances).
From the list of available objects in the right display pane, select the object that you want to edit and click
Update.
The Update dialog box is displayed.
Note
The Update button is enabled only after you select an object in the right pane of the display.
Step 3
Edit any of the values in the Update dialog box.
The name of the object is displayed in the dialog box, but cannot be edited.
Step 4
Click Update.
Note
The Update button is enabled only after you specify all the required details.
Deleting a Group Type, Group Instance, ID Pool Type, or ID Pool Instance
Procedure
Step 1
Step 2
In the left navigation pane of the Group and ID Pools interface, select the tab for the object type that you
want to delete. Values are Group Type, Groups (for group instance), ID Pool Types or ID Pools (for ID pool
instances).
From the list of available objects in the right display pane, select the object that you want to delete and click
Delete.
Note
You cannot delete a group type if the group type has any group instances; nor can you delete an ID
pool type if it has any ID pool instances.
Step 3
Click Confirm to confirm the action.
Cisco RAN Management System Administration Guide, Release 5.0
124
January 7, 2015
Managing Groups and ID Pools
Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance
The object is deleted from the interface.
Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance
Use this task to import properties for group type, group instance, ID pool type or ID pool instance. To determine
the format of the CSV file to import, you can export a file for a same-type group type or instance, or ID pool
type or instance and use it as a template. The advantage of using the Import option as opposed to the Add
option is that you can import multiple objects in a single CSV file.
Procedure
Step 1
Step 2
Step 3
Step 4
In the left navigation pane of the Group and ID interface, select the tab for the object type that you want to
import. Values are Group Type, Groups (for group instance), ID Pool Types or ID Pools (for ID pool instances).
Click Import.
The Import dialog box is displayed.
Click Select CSV File.
A dialog box is opened for you to specify the CSV file that you want to upload.
Navigate to the location of the CSV file and click Open.
The name of the file is displayed in the text box in the Import dialog box.
Step 5
Click Import.
The Import button is only activated after you select a CSV file to import.
Step 6
Click Confirm to confirm the action.
Once the import of the CSV file succeeds, a status message is displayed and the data is applied to the BAC.
Note
• You can view and edit the .csv files in Microsoft Excel and import into the application. However,
it is recommended to use a text editor to edit the .csv files. This is because Microsoft Excel
does not remove commas when a cell value is deleted, which can cause import to malfunction
and also lead to unintended formatting issues in the csv file values.
• Blank values are not permitted in the file. Operator must provide 'N/A' in case parameter values
are not specified in the file or remove the parameter from the file. The import engine treats
"N/A" as a parameter to be marked for deletion. Any parameter labeled 'N/A' is treated as 'blank'
value and is marked for deletion during import. This is to intentionally discourage accidental
deletion of parameters during import.
Sample CSV File
Table 6: ID Pool Instance
ID Pool Type Pool Name
STATE
RANGE
GROUPS
FC-LAC-ID
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
125
Managing Groups and ID Pools
Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance
SAI-POOL
CHILE-SAI-POOL-2 Planned
500..600
{name :Band_1, type
1023
:Area},{name
:Band_2_5, type :Area}
Importing the Exported Pools and Groups from the Previous Build to the New Build
This task outlines the steps to be followed for importing the exported pools and groups from previous build
to the new build.
Note
Follow these steps only if you have exported the groups and pools in the previous build.
Procedure
Step 1
Import the SAI-POOL as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool
Instance, on page 125. Before Importing the SAI pool, edit the exported .csv file and make the following
changes:
a) Change the Area to DefaultArea "{name:DefaultArea, type:Area}". The default area must be used in the
SAI-POOL, as the intended area mentioned in the exported SAI-POOL is not created yet in the RMS.
b) If needed, change the range.
The default SAI pool range is 500.900. The maximum range is from 0 to 65535. Generally, you can make
these changes in a standard text editor, but if a range is specified such as 3400..4000,23000, you must use
Microsoft Excel to make the changes.
Step 2
Import the CELL-POOL as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool
Instance, on page 125. Before importing the Cell pool, edit the exported .csv file and make the following
changes:
a) Change the FGW to Default FGW "{name:DefaultFGW, type:FemtoGateway}".
The default FGW must be used in the CELL pool, as the intended FGW mentioned in the exported CELL
pool is not created yet in the RMS.
b) If needed, change the range.
The default CELL pool range is 1..400. The maximum range is from 0 to 65535. Generally, you can make
these changes in a text editor, but if a range is specified as in 3400..4000,23000, you must use Microsoft
Excel to make the changes.
Step 3
Import the FGW as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool Instance,
on page 125. Before importing the FGW group, verify the following:
a) All cell pools present in the exported FGW group are imported before importing the FGW group. Refer
to Step 1, on page 126.
b) If you see the ZAP Route property in the exported file for the FGW group, you must delete this column
before importing the group. The reason for this is that the system throws an error on import when the
property is not already configured in the pmg-profile.xml.
c) The Provisioning Group name is same in the present and previous build. If not, edit the Provisioning Group
name in the exported .csv file to the one mentioned in the BAC UI.
Step 4
Import the AREA group as described in Importing a Group Type, Group Instance, ID Pool Type or ID Pool
Instance, on page 125.
Cisco RAN Management System Administration Guide, Release 5.0
126
January 7, 2015
Managing Groups and ID Pools
Exporting ID Pool or Group Types
Step 5
Step 6
Import all SAI pools and FGW groups contained in the exported Area group before importing the AREA
group. Follow Step 1, on page 126 and Step 3, on page 126 to import the FGW group and SAI pool. All the
SAI pools and Cell pools get associated with the intended and Default Area and FGW respectively. APs are
registered with the intended AREA and FGW. So the association of same pool (SAI-POOL or CELL-POOL)
with different groups (Intended and Default Area and FGW) does not cause any issue.
Import the Enterprise group group as described in Importing a Group Type, Group Instance, ID Pool Type
or ID Pool Instance, on page 125.
Note:Remove the Groups Column from the csv before Importing the Exported file.
Import the Site group group as described in Importing a Group Type, Group Instance, ID Pool Type or ID
Pool Instance, on page 125.
Note:Import all the Area and Enterprise groups contained in the exported site group before importing the Site.
Exporting ID Pool or Group Types
Export the ID pool types or group types to view the parameters set for these, or to use them as a template to
import a new ID pool type or group type.
Procedure
Step 1
From the Group and ID Pools interface, select ID Pool Types from the left navigation pane.
Step 2
Click Export.
A CSV text file containing the properties of all ID pool types is generated. A dialog box is displayed for you
to open or save the generated file.
Step 3
Step 4
Click Save File and specify a location for the file to be saved.
Click OK to complete the export operation.
Following is a sample of the exported pool type data (including the header row):
id Pool Type Name,Priority,Associated Group Type,BAC Property Name
SAI-POOL,50,Area,FC-SAC-ID
CELL-POOL,50,FemtoGateway,FC-OTA-CELL-ID
Exporting Information about a Group or ID Pool Instance
Export information about a group or ID pool instance to view the various properties used. You can edit exported
files to create new groups or ID pools. Use the Import option to import these groups or ID pool files into the
RMS.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
127
Managing Groups and ID Pools
Groups and IP Pools: Messages
Procedure
Step 1
In the left navigation pane of the Group and ID Pools interface, select the Groups tab.
Step 2
Step 3
Select one of the group types and click Export.
Select a specific group for which to export information in the Group drop-down list.
Note
The All Groups checkbox must be
unchecked.
In the Export Type drop-down list, select whether the export should include the group properties, or all related
EIDs for the group.
Note
By default, 'Properties' is selected as the Export
Type.
Click Export.
A CSV text file containing the properties of all the group instances of the selected group is generated and a
dialog box is displayed for you to specify where to save the exported file.
Step 4
Step 5
• Related EIDs refer to all the devices associated with the selected pool type/pool(s).
• Properties refer to all the attributes associated with the selected pool type/pool(s).
Step 6
Step 7
Navigate to the desired location and click Save File.
The export is complete after you specify the location to which the file should be saved.
Click OK.
The following is a sample of the exported group data (including the header row):
Group Type,Group Name,FC-FIRMWARE-PC202-3G-IMAGE,/IPDevice/
connectionRequestMethod,FC-3G-PC312-ENABLE,FC-FIRMWARE-PC202-ROUTER-IMAGE,
FC-3G-PC202-ENABLE,FC-FIRMWARE-PC312-ROUTER-VERSION,
FC-FIRMWARE-PC202-ROUTER-VERSION,FC-ROUTER-PC312-ENABLE,FC-FIRMWARE-PC312-3G-VERSION,
FC-ROUTER-PC202-ENABLE,FC-FIRMWARE-PC312-3G-IMAGE,
FC-FIRMWARE-PC202-3G-VERSION,FC-FIRMWARE-PC312-ROUTER-IMAGE,FC-CSG-ENABLE
Management,224Fcb,N/A,N/A,true,N/A,N/A,1.0.34,N/A,true,Bootloader:
224_001 176.4.0; Kernel: 224_002 197.3.0; Filesys: 224F004
491.49.0_Cb_710_11,N/A,rmm-224F007_491.49.0_Cb_710_11.sdp,N/A,router-1.0.34,N/A
Management,CRDiscovered,N/A,Discovered,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
Management,CRLeaseQuery,N/A,LeaseQuery,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A
Management,RichSR71,rmm-205F007_491.48.0_C_710_9.sdp,N/A,N/A,router-1.0.34,true,N/A,
1.0.34,N/A,N/A,true,N/A,Bootloader: 205_001 171.14; Kernel: 205_002 197.0; Filesys: 205F004
491.48.0_C_710_9,N/A,N/A
Groups and IP Pools: Messages
Adding a Group Type: Messages
This table lists the status messages that can be displayed when adding a group type:
Cisco RAN Management System Administration Guide, Release 5.0
128
January 7, 2015
Managing Groups and ID Pools
Updating a Group Type: Messages
UI Message
Description
Successfully added group type 'groupTypeName'
Failed to add group type 'groupTypeName'. RDU
Unavailable.
When BAC RDU is not available.
Failed to add group type 'groupTypeName'.
Unexpected error.
When the unexpected error occurs at Server.
Failed to add group type 'groupTypeName'.
Operation error occurred. Please try again. If the
problem persists please contact your system
administrator.
Generic error message.
Updating a Group Type: Messages
This table lists the status messages that can be displayed when updating a group type:
UI Message
Description
Successfully updated group type 'groupTypeName'
Failed to update group type 'groupTypeName'. RDU When BAC RDU is not available.
Unavailable.
Failed to update group type 'groupTypeName'.
Unexpected error.
When the unexpected error occurs at Server.
Failed to update group type 'groupTypeName'.
Operation error occurred. Please try again. If the
problem persists please contact your system
administrator.
Generic error message.
Import Group Type, Group Instance, ID Pool Type and ID Pool Instance:
Messages
This table lists the status messages that can be displayed when importing a group type, group instance, ID
pool type or ID pool instance:
UI Message
Description
CSV file successful imported and changes applied.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
129
Managing Groups and ID Pools
Export Group Type: Messages
UI Message
Description
You have cancelled applying the changes.
The user interrupted the import process by
clicking the Cancel button.
Export Group Type: Messages
This table lists the status messages that can be displayed when exporting group types:
UI Message
Description
Export of group types successful.
The export of group types could not be completed. Generic error message for such scenarios as
the PMG is unavailable.
Adding or Updating a Group Instance: Messages
This table lists the status messages that can be displayed when adding or updating a group instance:
UI Message
Description
Successfully added group '<groupName>'.
Failed to add group '<groupName>'. Unknown
Parameter <parameterName>
If the configured parameter is not recognized
by PMG. It has to be present in
pmg-profile.xml and BAC.
Failed to add group '<groupName>'. Invalid
Parameter <parameterName>
If the parameter value is not valid..
Failed to add group '<groupName>'. RDU
Unavailable
When BAC RDU is not available.
Failed to add group '<groupName>'. Unexpected
error
When the unexpected error occurs at server.
Failed to add group '<groupName>'. Operation error Generic Error Message.
occurred. Please try again. If the problem persists
please contact your system administrator.
Cisco RAN Management System Administration Guide, Release 5.0
130
January 7, 2015
Managing Groups and ID Pools
Deleting a Group Instance: Messages
Deleting a Group Instance: Messages
This table lists the status messages that can be displayed when deleting a group instance:
UI Message
Description
Successfully deleted group '<groupName>'.
Failed to delete group '<groupName>'. Unknown
Instance.
When a group does not exists at BAC.
Failed to delete group '<groupName>'. Unexpected When the unexpected error occurs at server
error.
like if .group is in active state
Failed to delete group '<groupName>'. RDU
unavailable.
When BAC RDU is not available.
Failed to delete group '<groupName>'. Operation
error occurred. Please try again. If the problem
persists please contact your system administrator.
Generic Error Message.
Exporting Information about a Group Instance: Messages
This table lists the status messages that can be displayed when exporting information about a group instance:
UI Message
Description
Export of group, '<groupName>', successful.
This message is presented to the user only if
he selected a single group to export.
Export of all groups successful.
This message is presented to the user only if
he chose to export all groups.
The export of group could not be completed.
Generic error message for such scenarios as
the PMG is unavailable.
Adding an ID Pool: Messages
This table lists the status messages that can be displayed when adding an ID pool:
UI Message
Description
Successfully added ID pool '<poolName>'.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
131
Managing Groups and ID Pools
Deleting an ID Pool Type: Messages
UI Message
Description
Failed to add ID pool '<poolName>'. Unknown
Parameter <parameterName>
If the configured parameter is not recognized
by PMG. It has to be present in
pmg-profile.xml and BAC.
Failed to add ID pool '<poolName>'. Invalid
Parameter <parameterName>
If the parameter value is not valid.
Failed to add ID pool '<poolName>'. RDU
Unavailable
When the BAC RDU is not available.
Failed to add ID pool '<poolName>'. Unexpected
error
When the unexpected error occurs at server.
Failed to add ID pool '<poolName>'. Operation error Generic Error Message.
occurred. Please try again. If the problem persists
please contact your system administrator.
Deleting an ID Pool Type: Messages
This table lists the status messages that can be displayed when deleting an ID pool type:
UI Message
Description
Successfully deleted ID pool type
'<idPoolTypeName>'.
Failed to delete ID pool type '<idPoolTypeName>''. Generic error message for such scenarios as
Operation error occurred. Please try again. If the
the BAC is unavailable.
problem persists please contact your system
administrator
Exporting ID Pool Type: Messages
This table lists the status messages that can be displayed when exporting information about an ID pool type:
UI Message
Description
Successfully exported details for all Pool types.
You have cancelled the requested Export
The user interrupted the import process by
pressing the "Cancel" button.
Cisco RAN Management System Administration Guide, Release 5.0
132
January 7, 2015
Managing Groups and ID Pools
Export an ID Pool: Messages
UI Message
Description
There has been a communication error with the
server. Please try again. If the problem persists
please contact your system administrator
Generic error message for such scenarios as
the PMG is unavailable.
Export an ID Pool: Messages
This table lists the status messages that can be displayed when exporting an ID pool instance:
UI Message
Description
Successfully exported details of <poolName>.
This message is presented to the user only if
he selected a single pool to export.
Successfully exported details for all <poolType>
pools.
This message is presented to the user only if
he chose to export all pools.
You have cancelled the requested Export
The user interrupted the import process by
pressing the "Cancel" button.
Please enter a Pool Instance or Select All Pools
This message is presented to the user only if
he clicks on export button when no pool and
no pools checkbox checked.
There has been a communication error with the
server. Please try again. If the problem persists
please contact your system administrator.
Generic error message for such scenarios as
the PMG is unavailable.
EID modifications for <poolTypeName> are not
supported. Export may proceed. For example: EID
This pool type does not allow export.
modifications for FemtoGateway are not
supported. Export may proceed.
Updating an ID Pool Instance: Messages
This table lists the status messages that can be displayed when updating an ID pool instance:
UI Message
Description
Successfully updated ID pool '<poolName>'.
Failed to update ID pool '<poolName>'. Unknown
Parameter <parameterName>
If the configured parameter is not recognized
by PMG. It has to be present in
pmg-profile.xml and BAC
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
133
Managing Groups and ID Pools
Updating an ID Pool Type: Messages
UI Message
Description
Failed to update ID pool '<poolName>'. Invalid
Parameter <parameterName>
If the parameter value is not valid
Failed to update ID pool '<poolName>'. RDU
Unavailable
When the BAC RDU is not available.
Failed to update ID pool '<poolName>'. Unexpected When the unexpected error occurs at server.
error
Failed to update ID pool '<poolName>'. Operation Generic Error Message
error occurred. Please try again. If the problem
persists please contact your system administrator.
Updating an ID Pool Type: Messages
This table lists the status messages that can be displayed when updating an ID pool type:
UI Message
Description
Successfully updated ID pool type
'<idPoolTypeName>'.
Failed to update ID Pool type '<idPoolTypeName
>'. RDU Unavailable.
When the BAC RDU is not available.
Failed to update ID Pool type '<idPoolTypeName
>'. Unexpected error.
When an unexpected error occurs at Server
Failed to update ID Pool type '<idPoolTypeName Generic error message.
>'. Operation error occurred. Please try again. If the
problem persists please contact your system
administrator.
Cisco RAN Management System Administration Guide, Release 5.0
134
January 7, 2015
CHAPTER
8
Global Configuration of Devices in BAC RDU
The Configuration tab provides the ability to manage global level configuration of devices in the BAC RDU
for properties such as DN Prefix Format and CWMP Defaults. This tab is disabled by default and can be
enabled by updating 'superuser' role from Admin tab->Roles. Refer to Editing a Role, on page 143 for more
details.
DN Prefix: It is used as part of the ManagedObjectInstance parameter that is in a fault. The DN Prefix
parameter is defined in TR-196. The Prefix is applied to the groups such as enterprise, site, or chasis so that
the applicable identification information is included. It allows the fault system to have all information
necessary without further integration with the RMS. Additionally, DN Prefix can be leveraged and used in
the PM file so that the PM system does not required integration with the RMS. The default value for
"FC-DN-PREFIX-FORMAT" parameter is "FC-ENTERPRISE-ID, FC-SITE-ID, FC-GRID-ID".
CWMP: It is the CPE WAN Management Protocol (CWMP). It defines an application layer protocol for
remote management of end-user devices. Any properties set under CWMP defaults level means that the
property value is applicable to the devices but can be overridden at group and device level.
• Configuring DN Prefix Format, page 135
• Adding CWMP Defaults, page 137
• Updating CWMP Defaults, page 138
• Deleting CWMP Defaults, page 138
Configuring DN Prefix Format
This feature allows the user to customize the DN Prefix format.
Procedure
Step 1
Log in to the DCC UI with valid credentials.
The Device Command and Control screen is displayed.
Step 2
Select the Configuration tab.
The Configuration screen is displayed.
Step 3
Select the DN Prefix Format tab.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
135
Global Configuration of Devices in BAC RDU
Configuring DN Prefix Format
The DN Prefix Format screen is displayed.
Figure 11: Configure DN Prefix format
Step 4
Step 5
Step 6
Step 7
Step 8
Enter the valid name in Label text box.
Select the suitable property from the Property drop down box.
Note
As you enter the label name and suitable property, the Add Property button is enabled and it allows
the user to add the property.
Click Add Property to add a property to the DN Prefix format.
Note
This adds the property to DN Prefix Format.
A tool-tip is displayed indicating that the changes are not saved, and the Submit button is enabled
to save the changes.
Optional. Click Delete icon against the respective property to delete that property.
Note
This deletes the property from the DN Prefix Format.
A tool-tip is displayed indicating that the changes are not saved, and the Submit button is enabled
to save the changes.
Click Submit.
Cisco RAN Management System Administration Guide, Release 5.0
136
January 7, 2015
Global Configuration of Devices in BAC RDU
Adding CWMP Defaults
The successful DN prefix format message is displayed.
Note
A success response or a failure response is displayed with an appropriate page error message depending
on the PMG response.
Adding CWMP Defaults
Procedure
Step 1
Log in to the DCC UI with valid credentials.
The Device Command and Control screen is displayed.
Step 2
Select the Configuration tab.
The Configuration screen is displayed.
Step 3
Select the CWMP Defaults tab.
The CWMP Defaults screen is displayed.
Step 4
Click Add to add the CWMP default property.
The Add CWMP Default Property screen is displayed.
Figure 12: Add CWMP Default Property
Note
The Add button is enabled only after all the required fields are entered.
Step 5
Enter the valid property name, type, and value and click Add.
The property gets updated in the CWMP Defaults screen.
Step 6
Click Cancel.
The dialog box closes.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
137
Global Configuration of Devices in BAC RDU
Updating CWMP Defaults
Updating CWMP Defaults
Procedure
Step 1
Log in to the DCC UI with valid credentials.
The Device Command and Control screen is displayed.
Step 2
Select the Configuration tab.
The Configuration screen is displayed.
Step 3
Select the CWMP Defaults tab.
The CWMP Defaults screen is displayed.
Step 4
Click Update.
The Update CWMP Default Property screen is displayed.
Figure 13: Update CWMP Default Property
Step 5
Enter the valid value and click Update.
The property gets updated in the CWMP Defaults screen.
Step 6
Click Cancel.
The dialog box closes.
Deleting CWMP Defaults
Procedure
Step 1
Log in to the DCC UI with valid credentials.
The Device Command and Control screen is displayed.
Step 2
Select the Configuration tab.
Cisco RAN Management System Administration Guide, Release 5.0
138
January 7, 2015
Global Configuration of Devices in BAC RDU
Deleting CWMP Defaults
The Configuration screen is displayed.
Step 3
Select the CWMP Defaults tab.
The CWMP Defaults screen is displayed.
Step 4
Click Delete.
Based on the selection of the property the delete confirmation screen is displayed.
Click Cofirm.
The selected property gets deleted and updates the CWMP Defaults screen.
Step 5
Step 6
Click Cancel.
The dialog box closes.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
139
Global Configuration of Devices in BAC RDU
Deleting CWMP Defaults
Cisco RAN Management System Administration Guide, Release 5.0
140
January 7, 2015
CHAPTER
9
Administering Users and Roles
The Device Command and Control User Interface supports the administration of the users and roles as a
single data storage solution, and in turn utilizes the administration information across all DCC UI components.
The authorization for the DCC UI resources is controlled by the Admin functionality of the DCC UI. The
Authorization system is linked to Roles Administration and provides access control based on role specifications
for all the applications installed on the DCC UI.
You can only access role-specific applications for which you are authorized. The access for applications is
specific to a role and is automatically denied, if the tabs for accessing the application do not appear in the
login.
Log in to the DCC UI using your password credentials. The DCC UI login and authentication system verifies
the login credentials and authentication details. The Device Command and Control screen is displayed, with
the tabs that you are authorized to use. By default, the Users tab is enabled in the left navigation pane. Select
the Users tab to view the Users and Roles interface.
Figure 14: Users and Roles Screen
All the users assigned to a specific role on the DCC UI are displayed on the screen. Each Role provides
access to the various applications of the DCC UI as read-only or read-write. For example, the superuser role
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
141
Administering Users and Roles
PAM Authentication
provides the most access to all applications of the DCC UI. However, you can define a very limited role that
provides only read-only access to the device manager, and not include access to the upgrade monitor tool
or the group and ID pool interface. Once you have defined your roles, you can assign them to each of your
users as needed.
• PAM Authentication, page 142
• User Roles and Access Permissions, page 142
• Managing Roles, page 143
• Managing Users, page 144
• User Administration: Messages, page 146
PAM Authentication
The Pluggable Authentication Module (PAM) is supported for DCC_UI to allow users to log in with their
own credentials through any Unix PAM service defined such as LDAP, SSH, and RADIUS.
The DCC UI allows user provisioning as internal or external user for authentication purposes through the Add
User and Edit User functionality.
Internal user authentication is handled by the DCC UI application through the dcc_ui database entries.
External user authentication is handled by the PAM through PAM service modules. Such users are not
authenticated by the DCC UI.
PAM authentication is driven by the following two preloaded properties in dcc.properties.
pam.service.enabled= true
pam.service= login
All users must be provisioned in the DCC_UI before login to specify the role authorization for all users.
User Roles and Access Permissions
The functionality that you can perform in the system is dependent on the permissions you are allowed. Your
ability to change information in the system will depend on whether you have read-only or read-write permission.
This table lists the permissions required for each functionality:
Table 7: User Roles and Group Type Permissions
Functionality
Description
Permission Allows
Functionality
Read-only
Read-write
View Group Types table There is no “View” button. This is simply entry into
the Group Types page to view the group types and
their attributes.
Yes
Yes
Add Group Type
Add a new group type
—
Yes
Update Group Type
Modify an existing group type
—
Yes
Cisco RAN Management System Administration Guide, Release 5.0
142
January 7, 2015
Administering Users and Roles
Managing Roles
Functionality
Description
Permission Allows
Functionality
Read-only
Read-write
Delete Group Type
Delete a group type
—
Yes
Import Group Types
Import a group type (or set of group types) via CSV
text file
—
Yes
Export Group Types
Export all group types to a CSV text file
Yes
Yes
Managing Roles
Adding a Role
You can define roles that can then been assigned to various users that should have similar access rights to the
DCC UI.
Procedure
Step 1
In the left navigation bar of the Administration interface, select the Roles tab.
The Roles screen is displayed with each of the defined Roles and their permissions.
By default, the Superuser option is displayed under the Roles
list.
Click Add, to add a new role.
The display is changed for you to define the new role.
Note
Step 2
Step 3
Step 4
Enter a name for the new role in the RoleName text box.
Select the individual privileges that are to be assigned for the specific DCC UI components.
For example, to allow read-write access for creating group types, click ReadWrite under Group Types.
Step 5
After you have assigned any desired privileges, click Add Role.
The Add Role button is enabled only after selecting at least one privilege.
Step 6
If necessary, click Reset, to revert the changes and change the privilege settings.
Editing a Role
Use this task to edit an existing role.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
143
Administering Users and Roles
Deleting a Role
Procedure
Step 1
In the left navigation bar of the Administration interface, select the Roles tab.
The Roles screen is displayed with each of the defined Roles and their permissions.
By default, the Superuser option is displayed under the Roles
list.
Select the role that you want to change and click Edit.
The display is changed for you to define the role.
Note
Step 2
Step 3
Select the individual privileges that are to be assigned for the specific DCC UI components.
For example, to allow read-write access for creating group types, click ReadWrite under Group Types.
Step 4
After you have changed any desired privileges, click Update Role.
The Update Role button is enabled only after changing at least one privilege.
Step 5
If necessary, click Reset, to revert the changes and change the privilege settings.
Deleting a Role
Procedure
Step 1
In the left navigation bar of the Administration interface, select the Roles tab.
The Roles screen is displayed with each of the defined Roles and their permissions. You can delete a role
from the Roles screen of the DCC UI Administration interface, if no users are assigned to the role.
Step 2
Select the role from the display and click Delete.
Managing Users
Adding a User
By enabling the administrative feature, you can perform user administration for all the applications installed
on the DCC UI. With the 'Application Administrator' access you can perform user administration for the
application you are authorized for. It is similar to the Role administration. User administration requires 'Super
User' access.
Procedure
Step 1
In the left navigation bar of the Administration interface, select the Users tab.
Cisco RAN Management System Administration Guide, Release 5.0
144
January 7, 2015
Administering Users and Roles
Editing a User
The Administration screen is displayed in the right pane with the list of defined users and their assigned
roles.
Step 2
Click Add to add a new user.
The Add User dialog box is displayed for you to provide information about the user.
Step 3
Enter a name for the new user.
The name must be unique. If you try to give a name which already exists, you will get an error message.
Step 4
Step 5
Step 6
Select the role to be assigned to the user from the Role drop-down list box.
Check the Is External User checkbox if the user is not authenticated from this application.
Click Add User.
The new user is added to the application and is listed in the user administration display in the right pane.
Editing a User
The Edit User screen facilitates an administrator to edit an existing user for a given application.
Procedure
Step 1
In the left navigation bar of the Administration interface, select the Users tab.
The Administration screen is displayed in the right pane with the list of defined users and their assigned
roles.
Step 2
Select a user from the display and click Edit to make changes to the user definition.
The Edit User dialog box is displayed for you to make the required changes.
Step 3
Step 4
Step 5
Check the Password Reset checkbox if you want to reset the password to the default password.
Select the role to be assigned to the user from the Role drop-down list box.
Check the Is External User checkbox if the user is not authenticated from this application.
If the user is an external user, the password reset option is not applicable.
Click Update.
Step 6
Deleting a User
A user can be deleted from the User Administration interface.
Procedure
Step 1
In the left navigation bar of the Administration interface, select the Users tab.
The Administration screen is displayed in the right pane with the list of defined users and their assigned
roles.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
145
Administering Users and Roles
User Administration: Messages
Step 2
Click the user that you want to delete and click Delete icon in the Delete column of the display. The user is
deleted and the display is refreshed.
Note
A logged in user cannot be
deleted.
User Administration: Messages
This table lists the status messages that can be displayed when adding or updating a user:
UI Message
Description
Successfully added '<userName>'.
Username '<userName>' already exists. Please try
another Username.
The user name provided by the user exactly
matches an already-existing user name on the
Database.
Unable to add new user '<userName>'.
Generic error message for such scenarios as
the Database is unavailable.
Unable to update user '<userName>'.
Generic error message for such scenarios as
the Database is unavailable.
Cisco RAN Management System Administration Guide, Release 5.0
146
January 7, 2015
CHAPTER
10
Operational Tools
• Operational Tools, page 147
• How to Use Ops Tools, page 148
• massCr.sh, page 149
• massReboot.sh, page 152
• getDeviceData.sh, page 154
• encryptPassword.sh, page 158
• searchAndExport.sh, page 159
• reassignDevices, page 160
• resync.sh, page 162
• massFactoryRestore.sh, page 163
• bulkimportexport.sh, page 166
• bulkStatusReport.sh, page 167
• gpsExportData.sh, page 174
• Configuring Crons, page 176
• Operational Tools for PMGDB, page 181
Operational Tools
The following tools are available to facilitate ease of operation:
• Bulk Import Export Tool—Imports or exports a large number of areas and sites.
• Mass Connection Request Tool—Performs mass TR-069 Connection Requests to CPEs that are registered.
• Mass Reboot Tool—Performs mass reboot of CPEs that are registered.
• Get Device Data Tool—Retrieves device data from the RDU DB, and/or directly from devices via what
is termed a "live data pull".
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
147
Operational Tools
How to Use Ops Tools
• Encrypt Password Tool—Encrypts passwords so that when they are stored on disk they are not in clear
text.
• Search and Export—Searches for devices in the BAC RDU DB that are associated with a given provgroup
or a configured RMS group type, report their counts, and then exports the device lists to a file.
• Reassign Devices—Performs a rebalanace of the assignments. This tool updates both BAC and FRM
for any devices that are to be reassigned to new groups. The requests for these reassignments are through
PMG.
• Resync—Performs a synchronization of FRM with BAC. Whitelist and groups and IDs data are considered
for synchronization.
For all these bulk tools, only one instance of the tool is allowed to execute at a time.
When the initial instance of the tool is still executing, and if a second instance of the tool is started, the
following scenario results:
1 The second instance of the tool terminates after sending the following message to the console and logs:
Another instance of the script is already running, exiting.
2 The initial tool instance is notified that another instance of the script is attempted.
3 The initial tool instance, upon receiving the notification from the second tool instance, outputs the following
to the console and the tool logs in separate lines:
New instance of script detected…, User Name = <second script user name>, and User current
working dir = <second script user working directory>.
The port that the scripts are to be bound to is configurable via the script properties. It is possible to configure
all the scripts to the same port number so that only one script at a time can be run.
All the Operational tools write their output files to a sub-directory underneath the current working directory
unless specified otherwise, using the -outdir command-line argument.
<current working directory>/<script name>-<date-time stamp>
The date-time stamp has the following format:
MMDDYY-hhmmss
Where, "M" is month, "D" is day, "Y" is year, "h" is hour, "m" is minutes, and "s" is seconds.
For Example:
GetDeviceData-041112-195530
How to Use Ops Tools
Following are general guidelines for using the Ops tools:
• Ops tools can be executed by any user in the ciscorms group.
• Execute the Ops tools from the home directory, or from any folder within the home directory. For
example,
/home/admin1$
/home/admin1/test$
/home/admin1/test/BFST$
Cisco RAN Management System Administration Guide, Release 5.0
148
January 7, 2015
Operational Tools
massCr.sh
• Do not pre-append absolute, or any path, or ./ to run ops tools. Just use the tool name as in the example
below.
For example,
$ getDeviceData.sh -help
$ bulkStatusReport.sh
• The default output directory of Ops tools is /rms/ops/<<tool name>>-<<timestamp>>.
For example,
/rms/ops/GetDeviceData-20140730-010708
/rms/ops/BulkStatusReport-20140729-000018
• The default output directory can be overridden by using the -outdir option.
For example, $ getDeviceData.sh -config gddt.conf -outdir /rms/ops/GDDT.
massCr.sh
To perform TR-069 connection requests(CRs) to CPEs, use the massCr.sh tool.
massCr.sh -help {all| -idfile file} [-type listType][-outdir dir] [-rate rate] [-retries retries] -force
Syntax Description
-help
Optional. This argument produces a console output of
the tool's syntax, arguments, description, and the
available group types (for -type listType).
If this option is selected with no other arguments, -help
will print out to the console and the tool will not run.
-all
Required if the inputFile option is not specified. When
this argument is specified, a TR-069 connection request
is sent to all devices.
-idfile file
Required if the "-all" option is not specified. The
argument specifies a path to a file that includes a list of
devices or group IDs (one ID per line) to report device
counts or export device lists. If no path is specified, the
local directory is used.
A TR-069 Connection Request is sent to all devices
associated with the specified objects.
-type listType
Optional. Specifies the content of the list file as
"devices", "provgroup", or a configured group type (for
example, "management"). If this argument is not
specified, the "devices" list type is the default type used.
If listType is found to be invalid, the tool aborts and
displays a list of the available group types from the BAC
to the console.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
149
Operational Tools
massCr.sh
-outdir dir
Optional. This argument specifies the directory where
the supporting report files are to be generated.
The logs and the output files must be written to a
directory as follows: <outputDir>/<script
name><date-time stamp>
If this argument is not specified, the current directory is
used: <outputDir> = $RMS_OPS. This can be either a
relative or absolute path. If a relative path is specified,
then the <outputDir> is created using $RMS_OPS as the
parent directory. If an absolute path is used, the path must
start with $RMS_OPS.
-rate rate
Optional. This argument specifies the maximum rate of
connection requests per second. The tool sends no more
than this number, but may send less depending on the
resource constraints. If this option is not specified, the
tool defaults to 20 requests per second.
The rate is limited between 1 and 100.
-retries retries
Optional. This argument is used for specifying the
number of times the TR069 connection request should
be retried on failure. If the argument is not specified, the
default value of "2" is used.
To set the range for retries parameter refer to following
properties which are defined in the massCR.properties:
• Minimum retries = 1 (lower boundary)
• Maximum retries = 20 (upper boundary)
The default range of number of retries is between 1 to
20 (inclusive).
-force
Usage Guidelines
Note
Optional. If specified, the tool executes irrespective of
other ops tools currently running.
Connection requests only work on CPEs that are connected to the RMS server at the time of the connection
request. A successful connection request results in the CPE contacting the BAC and getting reconfigured with
the latest configuration stored in the RDU and cached by the DPEs.
Only one instance of the massCr.sh tool is allowed to execute at a time. The recommended rate initiation
of connection requests using this tool is 5 per second (in other words, the argument to be used during
script execution for this is "-rate 5")
Cisco RAN Management System Administration Guide, Release 5.0
150
January 7, 2015
Operational Tools
massCr.sh
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. Summary information is produced as the result. The tool produces a file containing a list of devices
for failed connection requests. The administrator can retry running the tool using this file at a later point.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and the error logs. Failures due to the devices being offline are not flagged as errors.
A sample output of the massCr.sh tool is shown below:
$ massCr.sh -idfile eid_cr.txt -type devices -rate 5 -retries 1
Params:
Rate :: 5
Retries :: 1
Threads :: 10
Output Directory :: /home/krajain/massCr.sh/MassConnectionRequest-20120906-072000
** Please note this tool will request ConnectionRequest @ 5devices/sec
EID = BACF00-0000000002, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000002] failed. Embedded error.
[Failed to activate device [BACF00-0000000002]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000007, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000007] failed. Embedded error.
[Failed to activate device [BACF00-0000000007]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000010, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000010] failed. Embedded error.
[Failed to activate device [BACF00-0000000010]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000006, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000006] failed. Embedded error.
[Failed to activate device [BACF00-0000000006]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000001, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000001] failed. Embedded error.
[Failed to activate device [BACF00-0000000001]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000003, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000003] failed. Embedded error.
[Failed to activate device [BACF00-0000000003]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000004, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000004] failed. Embedded error.
[Failed to activate device [BACF00-0000000004]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000009, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000009] failed. Embedded error.
[Failed to activate device [BACF00-0000000009]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000005, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000005] failed. Embedded error.
[Failed to activate device [BACF00-0000000005]; Connection refused ]. Batch allowed to
proceed.
EID = BACF00-0000000008, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.ConnectionRequestFailedException:
BAC Status Code: -9999 - Activation of device [BACF00-0000000008] failed. Embedded error.
[Failed to activate device [BACF00-0000000008]; Connection refused ]. Batch allowed to
proceed.
All the ConnectionRequestData are completed.
*******************
Summary Report
*****************************************
Number of successful Connection Requests :: 0
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
151
Operational Tools
massReboot.sh
Number of failed Requests :: 10
********************************************************************************
*******************
Connection Request Failure List
*************************
Connection Request Failure EIDs:
/home/krajain/massCr.sh/MassConnectionRequest-20120906-072000/massCrFailure.eids
********************************************************************************
*******************
Log Report
**********************************************
Connection Request Success Log:
/home/krajain/massCr.sh/MassConnectionRequest-20120906-072000/massCrSuccess.log
Connection Request Failure Log:
/home/krajain/massCr.sh/MassConnectionRequest-20120906-072000/massCrFailure.log
Audit FileName: /home/krajain/massCr.sh/MassConnectionRequest-20120906-072000/logs/audit.log
Debug FileName: /home/krajain/massCr.sh/MassConnectionRequest-20120906-072000/logs/debug.log
Error FileName: /home/krajain/massCr.sh/MassConnectionRequest-20120906-072000/logs/error.log
********************************************************************************
Done.
massReboot.sh
To reboot all the CPEs, use the massReboot.sh tool.
massReboot.sh {all| -idfile <file>} [-type <listType>][-outdir <dir>] [-rate <rate>] [-retries <retries>]
[-mode <mode>] -help -force
Syntax Description
-all
Required if the inputFile option is not specified. When this argument is specified, a TR-069
connection request is sent to all devices.
-idfile <file>
Required if the "-all" option is not specified. The argument specifies a path to a file that
includes a list of devices or group IDs (one ID per line) to report device counts or export
device lists. If no path is specified, the local directory is used.
A TR-069 Connection Request is sent to all devices associated with the specified objects.
-type
<listType>
Optional. Specifies the content of the list file as "devices", "provgroup", or a configured
group type (for example, "management"). If this argument is not specified, the "devices"
list type is the default type used.
If <listType> is found to be invalid, the tool aborts and displays a list of the available
group types from the BAC to the console.
-outdir <dir>
Optional. This argument specifies the directory where the supporting report files are to be
generated.
The logs and the output files must be written to a directory as follows:
<outputDir>/<script name><date-time stamp>
If this argument is not specified, the current directory is used: <outputDir> = $RMS_OPS.
This can be either a relative or absolute path. If a relative path is specified, then the
<outputDir> is created using $RMS_OPS as the parent directory. If an absolute path is used,
the path must start with $RMS_OPS.
Cisco RAN Management System Administration Guide, Release 5.0
152
January 7, 2015
Operational Tools
massReboot.sh
-rate <rate>
Optional. This argument specifies the maximum rate of connection requests per second.
The tool sends no more than this number, but may send less depending on the resource
constraints. If this option is not specified, the tool defaults to 10 requests per second.
The rate is limited between 1 and 100.
-retries
<retries>
Optional. This argument is used for specifying the number of times the TR069 connection
request should be retried on failure. If the argument is not specified, the default value of
"2" is used.
-mode<mode>
Optional. If this flag is not specified, the tool defaults to the immediate mode. One of the
following modes is specified:
• immediate— a connection request is established to the device and is restarted when
the device connects. If unsuccessful, the connection request is retried a number of
times and then the operation is terminated for the device.
• onconnect—a restart operation is queued within the BAC for the device, but no
immediate connection request is established. The CPE is restarted the next time it
contacts the BAC, like the Periodic contact.
• hybrid—a restart operation is queued within the BAC for the device and a connection
request is established. If the connection request is unsuccessful (that is, the device
if offline), the device restart is performed on the next contact with the BAC.
-help
Optional. This argument produces a console output of the tool's syntax, arguments,
description, and the available group types (for -type listType).
If this option is selected with no other arguments, -help will print out to the console and
the tool will not run.
-force
Usage Guidelines
Note
Optional. If specified, the tool executes irrespective of other ops tools currently running.
The restart causes the CPEs to communicate to the BAC, at which time the CPE is reconfigured with the latest
configuration stored at the RDU and cached by the DPEs.
Only one instance of massReboot.sh is allowed to execute at a time.
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. The summary information is produced at the result. The tool produces a file containing a list of
devices for which the connection requests failed. The administrator can decide to retry executing the tool
using this file at a later point.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and in the error logs. Failures due to the devices being offline are not flagged as errors.
A sample output of themassReboot.sh tool is shown below:
$ massReboot.sh -idfile eid_reboot.txt -type devices -rate 20 -retries -mode hybrid
Params:
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
153
Operational Tools
getDeviceData.sh
infile :: /home/krajain/massReboot.sh/MassReboot-20120906-072717/procconnreqsort.eid
Rate :: 20
Retries :: 2
Threads :: 50
Output Directory :: /home/krajain/massReboot.sh/MassReboot-20120906-072717
Mode :: hybrid
** Please note this tool will request Reboot @ 20devices/sec
EID = BACF01-0000000002, status = true, statusMsg = BACF01-0000000002 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000003, status = true, statusMsg = BACF01-0000000003 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000009, status = true, statusMsg = BACF01-0000000009 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000007, status = true, statusMsg = BACF01-0000000007 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000004, status = true, statusMsg = BACF01-0000000004 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000001, status = true, statusMsg = BACF01-0000000001 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000010, status = true, statusMsg = BACF01-0000000010 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000005, status = true, statusMsg = BACF01-0000000005 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000006, status = true, statusMsg = BACF01-0000000006 is queued for re-boot
and will re-boot on next BAC contact
EID = BACF01-0000000008, status = true, statusMsg = BACF01-0000000008 is queued for re-boot
and will re-boot on next BAC contact
All the RebootData are completed.
*******************
Summary Report
*****************************************
Number of successful Reboots :: 10
Number of failed Reboots :: 0
********************************************************************************
*******************
Reboot Failure List
************************************
Reboot Failure EIDs:
/home/krajain/massReboot.sh/MassReboot-20120906-072717/massRebootFailure.eids
********************************************************************************
*******************
Log Report
**********************************************
Reboot Success Log:
/home/krajain/massReboot.sh/MassReboot-20120906-072717/massRebootSuccess.log
Reboot Failure Log:
/home/krajain/massReboot.sh/MassReboot-20120906-072717/massRebootFailure.log
Audit FileName: /home/krajain/massReboot.sh/MassReboot-20120906-072717/logs/audit.log
Debug FileName: /home/krajain/massReboot.sh/MassReboot-20120906-072717/logs/debug.log
Error FileName: /home/krajain/massReboot.sh/MassReboot-20120906-072717/logs/error.log
********************************************************************************
Done.
getDeviceData.sh
The Get Device Data Tool (GDDT) is a supporting tool for retrieving device data from the RDU database,
and directly from devices connected to the RMS server. The GDDT stores the retrieved data in a CSV file for
further processing or review. The tool is also used independently by administrators.
getDeviceData.sh [-sampleConfig] {-config file [-outdir dir] [-mergeOnColumnName] [-useBackup dir|
-useExport file] [-saveExport <file>] [-idfile file -type listType] [-rate num] [-timeout num] [-liveThreads
num] [-force]| -help}
Cisco RAN Management System Administration Guide, Release 5.0
154
January 7, 2015
Operational Tools
getDeviceData.sh
Syntax Description
-sampleConfig
Optional. Produces a sample configuration file.
-config <file> -
Required. Specifies the full path to a file which includes the configuration,
along with a list of parameters or properties to be retrieved.
-outdir <dir>
Optional. This argument specifies the directory where the supporting
report files are to be generated.
The logs and the output files must be written to a directory as follows:
<outputDir>/<script name><date-time stamp>
If this argument is not specified, the current directory is used: <outputDir>
= $RMS_OPS. This can be either a relative or absolute path. If a relative
path is specified, then the <outputDir> is created using $RMS_OPS as the
parent directory. If an absolute path is used, the path must start with
$RMS_OPS.
-mergeOnColumnName
Optional. When specified, columns in the device-data csv file with the
same column name are merged. This provides the values under one column
for the different TechTypes which serve the same purpose. If a value for
both columns exists then the value of the first column is used and the
value of the second column is ignored. Usually the columns are named
with same name when they serve the same purpose, but are of different
tech types.
useBackup dir
Optional. Specifies the full path to a directory with the RDU database
backup. If this argument is specified, the data is retrieved from an existing
RDU database backup snapshot instead of performing a new backup.
-useExport file
Optional. The argument provides the full path to a device export file
produced by the deviceExport.sh tool. If this argument is specified, the
tool skips RDU backup and export of data, and instead uses the provided
file.
-saveExport file
Optional. A full path to save a device export file produced by the
deviceExport.sh tool.
-idfile file
Optional. The argument specifies a path to a file that includes a list of
devices, provisioning or configured group type (one ID per line, for
example, "Management") to report device counts or export device lists.
If no path is specified, the local directory is used.
-type listType
Required only if "-idfile" is specified. The argument specifies the content
of the list file as either "devices", "provgroup", "cos", or a configured
group type (one ID per line, for example, "Management"). If <listType>
is found to be invalid, the tool will terminate and display a list of the
available group types from the BAC to the console.
-rate rate
Optional. Specifies the maximum rate of requests sent directly to live
devices. Default is 1000 per minute.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
155
Operational Tools
getDeviceData.sh
Usage Guidelines
-timeout num
Optional. This argument specifies the duration (milliseconds) to wait for
live data responses before timing out. The default value is 60,000
milliseconds.
-liveThreads num
Optional only if "-idfile" is not specified. The argument specifies the
maximum number of concurrent threads in requesting the live data.
-force
Optional. If specified, the tool executes irrespective of other ops tools
currently running.
-help
Optional. This argument prints the tool syntax, arguments, description,
and the available group types from the BAC (for -type's listType) to the
console. If this option is selected with no other arguments, -help will print
out to the console and the tool will not run.
The general syntax of the configuration file:
<ColumnType>, <SourceName>, <OutputColumnName>[, <Directives>]
The following parameter types are supported:
Column Type
Description
DeviceParameter
Retrieves a standard device parameter for which BAC defined and API
constant and/or property name.
DeviceProperty
Retrieves “custom” device properties such as CPE properties and discovered
CPE parameters stored in the RDU DB.
PropertyHierarchy
Retrieves a property from the device property hierarchy. The property is
first looked up on device. If not found, it is looked up on device’s
Management Group object. Then, Provisioning Group, Class of Service,
and finally Technology Defaults object. This is the same property hierarchy
that is used by BAC when processing templates and looking for a device
property.
NodeProperty{GroupType}
Retrieves a property from the Group of “GroupType” associated with the
device.
LiveParameter
Retrieves a specific TR-069 parameter from the CPE or CMHS server.
The list of supported TR-069 parameters is published separately with each
release of the CPE firmware.
The list can also be obtained via the BAC UI, by executing a Get Live
Data operation with “dcc-all-parameters.xml” list. This would request all
parameters from the CPE.
The directives are optional. The syntax is as follows:
<Directive>=<Value>; <Directive>=<Value>… <Directive>=<Value>
Cisco RAN Management System Administration Guide, Release 5.0
156
January 7, 2015
Operational Tools
getDeviceData.sh
The following directives are supported:
Directive
Description
TechType=<value>
This directive is ONLY applicable to LiveParameter column types. This
can be used to target retrieval of the value only for a specified tech type.
This allows to skip multiple attempts to retrieve device data for each Tech
Type.
There is an additional validation in place to check if the source name for
the given tech type is correct. The source name for TechType is ”UMTS”
to start with “InternetGatewayDevice.” The source name for TechType is
”LTE” to start with “Device.”
OUI
This directive is ONLY applicable to LiveParameter column types. This
can be used to target retrieval of the value for specified OUI. For example:
OUI=001B67.
Default=<value>
This directive forces a specific default value if no value is retrieved.
Note:
in the TR-069 world, there is no concept of a null string value. String values
always have some value, although it could be empty string. The default
value will not be applied to such parameters.
Type=Boolean
This directive indicates the type of the value. If this directive is specified
values will be normalized to "True" and "False" instead of 1, 0, true, false,
TRUE, FALSE, etc.
Type=dateTime
This directive is applicable to properties and parameters that are for a
particular moment in time on a particular day up to an arbitrary fraction of
a second in the ISO 8601 format: CCYY-MM-DDThh:mm:ss. This can be
suffixed with a Z to indicate coordinated universal time (UTC) or an offset
from UTC. For example, Neil Armstrong set foot on the moon at
1969-07-20T21:28:00-06:00 by the clock in Houston mission control which
is also known as 1969-07-21T02:28:00Z. If this directive is specified, the
values shall be converted from ISO 8601 UTC to the format yyy-MM-dd
HH:mm:ss zzz which can be used for Excel spread sheet import.
Note
In Excel the actual cell shows up to the minute granularity but
stores to the second to allow for proper sorting.
The output of the tool is a CSV file with columns corresponding to the ones specified in the configuration
file. The tool extracts the needed parameters from the correct number of instances and stores in a file. The
columns are specified by object instance number. According to the generic TR-069 protocol, the instance
numbers on the devices are not required to be sequential nor identical across devices. The instance numbers
are 1, 3, or 23; not just 1, 2, 3.
A sample GDDT configuration file generated by the getDeviceData.sh tool is shown here:
DeviceParameter, DeviceDetailsKeys.DEVICE_ID, EID
NodeProperty{Area}, Name, Area
NodeProperty{FemtoGateway}, Name, HNB-GW
NodeProperty{RFProfile}, Name, RF Profile
NodeProperty{Management}, Name, Management Group
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
157
Operational Tools
encryptPassword.sh
DeviceParameter, DeviceDetailsKeys.IS_PROVISIONED, Bootstrapped, Type=boolean
DeviceParameter, IPDevicKeys.REGISTERED_TIME, Type=dateTime
DeviceProperty, /IPDevice/homeProvGroup, Prov Group
DeviceProperty, /provisioning/classOfService/selected, Class of Service
DeviceProperty, FC-ACTIVATED, Activated, Default=false, Type=boolean
DeviceProperty, FC-SERVICE-STATUS, Service Provisioning Status
DeviceProperty, FC-SERVICE_STATUS-TS, Service Provisioning Status Timestamp
DeviceProperty, FC-FIRST-RADIO-ON, First Radio On
DeviceProperty, FC-LOCATION-VALID, Location Valid, Default=false, Type=boolean
DeviceProperty, FC-LOCATION-VALID-TS, Location Valid Timestamp
DeviceProperty, FC-DNM-STATUS, DNM Location Status
DeviceProperty, FC-DNM-STATUS-TS, DNM Location Status Timestamp
DeviceProperty, /cwmp/discovered/Inform.DeviceId.Manufacturer, Manufacturer
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.ModelName, Model Name
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.HardwareVersion, Hardware Version
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.SoftwareVersion, Software Version
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.X_00000C_3GModuleVersion, 3G Module
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.X_00000C_GpsModuleVersion, GPS Module
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.X_00000C_RouterModuleVersion, Router
Module
LiveParameter, Device.Services.X_00000C_FAPService.Enabled, Live Enabled, Type=boolean
LiveParameter, Device.Services.X_00000C_FAPService.Radio.Status, Radio Status
LiveParameter, Device.Services.X_00000C_FAPService.Radio.ErrorDetails, AP Error,
MinSwVersion=5.2.3
LiveParameter, Device.DeviceInfo.HardwareVersion, Live HW Version
LiveParameter, Device.DeviceInfo.SoftwareVersion, Live SW Version
LiveParameter, Device.DeviceInfo.ModelName, HW Model
LiveParameter, Device.DeviceInfo.X_00000C_Tampered, Tampered, Type=boolean
encryptPassword.sh
The encryptPassword.sh tool is used to encrypt passwords so that when they are stored on the disk, the
passwords are not in clear text.
encryptpassword.sh [-help][-type <value>]
Syntax Description
Usage Guidelines
-help
Optional. Produces a printout of the tool's syntax, arguments, and description.
-type <value>
Optional. This option specifies the algorithm to be used. The argument value can
be "DESEDE" or "DES" or "SHIFT". If the value is not specified, the default
algorithm used is DESEDE.
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. The summary information is produced at the result. The tool produces a file containing a list of
devices for which the connection requests failed. The administrator can decide to retry executing the tool
using this file at a later point.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and in the error logs. Failures due to the devices being offline are not flagged as errors.
A sample output of the encryptPassword.sh tool is shown below:
$ encryptPassword.sh
Enter password to encrypt:
Cisco RAN Management System Administration Guide, Release 5.0
158
January 7, 2015
Operational Tools
searchAndExport.sh
Confirm password to encrypt:
ELkvTVaIaew=
Done.
searchAndExport.sh
The searchAndExport.sh tool searches for devices in the BAC RDU DB that are associated with a given
provisioning group or a configured RMS group type, reports their counts, and then exports the device lists to
the CSV file.
searchAndExport.sh {-help| -idfile <file> [-type <listType>] [-outdir <dir>] -countsOnly}
Syntax Description
-help
Optional. This argument produces a console output of the tool's syntax, arguments,
description.
If this option is selected with no other arguments, -help will print out to the console and
the tool does not run.
-idfile <file>
Optional. The argument specifies a path to a file that includes a list of devices or group
IDs (one ID per line) to report device counts or export device lists. If no path is specified,
the local directory is used.
-type
<listType>
Required only if -idfile is specified and may not be used if -idfile is not used. This argument
specifies the content of the list file as either "provgroup", "cos", or a configured group
type (for example, "Management").
If <listType> is found to be invalid, the tool terminates and displays a list of the available
group types from the BAC to the console.
-outdir <dir>
Optional. This argument specifies the directory where the supporting report files are to be
generated.
The logs and the output files must be written to a directory as follows:
<outputDir>/<script name><date-time stamp>
If this argument is not specified, the current directory is used: <outputDir> = $RMS_OPS.
This can be either a relative or absolute path. If a relative path is specified, then the
<outputDir> is created using $RMS_OPS as the parent directory. If an absolute path is used,
the path must start with $RMS_OPS.
Upon completion, the tool prints the path and the name of the file to the console so the
user knows exactly how to access the generated file.
Usage Guidelines
Note
If the -idfile option is not specified, the tool searches for all devices.
The tool provides progress reports and prints the total number of devices exported.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
159
Operational Tools
reassignDevices
The tool produces a file which contains a list of devices to be exported.
If exporting the file fails with an error code indicating a provisioning system issue, the error is reported to the
console and in the error logs.
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. The summary information is produced at the result. The tool produces a file containing a list of
devices for which the connection requests failed. The administrator can decide to retry executing the tool
using this file at a later point.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and in the error logs. Failures due to the devices being offline are not flagged as errors.
A sample output of the searchAndExport.sh tool is shown below:
$ searchAndExport.sh -idfile Area.txt -type Area
*******************
Summary Report
*****************************************
Total number of devices obtained = 3069
********************************************************************************
*******************
DeviceIds OutFile
**************************************
DeviceIds OutFile:
/rms/home/sakuleti/OPSTools/SearchAndExport-20130329-023750/searchAndExport.out
********************************************************************************
*******************
Log Report
*********************************************
Audit FileName:/rms/home/sakuleti/OPSTools/SearchAndExport-20130329-023750/logs/audit.log
Debug FileName:/rms/home/sakuleti/OPSTools/SearchAndExport-20130329-023750/logs/debug.log
Error FileName:/rms/home/sakuleti/OPSTools/SearchAndExport-20130329-023750/logs/error.log
********************************************************************************
Done
reassignDevices
The reassignDevices.sh tool is used by administrators to rebalance assignments. This tool updates both BAC
and FRM for any devices that are to be reassigned to new groups. The requests for these reassignments are
performed through the PMG. The reassignments are flagged in the FRM.
reassignDevices.sh [-help| -idfile file [-type listType] [-outdir dir] [-rate num] [-threads num]
-donotAssignIds -force]
Syntax Description
-help
Optional. This argument produces a console output of the tool's syntax, arguments,
description.
If this option is selected with no other arguments, -help prints out to the console and the
tool does not run.
-idfile <file>
This argument denotes the path to a file with a list of devices or group IDs (one per line
to report device counts or export device lists. If no path is specified, the local directory
is used. The Reassign request is sent to all the devices associated with the specified
objects
Cisco RAN Management System Administration Guide, Release 5.0
160
January 7, 2015
Operational Tools
reassignDevices
-type <listType>
This argument is required only if inputFile is provided, and may not be used if inputFile
is not used. The argument specifies the content of the list file as either "devices",
"provgroup", "cos", or a configured group type (for example, "management").
If <listType> is found to be invalid, the tool will terminate and displays a list of the
available group types from the BAC to the console.
-outdir <dir>
Optional. This argument specifies the directory where the supporting report files are to
be generated.
The logs and the output files must be written to a directory as follows:
<outputDir>/<script name><date-time stamp>
If this argument is not specified, the current directory is used: <outputDir> = $RMS_OPS.
This can be either a relative or absolute path. If a relative path is specified, then the
<outputDir> is created using $RMS_OPS as the parent directory. If an absolute path is
used, the path must start with $RMS_OPS.
Upon completion, the tool prints the path and the name of the file to the console so the
user knows exactly how to access the generated file.
-rate <num>
Optional. This argument denotes a specific maximum rate of reassignments per second
to be sent. The tool will send no more than this number, but may send less depending
on the resource constraints. If this option is not specified, the tool will default to 100
requests per second.
The rate is limited between 1 and 100.
-threads <num>
Optional. The number of concurrent sessions with PMG.
Default value is 200. The threads value is bounded to be in the range of 1 to 500
(inclusive).
-donotAssignIds Optional. PMG does not assign IDs, instead it associates the missing groups to the device
such as Alarms Profile, Region, LTESecGateway, etc.
-force
Usage Guidelines
Optional. If the argument is specified, the tool executes irrespective of other operational
tools currently executing.
The tool periodically reports progress information (number complete, number failed, rate) to the console.
Summary information is produced at the end.
The tool only allow one instance of the reassignDevices to run at a time.
The tool produces a file which contains a list of devices with failed reassignments. The administrator may
decide to retry executing the tool using this file at a later point.
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. The summary information is produced at the result. The tool produces a file containing a list of
devices for which the connection requests failed. The administrator can decide to retry executing the tool
using this file at a later point.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and in the error logs. Failures due to the devices being offline are not flagged as errors.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
161
Operational Tools
resync.sh
A sample output of the reassignDevices.sh tool is shown below:
$ reassignDevices.sh -idfile reeid.txt -type devices
Rate :: 100
Threads :: 200
number of devices: 1
Output Directory :: /rms/home/sakuleti/OPSTools/ReassignDevices-20130329-025905
Please note this tool will process 100tasks/sec.
EID = BACF09-0000000012, status = true, statusMsg = Success
*******************
Summary Report
*****************************************
Number of successful reassignments :: 1
Number of failed reassignments :: 0
********************************************************************************
*******************
Log Report
*********************************************
Reassign Devices Success
Log:/rms/home/sakuleti/OPSTools/ReassignDevices-20130329-025905/reassignDevicesSuccess.log
Reassign Devices Failure
Log:/rms/home/sakuleti/OPSTools/ReassignDevices-20130329-025905/reassignDevicesFailure.log
Audit FileName:/rms/home/sakuleti/OPSTools/ReassignDevices-20130329-025905/logs/audit.log
Debug FileName:/rms/home/sakuleti/OPSTools/ReassignDevices-20130329-025905/logs/debug.log
Error FileName:/rms/home/sakuleti/OPSTools/ReassignDevices-20130329-025905/logs/error.log
********************************************************************************
Done.
resync.sh
The resync.sh tool performs resync of FRM with BAC. The details regarding Whitelist, groups, and IDs data
are considered for resync. The request to resync is through PMG.
Note
Only one instance of resync.sh tool is allowed to execute at a time. resync.sh <-help | <-start> [-force] >
resync.sh <-help | <-start> [-force] >
Syntax Description
-help
Optional. This argument produces a console output of the tool's syntax, arguments,
description.
If this option is selected with no other arguments, -help will print out to the console and
the tool does not run.
-start
Option to instruct PMG to start resync FRM with BAC. The Start option is required for
the tool to execute.
-force
Optional. If the argument is specified, the tool executes irrespective of other operational
tools currently executing.
Cisco RAN Management System Administration Guide, Release 5.0
162
January 7, 2015
Operational Tools
massFactoryRestore.sh
Usage Guidelines
The tool only allows one instance of the resync to run at a time.
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. The summary information is produced at the result. The tool produces a file containing a list of
devices for which the connection requests failed. The administrator can decide to retry executing the tool
using this file at a later point.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and in the error logs. Failures due to the devices being offline are not flagged as errors.
A sample output of the resync.sh tool is shown below:
$ resync.sh -start
Success
Done.
massFactoryRestore.sh
This tool performs factory restore of the CPEs. The tool SHALL only allow one instance of the
massFactoryRestore to run at a time.
massFactoryRestore.sh -help {all| -idfile file} [-type listType][-outdir dir] [-rate rate] [-retries retries][-mode
mode] -recovery time -force
Syntax Description
-help
Optional. Produces a print out of the tool's syntax,
arguments, description.
If this option is selected with no other arguments,
-help will print out to the console as expected and the
tool will not run.
-all
Optional. Specifies that all devices are to have a
factory restore sent to all devices.
-idfile file
Required if the "-all" option is not specified. A path
to a file with a list of devices or group IDs (one per
line) for which to report device counts or export
device lists. If no path is specified, the local directory
is used. A factory restore request is sent to all the
devices associated with these objects.
-type listType
Specifies the content type of the idfile, which can be
"devices", "provgroup", or "cos" or a configured RMS
group type. Required only if -idfile is specified and
may not be used if -idfile is not used.
If <listType> is found to be invalid, the tool will
display a list of the available group types from the
RMS to the console.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
163
Operational Tools
massFactoryRestore.sh
-outdir dir
Optional. A directory where the supporting report
files are generated. In all cases, the logs and output
files must be written to a directory as shown below:
<outputDir>/<script name>-<date-time stamp>
If this argument is not specified, <outputDir> =
$RMS_OPS.
This can be either a relative or absolute path. If a
relative path is specified then <outputDir> is created
using $RMS_OPS as the parent directory
Upon completion, the tool will print the path and
name of the file to the console so the user knows
exactly how to access the generated file.
-rate rate
Optional. A specific maximum rate of requests per
second to be sent to the BAC. The tool sends no more
than this number, but may send less depending on
the resource constraints. If this option is not specified,
the tool will default to 100 requests per second.
This parameter is bounded so that this tool will refuse
to execute when an unacceptable rate is entered,
which might have bogged down the RDU.
The following properties are defined in the
massFactoryRestore.properties so that an
administrator/user can change accordingly to set the
range for rate parameter:
• min.rate =1 (lower bound)
• max.rate =100 (upper bound)
i.e., by default the rate is bounded to be in the range
of 1 to 100 (inclusive)
-retries retries
Optional. Default value is 2. The number of times
the factory restore Request should be retried on
failure.
Cisco RAN Management System Administration Guide, Release 5.0
164
January 7, 2015
Operational Tools
massFactoryRestore.sh
-mode mode
Optional. If this flag is not specified, the tool defaults
to the immediate mode. One of the following modes
can be specified:
• immediate
• onconnect
• hybrid
In the "immediate" mode, a Connection Request is
made to the device and factory restore is performed
by the device when the device connects. If the
Connection Request is unsuccessful, the Connection
Request is retried a set number of times and then the
operation is aborted for the device.
In the "onconnect" mode, a factory restore operation
is queued within the BAC for the device, but no
immediate Connection Request is made. The CPE
will be rebooted the next time it contacts the BAC,
such as during the periodic contact.
In this "hybrid" mode, a factory restore operation is
queued within the BAC for the device and the
Connection Request is made to the device. If the
Connection Request is unsuccessful (i.e. device if
offline), the factory restore will be performed the next
time the device contacts the BAC.
-recovery time
Specifies when the recovery is performed:
• immediate
• onpowerup
• inleastbusyhour
• norecovery
If this flag is not specified, the tool defaults to the
factory reset.
-force
Optional. If specified the tool executes irrespective
of other ops tools currently running.
The tool periodically reports the progress information (number complete, number failed, rate) to the console.
Summary information is produced at the end.
A sample output of the massFactoryRestore.sh tool is shown below:
$ massFactoryRestore.sh -all
Config files script-props/private/MassFactoryRestore.properties or
script-props/public/MassFactoryRestore.properties not found.
Continuing with default settings.
number of devices: 2
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
165
Operational Tools
bulkimportexport.sh
Params:
Rate :: 100
Retries :: 2
Output Directory :: /rms/ops/MassFactoryRestore-20140317-093701
Mode :: immediate
** Please note this tool will request Factory Restore @ 100devices/sec
Please note this tool will process 100tasks/sec.
EID = 001B67-357539017729001, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.BacStatusException: BAC Status Code:
-846 - Failed to receive immediate operation results.
EID = 001B67-357539017729002, status = false, statusMsg =
com.cisco.ca.rms.dcc.common.rdu.BacStatusException: BAC Status Code:
-846 - Failed to receive immediate operation results.
*******************
Summary Report
*****************************************
Number of successful Reboots :: 0
Number of failed Reboots :: 2
********************************************************************************
*******************
MassFactoryRestore Failure List
**************************************
MassFactoryRestore Failure EIDs:
/rms/ops/MassFactoryRestore-20140317-093701/massRebootFailure.eids
********************************************************************************
*******************
Log Report
*********************************************
Audit FileName:/rms/ops/MassFactoryRestore-20140317-093701/logs/audit.log
Debug FileName:/rms/ops/MassFactoryRestore-20140317-093701/logs/debug.log
Error FileName:/rms/ops/MassFactoryRestore-20140317-093701/logs/error.log
bulkimportexport.sh
Use the bulkimportexport.sh tool to import or export a large number of areas and sites.
BulkImportExport.sh [-ops {import| export}] [-type {Area| Site}][-csvfile filepath]
[-outdirdir][-retryretries] [-defaultLinkedGroups default_groups] [-help]
Syntax Description
-ops {import | export
Specifies whether an import or export is to be performed.
-type{Area | Site
Specifies the type of groups, either area or site.
-csvfile filelpath
Specifies the path to a file with a list of groups to use for the import operation.
-outdir <dir>
Optional. Provides the path to a directory where the supporting log files are
generated.
-retry <retries>
Optional. Retry count for failed import operations.
-defaultLinkedGroups
default_groups
Default Groups to be linked with each group during import in the format
"{name:Grpname,type:Grptype}", e.g.
"{name:DefaultRegion,type:Region},{name:DefaultHeNBGW,type:HeNBGW}
Cisco RAN Management System Administration Guide, Release 5.0
166
January 7, 2015
Operational Tools
bulkStatusReport.sh
Usage Guidelines
You can use the DCC UI to import or export individual areas or sites. Use the bulkimportexport.sh tool to
import or export multiple areas or sites efficiently.
bulkStatusReport.sh
The bulkStatusReport.sh tool enables the retrieval of data from the RDU DB, and from the live FAPs into a
CSV file and produces the bulk status reports and provides you an option to limit reporting to just the
provisioning status data.
The bulkStatusReport.sh tool generates the following reports:
• Status Summary Report: The report generation is triggered using a command-line tool installed on
the RDU system.
• Status Exception Report: The report generates status information for all FAPs registered in BAC.
• Device Status Report: The report generates provisioning status (data stored in provisioning databases)
and live FAP status (obtained from FAP or FGW).
• Firmware Report: The report provides an option to administrator to limit reporting to just the
provisioning status data.
Following is the command-line syntax:
bulkStatusReport.sh {[-outdir dir]| -input file} -config dir [-useBackup dir| -useExport file][-saveExport
file] [-provDataOnly][-idfile file] [-type listType]-rate num-timeout num-help
Syntax Description
-outdir <dir>
Optional. Provides the path to a directory in which the report will be
produced.
-config <file>
Optional. Cannot coexist with -input option.
Provides the full path to a file which contains the configuration of a list
of parameters/properties to retrieve. The data retrieved from the file is
appended to the config file, generated by the tool after removing any
duplicates between the file specified with -config option and the tool
generated config file. If duplicates are found they should not be appended
to the generated config file and a message should be sent to the console
and error.log that the parameter/property is a duplicate and not being
added to the config file.
-input <file>
Optional. Cannot coexist with -config option
Provides the full path to a CSV file with raw data. If this argument is
specified, the tool skips the data retrieval. The input file could be generated
using the getDeviceData.sh tool. The tool aborts if the file does not exist.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
167
Operational Tools
bulkStatusReport.sh
-useBackup <dir>
Optional. Cannot co-exist with the -idfile and -useExport options
Provides the full path to a directory with the RDU db backup. If this
argument is specified, the data is retrieved from an existing RDU db
backup snapshot instead of performing a new backup.
-useExport <file>
Optional. Cannot co-exist with the -idfile and -useBackup options
Provides the full path to a CSV file which contains RDU export data. If
this argument is specified, the tool skips the export from RDU database.
The input file could be generated using the deviceExport.sh. The tool
aborts if file does not exist.
-saveExport <file>
Optional. This argument specifies that the exported device CSV file should
be saved for later reuse using the -useExport argument. If this argument
is specified, the full path for the resulting CSV must be specified.
-provDataOnly
Optional. If this flag is specified, the tool will only report on data stored
in the RDU database and will not attempt to retrieve any data from live
FAPs.
-idfile <file>
Optional. Cannot co-exist with -useBackup and -useExport options.
Specifies the path to a file with a list of devices or provisioning groups
or class of services or groupIDs (one per line). This option to co-exist
with -type option.
-type <listType>
Optional. Specifies the content type of the idfile, which can be devices,
rms, provgroup, cos or a configured RMS group type. This option to
co-exist with -idfile option.
The rms type supports any RMS group type as part of idfile. For example,
you can specify Site in idfile and define the type to be rms to derive all
devices under the Site group type.
-rate <rate>
Optional. The maximum rate of requests per minute to make to live FAPs.
-timeout <num>
Optional. The number of milliseconds to wait for get live data response
from FAP before timing out. Default is 60,000 msec.
-help
Optional. Produces a print out of the tool's syntax, arguments and
description to the console.
Following is an example of using the bulk status report script:
Login to su ciscorms
Go to the path /users/ciscorms/
bulkStatusReport.sh -apfile input.eids -liveThreads 175
Cisco RAN Management System Administration Guide, Release 5.0
168
January 7, 2015
Operational Tools
Status Summary Reports
Status Summary Reports
The bulk status report script can generate a Detailed Status Summary Report which provides statistics for
each of the reporting metrics for each HNB and HeNB Gateway and is generated in Comma-Separated Values
(CSV) format suitable for import into Excel. The Status Summary Report includes the following data for the
entire deployment:
• Provisioning Status Data:
◦Number of registered APs
◦Number of bootstrapped APs
◦Number of OSS-activated APs
◦Number of APs pending activation
◦Number of APs enabled during their last contact
◦Number of APs disabled during their last contact, due to pending activation, service block, tampering
or provisioning error
• Live AP Status:
◦Number of operational APs
◦Number of offline APs
◦Number of connected enabled APs
◦Number of operational APs
◦Number of connected disabled APs
Status Exception Reports
The Status Exception Report is suitable for import into Excel and contains rows of Comma-Separated Values
(CSV) with the following columns:
• EID
• Femto Gateway
• Exception
The Status Exception Report contains an entry for each AP which has an exception. If the AP has multiple
exceptions, only the first one is reported (the priority is based on the order of exception types in the list). The
following Exception types are defined:
• Never booted
• Pending activation
• AP Tampered
• Blocked
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
169
Operational Tools
Device Status Report
• Prov Error
• AP Offline
Note
The list of exception types may be expanded over time and some categories may be split into subclasses.
The report generates a Gateway Status Exception Report for each HNB and HeNB gateway, and is produced
in the same format as Status Exception Report. However, the Gateway column is omitted and the Gateway
name is included in the report file name.
Device Status Report
The Device Status Report is generated for each HNB and HeNB Gateway. The Device Status Report contains
one row for every AP assigned to a given gateway. The report contains the following columns in a CSV
format:
Column
Description
EID
AP Equipment ID
Area
Area ID
Prov group
Provisioning Group
Bootstrapped
Yes / No
Activated by OSS
One of:
• Yes
• No
• Pending
Last Enabled
Indicated if device service was enabled or not during the last contact
with provisioning systems. One of:
• Yes
• No
Cisco RAN Management System Administration Guide, Release 5.0
170
January 7, 2015
Operational Tools
Device Status Report
Column
Description
Enable Error
Indicates any errors preventing service enablement by the
provisioning system during last contact. One of:
• <Empty>
• Blocked
• Pending activation
• Tampered
• Prov Error
• Other Error
Connected
Indicates whether or not AP was connected to the FGW during the
report. One of:
• Yes
• No
Admin State
Indicates whether or not AP thinks it was administratively enabled.
One of:
• Yes
• No
Radio Status
Indicates the AP Radio status when report was generated. One of:
• Yes
• No
RFTx Status
Indicates the AP RFTx status when report was generated. One of:
• Yes
• No
Op State
Indicates the AP operational state when report was generated. One
of:
• Yes
• No
• Unknown
Note
SW Version
The unknown value is reported for any unconnected AP
because we are unable to retrieve the live status.
Software Version
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
171
Operational Tools
Device Status Report
Column
Description
HW Model
Hardware Model
GPS Enabled
GPS Enabled
GPS Status
GPS Status
GPS Status TS
GPS Status Timestamp
Expected Lat
Expected Latitude
Expected Long
Expected Longitude
GPS Lat
GPS Latitude
GPS Long
GPS Longitude
GPS Tolerance
GPS Tolernace
EDN Enabled
EDN related properties
EDN Status
EDN Status TS
EDN List
EDN Tolerance
DNL Enabled
DNL related properties
DNL Status
DNL Status TS
DNL Cell Loc File
DNL Tolerance
DNM Enabled
DNM related properties
DNM Status
DNM Status TS
DNM List
ISM Enabled
ISM related properties
Cisco RAN Management System Administration Guide, Release 5.0
172
January 7, 2015
Operational Tools
Firmware Reports
Column
Description
ISM Status
ISM Status TS
ISM File
ISM Reject Unknown
DNB Enabled
DNB related properties
DNB Status
DNB Status TS
DNB
DNB Power Tolerance
DNB Count Tolerance
DNB Freq Match
The report tool provides an option to generate a Cumulative Device Status Report . This report is identical to
Device Status Report, additionally covers all devices for all gateways and includes an additional column with
Femto Gateway.
Firmware Reports
The report tool generates a Firmware Summary Report in an user-friendly text form, in addition to the CSV
file format, suitable for import into Excel. The CSV report contains a column for the Gateway, AP Count,
and one column for each discovered firmware version. Each row represents a single Gateway.
The tool generates Firmware Version Device List files containing device EID lists (one per line). A separate
file is generated for each firmware version. One set of Firmware Version Device List files covers all devices
on each firmware version (irrespective of the gateway they are assigned to). Separate sets of files cover device
lists for each firmware scoped to each gateway. See Report Structure Example , on page 174 for more details.
The Firmware Summary Report contains the following data:
• Total number of bootstrapped APs
• Total number of APs on firmware x.y.z1
• Total number of APs on firmware x.y.z2
• Repeat for each firmware version reported by any AP
• For each HNB and HeNB gateway:
◦Number of bootstrapped APs assigned to this gateway
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
173
Operational Tools
Report Structure Example
◦Number of APs on firmware x.y.z1 assigned to this gateway
◦Number of APs on firmware x.y.z2 assigned to this gateway
◦Repeat for each firmware version reported by any AP
Report Structure Example
The overall report contains the following directory/file structure:
Directory / File
Description
/121312-152449
Root report directory
status-summary.txt
Status Summary Report
device-exceptions.csv
Status Exceptions Report
status-summary.csv
Detailed Status Summary Report
device-status.csv
Cumulative Device Status Report
firmware-report-by-gw.csv
Firmware Report by gateway in CSV format
firmware-report.csv
Firmware Report in CSV format
firmware-summary.txt
Firmware Summary Report in readable format
firmware-v1.0.0.txt
List of APs which last reported firmware v1.0.0
firmware-v1.1.0.txt
List of APs which last reported firmware v1.1.0
…
More files for each firmware version
/gateway-12345
A sub-directory with reports for gateway with Femto Gateway 12345
device-exceptions-12345.csv
Gateway Status Exceptions Report for Femto Gateway 12345
device-status-12345.csv
Device Status Report for Femto Gateway12345
firmware-12345-v1.0.0.txt
List of APs assigned to this gateway which last reported firmware v1.0.0
firmware-12345-v1.1.0.txt
List of APs assigned to this gateway which last reported firmware v1.1.0
…
Additional firmware files
/gateway-52345
A sub-directory with reports for gateway with Femto Gateway 52345
…
Same directory and file structure as for gateway 12345
See Glossaryfor more details on the BFST terminologies.
gpsExportData.sh
The tool exports the latest GPS data stored at the RDU database. Following is the command-line syntax:
Cisco RAN Management System Administration Guide, Release 5.0
174
January 7, 2015
Operational Tools
gpsExportData.sh
Usage:
gpsExportData.sh -l [-b db_file] [-ignoreOffline] [-v] [-outdir dir]
gpsExportData.sh -idfile file -type listType [-b db_file] [-ignoreOffline] [-v] [-outdir dir]
gpsExportData.sh {-h| -H| -help}
Syntax Description
-l
Exports data for all devices.
-idfile file
Specifies the path to a file with a list of devices, provisioning groups,
class of services or group IDs (one per line).
-type listType
Specifies the content type of the idfile, which can be devices, rms,
provgroup (provisioning groups), cos (class of services) or a
configured RMS group type.
The rms type supports any RMS group type as part of idfile. For
example, you can specify Site in idfile and define type to be rms to
derive all devices under the Site group type.
Usage Guidelines
-b
Exports data from user-generated database file: db_file. If this option
is not specified, then the latest database is generated automatically
by getDeviceData.sh tool, which may need to contact the FAP
Devices.
-ignoreOffline
Exports online devices only
-v
Exports data in VCIDDB format
-outdir
Output directory in which the files are to be generated
-help
Optional. Produces a print out of the tool's syntax, arguments and
description to the console
To generate a database file, db_file, use the command:
getDeviceData.sh -outdir <dir> -config gddt.conf
where gddt.conf specifies the following columns for the database file device_db.csv: EID, Femto Gateway,
Area, FAP-OTA-Cell-ID, Expected-Lat, Expected-Long, Authorized-Lat, Authorized-Long, Ignore-Location,
Is-Registered, Is-Provisioned, GPS-Failure-Cause, Activation-Request-Received,INSEE Code, First Time
Activation Time.
These examples show various uses of the gpsExportData script:
Export latest data for all devices:
gpsExportData -l
Export latest data for all devices, in VCIDDB format:
gpsExportData -l
-v
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
175
Operational Tools
Configuring Crons
Export latest data for online devices only:
gpsExportData -l -ignoreOffline
Export latest data for all online devices, in VCIDDB format:
gpsExportData -l -ignoreOffline -v
Export data for all devices in database file device_db.csv:
gpsExportData -l -b device_db.csv
Export latest data for list of devices in file EID.txt:
gpsExportData -idfile EID.txt -type devices
Export data for list of devices in file EID.txt, in database file device_db.csv:
gpsExportData -idfile EID.txt -type devices -b device_db.csv
Configuring Crons
This section explains how to configure crons.
Setting up the getDeviceData Cron
The getDeviceData cron is wrapped around the getDeviceData Tool (GDDT) to export device data for the
entire population (including complete stored data) as a cron. Additionally, the cron cleans up generated old
reports and logs. Following are configurable via dcc.properties:
• Log retention period in days: getDeviceData.log.retention.days=2
• Log location: getDeviceData.log.location=/rms/ops/GetDeviceData
• Report retention period in days: getDeviceData.report.retention.days=7
• Report location: getDeviceData.report.location=/rms/ops/GetDeviceData-reports
This cron automatically archive logs and reports which are one day older. The tool by default logs retention
period to 2 days, and reports retention period to 7 days.
The getDeviceData cron is located at
/rms/app/ops-tools/public/shell-scripts/getDeviceData.cron. The cron writes logs
to /rms/ops/GetDeviceData and reports to /rms/ops/GetDeviceData-reports.
Follow these steps to configure the getDeviceData cron:
Procedure
Step 1
Open the following file using vi editor: etc/cron.d/CSCOrms-ops-tools-ga.
Step 2
Ensure that HOME=/home/admin1. If not, then correct it to point to /home/admin1.
Step 3
Add the following entry at the end of the file and save it (below scheduled to be edited as needed)
0 2,12,18 * * * admin1
/rms/app/ops-tools/public/shell-scripts/getDeviceData.cron
Cisco RAN Management System Administration Guide, Release 5.0
176
January 7, 2015
Operational Tools
Setting up the getDeviceData Cron
Note
0 2,12,18 *** - Indicates that getDeviceData.cron to be executed every 2nd , 12th, 18th hour, 0 min
daily.
Figure 15: Cron Schedule Definition
The configuration file used to export data is as shown here:
DeviceParameter, DeviceDetailsKeys.DEVICE_ID, EID
DeviceParameter, DeviceDetailsKeys.FQDN, secondary ID
DeviceParameter, DeviceDetailsKeys.OWNER_ID, Subscriber ID
NodeProperty{FemtoGateway}, Name, Femto Gateway
NodeProperty{HeNBGW}, Name, Femto Gateway
NodeProperty{Area}, Name, Area
NodeProperty{Region}, Name, Region
NodeProperty{RFProfile}, Name, RF Profile
NodeProperty{Site}, Name, Site
NodeProperty{Sub-Site}, Name, Sub Site
NodeProperty{Enterprise}, Name, Enterprise
NodeProperty{CELL-POOL}, Name, Cell Pool
NodeProperty{CELL-ID-POOL}, Name, CellID Pool
NodeProperty{SAI-POOL}, Name, Sai Pool
NodeProperty{LTESecGateway}, Name, SecGateway
NodeProperty{UMTSSecGateway}, Name, SecGateway
DeviceProperty, /cwmp/discovered/InternetGatewayDevice.ManagementServer.ParameterKey,
Bootstrapped, Type=boolean
DeviceProperty, /cwmp/discovered/Device.ManagementServer.ParameterKey, Bootstrapped,
Type=boolean
DeviceProperty, FC-ACTIVATED, Activated by OSS, Default=False; Type=boolean
DeviceProperty, FC-BLOCKED, Blocked, Default=False; Type=boolean
DeviceProperty, FC-SERVICE-STATUS, Prov Status
DeviceProperty, FC-SERVICE-STATUS-TS, Prov Status TS
DeviceProperty, FC-TECH-TYPE, Tech Type
DeviceProperty, /cwmp/discovered/Inform.DeviceId.Manufacturer, Manufacturer
DeviceParameter, DeviceDetailsKeys.CLASS_OF_SERVICE_SELECTED, Class of Service
DeviceProperty, FC-FIRST-RADIO-ON, First Radio On TS
DeviceProperty, /IPDevice/homeProvGroup, Prov Group
DeviceProperty, /cwmp/discovered/InternetGatewayDevice.DeviceInfo.SoftwareVersion , SW
Version
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.SoftwareVersion , SW Version
DeviceProperty, /cwmp/discovered/InternetGatewayDevice.DeviceInfo.HardwareVersion , HW
Version
DeviceProperty, /cwmp/discovered/Device.DeviceInfo.HardwareVersion , HW Version
DeviceProperty, FC-LOCATION-VALID, Location Valid, Default=false, Type=boolean
DeviceProperty, FC-LOCATION-VALID-TS, Location Valid Timestamp
DeviceProperty, FC-CIG-STATUS, CIG Location Status
DeviceProperty, FC-CIG-STATUS-TS, CIG Location Status TS
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
177
Operational Tools
Setting up the getDeviceData Cron
DeviceProperty, FC-OTA-CELL-ID, UC-ID
DeviceProperty, FC-GPS-ENABLED, GPS Enabled, Default=False; Type=boolean
DeviceProperty, FC-GPS-STATUS, GPS Status
DeviceProperty, FC-GPS-STATUS-TS, GPS Status TS
DeviceProperty, FC-EXP-LAT, Expected Lat
DeviceProperty, FC-EXP-LONG, Expected Long
DeviceProperty, FC-GPS-LAT, GPS Lat
DeviceProperty, FC-GPS-LONG, GPS Long
DeviceProperty, FC-GPS-TOLERANCE, GPS Tolerance
DeviceProperty, FC-EDN-ENABLED, EDN Enabled, Default=False; Type=boolean
DeviceProperty, FC-EDN-STATUS, EDN Status
DeviceProperty, FC-EDN-STATUS-TS, EDN Status TS
DeviceProperty, FC-EDN-LIST, EDN List
DeviceProperty, FC-EDN-TOLERANCE, EDN Tolerance
DeviceProperty, FC-DNL-ENABLED, DNL Enabled, Default=False; Type=boolean
DeviceProperty, FC-DNL-STATUS, DNL Status
DeviceProperty, FC-DNL-STATUS-TS, DNL Status TS
DeviceProperty, FC-CELL-LOC-FILE, DNL Cell Loc File
DeviceProperty, FC-DNL-TOLERANCE, DNL Tolerance
DeviceProperty, FC-DNM-ENABLED, DNM Enabled, Default=False; Type=boolean
DeviceProperty, FC-DNM-STATUS, DNM Status
DeviceProperty, FC-DNM-STATUS-TS, DNM Status TS
DeviceProperty, FC-DNM-LIST, DNM List
DeviceProperty, FC-ISM-ENABLED, ISM Enabled, Default=False; Type=boolean
DeviceProperty, FC-ISM-STATUS, ISM Status
DeviceProperty, FC-ISM-STATUS-TS, ISM Status TS
DeviceProperty, FC-ISM-FILE, ISM File
DeviceProperty, FC-ISM-REJECT-UNKNOWN, ISM Reject Unknown
DeviceProperty, FC-DNB-ENABLED, DNB Enabled, Default=False; Type=boolean
DeviceProperty, FC-DNB-STATUS, DNB Status
DeviceProperty, FC-DNB-STATUS-TS, DNB Status TS
DeviceProperty, FC-DNB, DNB
DeviceProperty, FC-DNB-PWR-TOLERANCE, DNB Power Tolerance
DeviceProperty, FC-DNB-COUNT-TOLERANCE, DNB Count Tolerance
DeviceProperty, FC-DNB-FREQ-MATCH, DNB Frequency Match
PropertyHierarchy, FC-GRID-ENABLE, GRIDENABLED
PropertyHierarchy, HNB-CHASSIS-ID, HNB-GW
PropertyHierarchy, FC-FGW-NAME, HNB-GW-SRV
PropertyHierarchy, HeNB-CHASSIS-ID, HeNB-GW
PropertyHierarchy, HeNB-GW-SERVER, HeNB-GW-SRV
PropertyHierarchy, SeGW-CHASSIS-ID, SeGW
PropertyHierarchy, FC-FGW-NAME, SeGW-SRV
PropertyHierarchy, FC-ENTERPRISE-ID, ENTID
PropertyHierarchy, FC-SITE-ID, SITEID
PropertyHierarchy, FC-CHASSIS-ID, Chassis
PropertyHierarchy, FC-TECH-TYPE, RAT
PropertyHierarchy, FC-RNC-ID, FC-RNC-ID
PropertyHierarchy, FC-LAC-RAC-CL-GRID, FC-LAC-RAC-CL-GRID
PropertyHierarchy, CELL-CONFIG-RAN-CELL-ID, CELL ID
PropertyHierarchy, FC-RESERVED-MODE, ReservedMode
PropertyHierarchy, FC-LAC-ID, LAC ID
PropertyHierarchy, CELL-CONFIG-IU-PLMNID, CELL-CONFIG-IU-PLMNID
PropertyHierarchy, FC-PLMN-LIST, FC-PLMN-LIST
PropertyHierarchy, CELL-CONFIG-PLMNID, CELL-CONFIG-PLMNID
LiveParameter, InternetGatewayDevice.Services.FAPService.1.FAPControl.RFTxStatus, RFTx
Status, Type=boolean; TechType=UMTS
LiveParameter, Device.Services.FAPService.1.FAPControl.LTE.RFTxStatus, RFTx Status,
Type=boolean; TechType=LTE
LiveParameter, InternetGatewayDevice.Services.FAPService.1.FAPControl.OpState, OP State,
Type=boolean; TechType=UMTS
LiveParameter, Device.Services.FAPService.1.FAPControl.LTE.OpState, OP State, Type=boolean;
TechType=LTE
LiveParameter, InternetGatewayDevice.Services.FAPService.1.FAPControl.AdminState, Admin
State, Type=boolean; TechType=UMTS
LiveParameter, Device.Services.FAPService.1.FAPControl.LTE.AdminState, Admin State,
Type=boolean; TechType=LTE
LiveParameter, InternetGatewayDevice.DeviceInfo.SoftwareVersion, Live SW Version,
TechType=UMTS
LiveParameter, Device.DeviceInfo.SoftwareVersion, Live SW Version, TechType=LTE
LiveParameter, InternetGatewayDevice.DeviceInfo.HardwareVersion, Live HW Version,
TechType=UMTS
LiveParameter, Device.DeviceInfo.HardwareVersion, Live HW Version, TechType=LTE
LiveParameter, InternetGatewayDevice.DeviceInfo.ModelName, Live HW Model, TechType=UMTS
Cisco RAN Management System Administration Guide, Release 5.0
178
January 7, 2015
Operational Tools
Setting up the getDeviceData Cron
LiveParameter, Device.DeviceInfo.ModelName, Live HW Model, TechType=LTE
LiveParameter, InternetGatewayDevice.DeviceInfo.UpTime, FAPUptime, TechType=UMTS
LiveParameter, Device.DeviceInfo.UpTime, FAPUptime, TechType=LTE
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.FAPControl.UMTS.Gateway.SecGWServer1, SecGW
address, TechType=UMTS
LiveParameter, Device.Services.FAPService.1.FAPControl.LTE.Gateway.SecGWServer1, SecGW
address, TechType=LTE
LiveParameter, InternetGatewayDevice.Services.FAPService.1.GPS.LockedLatitude, Latitude of
AP, TechType=UMTS
LiveParameter, Device.FAP.X_CISCO_COM_GeoCoordinatesAndAltitude.Latitude, Latitude of AP,
TechType=LTE
LiveParameter, InternetGatewayDevice.Services.FAPService.1.GPS.LockedLongitude, Longitude
of AP, TechType=UMTS
LiveParameter, Device.FAP.X_CISCO_COM_GeoCoordinatesAndAltitude.Longitude, Longitude of AP,
TechType=LTE
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.FDDFAP.RF.PrimaryScramblingCodeInUse,
PSCInuse, TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.FDDFAP.RF.UARFCNDLInUse,
UARFCNDLInUse, TechType=UMTS
LiveParameter, InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.CN.SAC, SAC,
TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.CN.X_UBIQUISYS_COM_BroadcastSAC,
CBS SAC, TechType=UMTS
LiveParameter, InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.CN.LACInUse,
UuLAC, TechType=UMTS
LiveParameter, InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.CN.RACInUse,
UuRAC, TechType=UMTS
LiveParameter, InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.RNCID, RNC
ID, TechType=UMTS
LiveParameter, InternetGatewayDevice.Services.FAPService.1.REM.GSM.CellNumberOfEntries,
NUM_SCAN_GSM_Neighbors, TechType=UMTS
LiveParameter, Device.Services.FAPService.1.REM.UMTS.GSM.CellNumberOfEntries,
NUM_SCAN_GSM_Neighbors, TechType=LTE; OUI=001B67
LiveParameter, InternetGatewayDevice.Services.FAPService.1.REM.WCDMAFDD.CellNumberOfEntries,
NUM_SCAN_WCDMA_Neighbor, TechType=UMTS
LiveParameter, Device.Services.FAPService.1.REM.UMTS.WCDMA.CellNumberOfEntries,
NUM_SCAN_WCDMA_Neighbor, TechType=LTE; OUI=001B67
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.FDDFAP.NeighborListInUse.IntraFreqCellNumberOfEntries,
NUM_3G_INTRA_FREQ_NEIGHBORS, TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.FDDFAP.NeighborListInUse.InterFreqCellNumberOfEntries,
NUM_3G_INTER_FREQ_NEIGHBORS, TechType=UMTS
LiveParameter,
Device.Services.FAPService.1.CellConfig.LTE.RAN.NeighborListInUse.InterRATCell.UMTSNumberOfEntries,
NUM_3G_FREQ_NEIGHBORS, TechType=LTE
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.FDDFAP.NeighborListInUse.InterRATCell.GSMNumberOfEntries,
NUM_GSM_NEIGHBORS, TechType=UMTS
LiveParameter,
Device.Services.FAPService.1.CellConfig.LTE.RAN.NeighborListInUse.InterRATCell.GSMNumberOfEntries,
NUM_GSM_NEIGHBORS, TechType=LTE
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.CellConfig.UMTS.RAN.FDDFAP.RF.MaxFAPTxPowerInUse,
Power in Use, TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.X_UBIQUISYS_COM_SON.SONNeighboursNumberOfEntries,
SON Neighbors, TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.X_UBIQUISYS_COM_SON.PeersNumberOfEntries, SON
Peers, TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.X_UBIQUISYS_COM_SON.PeerNeighboursNumberOfEntries,
SON Peer Neighbors, TechType=UMTS
LiveParameter,
InternetGatewayDevice.Services.FAPService.1.FaultMgmt.CurrentAlarmNumberOfEntries, Current
Alarm number of Entries, TechType=UMTS
LiveParameter, Device.FaultMgmt.CurrentAlarmNumberOfEntries, Current Alarm number of Entries,
TechType=LTE; OUI=001B67
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
179
Operational Tools
Setting up the bulkStatusReport Cron
LiveParameter, InternetGatewayDevice.ManagementServer.ConnectionRequestURL, IpsecIpaddress,
TechType=UMTS
LiveParameter, Device.ManagementServer.ConnectionRequestURL, IpsecIpaddress, TechType=LTE
LiveParameter, InternetGatewayDevice.ManagementServer.X_UBIQUISYS_COM_BootReason, BootReason,
TechType=UMTS
LiveParameter, Device.ManagementServer.X_CISCO_COM_BootReason, BootReason, TechType=LTE;
OUI=001B67
LiveParameter, InternetGatewayDevice.Services.FAPService.1.DNPrefix, DNPREFIX, TechType=UMTS
LiveParameter, Device.Services.FAPService.1.DNPrefix, DNPREFIX, TechType=LTE
LiveParameter, Device.Services.FAPService.1.Alias, Alias, TechType=LTE; OUI=001B67
PropertyHierarchy, FC-TAC-ID, TAC ID
PropertyHierarchy, FC-LTE-PLMN-LIST, LTE PLMN LIST
PropertyHierarchy, FC-LTE-CELL-ID, LTE CELL ID
Setting up the bulkStatusReport Cron
The bulkStatusReport cron is wrapped around the bulkStatusReport script to export device data, and generate
reports for an entire population, as a cron. Additionally, the tool cleans up generated old reports and logs.
Following are configurable via dcc.properties:
• Log retention period in days: bulkStatusReport.log.retention.days=2
• Log location: bulkStatusReport.log.location=/rms/ops/BulkStatusReport
• Report retention period in days: bulkStatusReport.report.retention.days=7
• Report location: bulkStatusReport.report.location=/rms/ops/BulkStatusReport-reports
This cron automatically archives logs and reports which are one day older. The tool by default logs retention
period to 2 days, and reports retention period to 7 days. The tool by default logs location to
/rms/ops/BulkStatusReport, and reports location to /rms/ops/BulkStatusReport-reports.
The tool uses the last getDeviceData generated reported by default. This feature can be enabled or disabled
via dcc.properties-bulkStatusReport.uselatest.gddt.report.enabled=true.
Follow these steps to set up the bulkStatusReport cron:
Procedure
Step 1
Open this file using vi editor: /etc/cron.d/CSCOrms-ops-tools-ga.
Step 2
Ensure that HOME=/home/admin1. If not, then correct it to point to /home/admin1 .
Step 3
Add the following entry at the end of the file and save it (below scheduled to be edited as needed)
0 6 * * * admin1
/rms/app/ops-tools/public/shell-scripts/bulkStatusReport.cron
Note
0 6 *** - Indicates that the bulkStatusReport.cron is to be executed on the 6th hour 0th minute
daily.
Setting up gpsExportData cron
The gpsExport Data cron is wrapped around the gpsExportData script to export GPS data for the entire
population as a cron.
Additionally, this tool cleans up generated old reports and logs. Following are configurable via dcc.properties:
Cisco RAN Management System Administration Guide, Release 5.0
180
January 7, 2015
Operational Tools
Operational Tools for PMGDB
• Log retention period in days: gpsExportData.log.retention.days=2
• Log location: gpsExportData.log.location=/rms/ops
• Report retention period in days: gpsExportData.report.retention.days=7
• Report location: gpsExportData.report.location=/rms/ops/GPSExportData -reports
This cron automatically archives logs and reports which are one day older.
The tool by default logs retention period to 2 days, and reports retention period to 7 days. The tool by default
logs location to /rms/ops/GPSExportData and reports location to
/rms/ops/GPSExportData-reports.
Follow these steps to set up the gpsExportData cron:
Procedure
Step 1
Open the following file using vi editor: /etc/cron.d/CSCOrms-ops-tools-ga.
Step 2
Ensure that HOME=/home/admin1. If not, then correct it to point to /home/admin1.
Step 3
Add the following entry at the end of the file and save it (below scheduled to be edited as needed)
0 0 * * * admin1 /rms/app/ops-tools/public/shell-scripts/gpsExportData.cron
Note
0 0 *** - Indicates that bulkStatusReport.cron to be executed 0th hour 0th minute
daily.
Operational Tools for PMGDB
The following tools are available to facilitate ease of operation:
• Compare Polygons tool — Compares polygon data between mapinfo revision table and Area table in
PMG DB.
• Update Polygons tool — Updates polygon data from mapinfo revision table to Area table in PMG DB.
• Get Area Change Details tool — Retrieves details of polygons (areas) changed during a transaction of
update from mapinfo revision table to Area table in PMG DB.
• Get Areas tool — Retrieves areas from PMG DB based on specified arguments.
• Load Revision tool — Loads the data from mapinfo files to mapinfo table in PMG DB using EasyLoader
tool. The script is to be run from Windows Operating System.
• Update Polygons in PMG tool — Updates area groups in PMG to keep area groups in PMG and areas
in PMG DB in sync.
comparePolygons.sh
Compares the polygon data between mapinfo revision table and Area table in PMG DB. The results are
captured in a csv file showing old and new values and operation to be performed on the new area such as
Insert, Update, and Delete. This tool is useful before doing actual update from mapinfo revision table to Area
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
181
Operational Tools
comparePolygons.sh
table. Based on the results, operator can plan maintenance window and activities for actual update. As an
input, operator can either provide revision number or name of the source mapinfo revision table.
comparePolygons.sh <-help|[-rev <revisionnumber>][-srctab <sourcetablename>]>
Syntax Description
-rev
Required if source table name option (-srctab) is not specified. The revision number of the
source mapinfo table. The value should be a positive integer value. This option is useful when
name of the source mapinfo table specified in pmgdb.properties file has revision number
prefixed or suffixed to it. e.g. counties_gdt73 (counties_gdt<revisionnumber>)
-srctab
Required if revision number option (-rev) is not specified. The name of the source mapinfo
table. This option is useful when revision number is not used in the source mapinfo table
name or the name in pmgdb.properties file is to be overwritten.
-help
Optional. This argument produces a console output of the tool's syntax, arguments, description.
If this option is selected with no other arguments, -help will print out to the console and the
tool will not run.
Usage Guidelines
The tool produces a csv file comparePolygons.csv in the current working directory. The file contains a list of
areas which are different in source table and destination table. Following attributes are captured in the csv
file.
Area Key
Key of the area that is getting changed (which maps
to Area group in PMG)
New Name
New area name if changed else current name
Old Name
Old area name if changed else blank
New Region
New area region if changed else current region
Old Region
Old area region if changed else blank
Operation
Operation to be performed on the area
• I - Insert a new area
• U - Update existing area
• D - Inactive(soft delete) existing area
Last Updated
Date and Time of the last update
A sample output of the comparePolygons.sh tool is shown below:
$ comparePolygons.sh -rev 73
Config files script-props/private/ComparePolygonsInPmgDb.properties or
script-props/public/ComparePolygonsInPmgDb.properties not found. Continuing with default
settings.
Execution parameters:
Cisco RAN Management System Administration Guide, Release 5.0
182
January 7, 2015
Operational Tools
updatePolygons.sh
rev=73
Source table from propsmapinfo.counties_gdt73
Source table after replacing mapinfo.counties_gdt73
Source table is mapinfo.counties_gdt73
Initializing PMG DB
Compare Polygon processing can take some time please do not terminate.
Compared Polygons, total records changed 2
Writing to file: /users/ciscorms/comparePolygons.csv
Compare report is in file: /users/ciscorms/comparePolygons.csv
**** ComparePolygonsInPmgDb End Script ***
$
$ ls -l comparePolygons.csv
-rw-rw-r--. 1 ciscorms ciscorms 183 Feb 6 08:33 comparePolygons.csv
$ cat comparePolygons.csv
Area Key,New Name,Old Name,New Region,Old Region,Operation,Last Updated
2185,North Slope,,AK,,I,Thu Feb 06 14:03:46 UTC 2014
2188,Northwest Arctic,,AK,,I,Thu Feb 06 14:03:46 UTC 2014
updatePolygons.sh
The updatePolygons.sh tool updates polygon (area) data from the mapinfo revision table to Area table in PMG
DB. After completion, it provides a change id of the update transaction. This change id can be used to query
details of the records that are changed during the update transaction. The tool getAreaChangeDtls.sh can be
used to get these details. It is recommended to run comparePolygons.sh tool before running this tool so that
the operator can review the records that are going to be changed before performing the actual update. As an
input, operator can either provide revision number or name of the source mapinfo revision table.
updatePolygons.sh <-help|[-rev <revisionnumber>][-srctab <sourcetablename>]> -help
Syntax Description
-rev
Required if source table name option (-srctab) is not specified. The revision number of the
source mapinfo table. The value should be a positive integer value. This option is useful when
name of the source mapinfo table specified in pmgdb.properties file has revision number
prefixed or suffixed to it. e.g. counties_gdt73 (counties_gdt<revisionnumber>)
-srctab
Required if revision number option (-rev) is not specified. The name of the source mapinfo
table. This option is useful when revision number is not used in the source mapinfo table
name or the name in pmgdb.properties file is to be overwritten.
-help
Optional. This argument produces a console output of the tool's syntax, arguments, description.
If this option is selected with no other arguments, (-help) will print out to the console and the
tool will not run.
Usage Guidelines
Note
Only one instance of updatePolygons.sh tool is allowed to execute at a time.
A sample output of the updatePolygons.sh tool is shown below:
$ updatePolygons.sh -rev 73
Config files script-props/private/UpdatePolygonsInPmgDb.properties or
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
183
Operational Tools
getAreaChangeDtls.sh
script-props/public/UpdatePolygonsInPmgDb.properties not found. Continuing with default
settings.
Execution parameters:
rev=73
Source table is mapinfo.counties_gdt73
Initializing PMG DB
Update Polygon processing can take some time please do not terminate.
Updated Polygon in PmgDB Change Id: 6
**** UpdatePolygonsInPmgDb End Script ***
$
getAreaChangeDtls.sh
The getAreaChangeDtls.sh tool retrieves areas that are changed during an update transaction. The results are
captured in a csv file showing old/new values and operation (Insert/Update/Delete). As an input, operator has
to provide change id of the update transaction.
getAreaChangeDtls.sh <-help|[-changeid <changeid>]>
Syntax Description
-changeid
Required. The change id of an update transaction. The value should be a positive integer
value.
-help
Optional. This argument produces a console output of the tool's syntax, arguments,
description.
If this option is selected with no other arguments, (-help) will print out to the console
and the tool will not run.
Usage Guidelines
The tool produces a csv file getAreaChangeDtls.csv in the current working directory. The file contains a list
of areas which were updated during the update transaction related to the change id provided. Following
attributes are captured in the csv file.
Area Key
Key of the area that is getting changed (which maps
to Area group in PMG)
New Name
New area name if changed else current name
Old Name
Old area name if changed else blank
New Region
New area region if changed else current region
Old Region
Old area region if changed else blank
Operation
Operation to be performed on the area
• I - Insert a new new area
• U - Update existing area
• D - Inactive(soft delete) existing area
Last Updated
Date and Time of the last update
Cisco RAN Management System Administration Guide, Release 5.0
184
January 7, 2015
Operational Tools
getAreas.sh
A sample output of the getAreaChangeDtls.csv tool is shown below:
$ getAreaChangeDtls.sh -changeid 6
Config files script-props/private/GetAreaChangeDtls.properties or
script-props/public/GetAreaChangeDtls.properties not found. Continuing with default settings.
Execution parameters:
changeid=6
GetAreaChangeDtls processing can take some time please do not terminate.
Received areas changed, total areas 2
Writing to file: /users/ciscorms/getAreaChangeDtls.csv
The report captured in csv file: /users/ciscorms/getAreaChangeDtls.csv
**** GetAreaChangeDtls End Script ***
$
$ ls -l getAreaChangeDtls.csv
-rw-rw-r--. 1 ciscorms ciscorms 183 Feb 6 08:38 getAreaChangeDtls.csv
$ cat getAreaChangeDtls.csv
Area Key,New Name,Old Name,New Region,Old Region,Operation,Last Updated
2185,North Slope,,AK,,I,Thu Feb 06 14:07:06 UTC 2014
2188,Northwest Arctic,,AK,,I,Thu Feb 06 14:07:06 UTC 2014
getAreas.sh
The getAreas.sh tool retrieves areas that exist in PMG DB. The results are captured in a csv file showing the
details. Operator can retrieve all areas or can filter data based on input aruments such as area key, area name,
area region, status or combination of above. This tool is useful to get a list of areas in PMG DB to prepare
csv file for importing area groups through DCC UI.
getAreas.sh [-key <areakey>][-name <areaname>][-region <arearegion>][-status <areastatus>][-all]>
Syntax Description
-key
Optional, ignored if not specified. The key of the area to be retrieved. This should a
positive integer value.
-name
Optional, ignored if not specified. The name of the area to be retrieved. Names with
spaces can be included in double quotes. E.g. -name "New York"
-region
Optional, ignored if not specified. The region of the areas to be retrieved.
-status
Optional, Valid values are A (Active) or N (Not Active), ignored if not specified. The
status of the areas to be retrieved.
-all
Optional, if any other parameter specified, this will be ignored. To retrive all areas from
db.
-help
Optional. This argument produces a console output of the tool's syntax, arguments,
description.
If this option is selected with no other arguments, (-help) will print out to the console
and the tool will not run.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
185
Operational Tools
loadRevision.bat
Usage Guidelines
The tool produces a csv file getAreas.csv in the current working directory. The file contains a list of areas
based on specified arguments. Following attributes are captured in the csv file.
Area Key
Key of the area
New Name
Name of the area
Area Region
Region( e.g. State) of the area
Status
Status of area. A - Active, N - Not Active
A sample output of thegetAreas.sh tool is shown below:
$ getAreas.sh -key 2185
Config files script-props/private/GetAreas.properties or
script-props/public/GetAreas.properties not found. Continuing with default settings.
Execution parameters:
key=2185
GetAreas processing can take some time please do not terminate.
Received areas, total areas 1
Writing to file: /users/ciscorms/getAreas.csv
The report captured in csv file: /users/ciscorms/getAreas.csv
**** GetAreas End Script ***
$ ls -l getAreas.csv
-rw-rw-r--. 1 ciscorms ciscorms 60 Feb 6 08:40 getAreas.csv
$ cat getAreas.csv
Area Key,Area Name,Area Region,Status
2185,North Slope,AK,A
$ getAreas.sh -name "Northwest Arctic"
Config files script-props/private/GetAreas.properties or
script-props/public/GetAreas.properties not found. Continuing with default settings.
Execution parameters:
name=Northwest Arctic
GetAreas processing can take some time please do not terminate.
Received areas, total areas 1
Writing to file: /users/ciscorms/getAreas.csv
The report captured in csv file: /users/ciscorms/getAreas.csv
**** GetAreas End Script ***
$ ls -l getAreas.csv
-rw-rw-r--. 1 ciscorms ciscorms 65 Feb 6 08:41 getAreas.csv
$ cat getAreas.csv
Area Key,Area Name,Area Region,Status
2188,Northwest Arctic,AK,A
loadRevision.bat
The loadReviosn.bat is a windows batch file to be downloaded on operator's windows desktop/laptop tool
and run from windows command line. This is an utility script to invoke EasyLoader tool to load data from
mapinfo files to database revision table. Make sure Oracle Client steup is done, EasyLoader tool exe file is
present in some folder (e.g. c:\ezldr), MapInfo files are present in respective revision folder (v73). The
loadRevision.bat is to be run from the same folder where EasyLoader exe file is placed.
Cisco RAN Management System Administration Guide, Release 5.0
186
January 7, 2015
Operational Tools
loadRevision.bat
Note
• The loadRevision.bat is to be run from Windows Desktop/Laptop command line
• MAPINFO_MAPCATALOG table should be present in the database. If not, EasyLoader GUI can
be used to create it.
loadRevision.bat <revision number> [<input file path>]
For Example: loadRevision.bat 73 c:\ezldr\FemtoData
If default values are used: loadRevision.bat 73
Syntax Description
-rev
Required. The revision number of mapinfo file
-Input file path
Top Folder path where the mapinfo revision files are placed. This folder should
have folders for each revision. Eg. v72, v73, etc.
If not specified will take "c:\ezldr\FemtoData" as default value.
mapinfo_password
Usage Guidelines
Password for mapinfo user.
If this should not be passed as input, then edit the loadRevision.bat file to replace
"DEFAULT_TO_BE_SET" in the line "set defaultpass=DEFAULT_TO_BE_SET"
with the password value.
The batch file invokes EasyLoader tool and populates data into mapinfo revision table in MAPINFO tablespace
in PMG DB. The logs are captured in EasyLoader.log under the current working directory.
A sample output of the loadRevision.bat tool is shown below:
c:\ezldr>
c:\ezldr>loadRevision.bat
c:\ezldr>echo off
Command Line Parameters:
revision ID = ""
Usage:
loadRevision.bat <revision #> [<input file path>] [<mapinfo password>]
Example:
loadRevision.bat 73 c:\ezldr\FemtoData mapinfo_password
c:\ezldr>
c:\ezldr>loadRevision.bat 73 c:\ezldr\FemtoData mapinfo_password
c:\ezldr>echo off
Command Line Parameters:
revision ID = "73"
path = "c:\ezldr\FemtoData"
mapinfo password = "<Not Displayed>"
------Note:
MAPINFO_MAPCATALOG should be present in the database. If not, EasyLoader GUI can
be used to create it.
------Calling easyloader...
Logs are created under EasyLoader.log
Done.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
187
Operational Tools
updatePolygonsInPmg.sh
c:\ezldr>
updatePolygonsInPmg.sh
The updatePolygonsInPmg.sh tool updates area groups in PMG to keep area groups in PMG and areas in
PMG DB in sync. It takes change id of an update transaction as an input and updates PMG accordingly. The
change id is reported in the logs of updatePolygons.sh execution. The tool getAreaChangeDtls.sh can used
to verify the area groups that are going to be updated for given change id. The script is executed in multiple
threads mode.
If an area is added or reactivated in Area table of PMG DB, the script will create a respective area group in
PMG if it doesn't exists. If area is deactivated in Area table of PMG DB, it deactivates respective area group
in PMG.
Usage Guidelines
Note
Only one instance of updatePolygonsInPmg.sh tool is allowed to execute at a time.
The tool is executed using the Command-line options. The command-line syntax is as follows:
updatePolygonsInPmg.sh <-help | [-changeid <changeid>] [-outdir <dir>] [-rate <num>] [-threads
<num>] [-forceRun] [-forceUpdate]>
Syntax Description
-changeid
Required. The change id of an
update transaction. The value
should be a positive integer value.
-outdir
A directory where the supporting
report files are generated. If not
specified, this will default output
directory.
-rate
A specific maximum rate of update
requests per second to be sent. The
tool will send no more than this
number, but may send less
depending on the resource
constraints. If this option is not
specified, the tool will default to 20
requests per second.
-threads
Number of concurrent sessions with
PMG. Default value is 50. The
value is bounded to be in the range
of 1 to 500 (inclusive).
Cisco RAN Management System Administration Guide, Release 5.0
188
January 7, 2015
Operational Tools
updatePolygonsInPmg.sh
-forcerun
If this flag is specified, the tool
executes irrespective of other ops
tools currently running.
-forceupdate
If this flag is specified, the tool
updates to active state if area
already exists.
-help
Optional. This argument produces
a console output of the tool's
syntax, arguments, description.
If this option is selected with no
other arguments, (-help) will print
out to the console and the tool will
not run.
The tool periodically reports the progress information (number complete, number failed, and rate) to the
console. The summary information is produced at the result. The tool produces a file containing a list of keys
for which the connection requests failed. The administrator can decide to retry executing the tool for the keys
in the file.
If the connection request fails with an error code indicating a provisioning system issue, the error is reported
to the console and in the error logs.
updatePolygonsInPmgSuccess.log provides area groups Added/Activated/Deactivated/Not modified.
updatePolygonsInPmgFailure.log provides list of area keys failed, with message.
updatePolygonsInPmgFailure.keys provides list of area keys failed.
A sample output of the updatePolygonsInPmg.sh tool is shown below:
$ updatePolygonsInPmg.sh -changeid 29
Config files script-props/private/UpdatePolygonsInPmg.properties or
script-props/public/UpdatePolygonsInPmg.properties not found. Continuing with default
settings.
Rate :: 20
Threads :: 50
forceUpdate :: false
Output Directory :: /rms/ops/UpdatePolygonsInPmg-20140221-071827
Please note this tool will process 20tasks/sec.
Area Key = 999991, status = true, statusMsg = Success
Area Key = 999992, status = true, statusMsg = Success
*******************
Summary Report
*****************************************
Number of successful Area group updates :: 2
Number of failed Area group updates :: 0
********************************************************************************
$ cat /rms/ops/UpdatePolygonsInPmg-20140221-071827/updatePolygonsInPmgSuccess.log
Area Key = 999991, status = true, statusMsg = Success
Area Key = 999992, status = true, statusMsg = Success
$ updatePolygonsInPmg.sh -changeid 32
Config files script-props/private/UpdatePolygonsInPmg.properties or
script-props/public/UpdatePolygonsInPmg.properties not found. Continuing with default
settings.
Rate :: 20
Threads :: 50
forceUpdate :: false
Output Directory :: /rms/ops/UpdatePolygonsInPmg-20140221-085232
Please note this tool will process 20tasks/sec.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
189
Operational Tools
updatePolygonsInPmg.sh
Area Key = 999992, status = true, statusMsg = Area already exists, no modifications in PMG,
operation is I
Area Key = 999991, status = true, statusMsg = Success
*******************
Summary Report
*****************************************
Number of successful Area group updates :: 2
Number of failed Area group updates :: 0
********************************************************************************
$ cat /rms/ops/UpdatePolygonsInPmg-20140221-085232/updatePolygonsInPmgSuccess.log
Area Key = 999992, status = true, statusMsg = Area already exists, no modifications in PMG,
operation is I
Area Key = 999991, status = true, statusMsg = Success
Cisco RAN Management System Administration Guide, Release 5.0
190
January 7, 2015
CHAPTER
11
Performance Counters
The RMS has a variety of PMG performance counters and upload server (ULS) counters that are displayed
in the log files. These logs are located in the /rms/log/ directory. The various statistics that are calculated are
described here.
• PMG Counters, page 191
• Upload Server Counters, page 198
• RMS KPIs and Counters, page 201
PMG Counters
Performance counts are calculated for each PMG message type. The performance log files are located in
rms/log/pmg and the following files are available:
• pmg-msg-perf.csv—PMG Performance Messages
• pmg-perf-periodic.csv—PMG Performance Periodic Messages
• rms-perf-gateway-periodic.csv—Performance Periodic Gateway Statistics
This table lists the various PMG messages for which statistics are calculated. All counts are integer. The
polling interval is by default once per hour, but can be configured and is shown in the log as summary period
sec.
Table 8: Performance Message Types
Counters
Description
Activate
Inbound request to Activate a device
Block
Inbound request to Block a device
Connected
Inbound connected event
ConnectionRequest
Inbound request for connection request for a device
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
191
Performance Counters
PMG Counters
Counters
Description
CreateGroup
Inbound request to create a FRM group
CreateGroupType
Inbound request to create a FRM grouptype
CreatePool
Inbound request to create a FRM pool
CreatePoolType
Inbound request to create a FRM pooltype
Deactivate
Inbound request to Deactivate a device
Delete
Inbound request to Delete a device
DeleteFRMGroupType
Inbound request to delete FRM GroupTypes
DeleteFRMGroups
Inbound request to delete FRM Groups
DeleteFRMPoolType
Inbound request to delete FRM pool type
DeleteFRMPools
Inbound request to delete FRM pools
DeleteGroup
Inbound request to delete a FRM group
DeleteGroupType
Inbound request to delete a FRM grouptype
DeletePool
Inbound request to delete a FRM pool
DeletePoolType
Inbound request to delete a FRM pooltype
FirmwareUpgraded
Inbound Firmware upgrade event
FirmwareVerified
Inbound Firmware verified event
GetAllFRMGroupTypes
Inbound request to get all FRM GroupTypes
GetAllFRMGroups
Inbound request to get all FRM Groups with details of a type
GetAllFRMPoolTypes
Inbound request to get all FRM pool types
GetAllFRMPools
Inbound request to get all FRM pools with details of a type
GetDeviceAssignmentByGroups
Inbound request to get devie assignment infromation for a group
GetFRMGroupType
Inbound request to get FRM GroupType
GetFRMGroups
Inbound request to get details of FRM groups
GetFRMPoolType
Inbound request to get pool type details
Cisco RAN Management System Administration Guide, Release 5.0
192
January 7, 2015
Performance Counters
PMG Counters
Counters
Description
GetFRMPools
Inbound request to get FRM pool details
GetGroupNames
Inbound request to get names of all FRM groups of a type
GetGroupTypeNames
Inbound request to get all FRM Group type names
GetGroupTypesDetails
Inbound request to get GroupType details
GetGroupsDetails
Inbound request to get details of FRM group
GetIDPoolsByGroups
Inbound request to get group usage information
GetIDPoolsByTypes
Inbound request to get pool usage information
GetIDs
Inbound request for getting device IDs belongs same
group/subscriber
GetLiveData
Inbound request to get live data for a device
GetPoolNames
Inbound request to get all FRM pool names of a type
GetPoolTypeNames
Inbound request to get all FRM pool type names
GetPoolTypesDetails
Inbound request to get PoolType details
GetPoolsDetails
Inbound request to get details of FRM Pool
GetStoredData
Inbound request to stored data for a device
Location
Inbound Location event
LocationStatus
Notification that the CPE’s location status has changed
Online
Inbound Online event
ReassignDevice
Inbound request to reassign a device
RebootCPE
Inbound request to reboot a device
Register
Inbound request to register a device
Replace
Inbound request to replace an existing device id with a new device
id
ResetCPEToFactoryDefaults
Inbound request to reset a device to factory defauts
Service
Inbound service event
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
193
Performance Counters
PMG Counters
Counters
Description
ServiceError
Notification that there has been an error enabling service
ServiceOperational
Notification that service is now operational on the CPE after it
enabled
SetFRMGroupType
Inbound request to set FRM GroupType
SetFRMGroups
Inbound request to create/update FRM Groups
SetFRMPools
Inbound request to create/update FRM Pools
SetLiveData
Inbound request to set live data for a device
Shutdown
Inbound request to shutdown a device
Subscribe
Inbound request to subscribe for events
Tampered
Inbound tampered event
UnSubscribe
Inbound request to un-subscribe for events
Unblock
Inbound request to Unblock a device
Update
Inbound request to update a device
UpdateGroup
Inbound request to update a FRM group
UpdateGroupType
Inbound request to update a FRM grouptype
UpdateIMSI
Inbound request to update IMSIs for a device
UpdatePool
Inbound request to update a FRM pool
UpdatePoolType
Inbound request to update a FRM pooltype
For each message type, the following information is displayed in addition to the counts and statistics:
Performance Counter
Description
timestamp
The timestamp of the event (in UMT format).
summary period sec
The duration of the event (in seconds).
uptime ms
The length of time the Upload Server is operational at the time of the
associated timestamp (in milliseconds).
Cisco RAN Management System Administration Guide, Release 5.0
194
January 7, 2015
Performance Counters
Performance Periodic Statistics
The following example illustrates the Performance counter data captured for PMG, for a period of one hour.
period end, summary period sec, msg name, avg response time ms,
max response time ms, min response time ms, num msgs, num errors
2013-05-16T00:00:00.538Z,3600,Connected,0,0,0,151,0
2013-05-16T00:00:00.538Z,3600,Location,0,0,0,142,0
2013-05-16T00:00:00.538Z,3600,Register,250457,410637,102898,8,0
2013-05-16T00:00:00.538Z,3600,ServiceOperational,230348,240386,220310,2,0
Period End
Summary
Message
Period (sec) Name
Avg
Response
time (ms)
Max
response
time (ms)
Min
response
time (ms)
No of
Messages
No of Errors
2013-053600
16T00:00:00.
538Z
Connected
0
0
0
151
0
2013-053600
16T00:00:00.
538Z
Location
0
0
0
142
0
2013-053600
16T00:00:00.
538Z
Register
250457
410637
102898
8
0
2013-053600
16T00:00:00.
538Z
Service
230348
Operational
240386
220310
2
0
Performance Periodic Statistics
The performance periodic statistics file (pmg-perf-periodic.csv) lists the following statistics for each message
type received within a specified period of time:
Table 9: Performance Period Statistics
Statistic
Description
avg response time ms
The average response time in milliseconds for the message within the
summary period given by summary period sec.
max response time ms
The maximum response time in milliseconds for the message within
the summary period given by summary period sec.
min response time ms
The minimum response time in milliseconds for the message within the
summary period given by summary period sec.
num msgs
Total number of messages received during the summary period.
num errors
Number of errors occurred during the summary period for the message.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
195
Performance Counters
Performance Periodic Statistics
Statistic
Description
total bytes received
Total bytes received for the message within the summary period given
by summary period sec.
total bytes sent
Total bytes sent for the message within the summary period given by
summary period sec.
bytes received per second
Total bytes received per second for the message within the summary
period given by summary period sec.
bytes sent per second
Total bytes sent per second for the message within the summary period
given by summary period sec.
Here is an example of the performance period log:
period end,summary period sec,msg name,avg response time ms,max response time ms,min response
time ms,num msgs,num errors,total bytes received,total bytes sent,bytes received per second,
bytes sent per second
2014-09-01T11:00:00.469Z,2589,Connected,0,0,0,24,0,0,0,0,0
2014-09-01T11:00:00.469Z,2589,Location,0,0,0,24,0,0,0,0,0
2014-09-01T11:00:00.470Z,2589,ServiceOperational,490,490,490,1,0,0,0,0,0
2014-09-01T11:00:00.471Z,2589,GetAllFRMGroupTypes,135,161,114,14,0,2996,30226,1,8
2014-09-01T11:00:00.471Z,2589,SetFRMGroups,143,176,134,6,0,10251,1693,3,0
2014-09-01T11:00:00.472Z,2589,GetAllFRMPoolTypes,74,86,70,5,0,1060,2990,0,1
2014-09-01T11:00:00.472Z,2589,GetLiveData,142,234,121,6,0,3024,1698,1,0
2014-09-01T11:00:00.473Z,2589,GetFRMGroupType,73,85,63,7,0,1585,4516,0,1
This example displays as follows when imported into Excel (partial output):
period end
summary msg name
period sec
avg
response
time ms
max
response
time ms
min
response
time ms
num msgs
num errors
2014-092589
01T11:00:00.
469Z
Connected
0
0
0
24
0
2014-092589
01T11:00:00.
469Z
Location
0
0
0
142
0
2014-092589
01T11:00:00.
470Z
Service
490
Operational
490
490
1
0
2014-092589
01T11:00:00.
471Z
GetAllFRM 135
Grouptypes
161
114
14
0
Cisco RAN Management System Administration Guide, Release 5.0
196
January 7, 2015
Performance Counters
Performance Message Statistics
Performance Message Statistics
The performance message statistics file (pmg-msg-perf.csv) lists each message received and the following
times taken by the BAC PMG for processing:
Table 10: Performance Message Statistics
Statistic
Description
msg process time ms
The processing time in milliseconds for the message with BAC
processing time removed.
bac process time ms
The BAC processing time in milliseconds for the message.
total msg process time ms
Total message processing time in milliseconds including un-marshalling
the message, message processing time, BAC processing time and
response message marshalling.
Example of performance message log:
timestamp,msg name,trans id,eid,msg process time ms,bac process time ms,total msg process
time ms
2014-09-01T08:27:12.607Z,GetAllFRMGroupTypes,DCCdccadminf6c25bb6-fbd1-4e2e-a4aa-dfa9e762d25c,null,119,0,257,214,1966,0,1
2014-09-01T08:27:13.951Z,GetAllFRMPoolTypes,DCCdccadmin8fb9ffae-accb-442c-995d-eec6ce6a4c46,null,38,0,169,212,598,0,0
2014-09-01T08:27:14.765Z,GetAllFRMPools,DCCdccadmin4163d646-d277-4661-af83-97669b2d6bb3,null,24,0,116,241,605,0,0
2014-09-01T08:27:58.807Z,GetAllFRMPoolTypes,DCCdccadmin73b1f28f-68ea-40eb-ab3c-b4c8bf558531,null,31,0,120,212,598,0,0
2014-09-01T08:27:59.044Z,GetAllFRMGroups,DCCdccadmin1d74ccd2-e4d4-48e6-9839-3f5217b4ce66,null,30,0,132,241,3205,0,1
Performance Gateway Periodic Counters
The performance gateway periodic counters file (rms-perf-gateway-periodic.csv) lists for each specified period
the following counters. The period is set by the property "registration.metrics.time.interval.in.milli.seconds"
defined in dcc.properties, and the default value is 3600000. The polling interval is by default one hour or as
defined in the dcc.proeprties file: "registration.metrics.time.interval.in.milli.seconds." All counts are integer.
Table 11: Performance Gateway Periodic Counters
Counter
Description
num devices
Total number of devices.
num FemtoGateway
Total number of FemtoGateways.
num devices at each FemtoGateway Number of devices at each FemtoGateway separated by a colon.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
197
Performance Counters
Upload Server Counters
Here is an example of the performance gateway periodic counters log:
period end,num devices,num FemtoGateway,num devices at each FemtoGateway
2014-08-31T18:30:00.903Z,0,1,DefaultFGW=0
2014-08-31T19:30:00.904Z,0,1,DefaultFGW=0
2014-08-31T20:30:00.905Z,0,1,DefaultFGW=0
2014-08-31T21:30:00.905Z,0,1,DefaultFGW=0
Upload Server Counters
The Upload Server periodic counters files (upload-perf-periodic.csv and weekly-perf-summaries.csv) list for
each specified period the following counters. The upload-perf-periodic.csv file maintains counter data for the
current day (daily) and the weekly-perf-summaries.csv file contains the same data maintained weekly (seven
days).
The period is set by the property "perf.summary.intervalMS" defined in the UploadServer.properties, and the
default value is 3600000. The polling interval is one hour by default or as defined in the UploadServer.proeprties
file: "perf.summary.intervalMS".
All counters are integer.
Field
Description
Trigger Point
Southbound Statistics Counters
SB uploads completed
The number of southbound uploads Incremented if upload request is
completed in the interval ending with successfully handled by the ULS.
the associated timestamp
SB uploads failed
The number of southbound uploads Incremented if:
failed in the interval ending with the
• Southbound connection is rejected
associated timestamp
because the maximum connection
limit is reached. Maximum connection
limit is defined by the
UploadServer.sb.connection.limit.max
property.
• Upload URI references the parent
directory, for example, HTTP upload
request has ../../../../tmp/test.txt as
URI.
• ULS internal buffer is filled and no
more Upload requests can be
accepted.
• HTTP request has method other than
PUT, POST or GET.
• Bad HTTP request, for example,
initial line of HTTP request is of
length greater than 4096.
• Internal server error.
Cisco RAN Management System Administration Guide, Release 5.0
198
January 7, 2015
Performance Counters
Upload Server Counters
Field
Description
Trigger Point
SB bytes rcvd
The number of southbound bytes
received in the interval ending with
the associated timestamp
Incremented with size of request once it is
received over southbound interface.
SB bytes sent
The number of southbound bytes sent Incremented with the size of the response
in the interval ending with the
once it is sent over southbound interface.
associated timestamp
SB session timeout
The number of southbound session
timeouts in the interval ending with
the associated timestamp
Incremented if the southbound connection
persists for more than the period defined
by the UploadServer.sb.channel.maxsessms
property. Default is 20 mins.
SB status sent
Number of SB requests
served/responded
Incremented after sending 200 OK response
to HTTP GET request for a file defined by
/opt/CSCOuls/files/conf/index.html or any
other file defined by
UploadServer.probeFileLocation and
UploadServer.probeFilename properties.
SB status failure
Number of SB requests for which
ULS failed to respond
Incremented if failed to send the above
status.
Northbound Statistics Counters
NB downloads
completed
The number of northbound uploads Incremented when the HTTP download
completed in the interval ending with request is successfully served by ULS.
the associated timestamp
max concurrent uploads The maximum number of concurrent Set to current maximum concurrent uploads
uploads during the interval
if it is greater than the previous maximum
concurrent uploads.
NB downloads failed
The number of northbound uploads Incremented when the HTTP download
failed in the interval ending with the request is successfully served by the ULS.
associated timestamp
NB bytes rcvd
The number of northbound bytes
received in the interval ending with
the associated timestamp
NB bytes sent
The number of northbound bytes sent Incremented with the size of the response
in the interval ending with the
once it is sent over northbound interface.
associated timestamp
Incremented with size of request once it is
received over the northbound interface.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
199
Performance Counters
Upload Server Counters
Field
Description
Trigger Point
NB session timeout
The number of northbound session
timeouts in the interval ending with
the associated timestamp
Incremented when the northbound
connection persists for more than the period
defined by the
UploadServer.nb.channel.maxsessms
property. Default is 20 minutes.
max concurrent
downloads
Maximum number of concurrent
downloads during the interval
Set to current maximum concurrent
downloads if it is greater than the previous
maximum concurrent downloads.
File counters
Bytes before
compression
The total bytes of log files prior to
Incremented before compressing a file.
compressing them during the interval
Bytes after compression The total bytes of log files after
Incremented after file is successfully
compressing them during the interval compressed.
Bytes deleted
The total number of bytes deleted
during the interval
Incremented with the size of the file once
it is deleted.
Bytes archived
The total number of bytes archived
during the interval
Incremented after file is successfully
archived.
Number of files listed
The total number of files listed during Incremented once a file is listed down.
the interval
Number of files deleted The total number of files deleted
during the interval
Incremented once a file is deleted
successfully.
Number of files
archived
Incremented once a file is
archived/compressed.
The total number of files archived
during the interval
Total time compressing The total time spent compressing the Incremented with the time taken for
log files during the interval
compression of a file once it is completed.
Total time archiving
The total time spent archiving log
files during the interval
Incremented with the time taken for
archival of a file once it is completed.
Total time deleting
The total time spent deleting log files Incremented with time taken for deletion a
during the interval
file once the delete operation is complete.
Total time listing
The total time spent listing the log
files during the interval
Number of archives
The total number of archives created Incremented once a new archive file is
during the interval
created.
Incremented with time taken once all the
files are listed for directory maintenance
purpose (for example, deletion).
Cisco RAN Management System Administration Guide, Release 5.0
200
January 7, 2015
Performance Counters
RMS KPIs and Counters
Field
Description
Trigger Point
Total number of files
for each file type
Includes the total number of files for Incremented after uploaded file is written
each file type during the interval
to disk.
Total number of bytes
for each file type
Includes the total number of bytes for Incremented after uploaded file is written
each file type during the interval
to disk.
RMS KPIs and Counters
The RMS KPIs and Counters feature enables RMS to collect and report KPIs in .CSV file format. it also
provides the functionality to upload these counters to Prime Performance Manager (PPM).
Counters
Description
Total number of registered FAP in each HeNB GW
with operator specified interval
rms-perf-group-periodic.csv with a number of HenB
GW, femtogateways and associated devices per group
instance.
Default value for interval is 1 hour.
Total number of HNB GW, HeNB GW with operator rms-perf-gateway-periodic.csv with a number of
specified interval.
HenB GW, femtogateways and associated devices
per group instance.
Default value for interval is 1 hour.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
201
Performance Counters
RMS KPIs and Counters
Number of incoming boot inform
BAC UI collects these counters every 5 minutes and
logs it in a CSV file.
Number of incoming bootstrap inform
Number of successful admin up
Number of failed admin up
Number of location check failure
Number of incoming periodic inform
Number of incoming alarm
Number of NWL scan
Number of NWL tolerance failure
Number of benchmark update
Number of GPS scan
Number of GPS tolerance failure
Number of SetParameterValue
Number of erroneous SetParameterValue
Number of GetParameterValue
Number of erroneous GetParameterValue
Number of Firmware upgrade
Number of erroneous Firmware upgrade
Number of reboot
Average activation time
Number of TR-069 session
Number of DHCP Lease query
Number of config synch between RDU and DPE
Number of DPE registration with RDU
Number of PNR registration with RDU
Cisco RAN Management System Administration Guide, Release 5.0
202
January 7, 2015
Performance Counters
RMS KPIs and Counters
Number of BAC alarm raised
Number of user logged-in using DCC UI
DCC UI collects and logs these counters in a CSV
file.
Number of UI session
These counters are collected every 5 minutes.
Average UI response time
Number of OSS session
Number of incoming OSS request
Number of incoming QSS request
Number of notification sent to OSS
Number of notification sent to QSS
Number of “group” update message
Number of device registration message
Number of GetLiveData issued
Number of SetLiveData issued
Number of file upload
Upload server collects and logs these counters in a
CSV file.
Number of HTTP session
These counters are collected every 5 minutes.
Number of stored log file
Volume of data purged by clean up script
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
203
Performance Counters
RMS KPIs and Counters
Total number of enterprise
Total number of site
RMS collects and logs stats in a CSV file
These stats are collected every 30 minutes.
Total number of standalone enterprise AP
Total number of multicell enterprise AP
Total number of active entry AP, inner AP, idle entry
AP
Total number of residential AP
Number of UMTS only AP
Number of LTE only AP
Number of AP categorized by hardware version
Number of AP categorized by software version
Sample CSVs
• pmg-prov-stats-periodic.csv
Time, Interval, ActiveEntryAPcount,IdleAPcount, MulticellEnterpriseAPcount,
StandaloneAPCount, residemtialAPcount, UMTSAPcount, LTEAPcount
2014-11-17T03:17:02.715Z,6000,,,0,0,0,0,2
• pmg-prov-stats-periodic.csv
Time Stamp, period,Incoming IP stats, Outgoing IP stats, Number of Register,
Number of upgateGroup, Number of GLD, Number of SLV
2014-11-17T02:37:02.713Z,6000,127.0.0.1=6,,0,0,0,0,2
• rms-perf-group-periodic.csv
period end,Total Devices, num FemtoGateway,num devices at each FemtoGateway,num
HeNBGW,num devices at each HeNBGW, NumberOfEnterprise, NumberOfSites
2014-11-15T00:45:59.988Z,31,3,BGL-FGW=9;DefaultFGW=13;dummy-fgw=0,4,DefaultHeNBGW=6;
LTEHeNBGW=3;DummyHeNBGW=0;Jnui-hnbgw=0,12,45
• upload-perf-periodic.csv
period end,period duration (sec),uptime ms,SB uploads completed,SB uploads failed,
SB status sent,SB status failure,SB bytes rcvd,SB bytes sent,SB session count,SB session
timeout,NB downloads completed,NB downloads failed,NB bytes rcvd,NB bytes sent,NB
session
count,NB session timeout,Bytes before compression,Bytes after compression,Bytes deleted,
Bytes archived,Number of files listed,Number of files deleted,Number of files archived,
Total time compressing,Total time archiving,Total time deleting,Total time listing,
Number of archives,Total stat files,Total stat bytes,Total demand files,Total demand
bytes,
Total cmas files,Total cmas bytes,Total unknown files,Total unknown bytes,max concurrent
uploads,max concurrent downloads
2014-11-11T14:50:00.001,215,215765,0,0,0,0,0,0,0,0,0,0,1621,1029,2,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0
Cisco RAN Management System Administration Guide, Release 5.0
204
January 7, 2015
Performance Counters
RMS KPIs and Counters
BAC - RDU
##Version 3.9
#period end summary period sec configSyncRduandDpe dpeRegistration pnrRegistration
2014-10-08T11:02:01.724Z 300 0 0 0
BAC - DPE
##Version 3.9
#period end summary period sec avgActivationTime bacAlarmRaised
benchmarkUpdate dhcpLeaseQuery erroneousFirwareUpgrade
erroneousGetParamValue erroneousSetParamValue failedAdminUp
firmwareUpgrade getParamValue gpsScan gpsToleranceFailure
incomingAlarm incomingBootInform incomingBootStrapInform
incomingPeriodicInform locationCheckFailure nwlScan
nwlToleranceFailure reboot setParamValue successfulAdminUp
tr069Session
2014-10-08T11:02:00.866Z 300 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
205
Performance Counters
RMS KPIs and Counters
Cisco RAN Management System Administration Guide, Release 5.0
206
January 7, 2015
CHAPTER
12
INSEE Management
• INSEE Management, page 207
INSEE Management
Enhanced SAC Management
Enhanced SAC Management helps you geo-locate the FemtoCell for emergency call routing in case no macro
coverage is seen by the FemtoCell. INSEE code is not used for the following purpose:
• Search a femtocell based on INSEE code
The INSEE code is a numerical indexing code used by the French National Institute for Statistics and Economic
Studies (INSEE) to identify various entities, including communes, departments.
Configuring INSEE
Configuring INSEE allows you to enable or disable the INSEE feature in the RMS.
Add the following file at the location on the central node:rms/app/CSCObac/rdu/mappingfiles:
1 INSEE-SAC mapping file: insee_sac_femto.csv
To enable INSEE in RMS:
Procedure
Step 1
Step 2
Log in to the Central node.
Switch to root user:
su-
Step 3
Change the directory using command cd/rms/ova/scripts/post_install.
Step 4
Execute the following command:
./configure_func2.sh
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
207
INSEE Management
Configuring INSEE
System is enabled for INSEE code - SAC mapping feature.
This tool enables the following optional configurations in RMS:
• INSEE SAC configuration
• Additional RF-Profile parameters configuration
• Alarm profile group type support
Example:
Following is the output:
BPR client version: BPR2.7
Parsing Args...
Parsing File: /rms/app/baseconfig/ga_kiwi_scripts/insee_configuration. kiwi
Warning: On line 138 could not find class [ubi-config-v3] when searching
for constant value.
Using [ubi-config-v3.5-ee] as String value instead.
...
Warning: On line 543 could not find class [@ubiquisys] when searching for
constant value.
Using [@ubiquisys.com] as String value instead.
Executing 117 batches...
PASSED|batchID=Batch:rms-aio-central/10.5.4.32:57c9999f:1474447a937:
80000002
Batch
Activation mode = NoActivation|Confirmation mode = NoConfirmation|
Publishing mode = NoPublishing
EXPECT
ACTUAL|batch status code=BATCH_COMPLETED[0]|batch error msg=null
Cmd 0
Line 29|Proprietary.changeSystemDefaultsInternally
({/pace/crs/start=false}, null)
EXPECT|expected command status code=CMD_OK[0]
ACTUAL|command status code=CMD_OK[0]|command error msg=null|data
type=DATA_VOID[-1]|results=null
...
...
FAILED|batchID=Batch:rms-aio-central/10.5.4.32:57c9999f:1474447a937:8000004a
Batch
Activation mode = NoActivation|Confirmation mode =
NoConfirmation|Publishing mode = NoPublishing
EXPECT
ACTUAL|batch status code=BATCH_FAILED_WRITE[-121]|batch error msg=Batch
failed. See status of the
failed command for details.
Cmd 0
Line 73|Configuration.addCustomPropertyDefinition(FC-PCH-POWER,
java.lang.Integer)
EXPECT|expected command status code=CMD_OK[0]
ACTUAL|command status code=CMD_ERROR_CUSTOM_PROPERTY_REDEFINITION[-603]|
command error msg=A custom
property with the name [FC-PCH-POWER] already exists in the system.|data
type=DATA_VOID[-1]|results=null
-ERROR|command status code !=0
...
...
PASSED|batchID=Batch:rms-aio-central/10.5.4.32:57c9999f:1474447a937:800000d1
Batch
Activation mode = NoActivation|Confirmation mode = NoConfirmation|
Publishing mode = NoPublishing
EXPECT
ACTUAL|batch status code=BATCH_COMPLETED[0]|batch error msg=null
Cmd 0
Line 2039|Proprietary.changeSystemDefaultsInternally
({/pace/crs/start=true}, null)
EXPECT|expected command status code=CMD_OK[0]
ACTUAL|command status code=CMD_OK[0]|command error msg=null|data
type=DATA_VOID[-1]|results=null
File: /rms/app/baseconfig/ga_kiwi_scripts/insee_configuration.kiwi
Finished tests in 7824ms
Total Tests Run
- 117
Cisco RAN Management System Administration Guide, Release 5.0
208
January 7, 2015
INSEE Management
Creating an INSEE SAC CSV File
Total Tests Passed - 104
Total Tests Failed - 13
Step 5
Check PMGServer status if it is up then skip this step.
Example:
god status PMGServer
[rms-aio-central] /home/admin1 # god status PMGServer
PMGServer: unmonitored
Step 6
If the PMGServer status is unmonitored then run the following command.
Example:
god start PMGServer
Sending 'start' command
The following watches were affected:
PMGServer
check the status PMGServer should be up and running after sometime
[rms-aio-central] /home/admin1 # god status PMGServer
PMGServer: up
Creating an INSEE SAC CSV File
INSEE SAC csv files can be created in two ways. Both the options are provided in the following procedure.
Procedure
Step 1
Option 1:
a) Locally, create a csv file with the name “insee_sac_femto.csv”.
• The csv file should not contain any header fields or any comments (#, // etc are not permitted).
• In this file enter comma separated list of INSEE code, SAC value For example, insee1,100.
Note that there should not be any spaces before and after the comma.
• INSEE code can be an alphanumeric string. Spaces at the start and end of the INSEE code are not
permitted. Spaces in between INSEE code are allowed.
• Data type of SAC is an unsigned integer with maximum value of 65535.
b)
c)
d)
e)
Step 2
Using WinScp or similar, copy this file on the Central node in the /tmp dir or user login dir.
Log in to the Central node as root user.
Copy insee_sac_femto.csv to /rms/app/CSCObac/rdu/mappingfiles.
Validate this mapping file (see Verifying the Mapping Files, on page 210).
Whenever the INSEE SAC csv file is modified, it has to be validated to ensure that the changes are reflected.
Option 2:
a) Log in to the Central node with a non-root user.
b) Change to root user.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
209
INSEE Management
Verifying the Mapping Files
c) Change dir using command ‘cd /rms/app/CSCObac/rdu/mappingfiles’.
d) Create insee_sac_femto.csv file in the above dir using the vi insee_sac_femto.csv command.
• The csv file should not contain any header fields or any comments (#, // etc are not permitted).
• In this file enter comma separated list of INSEE code, SAC value For example, insee1,100.
Note that there should not be any spaces before and after the comma.
• INSEE code can be an alphanumeric string. Spaces at the start and end of the INSEE code are not
permitted. Spaces in between INSEE code are allowed.
• Data type of SAC is an unsigned integer with maximum value of 65535.
e) Save the file.
f) Validate this mapping file (see Verifying the Mapping Files, on page 210).
Whenever the INSEE SAC csv file is modified, it has to be validated to ensure that the changes are reflected.
Verifying the Mapping Files
Perform the procedure to validate the mapping file. If the INSEE code or the SAC value is not in the correct
format, validation of the mapping file will fail. The changes made in mapping files take effect only after
successful validation.
Before You Begin
Log in to the RMS and locate the mappingFiles.
Procedure
Step 1
Step 2
Log in to the Central node.
Switch to root user:
su-
Step 3
Execute the following command to change the directory to mapping files:
cd /rms/app/CSCObac/rdu/mappingfiles/
Step 4
Make sure that there are two sub-directories present in the mappingfiles directory.
a) latest
b) backup
Step 5
Copy the staged mapping files into the directory:
cd /rms/app/CSCObac/rdu/mappingfiles
Step 6
Validate the mapping files:
a) Confirm that BAC Config is deployed and the Shell script is located at:
/rms/app/baseconfig/bin/runkiwi.sh
b) Confirm that the Kiwi script is available at:
/rms/app/CSCObac/rdu/mappingfiles/addinsee_sac_femto.kiwi
Cisco RAN Management System Administration Guide, Release 5.0
210
January 7, 2015
INSEE Management
Verifying the Mapping Files
Note
Before running the command to validate the mapping files, ensure that entries in
insee_sac_femto.csv are in valid format. INSEE code with leading and trailing spaces is not
valid. However, INSEE code can contain spaces in between.
For example:
Valid entries in the mapping file:
AB123,567
AB123,567
Invalid entries in the mapping file:
AB123 ,567
AB 123 ,567
AB123,567
c) Run the following commands to validate the mapping files added in the mappingfiles folder.
d) Change directory using command cd /rms/app/baseconfig/bin.
e) Run the kiwi script using the INSEE code - SAC mapping: ./runkiwi.sh
/rms/app/CSCObac/rdu/mappingfiles/addinsee_sac_femto.kiwi.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
211
INSEE Management
Verifying the Mapping Files
Cisco RAN Management System Administration Guide, Release 5.0
212
January 7, 2015
CHAPTER
13
Cisco Provisioning Management Gateway (PMG)
The Cisco Provisioning Management Gateway (PMG) is a generic provisioning and management application
that provides the necessary workflow component between the Service Provider (SP) IT or Operations Support
Systems (OSS) applications and the Cisco provisioning Broadband Access Center (BAC). These OSS
applications include service management and custom care systems.
This guide describes the PMG operations, components and concepts, and services in detail. While PMG is
designed to be a generic product, this document describes the concepts specific to this release.
This chapter describes PMG components and concepts as used in the current release.
• PMG Overview, page 213
• PMG Event Subscription, page 219
• Managing the PMG, page 222
• PMG Profiles, page 229
PMG Overview
The PMG is a generic application suitable for any TR-069 deployment with the BAC. The application provides
an Extensible Markup Language (XML) interface over Hypertext Transfer Protocol (HTTP) based Application
Programming Interface (API) to the OSS that hides the complexity of the BAC API. The PMG provides the
ability to customize a deployment by using a profile that defines the elements of the API (such as messages,
parameters, and so on) that are applicable.
The PMG provides the following functionality:
• Interfaces to the OSS system for device provisioning and management.
• XML messages for provisioning and management.
• Interacts with the BAC and HNB-GW.
• Interfaces with the HNB-GW via RADIUS for dynamic whitelist.
• Reports events to the subscriber/OSS.
• Reports SNMP alarms for PMG service related events.
• Interfaces with the HNB-GW via RADIUS for dynamic whitelist.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
213
Cisco Provisioning Management Gateway (PMG)
PMG Overview
For requests from the OSS, the PMG accepts TCP connections, receives an HTTP request with XML payload
and provides response in HTTP response with XML payload. The connection can remain persistent for
subsequent requests unless it is closed by the client or times out.
For notifications, the PMG establishes a TCP connection to an IT / OSS / BSS, sends an HTTP request with
XML payload and gets confirmation in HTTP response. The connection can remain persistent for subsequent
notifications unless closed by target or times out.
The PMG API is defined by a profile, which is an XML document that describes the inbound messages that
the PMG supports. The XML schema provides a means for defining the structure, content, and semantics of
the XML document. The XML schema for the profile specifies the inbound requests, the required elements,
excluded elements, ignored elements, and the applicable parameters. These parameter elements include name,
type, readable, writable, deletable, and source type along with optional validation and source key.
Note
PMG is installed as part of the OVA installation.
This table lists a few standard HTTP status codes used in validating the PMG messages:
Table 12: PMG HTTP Status Codes
HTTP Status Codes
Description
200 OK
Occurs for any response containing a valid PMG message response
(which in turn may contain an application layer error).
400 Bad Request
Occurs when the request received does not contain a valid PMG
message (for example, wrong encoding).
503 Service Unavailable
Used when the service is unavailable, typically due to high load.
Note
The client must resend the service
request.
Following is the send.url for posting XML message for httpclientsh:
http://localhost:8083/pmg
Following is the URL for defining the HTTP POST messages to PMG:
http://<host name/IP address>:8083/pmg/
Where,
• <host name>, is the host name of the Central Node, or IP address.
• <IP address>, is the eth1 of the Central Node.
• 8083, is the port number.
• /pmg, is the path.
Digest authentication is supported in PMG.
• The default username for PMG digest authentication is 'pmguser' and it is defined in pmgServer.properties
• pmg.auth.username = pmguser
Cisco RAN Management System Administration Guide, Release 5.0
214
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Message Flow
• pmg.auth.password.pmguser=<encrypted password>
The path for pmgserve.properties is /rms/app/pmg/conf.
PMG Message Flow
The following is the flow of PMG messages:
1
2
3
4
5
6
7
8
9
OSS establishes an HTTP connection with the PMG service url.
OSS sends a message to PMG with the digest authentication credentials.
PMG receives the message and validates the content-type as application/xml or text/xml.
PMG validates that the message is valid XML.
PMG validates that the message complies with PMG XML Schema Definition (XSD).
PMG determines the message type by examining the root node name.
PMG determines if the message type is part of the configured profile.
PMG makes business orchestration by invoking PMG API.
Construct the response message and sent with HTTP 200 OK response message.
PMG Northbound Interface for LTE
The extensible-Operations Support Systems (OSS) integration of both LTE and UMTS is supported. Each
message exposed by the PMG is customizable by editing the associated field. Support is provided for:
• LTE module registration
• LTE-specific parameters, pools and groups, such as: PCI, LTE-CELL-ID of LTE AP, EAURF, HeNBGW
and TAC ID.
The PMG supports enhanced management capabilities for group and ID assignments using the BAC as its
data store. Operators can use HTTP Poster to perform all northbound operations on small cells.
Before You Begin
Download and install the HTTP Poster add-on.
Procedure
Step 1
Step 2
Enter the RMS IP address into the URL field in the following format: http://10.105.242.81:8083/pmg.
Select an XML file by clicking on the Browse button or pasting the XML content into the Content text box
and then click POST.
You are prompted for a username and password.
Step 3
Step 4
Enter your credentials, for example, username: pmguser, password: Rmsuser@1, and click OK.
Wait for the response. Verify that the response is successful and verify the same in the PMG audit logs and
debug logs. For each northbound operation, one xml file is provided.
The response should be similar to:
POST on http://10.105.233.87:8083/pmg
Status:
200 OK
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
215
Cisco Provisioning Management Gateway (PMG)
PMG Northbound Interface for LTE
<?xml version="1.0" encoding="UTR-8" standalone="no"?>
<SubscribeResponse xmlns="http://www.cisco.com/ca/sse
/PMGMessages=v3_0_0"><Status><Code>0</Code>
<Message>Success</Message></Status></SubscribeResponse>
Step 5
Use the relevant xml file for the required operation. For example, to perform a connection request on the AP
from HTTP poster, the following xml file is used:
<?xml version="1.0" encoding="UTF-8"?>
<!-This file is the confidential information and proprietary trade secret
of Cisco Systems, Inc. Possessions and use of this program must conform
strictly to the license agreement between the user and Cisco Systems,
Inc., and receipt or possession does not convey any rights to divulge,
reproduce, or allow others to use this program without specific written
authorization of Cisco Systems, Inc.
Copyright 2010-2012 Cisco Systems, Inc. All rights reserved.
-->
<ConnectionRequest xmlns="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0
pmg-messages-v2_0_0.xsd">
<TxnID>ConnectionRequest-TxnID-0</TxnID>
<!-- optionally can use SecondaryID -->
<EID>00223A-123456789012345</EID>
</ConnectionRequest>
Sample Register Residential XML File
Following are sample Register xml files to be used for registering an AP through HTTP poster:
<?xml version="1.0" encoding="UTF-8" ?>
- <Register xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">
<TxnID>DCCsangeetha7c33e9be-f1a7-46d8-a9e2-04f3ad74e791</TxnID>
<EID>001B67-352639051522276</EID>
<LTE />
<Activated>true</Activated>
- <GroupMemberships>
- <Group>
<Name>Area-1</Name>
<Type>Area</Type>
</Group>
</GroupMemberships>
- <AccessControl>
<AccessMode>Open</AccessMode>
</AccessControl>
- <Parameters>
- <Parameter>
<Name>FC-TAC-ID</Name>
<Value>555</Value>
</Parameter>
</Parameters>
</Register>
Sample Register Enterprise XML File
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
Cisco RAN Management System Administration Guide, Release 5.0
216
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Northbound Interface for LTE
- <Register xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0">
<TxnID>DCCsangeetha43611532-60a4-47ef-b07e-ca2a001b9a14</TxnID>
<EID>001B67-352639051522302</EID>
<LTE />
- <DeploymentMode>
<Role>ActiveEntry</Role>
<Purpose>Coverage</Purpose>
</DeploymentMode>
<Activated>false</Activated>
- <GroupMemberships>
- <Group>
<Name>Site-PMG</Name>
<Type>Site</Type>
</Group>
- <Group>
<Name>Ent-PMG</Name>
<Type>Enterprise</Type>
</Group>
</GroupMemberships>
</Register>
Sample Update TAC LTE XML File
<?xml version="1.0" encoding="UTF-8"?><!-This file is the confidential information and proprietary trade secret
of Cisco Systems, Inc. Possessions and use of this program must conform
strictly to the license agreement between the user and Cisco Systems,
Inc., and receipt or possession does not convey any rights to divulge,
reproduce, or allow others to use this program without specific written
authorization of Cisco Systems, Inc.
Copyright 2010-2012 Cisco Systems, Inc. All rights reserved.
--><Update xmlns="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0 pmg-messages-v2_0_0.xsd">
<TxnID>Update-TxnID-0</TxnID>
<!-- optionally can use SecondaryID -->
<EID>001B67-352639051522306</EID>
<Updates>
<Parameters>
<Parameter>
<Name>FC-TAC-ID</Name>
<Value>2565</Value>
</Parameter>
</Parameters>
</Updates>
</Update>
Sample Update TAC LTE XML File
<?xml version="1.0" encoding="UTF-8"?><!-This file is the confidential information and proprietary trade secret
of Cisco Systems, Inc. Possessions and use of this program must conform
strictly to the license agreement between the user and Cisco Systems,
Inc., and receipt or possession does not convey any rights to divulge,
reproduce, or allow others to use this program without specific written
authorization of Cisco Systems, Inc.
Copyright 2010-2012 Cisco Systems, Inc. All rights reserved.
--><Update xmlns="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0 pmg-messages-v2_0_0.xsd">
<TxnID>Update-TxnID-0</TxnID>
<!-- optionally can use SecondaryID -->
<EID>001B67-352639051522306</EID>
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
217
Cisco Provisioning Management Gateway (PMG)
LUS Organized Directory Structure for AP PM Files
<Updates>
<Parameters>
<Parameter>
<Name>FC-TAC-ID</Name>
<Value>2565</Value>
</Parameter>
</Parameters>
</Updates>
</Update>
<?xml version="1.0" encoding="UTF-8"?><!-This file is the confidential information and proprietary trade secret
of Cisco Systems, Inc. Possessions and use of this program must conform
strictly to the license agreement between the user and Cisco Systems,
Inc., and receipt or possession does not convey any rights to divulge,
reproduce, or allow others to use this program without specific written
authorization of Cisco Systems, Inc.
Copyright 2010-2012 Cisco Systems, Inc. All rights reserved.
--><Update xmlns="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v2_0_0 pmg-messages-v2_0_0.xsd">
<TxnID>Update-TxnID-0</TxnID>
<!-- optionally can use SecondaryID -->
<EID>001B67-352639051522306</EID>
<Updates>
<Parameters>
<Parameter>
<Name>FC-TAC-ID</Name>
<Value>2565</Value>
</Parameter>
</Parameters>
</Updates>
</Update>
LUS Organized Directory Structure for AP PM Files
Currently all the APs upload PM files to LUS server under the same directory (base path). Therefore, if the
number of APs are more, then the directory is unmanageable. This feature is added to categorize the APs
based on AP's associated group, and upload all these APs PM files to LUS into a same sub directory under
base path. (sub directory name will be the associated group name.) New property "ap.upload.url.suffix.group
" is added in PMGServer.properties file to enable this feature. By default value of this is "NO_GROUP",
means feature is disabled and the current behavior will continue. Possible values of this property are
Area/FemtoGateway/Enterprise/Site (Possible FRM group types).
For example: If ap.upload.url.suffix.group = Area,
A P-1,2,3 are associated to Area-1,
AP-4,5,6 are associated to Area-2,
then the uploaded PM files will be structured as below:
/opt/CSCOuls/files/uploads/Area-1/
AP1-stats_1.xml
AP1-stats_2.xml
AP2-stats.xml
AP3-stats.xml
/opt/CSCOuls/files/uploads/Area-2/
AP4-stats.xml
AP5-stats.xml
AP6-stats.xml
Cisco RAN Management System Administration Guide, Release 5.0
218
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Event Subscription
When this feature is enabled, PMG will set "FC-LOG-PERIODIC-UPLOAD-URL" custom property at device
level for all newly registered APs. The same can be added to existing APs with ReAssign API.
PMG Event Subscription
The subscriber should follow these steps for subscribing to the PMG events:
1 Send the getAllEventTypes message (subscribe.xml) to PMG for receiving all the supported events.
Note
Each subscriber can subscribe to all the events or selected events, and can have multiple (maximum 3 and
minimum 1) notification url for one subscriber. PMG picks up one url and delivers the event. If that URL1
is not reachable, then PMG picks up the next url for event delivery.
PMG event subscription supports these events: AssignedData, FirmwareUpgraded, GroupCreated,
GroupUpdated, GroupDeleted, LocationStatus, Online, ServiceError, ServiceOperational,Tampered. PMG
accepts three number of subscribers by default.
Following is the sample xml request for event subscriptions:
<Subscribe subscriber-name=”ATT-OSS-1”>
<URL>http:server1/notifyme </URL>
<URL>http:server2/notifyme </URL>
<URL>http:server3/notifyme </URL>
<Event name=”AssignedData”>
<Parameter name=”eCGI”>
</Event>
<Event name=”Groups” isEnabled=false>
</subscribe>
Following is an example xml:
<Subscribe xmlns="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xsi:schemaLocation="http://www.cisco.com/ca/sse/PMGMessages-v3_0_0
pmg-messages-v3_0_0.xsd"
subscriber-name='ATT-OSS-1'>
<URL>http://10.105.233.87:8085/pmg</URL>
<Events>
<Event name='AssignedData' isEnabled='true'>
</Event>
<Event name='GroupCreated' isEnabled='true'>
</Event>
<Event name='GroupUpdated' isEnabled='true'>
</Event>
<Event name='GroupDeleted' isEnabled='true'>
</Event>
<Event name='FirmwareUpgraded' isEnabled='true'>
</Event>
<Event name='LocationStatus' isEnabled='true'>
</Event>
<Event name='Online' isEnabled='true'>
</Event>
<Event name='ServiceError' isEnabled='true'>
</Event>
<Event name='ServiceOperational' isEnabled='true'>
</Event>
<Event name='Tampered' isEnabled='true'>
</Event>
</Events>
</Subscribe>
2 The subscriber can send this subscribe message from any host by specifying the subscriber name and the
list of notification URL. Subscribed events are specified in the <Event> element, and events are enabled
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
219
Cisco Provisioning Management Gateway (PMG)
RMS Alarm Handler
by default. Changing the Enabled state of particular event to false, to disable the event. Following is an
example:
<Event name='LocationStatus' isEnabled='false'>
</Event>
3 The subscriber can customize the events by specifying the parameter names that the notification server
prefers to receive. If the parameters are not specified, then the notification will contain all the parameters
of an particular event.
Note
If the events are not specified, it indicates that the subscriber has subscribed to all the events.
4 The subscriber can update event subscription by sending subscribe message with the updated set of
additional events and removing previously subscribed events.
For example, the subscriber can subscribe to events from the poster in Mozilla Firefox browser, by posting
the subscribe.xml message using the url http://<eth1 address of central node>:8083/pmg to receive the
notifications.
What to Do Next
Verify whether the event subscription is successful.
Follow the below steps to verify the event subscription:
1 Log in to RMS central node as root user.
2 Navigate to /rms/app/rms/conf/.
3 Check the file subscriber-conf.xml.
RMS Alarm Handler
RMS alarm handler raises the AP Reachability Alarm and AP location Verification Alarm.
AP Reachability Alarm
RMS has introduced a new alarm AP Reachablity Alarm with the severity "Major". The alarm raises whenever
the AP is abruptly down or Issue in the network connection between FAP and RMS. The scenarios are as
follows:
• RMS raises AP Reachability alarm if the current request for connection request has failed and previous
one is passed.
• RMS clears the AP Reachability alarm if the current request for connection request has passed and
previous one is failed.
• RMS forwards AP Reachability alarm to Prime Central for further processing.
• RMS treats this alarm in a similar way as it treats any other FAP alarm. For example, adding FAP ID,
DN Prefix and so on while sending this alarm to Prime Central.
• RMS defines a property using which operator can turn on/off generation of this alarm.
• RMS schedules massCR.sh to run every 10 minutes by default.
Cisco RAN Management System Administration Guide, Release 5.0
220
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
RMS Alarm Handler
AP Location Verification Alarm
RMS introduces a new alarm Location Verification Alarm with the severity Major. The alarm raises whenever
location verification fails for an AP. The scenarios are as follows:
• RMS raises Location Verification alarm if the current location verification has failed and the previous
location verification was passed.
• RMS clears Location Verification alarm if the current location verification has passed and previous
location verification was failed.
• RMS forwards Location Verification alarm to Prime Central for further processing.
• RMS treats this alarm in similar way as it treats any other FAP alarm. For example, adding FAP ID, DN
Prefix and so on while sending this alarm to Prime Central.
• RMS defines a property using which operator can turn on/off generation of this alarm.
The PMG Server Properties file, (/rms/app/pmg/conf/PMGServerProperties) must be configured
as shown below for enabling the Alarm Handler Feature.
#Alarms
#Following parameter is used to enable/disable the EPM alarm feature.
#1:Enable , 0:Disable
pmg.alarms.snmp.epm.alarmhandler=1(Enable by default)
pmg.alarms.snmp.epm.alarmhandler.port=4678 (Port)
pmg.alarms.snmp.epm.nummanagers=1
#<Prime central IP>
pmg.alarms.snmp.epm.manager.address.1=
pmg.alarms.snmp.epm.manager.port.1=162
pmg.alarms.snmp.epm.manager.community.1=public
#1:Enable AP reachability alarm, 0:Disable
pmg.alarms.snmp.epm.apreachability=1
#Connection Request Timer, By Default this is 10 min. Can be increased to interval of 60
min
pmg.alarms.snmp.epm.apreachability.interval=10
#Rate at which Connection Request is Triggered. By Default this Should be 10
pmg.alarms.snmp.epm.apreachability.rate=10
pmg.alarms.snmp.epm.apreachability.devices.max=5000
#idfile: A absolute path to a file with a list of devices or group IDs (one per line).
# Provide the Complete Path with ciscorms permissions
pmg.alarms.snmp.epm.apreachability.idfile=
#type: Specifies the content of the list file as either devices or a configured group type
(Available types are : all, devices, provgroup, cos, Area, CELL-POOL, Enterprise,
FRM-Group-Type-Meta-Data, FemtoGateway, Management, Pool-Type-Meta-Data, SAI-POOL, Site,
system)
pmg.alarms.snmp.epm.apreachability.type=all
#1:Enable AP location check , 0:Disable
pmg.alarms.snmp.epm.aplocation=1
#Serving Node Eth_0 Ip Address
pmg.alarms.snmp.epm.serving.address=
For the first time usage of the alarm handler, the below changes should be made in the PMGServer.properties
file under the path /rms/app/pmg/conf.
1 Add the PrimeCentral IP/SNMP Address:
#<Prime central IP>
For example, pmg.alarms.snmp.epm.manager.address.1= 10.142.52.41
2 Provide the Eth_0 Serving Node IP Address
#Serving Node Eth_0 Ip Address
For example, pmg.alarms.snmp.epm.serving.address=10.5.1.20
3 Provide the path of the file location
# Provide the Complete Path with ciscorms permissions
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
221
Cisco Provisioning Management Gateway (PMG)
Managing the PMG
For example, pmg.alarms.snmp.epm.apreachability.idfile=/rms/app/pmg/conf/idfile.txt
4 Modify the below Parameter value as required.
For example, if the alarm handler needs to be triggered for all devices, then provide all as mentioned
below.
pmg.alarms.snmp.epm.apreachability.type=all
User Guidelines
1 RMS issues Connection Request (CR) every 10 min (by default) as configured in the PMG Server Properties
file.
2 CR is issued based on the configuration in the PMG Server properties file. For example:
pmg.alarms.snmp.epm.apreachability.idfile= /rms/app/pmg/conf/ idfile.txt
#type: This specifies the contents of the list file as either devices or a configured group type. The available
types are: all, devices, provgroup, cos, Area, CELL-POOL, Enterprise, FRM-Group-Type-Meta-Data,
FemtoGateway, Management, Pool-Type-Meta-Data, SAI-POOL, Site, system.
pmg.alarms.snmp.epm.apreachability.type=all (This should be changed based on the configuration.)
This file should have ciscorms permissions, for example:
chown ciscorms:ciscorms idfile.txt
chmod 744 idfile.txt
3 The Alarm handler logs in to the path (/rms/log/AlarmHandler/AlarmHandler.console.log)
.
Managing the PMG
The PMG uses a standard HTTP request/response protocol with XML message content that allows provisioning
and managing the OSS applications. The PMG API involves a specific protocol to send XML encoded messages
as defined by XSD over HTTP.
There is a distinct path for messages, the inbound requests, where the OSS Request Sender sends requests to
PMG. Multiple simultaneous OSS Request Senders create their own TCP connections, send inbound requests
to PMG, and then receive the appropriate response on the same TCP connection.
The PMG upon receiving a message validates the following prior to performing the work flow of the message:
1
2
3
4
5
6
HTTP content-type is application/xml or text/xml.
XML content is a validated PMG message.
Excludes the elements that are as defined in the PMG profile for the messages.
Ignores the elements that are as defined in the PMG profile for the messages.
Validate the parameter names that include ParameterDefinitions or ParameterNames.
Validate the value of the parameter using ParameterDefinition validation.
PMG Logging
The PMG is capable of logging all requests and responses to and from the OSS, and to and from the BAC.
The PMG logging automatically rolls its log files on a daily basis. The maximum number of log files stored
is configurable through a configuration file. The path for pmglogs is /rms/log/pmg.
Cisco RAN Management System Administration Guide, Release 5.0
222
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Logging
This table lists some of the different types of PMG logs:
Table 13: Different Types of PMG Logs
PMG Logs
Description
Performance Logs
The Performance log determines the performance statistics and consists of two
files, one for individual message performance and the other periodic roll-up
performance metrics.
Audit Logs
The Audit log logs all interactions with the individual provisioning system
components and changes, to the device configuration.
Alarm Logs
The alarm logs are triggered for the following scenarios,
a) When the connection with the RDU is lost and once the connection with the
RDU is established.
b) When Radius connection is lost and reestablished with the ASR 5000.
c) When PMG server is started, stopped or restarted.
Message Logs
The OSS HTTP Message logs are used for testing and message tracking
purposes. The logs are maintained for 7 days.
Syslog
PMG server status will be logged when PMG is started/stopped/restarted. Syslog
contains the Alarm messages of PMG server.
Thus, PMG logging is useful in determining device performance and ensuring proper processing with the
BAC. Alarm information logged in pmg-alarms.log is also logged in the syslog. The syslog messages can
be found in /var/log/local0.log. In addition to the logs mentioned above, the server start/stop will also be
logged in syslog.
Note
The server, pmgServer, must be started with the user specified as ciscorms.
All PMG logs are stored in the directory defined in the $RMS-LOGS environmental variable with a
"/pmg" added.
PMG Performance Logs
The Performance logging consists of two files; one for individual message performance and the other hourly
roll-up performance metrics.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
223
Cisco Provisioning Management Gateway (PMG)
PMG Logging
Individual Performance Log File
The performance log for individual messages is output to the file "pmg-msg-perf.csv" and is stored in the
directory /rms/log/pmg. The Performance log file is in the CSV format and begins with a header row followed
by the individual message performance data. An example of the individual performance logs is shown here:
2011-12-09T01:01:49.309
2011-12-09T01:01:49.319
2011-12-09T01:01:49.329
2011-12-09T01:01:49.339
2011-12-09T01:01:49.349
2011-12-09T01:01:49.359
2011-12-09T01:01:49.359
2011-12-09T01:01:49.359
2011-12-09T01:01:49.359
Block
Unblock
Update
GetStoredData
Block
UnBlock
Unknown
Unknown Content
XML Parse error
ead1eb47-...-472bb
ead1eb47-...-472bb
ead1eb47-...-472bb
ead1eb47-...-472bb
ead1eb47-...-472bb
ead1eb47-...-472bb
Unknown
Unknown
Unknown
00223A-0000393086
00223A-0000393086
00223A-0000393086
00223A-0000393086
00223A-0000393086
00223A-0000393086
Unknown
Unknown
Unknown
220
220
222
220
221
220
2
2
2
215
215
216
225
215
215
0
1
0
319
320
321
319
320
319
3
3
3
Following are the headings of the fields in the log file and their descriptions:
• timestamp is the date and time of the received message. The timestamp is represented in the ISO 8601
format "YYYY-MM-DDThh:mm:ss.fffZ", where:
◦YYYY-represents the four-digit year
◦MM-represents the two-digit month
◦DD-represents the two-digit day of the month
◦T-is the time delimiter
◦hh-represents the time in hours
◦mm-represents the time in minutes
◦ss-represents the time in seconds
◦fff-represents the time in milliseconds
◦Z-represents the zone designator for the zero (Co-ordinated Universal Time) UTC off set, if the
time is in UTC
• msg name-the message name as found in the XML root element
• trans id-the transaction ID in the message
• eidthe device ID for the record. If the message is called with a Secondary ID, the EID must be looked
up and used
• msg process time ms-the message processing time of the message processor in milliseconds, with the
BAC processing time removed
• BAC process time ms-the BAC processing time in milliseconds
• total msg process time ms-the total message processing time in milliseconds that includes time in
un-marshaling the message, message processing time, BAC processing time, and the response time in
message marshaling.
To track the performance of unknown messages, messages with XML parser errors and messages that are not
of XML content are also logged in the individual performance log file.
Following are some of the logging details for unknown messages:
Cisco RAN Management System Administration Guide, Release 5.0
224
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Logging
• All unknown messages have the message name, transID, and EID as "Unknown".
• All message XMLs that fail to parse, have the message name as "XML Parse error" with transID and
EID as "Unknown".
• All messages that are not of content type application/xml or text/xml have the message name as "Unknown
Content", with transID and EID as "Unknown".
The audit logging is output to the file "pmg-audit.log" and is stored in the directory /rms/log/pmg. The audit
logs are used to identify the workflow from the receipt of a PMG message to the response back to the OSS.
The audit logs will be rotated at 12 a.m. each day or if larger than 250 MB in size.
Note
The individual logs are maintained on the RDU for 60 days, at which time they are backed up and removed
from the RDU.
Periodic Performance Log File
The periodic performance log file is a summary of each message performance from the start of PMG or for
the last period defined. The period is specified by the pmg.perf.periodic.log.interval.milli.seconds property
in the dcc.properties file. The period is specified in milliseconds. If this property is not set in the dcc.properties
file, the default value of 3600000 (1 hour) is used.
For example, if the period is set to 900000, which corresponds to 15 minutes, and the PMG starts at 2:03, the
first log is printed at 2:18 and then at 2:33 and so on. The periodic performance log files are output to the file
"pmg-perf-periodic.csv", and are stored in the directory /rms/log/pmg. The periodic performance log file is
in csv format and begins with a header row followed by a performance summary for each message.
An example of the messages in the file for the period performance logs is shown below for 15 minute intervals:
2014-09-24T16:41:49.735Z,899,GetAllFRMPools,96,96,96,1,0,245,524,0,0
2014-09-24T16:41:49.736Z,899,GetAllFRMPoolTypes,113,118,108,2,0,424,1486,0,0
2014-09-24T16:41:49.737Z,899,GetAllFRMGroupTypes,447,767,272,3,0,642,8694,0,2
2014-09-24T16:41:49.737Z,899,GetAllFRMGroups,157,157,157,1,0,241,6914,0,2
2014-09-24T16:56:49.735Z,899,GetLiveData,145,145,145,1,0,606,283,0,0
2014-09-24T16:56:49.736Z,899,GetAllFRMPools,69,70,68,2,0,487,1047,0,0
2014-09-24T16:56:49.737Z,899,GetAllFRMPoolTypes,99,108,91,2,0,424,1486,0,0
2014-09-24T16:56:49.737Z,899,GetAllFRMGroupTypes,204,211,200,3,0,642,8694,0,2
2014-09-24T16:56:49.738Z,899,GetStoredData,259,271,248,2,0,448,35272,0,10
The headers for the fields in the periodic performance summary file are described here:
• period end-the summary period end timestamp in the ISO 8601 format. The timestamp is in the format
"YYYY-MM-DDThh:mm:ss.fffZ", where time is represented in milliseconds
• summary period sec-the time interval in milliseconds, for receiving the messages during the summary
period
• msg name-the message name received during the summary period
• avg response time ms-the average response time in milliseconds
• max response time ms-the maximum response time in milliseconds
• min response time ms-the minimum response time in milliseconds
• num msgs-the total number of messages received during the summary period
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
225
Cisco Provisioning Management Gateway (PMG)
PMG Logging
• num errors-the number of errors occurred during the summary period
To track the performance of unknown messages, messages with XML parser errors and messages that are not
of XML content are also rolled up in the periodic performance summary file.
Following are some of the logging details for unknown messages:
• All unknown messages have the message name as "Unknown".
• All message XMLs that fail to parse have the message name as "XML Parse error".
• All messages that are not of content type application/xml or text/xml have the message name as "Unknown
Content".
Note
The periodic performance log files are maintained on the RDU for 30 days, at which time the log files are
backed up and removed from the RDU. Each periodic performance log file is rotated at 12 a.m. each day,
or if the file size exceeds 250 MB. 2.1.2 Audit Logs
The audit logging is output to the file "pmg-audit.log" and is stored in the directory /rms/log/pmg. The audit
logs are used to identify the workflow from the receipt of a PMG message to the response back to the OSS.
The audit logs will be rotated at 12 a.m. each day or if larger than 250 MB in size.
Note
The individual logs are maintained on the RDU for 60 days, at which time they are backed up and removed
from the RDU.
PMG Alarm Logs
The PMG triggers alarms for the following conditions and these alarm messages are logged to the file
"pmg-alarm.log".
Table 14: PMG Alarm Log Messages
Alarm Condition
Alarm Level
Alarm Text
Connection with the RDU lost
Critical
Alarm raised: Type=RDU
Connection
Connection with RDU established Clear
Alarm resolved: Type=RDU
Connection
Radius connection lost
Minor
Alarm raised: Type=Radius
Connection
Radius connection restored
Clear
Alarm rersolved: Type=Radius
Connection
PMG connection limit exceeded
warning
Alarm raised: Type=PMG
Connection
Cisco RAN Management System Administration Guide, Release 5.0
226
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Logging
Alarm Condition
Alarm Level
Alarm Text
PMG connection limit exceeded
Major
Alarm raised: Type=PMG
Connection
PMG Server start
warning
Alarm resplved Type= PMG Status
PMG Server stop
Major
Alarm raised Type= PMG Status
PMG Syslogs
The alarms logged in pmg-alarms.log are logged in the syslog (/var/log/local0.log). In addition to the
above mentioned logs, the server start/stop are also logged in the syslog.
For the statements to appear in the syslogs, the udp port has to be uncommented in
/etc/rsyslog.conf.
These parameters, (if commented) need to be uncommented in rsyslog.conf.
• #$ModLoad
imudp.so
• #$UDPServerRun
514
The rsyslog needs to be restarted: /etc/init.d/rsyslog
restart
PMG Message Logs
The PMG includes inbound message logs for testing and inbound message tracking. This logging is output
to the file "pmg-inbound-msg.log", and is stored in the directory /rms/log/pmg. The PMG also includes
outbound message logs for testing and outbound message tracking. This logging is output to the file
"pmg-outbound-msg.log", and is stored in the directory /rms/log/pmg. Inbound message logs and outbound
message logs are rotated at 12 a.m. each day or if the file is larger than 250 MB in size.
Note: The individual logs are maintained on the RDU for seven days, at which time they are removed from
the RDU.
PMG Troubleshooting
Use these commands to monitor the status of the PMG server and start or stop the server.
Procedure
Step 1
god status PMGServer
Verifies the status of the PMG server. The server states can be up (running), unmonitored (stopped),
init(intermediate).
Example:
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
227
Cisco Provisioning Management Gateway (PMG)
Alarm Messages
This example shows sample output when the server is up:
[rms-aio-central] /home/admin1 # god status PMGServer
PMGServer: up
This example shows sample output when the server is stopped:
[rms-aio-central] /home/admin1 # god status PMGServer
PMGServer: unmonitored
Step 2
god start PMGServer
Starts the PMG server.
Example:
This example shows sample output when the server is started.
[rms-aio-central] /home/admin1 # god start PMGServer
Sending 'start' command
The following watches were affected:
PMGServer
Step 3
god stop PMGServer
Stops the PMG server.
Note
Check the status of the PMG server before starting or stopping the server. Wait for some time after
executing the command as it can take 10 to 12 seconds.
Example:
This example shows sample output when the server is stopped:
[rms-aio-central] /home/admin1 # god stop PMGServer
Sending 'stop' command
The following watches were affected:
PMGServer
Alarm Messages
The PMG triggers SNMPv1 traps to multiple configurable destinations on the following conditions:
• Exceeds the maximum concurrent messages of 1500.
• Lost connection with BAC. A critical alarm is triggered in this case.
• A critical alarm is raised when connection is lost with HNB-GW (ASR 5000) and the clear alarm is
raised when connection is restored.
• When the PMG is stopped and started.
SNMP TRAP - MIB:
The PMG server sends the following alarm and uses ciscoMhsServerAlarm object to send SNMPV1 alarms.
1.3.6.1.4.1.9.9.9999.0.5 ( ciscoMhsServerAlarm )
Cisco RAN Management System Administration Guide, Release 5.0
228
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
PMG Profiles
ciscoMhsServerAlarm NOTIFICATION-TYPE
OBJECTS {
ciscoMhsServerType,
ciscoMhsServerName,
ciscoMhsAlarmDescription,
ciscoMhsAlarmSeverity,
ciscoMhsTimeStamp
}
ciscoMhsServerType OBJECT-TYPE
SYNTAX INTEGER {
cmhs(1),
others(2),
upload(3),
watchdog(4),
bac rdu(5),
radius(6),
pmg(7)
}
where,
ciscoMhsServerType = PMG, ciscoMhsServerName=machine name, ciscoMhsAlarmDescription="Exceeds
the maximum concurrent messages of 1500"
Note
ciscoMhsServerType specifies the component which raises the trap.
Note
The internal Watchdog also monitors the process and enables to log to the syslog, the watchdog alarms
that are triggered.
PMG Profiles
A PMG profile defines the messages used for the configuration and activation processes. The profile specifies
the inbound requests that are used along with the required, ignored, and excluded elements. The PMG profile
also contains a number of exclusions, but does not add element requirements. The PMG profile is referred to
as pmg-profile.xml in the server.
Using the pmg-profile.xml, the operator can add/remove/exclude/ignore for any message.
For all PMG messages, either an EID or SecondaryID is specified as the device ID. The device search is
performed using the SecondaryID which is the device's Fully Qualified Domain Name (FQDN) in BAC or
with the EID which is the device's DeviceID property in the BAC.
Profiles are used to specify the subset of messages, elements, and parameters to be used in a given deployment.
A Profile is a way to configure the generic PMG to deployment-specific requirements.
The PMG profile contains the Parameter Definition section, which defines the names and types of the supported
parameters.
Note
When pmg-profile is customized for the first time, the PMG server must be restarted. Place the customized
pmg-profile.xml in the /rms/app/rms/conf/ directory.
The path for the default pmg-profile.xml is /rms/app/rms/doc/pmg/pmg-profile.xml.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
229
Cisco Provisioning Management Gateway (PMG)
Parameter Definitions
Parameter Definitions
Some PMG messages support the parameter structure to add, update, delete, or retrieve parameters. The PMG
profile contains the Parameter Definition section, which defines the names and types of the supported
parameters.
This table lists some of the parameter elements that are defined in the parameter definition.
Table 15: Parameter Elements and Description
Parameter Elements
Description
Name
The parameter name or the alias used in the message.
Type
The type of the parameter that can be:
• String
• Integer (BAC custom property which is an integer)
• Unsigned integer (BAC custom property which is of the type Long)
• Decimal
• Boolean
• Date/Time
Source Type
The type of the source that includes:
• DeviceParameters
An example of BAC API constant: DeviceDetailsKeys.DEVICE_ID.
• DeviceProperty (BAC property or custom property)
Writable
Indicates if the parameter is writable (can be added or updated).
Readable
Indicates if the parameter is returned by a get.
Deletable
Indicates if the parameter can be deleted.
Cisco RAN Management System Administration Guide, Release 5.0
230
January 7, 2015
Cisco Provisioning Management Gateway (PMG)
Parameter Definitions
Parameter Elements
Description
Validation
Defines the validation to use on a Writable parameter value and is defined
by the following:
• Type - defines the type of validation that can be:
◦A range, used to validate numbers. The expression element is of
the format [low:high], where "low" is the lowest number in the
range, or empty if there is none, and "high" is the highest number
in the range or empty if there is none.
◦A Regular expression. The expression element contains a regular
expression that is used to match the value.
• Expression - Expression as defined by the type, either a range or regex
expression.
Following is an example for validation:
<ParameterDefinition>
<Name>MAX-TRANS-PWR</Name>
<Type>int</Type>
<SourceType>DeviceProperty</SourceType>
<Writable>true</Writable>
<Readable>true</Readable>
<Deletable>true</Deletable>
<Validation>
<Type>range</Type>
<Expression>[-100:10]</Expression>
</Validation>
</ParameterDefinition>
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
231
Cisco Provisioning Management Gateway (PMG)
Parameter Definitions
Cisco RAN Management System Administration Guide, Release 5.0
232
January 7, 2015
CHAPTER
14
Troubleshooting
There are logs available for troubleshooting the DCC as well as the operational tools.
• Troubleshooting the Device Command and Control UI, page 233
• Operational Tools Troubleshooting, page 234
• Using the Logs for Troubleshooting, page 235
Troubleshooting the Device Command and Control UI
The DCC UI log files are generated and stored in the logs directory,/rms/log/dcc_ui/, by default. The Audit
logs capture the entire tool access process. You can check the logs for checking the tool access details.
A sample Audit log of the application is shown below:
[03-13-2012 00:00:02]Timer-1 - Writing perf log header after file rotation[03-13-2012
.
.
.
05:11:33]http-80-3 - [000001-000000001000|FPGe89e1e45-dba9-46d9-a688-72f4aba3de73]
Attr: xmlns = http://www.cisco.com/ca/sse/PMGMessages-v1_0_0[03-13-2012 05:11:33]http-80-3
- [000001-000000001000|FPGe89e1e45-dba9-46d9-a688-72f4aba3de73] Attr: xmlns:xsd
= http://www.w3.org/2001/XMLSchema[03-13-2012 05:11:33]http-80-3 [000001-000000001000|FPGe89e1e45-dba9-46d9-a688-72f4aba3de73] Attr: xmlns:xsi =
http://www.w3.org/2001/XMLSchema-instance[03-13-2012 05:11:33]http-80-3 [000001-000000001000|FPGe89e1e45-dba9-46d9-a688-72f4aba3de73] Attr:
xsi:schemaLocation = http://www.cisco.com/ca/sse/PMGMessages-v1_0_0
pmg-messages.xsd[03-13-2012 05:11:33]http-80-3 .
.
.
The Debug logs are used for debugging the errors that occur during programming. A sample
Debug log of
the application is shown below
[04-20-2012 00:00:14-668]Timer-1 Servlet INFO [SystemStatusMonitor$FPGHourlyStatusTask.run]
- Start running hourly timer task[04-20-2012 00:00:14-670]Timer-1 Servlet DEBUG
[SingletonInstanceManager.getInstance] - Using existing SingletonInstanceManager
object...[04-20-2012 00:00:14-671]Timer-1 Servlet DEBUG [SingletonInstanceManager.getInstance]
- Reusing existing singleton instance:
.
.
.
14:14:09-332]main Servlet DEBUG [SetupServlet.destroy] - Destroying SetupServlet... Shutting
down SystemMonitor timers...[04-20-2012 14:14:09-333]main Servlet DEBUG
[SetupServlet.destroy] - Destroying SetupServlet... Shutting down SystemMonitor timers..
DONE.[04-20-2012 14:14:09-335]main Servlet INFO [SetupServlet.destroy] - Destroying
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
233
Troubleshooting
Operational Tools Troubleshooting
SetupServlet... DONE.[04-20-2012 14:14:10-525]ol_Thread-1 Core DEBUG [DebuggableThread.run]
- Exiting SCICARE_UMTThreadPool_Thread-1
Operational Tools Troubleshooting
The following logs are available for troubleshooting the Operational tools:
• Audit logs
• Debug logs
• Error logs
Note
For all operational tools, the logs are written into the Central Log file as defined in $RMS_OPS. The log
files are generated and stored under $RMS_OPS/<time-stamped directory>/logs. However the output
directory location can be overridden by using -outdir option. Please see tools -outdir option for details.
Audit Logs
The path to the log file is printed to the console after the tool execution is complete. The Audit logs capture
the entire tool execution process. The administrator can check the logs to ensure that the tool execution is a
success.
A sample Audit log of the massReboot.sh tool execution is shown below:
$ cat /home/krajain/massReboot.sh/MassReboot-20120906-072717/logs/audit.log
[09-06-2012 07:27:19-376]main Audit INFO [ScriptUtils.initLog4j:428] - Audit log configured
and ready.
[09-06-2012 07:27:19-912]main Audit INFO [BacConnection.initialize:125] - RDU connection
established (host=localhost, port=49187).
.
.
.
Summary Report *****************************************
[09-06-2012 07:27:20-489]main Audit INFO [Category$info.call:?] - Number of successful
Reboots :: 10
[09-06-2012 07:27:20-489]main Audit INFO [Category$info.call:?] - Number of failed Reboots
:: 0
[09-06-2012 07:27:20-489]main Audit INFO [Category$info.call:?] ********************************************************************************
[09-06-2012 07:27:20-490]main Audit INFO [Category$info.call:?] -
Debug Logs
The Debug logs are used for debugging the errors that occur during programming. A sample Debug log of
massReboot.sh tool execution is shown below:
$ cat /home/krajain/massReboot.sh/MassReboot-20120906-090645/logs/debug.log
[09-06-2012 09:06:47-411]main Core INFO [DCCProperties.loadProperties:93] - Property file
/rms/app/rms/conf/dcc.properties loaded.
.
.
.
[09-06-2012 09:06:48-306]PoolWorker3 Threadpool WARN [QueueClosedException.<init>:31] Queue closed exception
[09-06-2012 09:06:48-362]Thread-2 Core INFO [ApplicationInstanceManager$1.run:102] - Script
Cisco RAN Management System Administration Guide, Release 5.0
234
January 7, 2015
Troubleshooting
Using the Logs for Troubleshooting
terminated. Releasing lock.
Error Logs
The Error logs are generated and stored in the $RMS_OPS/<time-stamped directory>/logs by default. If
another output directory is specified in the arguments, then the logs are stored in the specified directory. The
Error logs capture the errors and exceptions causing the tool to terminate. If the tool terminates, the administrator
can check the Error logs for the error details. This facilitates troubleshooting decisions.
Using the Logs for Troubleshooting
The following log files are available in the RMS:
Log
Description / Usage
DCC UI Audit and Debug Logs all DCCUI Operation Logs. Location:
logs
/rms/log/dcc_ui/ui-debug.log
/rms/log/dcc_ui/ui-audit.log
PMG logs
Logs all PMG Processing logs. Location:
rms/log/pmg/pmg-audit.log
/rms/log/pmg/pmg-debug.log
RDU log
Records all RDU events according to the configured logging severity
level.Location:
/rms/data/CSCObac/rdu/logs/rdu.log
To enable this log, use this command on the Central node:
/rms/app/CSCObac/rdu/bin/setLogLevel.sh 6
/rms/app/CSCObac/rdu/bin/setLogLevel.sh 6
Please enter RDU username: bacadmin
Please enter RDU password:<RMS_APP_Password>
Audit log
Records all high-level changes to the Cisco BAC configuration or functionality
including the user who made the change.
Troubleshooting log
Records detailed device information for troubleshooting a specific device.
Troubleshooting logs are enabled from the BACUI (admin UI) as follows:
1 Login to the Admin UI.
2 Search for devices.
3 Click the Identifier.
4 Click on Enable Troubleshooting.
5 Click Submit.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
235
Troubleshooting
Using the Logs for Troubleshooting
Log
Description / Usage
Performance statistics log Records the performance of message statistics related to the system on RDU.
Location:
/rms/data/CSCObac/rdu/logs/statistics
Records the TR-069 messages received and processed by the DPE. Location:
/rms/data/CSCObac/dpe/logs/statistics
DPE logs
Logs DPE activities such as CWMP messages, file download messages, extension
flows, PG re-directs, Lease Query, Proxy operations, and so on. To enable this
log, do the following:
1 Log on to the Serving node.
2 telnet localhost 2323
3 show config
4 log level 6-info
[root@blr-rms12-serving_41N ~]# telnet localhost 2323
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
blr-rms12-serving_41N BAC Device Provisioning Engine
User Access Verification
Password:
blr-rms12-serving> en
Password:
blr-rms12-serving# show config
blr-rms12-serving# log level 6-info
% OK
* Password will be RMS_APP_Password
NR logs
Location:
rms/data/nwreg2/local/logs/name_dhcp_1_log
AR logs
Location:
/rms/app/CSCOar/logs/name_radius_1_trace
To enable this log, use the following command:
/rms/app/CSCOar/usrbin/aregcmd -N admin
/rms/app/CSCOar/usrbin/aregcmd -N admin
Cisco Prime Access Registrar 6.0.1 Configuration Utility
Copyright (C) 1995-2013 by Cisco Systems, Inc. All rights reserved.
Cluster:
Password:
[ //localhost ]
LicenseInfo = PAR-NG-TPS 6.0(100TPS:expires on 11-Sep-2014)
Radius/
Administrators/
Server 'Radius' is Running, its health is 10 out of 10
--> trace 5
Trace level is set to 5
*Password =<RMS_APP_PASSWORD>
Cisco RAN Management System Administration Guide, Release 5.0
236
January 7, 2015
APPENDIX
A
Additional Location Verification Tasks
• Creating Neighbor ID for EDN and DNL, page 237
• Creating Frequency Signature for DNB, page 238
• Adding Files for DNL and ISM from BAC, page 239
• Adding Various LV Related Properties from BAC UI, page 239
• Configuring and Testing Syslog, page 240
Creating Neighbor ID for EDN and DNL
Neighbor ID can be created for:
1 2G (GSM)
2 3G (UMTS)
2G (GSM)
The 2G neighbor identifier comprises:
• PLMN ID (MCC/MNC)
• LAC
• CID
The encoding for a 2G neighbor identifier is defined in a length of 18 characters in the form of
2GCCCNNNLLLLLIIIII
Where,
• 2G - indicates the technology
• CCC - indicates the MCC fixed at 3 characters
• NNN - indicates the MNC fixed at 3 characters (0 prefixed if required)
• LLLLL -indicates the LAC fixed at 5 characters (0 prefixed if required)
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
237
Additional Location Verification Tasks
Creating Frequency Signature for DNB
• IIIII - indicates the CID fixed at 5 characters (0 prefixed if required)
For example, if PLMN ID (MCC/MNC) value is 31011, LAC value is 3332 and CID value is 1233, then the
neighbor ID is 2G3100110333201233
3G (UMTS)
The 3G neighbor identifier comprises:
• PLMN ID (MCC/MNC)
• Cell ID (RNC-ID, CID)
The encoding for a 3G neighbor identifier is defined in a length of 18 characters in the form of
3GCCCNNNRRRRRIIIII
Where,
• 3G - indicates the technology
• CCC - indicates the MCC fixed at 3 characters
• NNN - indicates the MNC fixed at 3 characters (0 prefixed if required)
• RRRRR -indicates the RNC ID fixed at 5 characters (0 prefixed if required)
• IIIII - indicates the CID fixed at 5 characters (0 prefixed if required)
For example, if PLMN ID (MCC/MNC) value is 31011, CellID value is 11111111 ( RNC ID and CID is
derived from CellID as follows: CellID (28bits) = RNC ID (12 bits) + CID (16 bits) ), then the neighbor ID
is 3G3100110016935527.
Creating Frequency Signature for DNB
Frequency Signature for DNB can be created for:
1 2G (GSM)
2 3G (UMTS)
2G (GSM)
• Device.Services.FAPService.{i}.REM.GSM.Cell.{i}.BSIC
• Device.Services.FAPService.{i}.REM.GSM.Cell.{i}.ARFCN
Frequency signature is defined in fixed length of 8 characters in the form AAAAASSS,
Where,
• AAAAA - ARFCN for 2G, fixed at 5 characters, prefix 0 if required.
• SSS - bsicSc (Base Station Identifier) for 2G, fixed at 3 characters, prefix 0 if required.
For example, if ARFCN value is 1020, BSIC value is 55, then the framed frequency signature as per the above
format for 2G cell will be 01020055.
Cisco RAN Management System Administration Guide, Release 5.0
238
January 7, 2015
Additional Location Verification Tasks
Adding Files for DNL and ISM from BAC
3G (UMTS)
• Device.Services.FAPService.{i}.REM.WCDMAFDD.Cell.{i}.RF.UARFCNDL
• Device.Services.FAPService.{i}.REM.WCDMAFDD.Cell.{i}.RF.PrimaryScramblingCode
Frequency signature is defined in fixed length of 8 characters in the form AAAAASSS.
Where,
• AAAAA - ARFCN for 2G or UARFCN for 3G, fixed at 5 characters, prefix 0 if required.
• SSS - Primary Scrambling Code for 3G , fixed at 3 characters, prefix 0 if required.
For example, if UARFCN value is 10201, Primary Scrambling Code value is 222, then the framed frequency
signature as per the above format for 3G cell will be 10201222.
Adding Files for DNL and ISM from BAC
Below are the steps to add the files for DNL and ISM from BAC UI:
1
2
3
4
Note
Log in to BAC UI <https://www.<central-node NB IP>>.
Go to Configuration and Files.
Click Add and select Generic from File Type drop-down menu.
Browse the file and provide the file name and Submit.
The same file name should be provided to the FC-CELL-LOC-FILE or FC-ISM-FILE depending on the
filename provided for DNL or ISM respectively.
Adding Various LV Related Properties from BAC UI
Below are the steps to add any of the custom property through BAC UI for various LV methods:
1
2
3
4
5
6
7
8
Log in to BAC UI.
Go to Groups.
From Search Type drop-down select Group.
From Group Type drop-down select the group type in which the properties needs to be added and click
Search (for example, to add properties at area level then select the group type as Area).
Click on the group in which the properties needs to be added.
Click on the Group name, scroll-down to the end of the page, and select the property which needs to be
added from the drop-down list .
After selecting the property, provide the value and click Add.
After all the parameter and their respective values are added, click Submit.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
239
Additional Location Verification Tasks
Configuring and Testing Syslog
Configuring and Testing Syslog
Consider the Upload Server (ULS) as a centralized syslog server that receives system logs from the Central
and Serving Nodes.
• Central node eth0 IP - 10.5.1.55
• Serving node eth0 IP - 10.5.1.56
• Upload node eth0 IP - 10.5.1.58
Configuring Upload Node as Centralized Syslog Server
1 Edit /etc/rsyslog.conf file as below:
Uncomment the below lines:
# Provides UDP syslog reception
#$ModLoad imudp.so
#$UDPServerRun 514
# Provides TCP syslog reception
#$ModLoad imtcp.so
#$InputTCPServerRun 514
Add the below lines :
# Template to generate the log filename dynamically, depending on the client's IP address.
$template FILENAME,"/var/log/%fromhost-ip%/syslog.log"
# Log all messages to the dynamically formed file.
*.* ?FILENAME
2 Restart the rsyslog process after making changes to the file using the below command.
service rsyslog restart
3 Edit the firewall setting to allow UDP packets on port 514.
iptables -I INPUT -p tcp --dport 514 -j ACCEPT
iptables -I INPUT -p udp --dport 514 -j ACCEPT
service iptables save
Configuring Central and Serving Nodes to Send Logs to Upload Node
The below steps should be executed on the Central and Serving node if logs are required from both the nodes.
1 Edit /etc/rsyslog.conf file as below.
Add the below line under "#### RULES ####" section(the ip is the eth0 Ip of the upload node which is
acting as syslog server:
*.* @10.5.1.58
Uncomment the below line under "# ### begin forwarding rule ###" section and give the upload node
eth0 IP.
*.* @@10.5.1.58:514
2 Restart the rsyslog process after making changes to the file using the below command.:
service rsyslog restart
3 Edit the firewall setting to allow udp packets on port 514 (source IP is central node eth0 IP and destination
IP is upload node eth0 IP).
iptables -A OUTPUT -s 10.5.1.56/32 -d 10.5.1.58/32 -o eth0 -p udp -m udp --dport 514 -m
state --state NEW -j ACCEPT
Cisco RAN Management System Administration Guide, Release 5.0
240
January 7, 2015
Additional Location Verification Tasks
Configuring and Testing Syslog
Verifying Logs on Upload Node
1 On Upload node navigate to /var/log folder and check if a folder is created with IP address of the Central
and Serving nodes.
2 Restart the bprAgent process on the Central and Serving nodes. The syslog.log file should be seen under
the /var/log/<IP-address>. For example, tail -f /var/log/10.5.1.55/syslog.log.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
241
Additional Location Verification Tasks
Configuring and Testing Syslog
Cisco RAN Management System Administration Guide, Release 5.0
242
January 7, 2015
Glossary
Configurable Parameters Terminology
Listed here is the GDDT configuration category for each RMS configurable parameter.
Parameter
Description
DeviceParameter
Retrieves a standard device parameter for which BAC defined and API
constant and/or property name.
DeviceProperty
Retrieves “custom” device properties such as CPE properties and
discovered CPE parameters stored in the RDU DB.
PropertyHierarchy
Retrieves a property from the device property hierarchy. The property
is first looked up on device. If not found, it is looked up on groups as
per group type priority in BAC. The group with less group type priority
is the first group to be searched. Then, Provisioning Group, Class of
Service, and finally Technology Defaults object. This is the same property
hierarchy that is used by BAC when processing templates and looking
for a device property.
NodeProperty{GroupType}
Retrieves a property from the Group of “GroupType” associated with the
device.
LiveParameter
Retrieves a specific TR-069 parameter from the CPE. The list of
supported TR-069 parameters is published separately with each release
of the CPE firmware.
Bulk Status Report Terminology
Reports use the following terminology in reference to AP provisioning system states:
Term
Description
Registered AP
An AP for which device record exists in BAC. This means that the
customer has registered his FAP via the web portal. The record about
registered APs is removed from BAC when AP service is shutdown.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
243
Glossary
Term
Description
APs Assigned to Gateway
A number of registered FAPs which are assigned to a given FGW in
BAC. During registration, the SecGW and FGW for the FAP get selected.
The AP is not aware of the assignment until it contacts the BAC and gets
provisioned for the first time (Bootstrapped AP).
Bootstrapped AP
A registered AP that already made the first contact with the start-up DPE,
was redirected to home DPE and successfully completed it is first session
with the home DPE. A bootstrapped FAP gets configured with baseline
configuration which includes the location of the SeGW and FGW.
Following the bootstrap process, the FAP shall maintain a persistent
IPSec tunnel with SecGW and a persistent Iuh connection with the FGW.
The information about bootstrapped APs is retrieved from BAC.
Non-bootstrapped AP
A Registered AP which has not yet completed the Bootstrap process.
OSS-activated AP
An AP for which Activate message was received from the OSS. Such
devices have the FC-ACTIVATED=true property set in BAC.
AP Pending OSS Activation
A bootstrapped AP which passed location verification checks and for
which AssignCGI message was sent to the OSS, but no Activate message
was received yet.
AP Disabled Due to Service Block An AP which was not allowed to enable Femto service because the
service was administratively blocked by the OSS (such as AT&T
Snooper) via blockService command.
Enabled AP (prov status)
An AP which was instructed to turn the Femto service on
and radiate during the last contact with the provisioning system. This
status is retrieved from the provisioning systems.
AP Disabled due to Tampering
An AP which could not be enabled for service during its last contact with
the provisioning system due to tampering.
AP Disabled due to GPS Lock
Error
An AP which could not be enabled for service during its last contact with
the provisioning system due to inability to lock GPS satellites.
AP Disabled due to GPS
Tolerance Issue
An AP which could not be enabled for service during its last contact with
the provisioning system due to reported GPS location being too far from
the expected or authorized location.
AP Disabled due to Provisioning An AP for provisioning system error occurred during its last with the
Error
provisioning system.
AP Firmware Version
The AP firmware version is the version of the current firmware reported
by the AP during its last contact with the provisioning system. If the AP
was instructed to download a new firmware version, but has not yet
reported running on a new version, the last reported version is used in
reports.
Cisco RAN Management System Administration Guide, Release 5.0
244
January 7, 2015
Glossary
Reports use the following terminology in reference to AP live status system states:
Term
Description
Connected AP
An AP that was connected to the FGW when report was generated. Any
bootstrapped FAP should maintain a persistent connection to the FGW,
but such connection does not mean that AP has been activated for service.
AP Operational
An AP which has the radio operational and is providing the Femto service.
Note that when radio is suspended for NWL, the AP is not considered
operational. This is the current live status retrieved from AP or FGW
when report was generated.
Enabled AP (live status)
An AP which was instructed to turn the Femto service on
. This status is retrieved from the live AP (if online) when report is
generated.
Note
Tampered AP (live status)
An AP that is flagged as tampered according to the live status retrieved
from AP when report was generated.
AP Offline
An AP which was bootstrapped and therefore should be connected to
AC, but which did not respond to connection requests when report was
generated.
AP Live Firmware
The AP firmware reported by AP when report was generated.
AP Offline
The AP did not respond to connection request when report was generated.
Service Enabled state is also referred to as "administrative state unlocked" in OMCR.
Cisco RAN Management System Administration Guide, Release 5.0
January 7, 2015
245
Glossary
Cisco RAN Management System Administration Guide, Release 5.0
246
January 7, 2015