===============================================================================

BTS Site Manager Command Line Tools

===============================================================================

This document describes System Requirements, Installation, Usage and

Uninstallation of these tools.

===============================================================================
SYSTEM REQUIREMENTS
===============================================================================

If you install the tools with BTS Site Manager release, proper Java SE Runtime
Environment is delivered and installed with the delivery.

Tools require write permissions to the file system.

===============================================================================
INSTALLATION
===============================================================================

Command line tools are installed when installing BTS Site Manager release.
Installation is located in \Managers\BTS Site\BTS Site Manager\tools\CLI.

Installation folder may be copied as such also to other locations, but path
definition for Java must be checked and possibly modified manually.

===============================================================================
USAGE
===============================================================================

-------------------------------------------------------------------------------
Restrictions
-------------------------------------------------------------------------------

Since these tools use BTS Site Manager XoH connection, they cannot be operated
concurrently with any other tool using the same interface including BTS Site
Manager.

-------------------------------------------------------------------------------
Common Parameters
-------------------------------------------------------------------------------

Use either

-ne address

to execute tool(s) against a single site or

-ipfile filename

for multiple sites.

If BTS requires authentication, use

-pw username:password,...
for login. You can list all the different sets of credentials here. The tools
will use them in given order when trying to login into a site.

Optional parameters

-attempts Maximum number of connection attempts (3 by default).

-concurrent Maximum number of concurrent connections (10 by default).
-connectout Timeout for connection (60 seconds by default).
-debug Runs the tool in debug mode. Tool behaviour varies.
-nolog Prevents the tool from creating log file.
-nosummary Prevents the tool from creating summary file.
-outdir Redirects all output files to a specific directory.
-output Saves console output also to given file.
-timeout General timeout for operations (60 seconds by default).
-verbose Generate more detailed console output.

-------------------------------------------------------------------------------
Logging
-------------------------------------------------------------------------------

Tools log the progress to the console and, if defined in start parameter, also
to a file appending existing file if any.

Here is an example console output:

02/12 06:53:18 INFO File Collector Tool version 7.6

02/12 06:53:18 INFO Connecting to localhost...
02/12 06:53:19 INFO Connected to localhost
02/12 06:53:22 INFO Successfully got scf.xml from localhost
02/12 06:53:24 INFO Successfully got siteconf.xml from localhost
02/12 06:53:25 INFO Successfully got currentBD.xml from localhost
02/12 06:53:27 INFO Successfully got 3 files from localhost
02/12 06:53:29 INFO File Collector Tool finished
02/12 06:53:29 INFO Operations finished

Tools also generate a more detailed Tool.log file which can be used for
troubleshooting.

-------------------------------------------------------------------------------
Exit Codes
-------------------------------------------------------------------------------

All tools use exit codes to roughly indicate any problems during execution.
Common exit codes are

0 No problems
1 Miscellaneous problems
2 Invalid operation
3 Invalid parameters
4 Site unreachable
5 Site reserved
6 Login failed
7 Unexpected error
8 Timeout

Exit code 1 is used when several operations (or sites) are executed and some
(or all) of them fail.

-------------------------------------------------------------------------------
Alternative Guidance
-------------------------------------------------------------------------------

For alternative guidance and help, see also .bat and .sh files, which offer
short guidance. You can display help with option -? in Windows or with -h in
Unix.

===============================================================================
TOOLS
===============================================================================

-------------------------------------------------------------------------------
File Collector Tool
-------------------------------------------------------------------------------

Gets miscellaneous files from given site(s).

The command is

collectfiles

Possible error codes are

11 Files missing

-------------------------------------------------------------------------------
Reset Tools
-------------------------------------------------------------------------------

Reset objects in given site(s).

The commands are

reset
resetcell
resetunit

Possible error codes are

68 Object not found

69 Operation failed
70 HW model missing

-------------------------------------------------------------------------------
Block Tool
-------------------------------------------------------------------------------

Block objects in given site(s).

The commands are

blockcell

Possible error codes are

 68 Object not found
69 Operation failed
70 HW model missing

-------------------------------------------------------------------------------
UnBlock Tool
-------------------------------------------------------------------------------

Block objects in given site(s).

The commands are

unblockcell

Possible error codes are

68 Object not found

69 Operation failed
70 HW model missing

-------------------------------------------------------------------------------
RX/TX monitor Tool
-------------------------------------------------------------------------------

Executes RX/TX level monitoring for given site and then stop monitoring in given
site(s).

The commands are

rxtxmonitor

Possible error codes are

140 Failed to generate RX/TX level data file

-------------------------------------------------------------------------------
Fetch Techlog Tool
-------------------------------------------------------------------------------

Fetch techlog using SSH/Telnet in given site(s).

The commands are

fetchtechlog -ssh sshUsername:sshPasswrod

Possible error codes are

155 Failed to get techlog

-------------------------------------------------------------------------------
SCF Convert Tool
-------------------------------------------------------------------------------

Convert configuration data in given site(s).

The command is

scfconvert
Possible error codes are

160 Failed to convert

161 Nothing changed after convert

===============================================================================
UNINSTALLATION
===============================================================================

If the tools have been installed while installing BTS Site Manager application,
command line tools can be uninstalled by deleting the folder
\Managers\BTS Site\BTS Site Manager\tools\CLI.

If the tools have been extracted from a zip file, just delete the extracted
files.