Command Line Interface (CLI) (How to use CLI Tool - refer to CLI Tool Overview)
|
|
Graphical User Interface (GUI) |
Get List of HW options
cli>(config)
->hw ?
[code] - hw configuration mode
Vendor codes:
shcti - Synway boards
smart - AudioCodes boards
parrot - Nice(Cybertech)
voip - Software only, VoIP
siprec - Software only, SipRec
ipcast - Software only, IPCast
show - show current configuration
cli>(config)
|
|
Get List of HW options
1) Sign in through VSLogger as an Administrator
Default logins: user: admin, password: admin user: admin, password: adutante user: admin, password: Welcome1!
2) Click on the dropdown arrow next to “ at the top, 3) Select “Setup” from the dropdown menu 4) Click “Hardware” on the left sidebar 5) Click the edit button for your selected hardware.
Finalize selected settings
6) After enabling the selected board type and clicking submit, save and reload the settings. This step is necessary any time a setting is changed.
|
Get list of Hardware options currently available for use
cli>(config)
->hw list
----------------------------------------
# |hw |available/enabled
----------------------------------------
1 shcti n/n
2 smart n/n
3 parrot n/n
4 voip n/n
5 siprec/n
6 ipcast y/n
cli>(config)
|
Specific HW option becomes available for use, when:
- shcti - Synway drivers installed.
- smart - AudioCodes SmartTap drivers installed.
- parrot - Parrot MOD drivers drivers installed
- voip - WinPCap drivers installed
- siprec - no special requirement. Always available.
- ipcast - no special requirement. Always available.
|
Enabled Hardware and channel list
Channel list and channel objects available for configuration will be created on Recording service start (reload)
HW configuration is validated and channels created in following order (order can be changed with hw swap command)
- shcti available and enabled - total number of channels from all installed Synway boards added to channels list 1..N.
- smart available and enabled - total number of channels from all installed SmartTap boards appended to channels list.
- parrot available and enabled - total number of channels from all installed Parrot MOD boards appended to channels list.
- voip available and enabled - numdev (number of devices ) configured in hw voip appended to channels list.
- voip trunks configured - numch (number of channels in trunk) for each trunk appended to channels list.
- siprec available and enabled - numdev (number of devices ) configured in hw siprec appended to channels list.
- ipcast available and enabled - numdev (number of devices ) configured in hw ipcast appended to channels list.
|
|
|
For example, if Administrator enabled hw smart, and recorder has single 8 channel board installed in the system. After reload Administrator can expect following channel list
|
cli>(config)
->channel list
channels
----------------------------------------
ch# |type |hwch# |hw |enabled
----------------------------------------
1 SMART_LD 0 smart y
2 SMART_LD 1 smart y
3 SMART_LD 2 smart y
4 SMART_LD 3 smart y 5 SMART_LD 4 smart y 6 SMART_LD 5 smart y 7 SMART_LD 6 smart y 8 SMART_LD 7 smart y
cli>(config)
|
|
|
If later at the same recorder Administrator also enabled hw voip, and set up 4 channels (numdev = 4). After reload he can expect following channel list
|
cli>(config)
->channel list
channels
----------------------------------------
ch# |type |hwch# |hw |enabled
----------------------------------------
1 SMART_LD 0 smart y
2 SMART_LD 1 smart y
3 SMART_LD 2 smart y
4 SMART_LD 3 smart y
5 VSVOIP_CH 1 voip y
6 VSVOIP_CH 2 voip y
7 VSVOIP_CH 3 voip y
8 VSVOIP_CH 4 voip y
cli>(config)
|
|
|
Changing hw order
cli>(config)
->hw list
----------------------------------------
# |hw |available/enabled
----------------------------------------
1 shcti n/n
2 smart n/n
3 parrot n/n
4 voip n/n
5 siprec/n
6 ipcast y/n
cli>(config)
For example, to exchange orders of shcti and ipcast hardware use hw swap 1 6 cli command, where 1 and 6 current hw index (as shown after list command).
cli>(config)
->hw swap 1 6
cli>(config)
Attention!!! Recorder settings will be saved and recorder will be reloaded.
cli>(config)
->hw list
----------------------------------------
# |hw |available/enabled
----------------------------------------
1 ipcast/n
2 smart n/n
3 parrot n/n
4 voip n/n
5 siprec/n
6 shcti y/n
cli>(config) |
|
Click on Hardware Order
A new window will appear
The hardware order can be changed using the blue up and down arrows to relocate the selected hardware device.
|
AudioCodes SmartWorks Hardware (hw smart)
cli>(config)
->hw smart
cli>(config-hw_smart)
->?
help|? - embedded help
enable [y|n] - enable/disable hw
exit - exit current configuration mode
show - show current configuration
cli>(config-hw_smart) ->show ---------------------------------------- hw [smart] ---------------------------------------- available: y enabled: y
As you see, AudioCodes hardware is:
- available - drivers installed
- enabled - VSLogger adds all channels from the installed AudioCodes boards to the recording channels list.
and the only parameter we can change is enable parameter
If you disable AudioCodes SmartWorks hardware, all channels from the AudioCodes boards will be removed from the recording channels list, even if you have AudioCodes boards in the system.
cli>(config-hw_smart)
->enable n
cli>(config-hw_smart)
->show
----------------------------------------
hw [smart]
----------------------------------------
available: y
enabled: n
cli>(config-hw_smart)
|
|
AudioCodes SmartWorks Hardware
For AudioCodes the only parameter we can change is:
Enable: enables/disables the card
If you disable AudioCodes SmartWorks hardware, all channels from the AudioCodes boards will be removed from the recording channels list, even if you have AudioCodes boards in the system.
|
Synway Hardware (hw shcti)
cli>(config)
->hw shcti
cli>(config-hw_shcti)
->?
help|? - embedded help
enable [y|n] - enable/disable hw
inifile [ini files folder path] - set ini files location folder
show - show current configuration
exit - exit current configuration mode
cli>(config-hw_shcti)
->show
----------------------------------------
hw [shcti]
----------------------------------------
available: y
enabled: y
inifile: c:\shcti
cli>(config-hw_shcti)
As you see:
- Synway hardware is available but disabled, all channels from the Synway boards are currently removed from the recording channels list..
- two parameters available for configuration: enable and inifile.
inifile - should point to folder with Synway driver initialization files (e.g. C:\ShCti )
cli>(config-hw_shcti)
->show
----------------------------------------
hw [shcti]
----------------------------------------
available: y
enabled: y
inifile: C:\ShCti
cli>(config-hw_shcti)
|
|
Synway Hardware
The two parameters available for configuration are:
Enable: enables/disables the card
.ini files folder: Should point to folder with Synway driver initialization files (e.g. C:\ShCti )
|
Parrot MOD Hardware (hw parrot)
cli>(config)
->hw parrot
cli>(config-hw_parrot)
->show
----------------------------------------
hw [parrot]
----------------------------------------
available: y
enabled: n
inifile: C:\Program Files\CyberTech\Parrot DSC
input: mlaw
reversedir: n
reversenum: n
cli>(config-hw_parrot)
->?
help|? - embedded help
enable [y|n] - enable/disable hw
exit - exit current configuration mode
show - show current configuration
input [alaw|mlaw] - set input codec
reversedir [y|n] - reverse call direction
reversenum [y|n] - reverse callid/dialed numbers
inifile [ini files folder path] - set ini files location folder
cli>(config-hw_parrot)
As you see:
- MOD hardware is available but disabled, all channels from the MOD boards are currently removed from the recording channels list..
- five parameters available for configuration: enable, inifile , input, reversedir and reversenum
|
|
Parrot MOD Hardware
MOD has five parameters available for configuration:
Enable: enables/disables the card
.ini files folder: Should point to folder with MOD driver initialization files (e.g. C:\... )
Input Codec: Audio compression protocol
Reverse Call Direction: Software will reverse call direction
Reverse Numbers: Swap caller ID and dialed number fields
|
Passive VOIP Recording package (hw voip)
cli>(config)
->hw voip
see Passive VOIP Recording configuration
|
Terminating VOIP Recording package (hw siprec)
cli>(config)
->hw siprec
see Terminating VOIP Recording configuration
|
Terminating RoIP (Unicast or Multicast )Recording package (hw ipcast)
cli>(config)
->hw ipcast
|