About VSLogger CLI tool

VSLogger CLI Tool as a stand-alone application included with VSLogger installation. It provides the following functionality for VSLogger Administration:

• Command line configuration interface to VSLogger server
• Database maintenance utilities
• Database migration or upgrade utilities(File converter)
• Self-signed SSL certificate generation utility (see SSL configuration )

 
Attention!!: most of the corresponding configuration functionality is also available within Versadial VSLogger Monitor graphical interface.  Select setup View  Setup View and the corresponding section (General, Storage, Channels, etc..). 

Command Line Configuration Basics

VSLogger CLI has the following modes:

• Login Mode: Initial mode before cli client connection assigned to cli server. Within this mode, the authentication process is done.     
• Root Mode: This is initial mode after successful authentication. This is an entry point from where all other modes can be reached.
• Config Mode: Mode where a configuration is done. This mode can have custom sub-modes (defined by the application).
• Debug Mode: Mode where debugging and troubleshooting is done. This mode can have application-specific sub-modes.
• Exec Mode: This mode used for sending run-time commands to the application. (For example: enable HW channels, Restart Services, and etc…)

To Open VSLogger CLI tool:

• Access “VSLogger CLI Configuration Tool” from Windows Start Menu :  Start > All Programs > Versadial > VSLogger > VSLogger CLI Configuration Tool (vscli.exe)
• Select Tools menu, and start Recording service, if not started already
• Select File menu, and press Connect. In connection dialog press OK. Optionally change IP address prior to connection, if connecting to remote VSLogger.

Use Input section of CLI Tool to enter commands.

Help Commands:

help or? - commands will display currently available options at any specific time 

->?
help|? - embedded help
user [your userid] password [your password] - login as cli administrator

login>

Default login to cli (user “admin” password “admin”):

login>

->u admin p admin
Today is: Wed Apr 01 00:42:56 UTC 2015

VSLogger version 4.6.1.5
Cli version 1.4.2.1
Total number of channels 0
License Key: 1619256928
Line Licenses Available: 256
Hours Per Day Available: 0
G.729 Licenses Available: 255

cli>

View root cli commands

->?
config - enter configuration mode.
debug - enter debug mode.
exec - enter exec mode.
exit - exit from info mode.
help|? - embedded help
show - show details
set - change cli user (password)

cli>

Access  Configuration mode and configuration options:

cli>
->config

cli>(config)
->?

adutante - adutante configuration mode
alarms - alarms configuration mode
archives - archives configuration mode
channel [1..N] - channel configuration mode
convert - convert old (before ver 4.5) configuration files
exit - exit config mode
t1e1 - e1/t1 schemes and pri configuration mode
general - general configuration mode
help|? - embedded help
hw [id] - hw configuration mode (shcti|smart|parrot|voip|antares|siprec|lync)
license - license configuration mode
logging - logging configuration mode
netserver - connection service configuration mode
reload - reload configuration
save - save configuration
show - show current configuration
smdr - smdr configuration mode
smtp - smtp configuration mode
storage[main|net|ftp] - storage configuration mode

cli>(config)

IMPORTANT!! - Saving and Reloading configuration

Please note two commands available in CLI config mode: 

reload - reload configuration 
save - save configuration

It is essential to call save command periodically and after configuration was finished.

Periodic saving of configuration has the same purpose as saving edited documents, to avoid losing your changes in case something unexpected happens (Program crashed or stopped by another user, communication lost etc).

It is essential to call reload command to apply all your changes to currently running instance.

Saving configuration does not automatically apply it to currently running recording service instance.

To apply your changes call reload command after you finished and saved the configuration.

Please note, reloading configuration has the same effect as reloading recording service and will interrupt current recordings in progress.

cli>(config)
->save

Saving...
server is busy, wait...
Saving logger settings...
Logger settings were saved.
Saving channel settings ...
Channel settings were saved
Type "reload" command, to take effect.

cli>(config)
->reload

Reloading...
server is busy, wait...
Stopping vslogger ...
Stopping pipeserver ...
Stopping adutante link...
Stopping channels ...
Stopping HW ...
Stopping recording threads ...
Destroying uncompressor...
Stopping compressor...
Stopping vclogger...
Stopping smdrserver...
Stopping alarmserver...
Destroying compressor...
Destroying vclogger...
Destroying schedules...
Destroying smdrserver...
Destroying pipeserver...
Destroying adutante link...
Destroying ctl server...
Destroying HW...
Destroying alarmserver...
Reading logger settings...
Enumerating loggers ...
Creating voip hw ...
Creating siprec hw ...
Initializing HW...
HW Initialized. 20 channels were created.
Reading channel settings ...
Starting VSLogger main thread ...
HW Started
Restarting Connection service ...
Logger started.

login>

VSLogger Administrator user and password reset

VSLogger Administrator password used to sign into CLI tool can also be used for login into VSLogger HTML UI in local Administrator mode, with full permissions.

It is essential security practice to change default administration user and password to new values right after installation!!.

user and password can be changed with root cli command set.

If for some reason user and password were lost, you can reset password and user to default values (ID: admin  PSWD: admin) by following steps:

• delete file C:\ProgramData\Adutante\vslogger\data\cli.xml
• Restart VSLogger recording service
• sign in to cli and change user and password

CLI Tool connection port change

By default, CLI connection is set to port 9977 (see default connection dialog below)

 If Administrator wants to change connection port for some reason, it can be done with the following steps.

For example, to change connection port to =9980:

• Create file logger.properties in C:\ProgramData\Adutante\vslogger\data\   folder. (It is not there by default).
• add one line entry  cli.port=9980
• restart recording service

From this point, to connect, users should change the port in Connect dialog to 9980.