Device Command and Control

Device Command and Control
Device Command and Control
• DCC Overview, page 1
• DCC UI Requirements, page 1
• Device Manager User Roles and Permissions, page 2
• Information About the DCC UI, page 3
• Logging In to the DCC-UI, page 4
• Configuring DCC Dialog Boxes, page 6
• Configuring the DCC Dashboard, page 12
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 and LTE 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
• 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.1 MR
1
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 Read-write
Basic
View
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
Delete Device
—
—
Yes
Static Neighbors
—
Yes
Yes
Device Replacement
—
Yes
Yes
Connection
Request
—
Yes
On-Demand Log
Upload
—
Yes
Yes
Reboot
—
Yes
Yes
Factory
Recovery/Reset
—
Yes
Yes
Set Live Data
—
—
Yes
Set Modified
Live Data
—
—
Yes
Cell Traffic
Trace
Configuration
—
—
Yes
—
Yes
Yes
Provision
Perform
Register
Register a Device
Yes
The three access levels restrict basic users to access advanced operations that require knowledge of device
parameters. The levels of access are:
Cisco RAN Management System Administration Guide, Release 5.1 MR
2
Device Command and Control
Information About the DCC UI
• 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, Delete Device, Reset, Static neighbours, CR, On demand log upload and so on in
addition to the Read Only operations.
• 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 1: 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 the Provisioning Management Gateway (PMG and Broadband Access Center
Regional Distribution Unit (BAC RDU).
Cisco RAN Management System Administration Guide, Release 5.1 MR
3
Device Command and Control
Logging In to the DCC-UI
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.
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:
DCC UI does not allow the change of the password if any of three consecutive character (substring or pattern)
matches with the previous password. Also, the DCC-UI does not allow the password to be changed to any
one of the previous five used passwords. The new password must be must be a minimum of 8 but not more
than 127 characters long. It should be alphanumeric, should contain a mixed case, at least one of the special
characters(*,@,#), and no spaces.
DCC UI User Login Information:
The DCC UI displays the last successful and failed login time stamps of each user. It also displays the username,
user role, the 'Change Password', 'Log Out', and 'About' options in addition to the 'Last Successful Login' and
'Last Failed Login' time.
DCC UI Warning Banner:
A Warning Banner is shown in the login page and after successful login. The content in the Warning Banner
is configurable. The configuration file "warning_banner.msg" needs to maintained in the
/rms/app/rms/conf directory. The file should have 'ciscorms' group and user permissions. The filename
should be updated in the dcc.properties file, if it is different from the default filename. The dcc.properties file
has the below property by default :
warning.message.filename=warning_banner.msg
The sample warning message file is present at this path:
/rms/app/rms/doc/config/sample/warning_banner.msg
The default content of the Warning Banner message is as follows:
WARNING! This computer system and network is PRIVATE and PROPRIETARY and may only be accessed
by
authorized users. Unauthorized use of this computer system or network is strictly prohibited
and may be
subject to criminal prosecution, employee discipline up to and including discharge, or the
termination of
vendor/service contracts. The owner, or its agents, may monitor any activity or communication
on the
computer system or network. The owner, or its agents, may retrieve any information stored
within the
computer system or network. By accessing and using this computer system or network, you are
consenting to
such monitoring and information retrieval for law enforcement and other purposes. Users
should have no
expectation of privacy as to any communication on or information stored within the computer
system or
Cisco RAN Management System Administration Guide, Release 5.1 MR
4
Device Command and Control
Logging In to the DCC-UI
network, including information stored locally or remotely on a hard drive or other media
in use with this
computer system or network.
DCC UI User Password Expiration Warning
• You can login to the DCC UI and access the Dashboard until password expiration time frame starts.
• When the password expiration time frame begins, that is, after a warning message is displayed, "Your
Password is going to expire in 3 days", change your password in the DCC UI Dashboard after you log
in.
• When your password expires, that is, after the "UserPasswordExpiryTime" has passed, there is a grace
period that is provided (UserPasswordGraceTimePeriod).
You must change your password before the session is allowed to proceed. After the password is changed
, the session continues normally.
• After the ‘UserPasswordGraceTimePeriod’, your access is locked and no user operations are allowed to
be performed. User access can be re-enabled only by an administrator.
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.
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.
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.
Cisco RAN Management System Administration Guide, Release 5.1 MR
5
Device Command and Control
User Account Suspension
User Account Suspension
RMS has the capability to lock a user after a specified time interval ('UserSuspensionTimeInterval'), if the
user does not access the DCC UI to perform any activity during the defined time interval. The default user
suspension time interval is 30 days. The supported range for user suspension is 20 to 60 days. Only the System
Administrator has the capability to unlock the locked user.
The default user suspension time interval can be configured in the dcc.properties file. The
'UserSuspensionTimeInterval' property is not available in the dcc.properties file by default. The property
details are as follows :
rms.user.max.allowed.inactivity.period.days=30
The User Account Suspension lock is not applicable to default RMS users.
User Session Lock Out on Failed Authentication Attempts
DCC UI is responsible for the user session lock-out or suspension if there are consecutive failed login attempts.
The threshold for failed login attempts is five. When the 'UserAccessTempLockTime' threshold is reached,
the user is locked out for 15 minutes. The 'UserAccessTempLockTime' property is configurable and can range
from 5 to 60 minutes.
The threshold for consecutive failed login attempt as well as the temporary lock time period can be configured
in the dcc.properties file. The 'UserAccessTempLockTime' property is not available in the dcc.properties file
by default. The property details are as follows:
rms.user.access.temp.lock.time.minutes=15
rms.user.max.allowed.consecutive.login.failures=5
The valid range for the 'rms.user.max.allowed.consecutive.login.failures' property is 5 to 15. Temporary lock
out is calculated based on 'failedlogincount' and 'lastloginfailtime' property values. 'lastloginfailtime' and
'failedlogincount' values are cleared after every temporary lock out of a default of 15 minutes. After every
successful login, the 'failedlogincount' is reset.
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
in the Central node. 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 of a device is also named in similar format sdm-update-< DeviceType >-<
DeviceMode >-screen-setup.xml. The xml files are as follows:
• UMTS Residential mode : sdm-update-UMTS-residential-screen-setup.xml
Cisco RAN Management System Administration Guide, Release 5.1 MR
6
Device Command and Control
Dynamic Screen Configuration Files
• UMTS enterprise mode : sdm-update-UMTS-enterprise-screen-setup.xml
• LTE residential mode : sdm-update-LTE-residential-screen-setup.xml
• LTE enterprise mode : sdm-update-LTE-enterprise-screen-setup.xml
For an example of the sdm-register-UMTS-residential-screen-setup.xml file see Example of
sdm-register-UMTS-residential-screen-setup.xml, on page 10.
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
Directory Name
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
Inter-Frequency
Neighbors
Device Manager sdm-UMTS-inter-freq-static-neighbors.xml /rms/app/rms/conf
Update UMTS Device Device Manager sdm-update-UMTS-residential-screen-setup.xml /rms/app/rms/conf
Registration-Residential
Update UMTS Device
Registration-Enterprise
Device Manager sdm-update-UMTS-enterprise-screen-setup.xml /rms/app/rms/conf
Update LTE Device
Device Manager sdm-update-LTE-residential-screen-setup.xml /rms/app/rms/conf
Registration-Residential
Update LTE Device
Registration-Enterprise
Device Manager sdm-update-LTE-enterprise-screen-setup.xml /rms/app/rms/conf
Cisco RAN Management System Administration Guide, Release 5.1 MR
7
Device Command and Control
Dynamic Screen Configuration Files
DCC UI Dialog Box
DCC UI Area
XML Filename
Directory Name
Inter-RAT Neighbors
Device Manager sdm-UMTS-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
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 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
Neighbor List In Use
Device Manager neighborListParamsDisplayConfig.xml
Inter-rat GSM Static
Neighbors
Device Manager sdm-LTE-inter-rat-gsm-static-neighbors.xml /rms/app/rms/conf
Inter-rat UMTS Static
Neighbors
Device Manager sdm-LTE-inter-rat-umts-static-neighbors.xml /rms/app/rms/conf
LTE Cell Static
Neighbors
Device Manager sdm-LTE-inter-rat-lte-static-neighbors.xml /rms/app/rms/conf
Add Area Instance in
UMTS Only
Deployment
Groups and IDs bgmt-add-group-screen-setup-Area-UMTS.xml /rms/app/rms/conf
Add Area Instance in
LTE Only Deployment
Groups and IDs bgmt-add-group-screen-setup-Area-LTE.xml /rms/app/rms/conf
Add Area Instance in
Mixed Deployment
Groups and IDs bgmt-add-group-screen-setup-Area-MIXED.xml /rms/app/rms/conf
Cisco RAN Management System Administration Guide, Release 5.1 MR
8
/rms/app/rms/conf
Device Command and Control
Adding or Updating Fields in the Group Dialog Box
DCC UI Dialog Box
DCC UI Area
XML Filename
Directory Name
Add HeNB Gateway
Instance
Groups and IDs bgmt-add-group-screen-setup-HeNBGW.xml /rms/app/rms/conf
Add LTE SecGateway
Instance
Groups and IDs bgmt-add-group-screen-setup-LTESecGateway.xml /rms/app/rms/conf
Add UMTS SecGateway Groups and IDs bgmt-add-group-screen-setup-UMTSSecGateway.xml /rms/app/rms/conf
Instance
Add LTE RFProfile
Instance
Groups and IDs bgmt-add-group-screen-setup-RFProfile-LTE.xml /rms/app/rms/conf
Add Region Instance
Groups and IDs bgmt-add-group-screen-setup-Region.xml /rms/app/rms/conf
Add Subsite Instance
Groups and IDs bgmt-add-group-screen-setup-SubSite.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.
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.
Cisco RAN Management System Administration Guide, Release 5.1 MR
9
Device Command and Control
Example of sdm-register-UMTS-residential-screen-setup.xml
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.
Example of sdm-register-UMTS-residential-screen-setup.xml
<?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>
Cisco RAN Management System Administration Guide, Release 5.1 MR
10
Device Command and Control
Example of sdm-register-UMTS-residential-screen-setup.xml
<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>
<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>
Cisco RAN Management System Administration Guide, Release 5.1 MR
11
Device Command and Control
Configuring the DCC Dashboard
<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>
<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>
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.
To see an example of the deviceParamsDisplayConfig.xml file, refer to Example of
deviceParamsDisplayConfig.xml, on page 14.
Cisco RAN Management System Administration Guide, Release 5.1 MR
12
Device Command and Control
Example of Adding a New Parameter to Assigned Data
Example of Adding a New Parameter to Assigned Data
This procedure shows how to add a new parameter "JOB ID" to the Assigned Data section in the DCC
Dashboard.
Procedure
Step 1
Log in to the central node as a root user.
Step 2
Copy the file deviceParamsDisplayConfig.xml to the /rms/app/rms/conf
Step 3
Open the file using the VI editor and edit the parameters as shown in this example:
<parameter>
<source>parameters</source>
<key>FC-JOB-ID</key>
<displayName>JOB ID</displayName>
</parameter>
Step 4
Step 5
Save the changes using the command: :wq!.
Log in to the DCC UI, and verify whether the 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 is not visible in the Dashboard.
Example of Adding A Parameter to Live Data
This procedure describes how to add a new parameter, "OnDemand.URL" to the Live Data section of the
DCC UI Dashboard.
Procedure
Step 1
Step 2
Log in to central node as a root user.
Copy the file deviceParamsDisplayConfig.xml to the /rms/app/rms/conf folder.
Step 3
Open the file using the VI editor and add the parameter key as shown here:
<LiveParameterList>
<parameter>
<key>Alias.Device.X_00000C_LogUpload.OnDemand.URL</key>
</parameter>
Step 4
Step 5
Save the changes using the command: :wq!.
Add a key value pair as described here to one of the livedata-alias properties files:
• If the parameter is Ubiquisys device specific, add the key value pair,
Alias.Device.X_00000C_LogUpload.OnDemand.URL=InternetGatewayDevice.
Cisco RAN Management System Administration Guide, Release 5.1 MR
13
Device Command and Control
Example of deviceParamsDisplayConfig.xml
Services.FAPService.1.X_UBIQUISYS_COM_Diagnostics.PostEventUploadURL,
to the livedata-alias-UMTS.properties file in /rms/app/rms/conf/.
• If the parameter is 4G-LTE device specific, add this key value with the value set to an actual device
level parameter name, into the livedata-alias-LTE.properties file in /rms/app/rms/conf/.
• If the parameter is applicable to both Ubiquisys and 3G-LTE devices, add this key specified in
deviceParamsDisplayConfig.xml with the value set to an appropriate device level parameter name, into
both the livedata-alias property files.
Step 6
Log in to the DCC UI, and verify that the new parameter
"InternetGatewayDevice.Services.FAPService.1.X_UBIQUISYS_COM_Diagnostics.PostEventUploadURL"
has been updated in the Live Data section of the device dashboard.
Example of deviceParamsDisplayConfig.xml
<?xml version="1.0" encoding="UTF-8"?>
<!-$Id$
***************************************************************************
* CISCO CONFIDENTIAL
* 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>
Cisco RAN Management System Administration Guide, Release 5.1 MR
14
Device Command and Control
Example of deviceParamsDisplayConfig.xml
</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>
<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>
Cisco RAN Management System Administration Guide, Release 5.1 MR
15
Device Command and Control
Example of deviceParamsDisplayConfig.xml
<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>
<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>
Cisco RAN Management System Administration Guide, Release 5.1 MR
16
Device Command and Control
Example of deviceParamsDisplayConfig.xml
<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>
<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>
Cisco RAN Management System Administration Guide, Release 5.1 MR
17
Device Command and Control
Example of deviceParamsDisplayConfig.xml
</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>
</parameter> -->
</LiveParameterList>
Cisco RAN Management System Administration Guide, Release 5.1 MR
18
Was this manual useful for you? yes no
Thank you for your participation!

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

Download PDF

advertising