PAGE TITLE
Date Last ModifiedPAGE TITLE
Date Last ModifiedHow to use CLI Tool - refer to CLI Tool Overview
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..).
Connection service is responsible for several important tasks and roles
cli>(config)->netserver
cli>(config-netserver)->?help|? - embedded helpnicset [1-n] - set server NIC (or 0 to listen on all )niclist - show available NICsport [1025-65000] - http server port(default 22443)ssl [y|n] - enable/disable ssl(default y)timeout [min] - http session timeout(default 60 mins)apiport [1025-65000] - listening simple API tcp port(default 22222)allowapi [y|n] - allow simple APIallowdelete [y|n] - allow delete recording for users with delete permissionmaxsearchchan [1-n] - max channel for search channels range control (default 256)httpapi [y|n] - enable/disable HTTP API
httpapidemo [y|n] - enable/disable HTTP API demo page
httpapisalt [] - http api security string
httpapihash [] - http api hash type (none,sha1,sha256)
publichost [x.x.x.x] - public (external) host/ip
privatehost [x.x.x.x] - private (internal) host/ip
downloadname [0-1] - download file display name (0 - utc time (default),1 - server local time)
screencapcores [0-6] - screen capture encoder used cpu cores (<= cpu cores - 2)
show - show current settings
cli>(config-netserver)
| Command Format | Description | Extra Notes |
nicset [1-n] |
set server NIC (or 0 to listen on all ) |
|
niclist |
show available NICs |
|
port [1025-65000] |
http server port(default 22443) |
|
ssl [y|n] |
enable/disable ssl(default y) |
We do not recommend disabling ssl connection. We recommend to add self-signed SSL certificate to disable SSL warning during connection. see SSL Certificates |
timeout [min] |
http session timeout(default 60 mins) |
|
apiport [1025-65000] |
listening API tcp port(default 22222) |
Always open. |
allowapi [y|n] |
allow TCP API |
Allow TCP or SIMPLE API connection |
allowdelete [y|n] |
allow delete recording for users with delete permission |
If allow delete = n, even users with delete permission won't be able to delete recordings via VSLogger Monitor |
maxsearchchan [1-n] |
max channel for search channels range control (default 256) |
For systems with small number of channels , this feature allows to simplify Search and Playback parameters user interface. |
httpapi [y|n] |
enable/disable HTTP API |
API connection endpoint <recorderhost>/api/v1 |
httpapidemo [y|n] |
enable/disable HTTP API demo page |
Demo page connection endpoint <recorderhost>/api/v1/demo |
httpapisalt [] |
http api security string |
refer to API specs. Provided to customers on request |
httpapihash [] |
http api hash type (none,sha1,sha256) |
refer to API specs. Provided to customers on request |
publichost [x.x.x.x] |
public (external) host/ip |
|
privatehost [x.x.x.x] |
private (internal) host/ip |
|
downloadname [0-1] |
download file display name (0 - utc time (default),1 - server local time) |
Available from ver. 4.6.3.0. Downloaded recording name is based on recording start time (UTC or server local time).
|
screencapcores [0-6] |
screen capture encoder used cpu cores (<= cpu cores - 2) |
Available from ver. 4.7.0.0. To improve screen capture encoding time , select 2, if multi-core (4 or more) CPU is used. |
For data security reasons both Adutante server and VSLogger Call Recorder are usually installed on an internal network, (LAN behind firewall)
Access to recorder from the internal network via local IP address specified in privatehost parameter, we call Internal Access
Access to Adutante server and connected VSLogger Call Recorder from the outside (e.g. Internet, before firewall), we call External Access
If External access is required, customer has to make sure that corresponding connection to external (public) address of the Firewall is redirected (passed through) to Adutante Module and to VSLogger server.
publichost - parameter is used to notify Vslogger software about external address redirected to VSLogger recorder.
Why it is needed? - to provide end user link to access specific recorder from the external interface (see Adutante Recorders module). When external interface is enabled, users of Adutante recorders module will have two options to connect to recorder, external and internal.
Open CLI from programs, go to File and connect, click ‘OK’.
Remember: The “?” lists the available commands.
login>->u admin p admin
Today is: (Current Date / Time displayed UTC)
VSLogger version 4.6.2.1
Cli version 4.6.2.1
Total number of channels (Your number of Channels)
License Key: (Your license number)
Key Time: 12/31/1999 23:35:45
Expiration Date: Unlimited
Total hours used for period: 0
cli>->config netserver
cli>(config-netserver)->niclist
nic# |set |id |ip |description
----------------------------------------
1 | no |LAN| 192.168.1.123| Intel(R) 82574L Gigabit Network Connection
2 | no Teredo Tunneling Pseudo-Interface| 2001:0:9d38:90d7:20e3:8f3:9d42:31ea| Teredo Tunneling Pseudo-
Interface
If more than one NIC in the system, select NIC used for connection to recorder (Other NIC might be used for different purpose, e.g. for VoIP IP sniffing)
cli>(config-netserver)->nicset 1
*settings were modified, type 'save' command to save current settings.cli>(config-netserver)->privatehost myrecorderpcname
*settings were modified, type 'save' command to save current settings.cli>(config-netserver)->save
Saving...
Logger settings were saved.
Saving channel settings ...
Channel settings were saved
Type "reload" command, to take effect.
cli>(config-netserver)->exit
cli>(config)->reload
Reloading...
server is busy, wait...
This completes the configuration.
If you would like to configure the recorder for direct external access, you’ll need to know your external IP address, domain registrar information (if you plan to use your domain name).
Also, your router's information such as; logon and how to configure it.
1 - Your external IP address (required)
You can check your public facing IP address, by opening websites such as: www.ipchicken.com or www.dnsstuff.org from the recorder PC browser. Make note of the public address as you’ll use it later.
2 - Configure your Router (required)
You’ll need to configure your router’s external IP port to forward TCP ports to recorder:
8443 - Adutante interface port at recorder
22443 - VSLogger interface at recorder
3 – Make a subdomain entry (optional)
If you have a domain name and would rather use a name instead of the external IP, you will need to make a subdomain entry with your domain name registrar (e.g. Go Daddy).
Ex… myrecorder.mydomain and not IP 10.1.2.3 (Your external IP address).
Please keep in mind DNS naming can take 24 hours to replicate.
In the configuration example, both choices will be listed.
Open CLI from programs, go to File and connect, click ‘OK’.
Remember: The “?” lists the available commands.
login>->u admin p adminToday is: (Current Date / Time displayed UTC)
VSLogger version 4.6.2.1Cli version 4.6.2.1Total number of channels (Your number of Channels)License Key: (Your license number)Key Time: 12/31/1999 23:35:45Expiration Date: UnlimitedTotal hours used for period: 0
cli>->config netserver
cli>(config-netserver)->publichost subdom.mydomain.not
***Or use Public IP address if you do not have a domain name***
cli>(config-netserver)->publichost 10.1.2.3
*settings were modified, type 'save' command to save current settings.
cli>(config-netserver)
->saveSaving...Saving logger settings...Logger settings were saved.Saving channel settings ...Channel settings were savedType "reload" command, to take effect.
cli>(config-netserver)->exit
cli>(config)->reload
Reloading...server is busy, wait...
This completes the configuration.
Now, you'll need to re-create your SSL certificate as per the help found here:
During certificate creation make sure to add the name or Public IP address you used as your Public host to the Public Host field.
Delete operation is disabled by default on configuration level
You can enable it in recorder configuration
allowdelete [y|n] - allow delete recording for users with delete permission
Here’s the exact commands to type:
Open CLI Tool, select menu, File and Connect. Click ‘OK’ in Connect dialog.
Typed commands are preceded by ->
login>
->u admin p admin
Welcome to VSlogger command line Interface!
Today is: (Current Date / Time displayed UTC)
VSLogger version (Your Version)
Recording Service (vslogger.exe)
CPU usage: 0.1% Memory usage: 30.9 Mb
Started at: ?
Uptime: 280 days 03:53:23
Total number of hw channels 99
Total number of virtual channels 1
----------------------------------------
VSLogger license info
----------------------------------------
License: AAAA-12345-BBBB
Activated: y
Expiration Date: 2017-11-30 08:00:00
Support Contract id: 11111
Support Expiration Date: 2020-02-29 08:00:00
TDM Licenses Available: 100
VOIP Licenses Available: 100
Screen Licenses Available: 30
G.729 Licenses Available: 120
Encryption License: y
cli>
->config netserver
cli>(config-netserver)
->allowdelete y
cli>(config-netserver)
->save
Saving...
Logger settings were saved.
Saving channel settings ...
Channel settings were saved
Type "reload" command, to take effect.
cli>(config-netserver)
->exit
cli>(config)
->reload
Reloading...
server is busy, wait...
When the system reloads, use search and playback in the Web UI to select the recordings you'd like to delete.