device command and control - cisco · device command and control • dccoverview,page1 •...

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 5

• Configuring the DCC Dashboard, page 10

DCC OverviewTheDevice Command andControl (DCC) application is the user interfacewithin the CiscoRemoteManagementSystem (RMS) that provides operation, administration and management of 3G access points. It is a collectionof tools and contains both a graphic user interface (GUI) and a command line interface (CLI). It enables thefollowing functions:

• Device data export

• Upgrade monitoring

• Device group management

• Single device management for troubleshooting

• Mass connection request and reboot

• SAI pool management

DCC UI RequirementsThe DCC UI is supported on the following browser:

• Mozilla Firefox Version 16.0.1 and above.

Cisco RAN Management System Administration Guide, Release 4.x OL-32398-01 1

Device Manager User Roles and PermissionsTo access the various device manager operations you must have the correct permission. Your permissionsdetermine which functionality you have within the system.

Table 1: Device Manager Functionality According to User Permissions

User Permission Allows FunctionalityOperationFunctionality

Read-write AdvancedRead-write BasicRead-only

YesYesYesDashboardView

Yes——Live Data

YesYes—UpdateProvision

YesYes—Shutdown

Yes——Log Upload Triggers

YesYes—Static Neighbors

YesYes—Device Replacement

YesYes—Connection RequestPerform

YesYes—On-Demand Log Upload

YesYes—Reboot

YesYes—Factory Reset

Yes——Set Live Data

Yes——Set Modified Live Data

YesYes—Register a DeviceRegister

The three access levels restrict basic users to access advanced operations that require knowledge of deviceparameters. 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 additionto the Read Only operations.

• Read Write Advanced: Allows access to advanced operations such as View/Set Live Data, ModifiedLive Data, Log upload triggers and so on in addition to the Read Write Basic operations. This is meantfor a user with advanced knowledge.

Cisco RAN Management System Administration Guide, Release 4.x2 OL-32398-01

Device Command and ControlDevice Manager User Roles and Permissions

Information About the DCC UIThe DCC UI presentation framework has a generic design and layout. All the applications hosted on thisframework use this layer for display. The common elements like the header, application navigation, andprimary navigation are available to all the applications installed on this framework. The application navigationis displayed below the header. All the installed and enabled applications that are approved are displayed inthis 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 toeasily navigate through the device data model and view values.


Device Command and ControlInformation About the DCC UI

Some of the components of the device manager are located on the same machine, and the communicationwith the CPE occurs through Provisioning Management Gateway (PMG), and Broadband Access CenterRegional Distribution Unit (BAC RDU).

Upgrade Monitor

The Upgrade Monitoring Tool (UMT) is a web based tool that supports multiple users concurrently viewinga single monitoring job or executing multiple monitoring jobs. The tool is able to efficiently scale by receivingreal 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.

Admin

Admin allows you to manage Users and Roles without having to access the DCC UI Admin User Interfacedirectly.

Configuration

Configuration allows you to manage global level configuration of devices in BAC RDU for properties suchas DN Prefix Format. This tab is disabled by default and can be enabled by updating 'superuser' role fromAdmin tab->Roles.

