Operational Tools

Operational Tools
Operational Tools
The following tools are available to facilitate ease of operation:
• 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".
• 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.
• On-Demand NWL— Triggers on-demand NWL for the CPEs requested.
• 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>.
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
1
Operational Tools
massCr.sh
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
• massCr.sh, page 2
• massReboot.sh, page 5
• getDeviceData.sh, page 8
• encryptPassword.sh, page 12
• searchAndExport.sh, page 12
• reassignDevices, page 14
• resync.sh, page 16
• massFactoryRestore.sh, page 17
• Operational Tools for PMGDB, page 20
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.
Cisco RAN Management System Administration Guide, Release 4.x
2
OL-32398-01
Operational Tools
massCr.sh
-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.
-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.
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).
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
3
Operational Tools
massCr.sh
-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 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 10 -retries 1
Params:
Rate :: 10
Retries :: 1
Threads :: 10
Output Directory :: /home/krajain/massCr.sh/MassConnectionRequest-20120906-072000
** Please note this tool will request ConnectionRequest @ 10devices/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.
Cisco RAN Management System Administration Guide, Release 4.x
4
OL-32398-01
Operational Tools
massReboot.sh
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
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.
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
5
Operational Tools
massReboot.sh
-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.
-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
Optional. If specified, the tool executes irrespective of other ops tools currently running.
Cisco RAN Management System Administration Guide, Release 4.x
6
OL-32398-01
Operational Tools
massReboot.sh
Usage Guidelines
Note
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:
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:
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
7
Operational Tools
getDeviceData.sh
/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>] [noSubdir][-useBackup <dir>|
-useExport <file>] [-saveExport <file>] [-idfile <file> -type <listType] [-rate <num>] [-timeout <num>]
[-liveThreads <num>] -help -force
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.
-noSubdir
Optional. If this argument is specified, no subdirectory
is created under the directory specified by -outdir
argument. If the argument is not specified, then the
output files are written to a subdirectory which is created
under the directory specified by -outdir (The subdirectory
name will be gddt followed by timestamp. For example:
gddt-20100503-092608).
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.
Cisco RAN Management System Administration Guide, Release 4.x
8
OL-32398-01
Operational Tools
getDeviceData.sh
-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.
-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 10000 ops/min.
-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.
-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.
-force
Optional. If specified, the tool executes irrespective of
other ops tools currently running.
Usage Guidelines
Note
Only one instance of the getDeviceData.sh tool is allowed to execute at a time.
The configuration file defines which parameters and properties the getDeviceData.sh tool should retrieve.
The general syntax of a line is:
<ColumnType>, <SourceName>, <OutputColumnName>[, <Directives>]
The following parameter types are supported:
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
9
Operational Tools
getDeviceData.sh
Column Type
Description
DeviceParameter
This retrieves a standard device parameter for which BAC defined and API
constant and/or property name.
DeviceProperty
This retrieves custom device properties such as CPE properties and
discovered CPE parameters stored in the RDU DB.
PropertyHierarchy
This 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}
This retrieves a property from the Group of "GroupType" associated with
the device.
LiveParameter
This 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. The list can also be obtained via 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>
The following directives are supported:
Directive
Description
MinSwVersion=<version>
This directive is applicable to LiveParameter column types. This can be used
to target retrieval of the value only from CPEs which have a software version
equal to or exceeding the specified one. This allows skipping attempts to
retrieve parameters which would be considered invalid by older versions of
the CPE.
Default=<value>
This directive would force a specific default value if no value was 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.
Cisco RAN Management System Administration Guide, Release 4.x
10
OL-32398-01
Operational Tools
getDeviceData.sh
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 [1] .
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 report generated by the getDeviceData.sh tool is shown below:
Some columns may be empty if a device does not have that many instances.
EID,Area,HNB-GW,RF Profile,Management Group,Bootstrapped,Type=dateTime,Prov Group,Class of
Service,Activated,Service Provisioning Status,Service Provisioning Status Timestamp,First
Radio On,Location Valid,Location Valid Timestamp,DNM Location Status,DNM Location Status
Timestamp,Manufacturer,Model Name,Hardware Version,Software Version,3G Module,Admin State,Op
State,Scan Status,Access Mode,REM Population Method,Tampered
105F49-0015199310,Chile,ChileFGW,ChileRFProfile1,,TRUE,,default,activated-DPH153-LA-v8.7.0,TRUE,Operational,,2013-04-24T06:18:05Z,TRUE,2013-04-24T06:17:24Z,Valid
location,2013-04-24T06:17:22Z,Cisco,DPH153-LA,W3GFP-103X164CL-Rev_1.0,8.7.0,Bootloader:
224_001 180.0; Kernel: 224_002 225.0; Filesys: 224E004
579.9.0_C_870_101,TRUE,FALSE,Success,Open Access,Merge Detected and Static,FALSE
A sample GDDT configuration file generated by the getDeviceData.sh tool is shown below:
DeviceParameter, DeviceDetailsKeys.DEVICE_ID, EID
NodeProperty{Area}, Name, Area
NodeProperty{FemtoGateway}, Name, HNB-GW
NodeProperty{RFProfile}, Name, RF Profile
NodeProperty{Management}, Name, Management Group
DeviceParameter, DeviceDetailsKeys.IS_PROVISIONED, Bootstrapped, Type=boolean
DeviceProperty, /IPDevice/homeProvGroup, Prov Group
DeviceParameter, DeviceDetailsKeys.CLASS_OF_SERVICE_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/InternetGatewayDevice.DeviceInfo.ModelName, Model Name
DeviceProperty, /cwmp/discovered/InternetGatewayDevice.DeviceInfo.HardwareVersion, Hardware
Version
DeviceProperty, /cwmp/discovered/InternetGatewayDevice.DeviceInfo.SoftwareVersion, Software
Version
LiveParameter, InternetGatewayDevice.ManagementServer.PeriodicInformEnable, PeriodicInform
Enabled, Type=boolean
LiveParameter, InternetGatewayDevice.DeviceInfo.HardwareVersion, Live HW Version
LiveParameter, InternetGatewayDevice.DeviceInfo.SoftwareVersion, Live SW Version
LiveParameter, InternetGatewayDevice.Services.FAPService.1.FAPControl.AdminState, Admin
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
11
Operational Tools
encryptPassword.sh
state, Type=boolean
LiveParameter, InternetGatewayDevice.Services.FAPService.1.FAPControl.RFTxStatus, RF
transmitter state, Type=boolean
LiveParameter, InternetGatewayDevice.Services.FAPService.1.FAPControl.OpState, Operational
state, 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:
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}
Cisco RAN Management System Administration Guide, Release 4.x
12
OL-32398-01
Operational Tools
searchAndExport.sh
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.
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.
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
13
Operational Tools
reassignDevices
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 throughthe PMG. The reassignments are flagged in the FRM.
reassignDevices.sh [-help| -idfile <file> [-type <listType>] [-outdir <dir>] [-rate <num>] [-threads
<num>] -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
-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.
Cisco RAN Management System Administration Guide, Release 4.x
14
OL-32398-01
Operational Tools
reassignDevices
-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).
-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.
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
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
15
Operational Tools
resync.sh
********************************************************************************
*******************
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.
Usage Guidelines
-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.
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.
Cisco RAN Management System Administration Guide, Release 4.x
16
OL-32398-01
Operational Tools
massFactoryRestore.sh
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>] -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 4.x
OL-32398-01
17
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 4.x
18
OL-32398-01
Operational Tools
massFactoryRestore.sh
-mode <retries>
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.
-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
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
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
19
Operational Tools
Operational Tools for PMGDB
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
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
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>)
Cisco RAN Management System Administration Guide, Release 4.x
20
OL-32398-01
Operational Tools
comparePolygons.sh
-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:
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
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
21
Operational Tools
updatePolygons.sh
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
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 ***
$
Cisco RAN Management System Administration Guide, Release 4.x
22
OL-32398-01
Operational Tools
getAreaChangeDtls.sh
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
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
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
23
Operational Tools
getAreas.sh
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.
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
Cisco RAN Management System Administration Guide, Release 4.x
24
OL-32398-01
Operational Tools
loadRevision.bat
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.
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
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
25
Operational Tools
updatePolygonsInPmg.sh
-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.
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.
Cisco RAN Management System Administration Guide, Release 4.x
26
OL-32398-01
Operational Tools
updatePolygonsInPmg.sh
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).
-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.
Cisco RAN Management System Administration Guide, Release 4.x
OL-32398-01
27
Operational Tools
updatePolygonsInPmg.sh
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.
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 4.x
28
OL-32398-01
Was this manual useful for you? yes no
Thank you for your participation!

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

Download PDF

advertising