CLI (Command Line Interface)
How to use CLI Tool - refer to CLI Tool Overview
VSLogger Passive VOIP recording package is configured in config hw voip mode.

Passive VOIP  (hw voip) channels

For this example, we assume that Administrator enabled only hw voip installed in the system. After reload, Administrator can expect following channel list.

cli>(config)
->channel list
channels
----------------------------------------
ch# |type |hwch# |hw |enabled
----------------------------------------
1 VSVOIP_CH 1 voip n
2 VSVOIP_CH 2 voip n
3 VSVOIP_CH 3 voip n
4 VSVOIP_CH 4 voip n
.....
cli>(config)

Enabled: enables/disables channel (only if dynamic license group is set)

Name: channel description

License Group: set channel license group

Compression: set channel compression codec: MLAW (default), ADPCM, or GSM

Source: Recording Source. Use this parameter to differentiate channel display (phone,radio,mic) on live monitoring screen.

Record Rx/Tx Streams: How to record Rx/Tx streams. Record single stream (mixed, Rx only or Tx only ), single recording will be created. Or all streams (mixed, Rx and Tx), three separate recordings will be created.

No RTP Timeout: Recording will be halted if receiving no RTP packets during this timeout (seconds).

Generate DTMF tone: Generate and inject DTMF tones from RTP packets (rfc2833). Available options: near-end (Tx stream), far-end (Rx stream), all or none. (Default value: none)

Handle DTMF event: Handle DTMF tones (trigger DTMF start/stop, append digits to dialed/callerid fields) from RTP packets (rfc2833). Available options: near-end (Tx stream), all ( Rx and Tx streams). (Default value: near-end).

Addressing: Defines what address to use to identify channel traffic, MAC or IP 

MAC Address: MAC address ("XX:XX:XX:XX:XX:XX"). This parameter is used if Addressing is set to MAC.

IP Address: IP address ("XXX.XXX.XXX.XXX"). This parameter is used if Addressing is set to IP.

Protocol: Signaling protocols: SIP, SCCCP, H323, MGCP, UNISTIM, UAUDP, LYNC, AVAYA, NEC

CTI Link: Use CTI Link (None, or JTAPI)

Map to Extension: Map to extension from CTI Link

Set Extension: Retrieve extension from signaling and update recording field.

Break recording when ON HOLD: When recording put on Hold, VOIP RTP stream is closed and recorder has two options:

1. Stop recording and restart when caller returned from hold or
2. Insert silence into the original recording.

One option creates a single long recording with silence during hold, the other option creates multiple recordings

ON_HOLD timeout: Stop recording after timeout if no RTP traffic during On-Hold state.

WAN IP Address: Try to use external IP address if no recording sessions, created according information received from SDP, found for current RTP packet. This is applicable only for channels with SIP signaling protocol.

Open Individual channel in configuration mode.

cli>(config)
->channel 1
cli>(config-ch_1)

Display current channel setting.

->show
ch# 1
----------------------------------------
hwnum: 1
hw: voip
type: VSVOIP_CH
name:
enabled: n
licgroup: none
allowenbl: n
compression: mlaw
nortptimeout: 1
addressing: mac
protocol: none
ipaddress:
macaddress:
breakonhold: y
onholdtimeout: 15
events:
----------------------------------------

cli>(config-ch_1)

Display configuration commands available for this channel.

->?
allowenbl [y|n] - allow enable/disable channel (only if dynamic license group set)
address [mac|ip] - set address type (mac,ip)
breakonhold [y|n] - break recording on hold event(default y)
mac [00:00:00:00:00:00] - set mac address
ip [000.000.000.000] - set ipv4 address
nortptimeout [1-10] - set no rtp timeout (sec)
setext [y|n] - set extension (retrieved from signaling protocol)
compress [ulaw|adpcm|gsm] - set channel compression codec
name [...] - channel description
enable [y|n] - enable/disable channel
gendtmf [0-3] - generate dtmf event tone (rfc2833) 0- none, 1- near-end, 2- far-end, 3 -all
hndldtmf [0-1] - handle dtmf event (rfc2833), 0- near-end,1 -all 
event [id] - channel events configuration
exit - exit current configuration mode
help|? - embedded help
licgroup [none|1-n] - set channel license group
onholdtimeout [1-30] - set no rtp after onhold event timeout (min, default 15 min)
protocol [none|sip|...] - set channel signaling protocol (proto ?, list all available signaling protocols)
copy [1-n] - copy channel settings to range of channels [range]
show - show current settings

cli>(config-ch_1)