Logging In to the DCC-UIThe 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 thepassword policy. The new password must be minimum 8-16 characters long and alphanumeric, should bemixed case, should contain one of the special characters(*,@,#) and no spaces.

Procedure

Step 1 Navigate to the DCC-UI application URL. Below is a sample url:https://central node eth1 IP address/dcc_ui/admin/Login.do

Step 2 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 defaultpassword and is prompted to enter a new password.

For the new user changing the password is a must to log in to the DCC UI application. With thedefault password user cannot log in to the application.

Note

Step 3 Enter the existing and new password as requested and click Save. After entering the new password theapplication 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 thepassword policy.


Device Command and ControlLogging In to the DCC-UI

A popup is displayed that requests the user for which you are changing the password. This is a browser featureand not triggered through the DCC UI.

Figure 2: Confirm Password Change Dialog

In order to disable this popup, the password history needs to be disabled for the browser through the browseroptions.

If you are an application administrator for a specific application, the specific application page displayson successful login.

If the login credentials fail to authenticate, you are returned to the login page with a failure message.

Note

DCC UI Session expiry: The session times out if the period of inactivity exceeds the time limit set for theDCC UI. If you try to access the page after the session has expired, then you are navigated back to the loginpage. The session timeout period is 45 minutes.

DCC UI Input Validation: As part of security feature XSS implementation, invalid data such as script tagsor 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 BoxesThe dialog boxes of the Device Command and Control user interface can be customized according to yourneeds. Each of the dialog boxes is controlled via an xml file contained in the/rms/app/rms/conf directory.For example, the xml file for the dialog box for registering a device in Residential mode is named assdm-register-residential-screen-setup.xml and for Enterprise mode is named assdm-register-enterprise-screen-setup.xml. You can open this file in an xml or text editor and changeit as necessary to customize the dialog box for your needs. The xml file for the update screen for registeringa device in Residential mode is named as sdm-update-residential-screen-setup.xml, and for Enterprisemode is named assdm-update-enterprise-screen-setup.xml.

This is an example of the sdm-register-residential-screen-setup.xml file:

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

<!--This file is the confidential information and proprietary trade secretof Cisco Systems, Inc. Possessions and use of this program must conformstrictly to the license agreement between the user and Cisco Systems,Inc., and receipt or possession does not convey any rights to divulge,


Device Command and ControlConfiguring DCC Dialog Boxes

reproduce, or allow others to use this program without specific writtenauthorization 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&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&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><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>

<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>

The DCC UI exposes xml files which the customer can modify to build their user interface.Note

Dynamic Screen Configuration FilesThis table lists the xml files that are used to customize the associated DCC UI screens with additionalparameters. The complete list of configurable parameters that can be used is provided in the RMSConfigurableParameters for Release 4.0 document.

Folder PathXML FilenameDCC UI AreaDCC UI Dialog Box

rms/app/rms/confsdm-register-enterprise-screen-setup.xmlDeviceManagerDeviceRegistration—Enterprise

rms/app/rms/confsdm-register-residential-screen-setup.xmlDeviceManagerDeviceRegistration—Residential

rms/app/rms/confsdm-update-enterprise-screen-setup.xmlDeviceManagerUpdate DeviceRegistration—Enterprise

rms/app/rms/confsdm-update-residential-screen-setup.xmlDeviceManagerUpdate DeviceRegistration—Residential

rms/app/rms/confsdm-inter-freq-static-neighbors.xmlDeviceManagerInter-FrequencyNeighbors

rms/app/rms/confsdm-inter-rat-static-neighbors.xmlDeviceManagerInter-RAT Neighbors

rms/app/rms/confsdm-static-neighbors-filter-screen-setup.xmlDeviceManagerUpdate Static NeighborsFilter

rms/app/rms/confumt-setup.xmlUpgradeMonitor

Add Firmware Type

rms/app/rms/confumt-config.xmlUpgradeMonitor

Add Firmware Version


Device Command and ControlDynamic Screen Configuration Files

Folder PathXML FilenameDCC UI AreaDCC UI Dialog Box

rms/app/rms/confuploadServers.xmlDeviceManagerLog Uploads andTriggers

Copy the xml file to/rms/app/rms/confdirectory from/rms/app/rms/doc/config/sampledirectory and makeappropriatechanges.

deviceParamsDisplayConfig.xmlDeviceManagerDashboard Display

rms/app/rms/confbgmt-add-group-screen-setup-Area.xmlGroups and IDsAdd Area Instance

rms/app/rms/confbgmt-add-group-screen-setup-Enterprise.xmlGroups and IDsAdd Enterprise Instance

rms/app/rms/confbgmt-add-group-screen-setup-FemtoGateway.xmlGroups and IDsAdd FemtoGatewayInstance

rms/app/rms/confbgmt-add-group-screen-setup-RFProfile.xmlGroups and IDsAdd RF Profile Instance

rms/app/rms/confbgmt-add-group-screen-setup-Site.xmlGroups and IDsAdd Site Instance

rms/app/rms/confbgmt-add-group-screen-setup-SAI-POOL.xmlGroups and IDsAddSAI-POOL Instance

rms/app/rms/confbgmt-add-group-screen-setup-CELL-POOL.xmlGroups and IDsAdd CELL-POOLInstance

Adding or Updating Fields in the Group Dialog BoxUse this task to make fields available in the Add/Update group dialog box.

Procedure

Step 1 Create a file named 'bgmt-add-group-screen-setup-<groupTypeName>.xml' in the /rms/app/rms/conf directory.Step 2 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. Thebgmt-add-group-screen-setup-Area.xml and bgmt-add-group-screen-setup-FemtoGateway.xml are availablein /rms/app/rms/doc/config/sample for reference.

Step 4 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 tooltipmessages. Values for each field can be validated by setting a regular expression on textbox value.

Step 5 Restart the DCC UI application, so that it can pick up the new configuration file. Further changes made tothis file will be automatically reloaded by DCC UI after one minute.

Step 6 Open the add/update group screen. The screen should contain dynamically added input elements for all theconfigured properties as per the xml. If it does not, check for file loading/validation errors in DCC UI debug


Device Command and ControlAdding or Updating Fields in the Group Dialog Box

log. Also the headers in the grid inside Groups main page should show labels configured inside XML insteadof property names.

Step 7 If you get an 'Unknown Parameter' error while adding/updating group with property values, make sure it isconfigured in pmg-profile.xml so that PMG can recognize them. The sample PMG files (configs, xmls, andxsds) 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 PMGmaintains 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 DashboardThe Dashboard (combined view) can be configured dynamically with the help of a sample XML file presentin RMS. The sample file deviceParamsDisplayConfig.xml contains the default contents of the Dashboardscreen 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 centralnode 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 yourneeds.

This is an example of the deviceParamsDisplayConfig.xml file:<?xml version="1.0" encoding="UTF-8"?><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>


<source>group_parameter</source><key>FemtoGateway:FC-MNC</key><displayName>MNC</displayName>


<source>parameters</source><key>FC-LAC-ID</key><displayName>LAC ID</displayName>



Device Command and ControlConfiguring the DCC Dashboard

<source>group_parameter</source><key>FemtoGateway:FC-RNC-ID</key><displayName>RNC ID</displayName>


<source>parameters</source><key>FC-SAC-ID</key><displayName>SAC ID</displayName>


<source>parameters</source><key>CELL-CONFIG-RAN-CELL-ID</key><displayName>Cell ID</displayName>


<source>access_control</source><key>AccessMode</key><displayName>AccessMode</displayName>

</parameter><parameter>

<source>group_parameter</source><key>FemtoGateway:FC-PROV-GRP-NAME</key><displayName>Provisioning Group</displayName>


<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>


<source>parameters</source><key>FC-FIRST-RADIO-ON</key><displayName>First Radio On</displayName>


<source>element</source><key>LocationValid</key><displayName>Location Valid</displayName><defaultValue>false</defaultValue>


<source>element</source><key>LocationValidTS</key><displayName>Location Valid Timestamp</displayName>


<source>location_status</source>

<key>DNMStatus</key><displayName>DNM Location Status</displayName>


<source>location_status</source><key>DNMStatusTS</key><displayName>DNM Location Status Timestamp</displayName>


<source>parameters</source><key>FC-EDN-STATUS</key><displayName>Detected Neighbors Status</displayName>


<source>parameters</source><key>REPORTED-BANDS-SUPPORTED</key><displayName>Bands Supported</displayName>


<source>parameters</source><key>REPORTED-MAX-TX-POWER</key><displayName>Max Transmission Power</displayName>


<source>parameters</source><key>REPORTED-GPS-CAPABILITY</key><displayName>GPS Capability</displayName><format>int_to_boolean</format>


<source>element</source><key>BLOCKED</key><displayName>Blocked</displayName>


<source>parameters</source><key>FC-CSON-STATUS-HANR</key><displayName>QSS optimization status for HANR</displayName>


<source>parameters</source><key>FC-CSON-STATUS-HSCO-M2F</key><displayName>QSS optimization status for HSCO M2F</displayName>


<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>


<source>parameters</source><key>/cwmp/discovered/Inform.DeviceId.ManufacturerOUI</key><displayName>Manufacturer OUI</displayName>

</parameter>

<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>



<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.SoftwareVersion</key><displayName>Software Version</displayName>



<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.X_00000C_3GModuleVersion</key><displayName>3G Module Version</displayName>



<key>/cwmp/discovered/InternetGatewayDevice.DeviceInfo.X_00000C_RouterModuleVersion</key><displayName>Router Module Version</displayName>



<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>


<source>groups</source><key>Site</key><displayName>Site</displayName>


<source>groups</source><key>Area</key><displayName>Area</displayName>


<source>groups</source><key>RFProfile</key><displayName>RF Profile</displayName>


<source>element</source><key>Activated</key><displayName>Activated</displayName>


<source>parameters</source><key>FC-LOG-PERIODIC-UPLOAD-ENABLE</key><displayName>Periodic Log Upload Enabled</displayName>


<source>parameters</source><key>FC-LOG-PERIODIC-UPLOAD-INTERVAL</key><displayName>Periodic Log Upload Interval</displayName>


<source>parameters</source><key>FC-AP-ROLE</key><displayName>Role</displayName>




<source>parameters</source><key>FC-AP-PURPOSE</key><displayName>Purpose</displayName>


<source>parameters</source><key>FC-RESERVED-MODE</key><displayName>Reserved Mode</displayName>


<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>


<key>Alias.FAPService.FAPControl.OpState</key><format>int_to_boolean</format>


<key>Alias.FAPService.FAPControl.RFTxStatus</key><format>int_to_boolean</format>


<key>Alias.DeviceInfo.HardwareVersion</key></parameter>

<parameter><key>Alias.DeviceInfo.SoftwareVersion</key>

</parameter></LiveParameterList>

Following is an example explaining how to add a new parameter, "JOB ID" to the "Assigned Data" sectionin 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 DCCUI, and verify whether the newly added parameter JOB ID has been updated in the Assigned

Data section of the device dashboard.

If a configured parameter is not set for a particular device, it will not be visible in the Dashboard.Note

device command and control - cisco · device command and control • dccoverview,page1 •...

Documents