TANDBERG D1392602 User Manual
TANDBERG Video Portal Data port Command Interface User Guide
TANDBERG Video Portal
Data port Command Interface User Guide
Software version V 3
D1392602
TANDBERG
D1392602 1
TANDBERG Video Portal Data port Command Interface User Guide
Table of Contents
1. INTRODUCTION ..........................................................................................................................3
2. CONNECTING TO THE DATA PORT COMMAND INTERFACE THROUGH THE RS-232 PORT. 4
2.1. HARDWARE AND CABLING ...........................................................................................................4
2.2. TROUBLESHOOTING......................................................................................................................4
3. CONNECTING TO THE DATA PORT COMMAND INTERFACE USING TELNET........6
4. THE TANDBERG VIDEO PORTAL COMMANDS .................................................................7
4.1. INTRODUCTION .............................................................................................................................7
4.1.1. Command format.....................................................................................................................7
4.1.2. Command types.......................................................................................................................7
4.2. THE COMMANDS ...........................................................................................................................8
4.2.1. System Configuration Commands...........................................................................................9
4.2.2. General Video Portal Commands.........................................................................................19
4.2.3. System Status Commands......................................................................................................20
4.2.4. Debug Commands.................................................................................................................26
4.2.5. Special Commands................................................................................................................26
4.3. INDEX COMMANDS .....................................................................................................................32
D1392602 2
TANDBERG Video Portal Data port Command Interface User Guide
1. Introduction
The TANDBERG Video Portal Data port Command Interface User Guide contains guidelines on how to use the
textual command interface supported by the Video Portal system, further referred to as Video Portal. The Data port
Command Interface can be accessed through Telnet via the LAN interface or through RS-232 by connecting a serial
cable to the serial interface connector, referred to as the Data port (ref. chapter 2). Three Telnet sessions can be
connected to the Video Portal at the same time in addition to the RS-232 connection.
If, after reading this manual, you require additional information concerning the use of the TANDBERG Video Portal
Data port Command Interface, please contact your local TANDBERG dealer who will be able to supply you with
relevant information for special applications.
D1392602 3
TANDBERG Video Portal Data port Command Interface User Guide
2. Connecting to the Data port Command Interface through the RS-232 port.
The RS-232 port is a 9-pin, female, sub-D connector located on the front of the Video Portal. The port is configured
as a DCE (Data Communications Equipment). The RS-232 port is default set to 115200 baud, 8 data bits, none
parity and 1 stop bit from factory. The RS-232 port is also referred to as the Data port.
2.1. Hardware and Cabling
The pin outs for the RS-232 are defined in the following table (the DTE, Data Terminal Equipment, could be a PC
or other device capable of serial communication).
Pin no Signal Description Direction
1 CD Carrier detect To DTE
2 RD Receive data To DTE
3 TD Transmit data From DTE
4 DTR Data terminal ready From DTE
5 Ground
6 DSR Data set ready To DTE
7 RTS Ready to send From DTE
8 CTS Clear to send To DTE
9 RI Ring indicator To DTE
NOTE! A straight through cable should be used between the TANDBERG Video Portal’s RS-232 port and the DTE.
The figure below illustrates the recommended cable-wiring scheme for connecting the Video Portal to a PC through
RS-232.
TANDBERG VIDEO PORTAL PC
DCE, 9 pin DTE, 9 pin
1 CD 1 CD
2 RD 2 RD
3 TD 3 TD
4 DTR 4 DTR
5 GND 5 GND
6 DSR 6 DSR
7 RTS 7 RTS
8 CTS 8 CTS
9 RI 9 RI
DTR and RTS are ignored. DSR, CD, and CTS are always asserted, while RI is not used.
2.2. Troubleshooting
D1392602 4
TANDBERG Video Portal Data port Command Interface User Guide
If communication cannot be established between the PC/terminal and the TANDBERG Video Portal’s Data port the
following should be checked:
• Verify that the serial cable is a straight through 9-pin to 9-pin cable
• Confirm that the configuration of the PC/terminal’s serial RS-232 port is identical to the configuration of
the TANDBERG Video Portal RS-232 port.
• Verify that the PC/terminal’s serial RS-232 port is working properly by connecting it back-to-back to
another PC/terminal and send characters in both directions
1
.
1
It requires a null-modem cable to perform this test
D1392602 5
TANDBERG Video Portal Data port Command Interface User Guide
3. Connecting to the Data port Command Interface using Telnet
The TANDBERG Video Portal has one LAN port.
The Video Portal’s Telnet server provides access to the Data port Command Interface through a 10/100 base T
network interface supporting the TCP/IP protocol.
When connected to the Video Portal, type tsh to start a t-shell from the command line. The Telnet client will receive
a welcome message similar to the following:
Welcome to <System Name>
TANDBERG Video Portal Release V3.0
SW Release Date: 2007-03-13
NOTE! If the TANDBERG Video Portal has been protected with an IP password you will be prompted to enter this
password before you can access the Data port Command Interface via Telnet.
D1392602 6
TANDBERG Video Portal Data port Command Interface User Guide
4. The TANDBERG Video Portal Commands
4.1. Introduction
Typing ‘?’ or ‘help’ when connected to the Data Port Command Interface will return a list of valid commands. The
commands are used to control the functions of the Video Portal. A command may be followed by a set of
parameters and sub-commands. This chapter gives a description of all valid commands for the Video Portal.
4.1.1. Command format
Typing ‘?’ or ‘help’ after a command will result in a usage text (*h of help response) being displayed. Usage text
gives information about the command format, i.e. valid parameters, sub-commands etc. An example is shown below
(the user input is shown in bold).
Xconf DialPlan Entry 1 NetType ?
*h xConfiguration Dialplan Entry [1..64] NetType: <All/H324m/H323/SIP>
"Specifies the type of network to listen for incoming connections."
Numbers 1-64 and All/H324m/H323/SIP are parameters of the configuration (Xconf) command. Parameters
are
arguments on which the command will operate upon. Required parameters are denoted by: < >, while optional
parameters are denoted by: [ ]. All possible values for given parameters are separated with slashes ( / ). For some
parameters, only their names are supplied within the brackets. In these cases specific parameter values need to be
substituted for the parameter names. Allowed parameter values, unless obvious, are provided when the commands
are discussed.
Sub-commands
are commands grouped together within a command. Different sub-commands within a command
may have different parameter sets. In the example below: Address and Authentication are sub-commands to the
command H323Gatekeeper. In the same sense Mode, ID and Password are sub commands of H323Gatekeeper
Authentication.
xconf H323Gatekeeper ?
*h xConfiguration H323Gatekeeper Address: <IPAddr>
*h xConfiguration H323Gatekeeper Authentication Mode: <Auto/Off>
*h xConfiguration H323Gatekeeper Authentication ID: <S: 0, 50>
*h xConfiguration H323Gatekeeper Authentication Password: <S: 0, 50>
NOTE! The Data port Command Interface is not case sensitive.
4.1.2. Command types
The commands can be divided into three major classes:
• Parameter Configuration Commands, Xconf.
• Status Commands, Xstat.
D1392602 7
TANDBERG Video Portal Data port Command Interface User Guide
• User Commands, Xcom.
Parameter Configuration Commands
are commands that set a system parameter to a specific value. E.g.: The
command Xconf telnet mode: "on" enables telnet access on the Video Portal. If the command is syntactically
correct the Video Portal returns OK, otherwise the Video Portal returns ERROR. An example is shown below (the
user input is shown in bold).
Xconf telnet mode: "on"
OK
When issuing a Parameter Setting Command without a parameter, the Video Portal will return the command with
the current setting. E.g.:
Xconf telnet mode
*c xConfiguration Telnet Mode: On
OK
Status Commands
are commands that list different sets of system parameters. Status commands are automatically
called when corresponding parameters are being changed.
User Commands
are commands that allow users to configure operational parameters, like option keys, service and
dial plan entry manipulations, disk operations and system reboot.
4.2. The commands
The commands are divided into five groups: System Configuration Commands, General Video Portal Commands,
System Status Commands, Debug Commands and Special Commands.
D1392602 8
TANDBERG Video Portal Data port Command Interface User Guide
4.2.1. System Configuration Commands
Command: Description:
lplan
Mapping of a call onto a service or another call.
Dialplan Entry [1..64] Enabled: <On/Off>
Dialplan Entry [1..64] Name: <S: 0, 30>
Dialplan Entry [1..64] NetType: <All/H324m/H323/SIP>
Dialplan Entry [1..64] Prefix: <S: 0, 128>
Dialplan Entry [1..64] Suffix: <S: 0, 64>
Dialplan Entry [1..64] ServiceId: <0..64>
Dialplan Entry [1..64] Property [1..16] Name: <S: 0, 32>
Dialplan Entry [1..64] Property [1..16] Value: <S: 0, 64>
Dialplan Entry [1..64] Source [1..8] ID: < 0, 65535>
Dialplan Entry [1..64] Source [1..8] Path: <S: 0, 128>
sub-commands:
Each dial plan has the following general fields, i.e. Dialplan entry details:
• Enabled – If the box is checked the service becomes available.
• Name – The name of the dial plan as represented in the Dialplan Configuration
overview.
• Net type – Inbound call net type; either H324m, H323, SIP or All. All means that
independent of the net type the call is accepted on a match with the
predefined Prefix and Suffix.
• Prefix - Number to which the first part of the inbound number (bnr) is matche d. The
prefix
is specified in the dial plan entry. The prefix is stripped from the inbound
number.
• Suffix - Number to which the last part of the inbound number (bnr) is matched. The
suffix
is specified in the dial plan entry. The suffix is also stripped from the inbound
number. The part of the number which remains after stripping both prefix and
suffix is called remainder (See also the “useremainder” option in a DID service).
• ServiceId – Select one of the services as configured in th e Services menu ite m.
Each dial plan has the following service specific fields:
• Property – User configurable arguments used within a service.
• Source – User configurable figures and movies used within the service.
Argument details for the default DID service:
For a dial plan based on a DID service the following Arguments, i.e. properties, can be
D1392602 9
TANDBERG Video Portal Data port Command Interface User Guide
distinguished:
• Net type - Either H324m, H323 or SIP of the outbound call.
• AV mode – This mode determines the outbound audio and video call settings. It is either
Audio Only, Audio + Video, Auto(matic) no fallback to audio, Auto + fallback to audio
and Auto + always fallback to audio. In the “Audio Only” mode a voice call is being
setup, even when all endpoints support both audio and video capabilities. In th e “Audio
+ Video” mode a call is only being setup when endpoints support both audio and video
capabilities and a call with both these capabilities can be setup. In the “Auto” mode a
call is being setup according to the capabilities of the endpoints. Of the latter, 3 versions
can be distinguished: no fallback to audio, fallback to audio or always fallback to audio.
In the “no fallback to audio” case either an “audio + video“ or an audio only call is being
setup, depending on the capabilities choice of the initiating endpoint, i.e. when an “aud io
+ video” call is being setup, whereas the receiving endpoint only supports audio, the call
is terminated. In the “fallback to audio” case capabilities can be changed to an audio
only call when the receiving endpoint supports only audio, even when an “audio +
video“ call is being setup by the initiating endpoint. The “always fallback to audio” case
is used in case the telephony switch interferes or cannot handle capability renegotiation,
therefore when an “audio + video” call fails automatically an audio call is being setup.
• Prefix – Specifies the first part, i.e. the part preceding the remainder, of the outbound
number. The outbound prefix can be defined under “Arguments”.
• Suffix – Specifies the last part, i.e. the part appended to the remainder, of the Outbound
number. The outbound suffix can be defined un der “Arguments”.
• Use remainder - Specifies whether a particular part, i.e. the remainder, of the inbound
number will be used to form a part of the outbound number. For a remainder to become
non-zero a specified inbound “Prefix” has to match the first part and/or a specified
inbound “Suffix” has to match the last part of an inbound number, however individually
or combinations of both never fully match the complete inbound number. Both inbound
Prefix and Suffix can be defined under “Dialplan entry details”. When “Use remainder”,
is active the previously mentioned “remainder” will be appended to and precede the
“Prefix” and the “Suffix” of the outbound number, respectively. The outbound “Prefix”
and “Suffix“ precede and append, respectively, the “remainder” as to form the complete
outbound number. The latter prefix and suffix can be defined under “Arguments”.
Prefixes and suffixes are standard parameters of dial plans. Suppose, as an example, the
prefix, inbound, prefix and postfix numbers equal 1234, 9876154, 9876 and 54
respectively then the remainder equals 1 and the outbound number will be 12341. For
the same settings with an inbound number 9876254 results in an outbound number
12342. In case the prefix and/or suffix fully match the inbound number the remainder
will be empty and the useremainder value will be ignored.
• Allow forwarding - After call setup the call is offloaded from the Video Portal system,
i.e. not routed via the Video Portal system any longer, to free resources.
• Use sub number - The sub number is a number extension following the main number
and is separated from the main number by a "*". In this way a number plan behind a
main number can be reached directly.
Example of a DID Dialplan for mobile to SIP calls:
Note:
• For DID ServiceId = 1.
• avmode equals 1, 2, 3, 4 or 5 for Audio Only, Audio + Video and Auto (no fallback to
audio), Auto + fallback to audio or Auto + always fallback to audio, respectively.
• useremainder equals 0 or 1, for No and Yes, respectively.
*c xConfiguration Dialplan Ent ry 1 E nabled: On
*c xConfiguration Dialplan Entry 1 Name: "H324m - SIP"
*c xConfiguration Dialplan Entry 1 NetT y pe: H324m
D1392602 10
Loading...