TANDBERG D1392602 The TANDBERG Video Portal Commands, Introduction, Command format, Command types

Page 7

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

Image 7

Contents Data port Command Interface User Guide Software version VD1392602 TANDBERG Video Portal Data port Command Interface User GuideCommand format Table of Contents3. CONNECTING TO THE DATA PORT COMMAND INTERFACE USING TELNET 4. THE TANDBERG VIDEO PORTAL COMMANDS1. Introduction DCE, 9 pin 2.2. Troubleshooting2.1. Hardware and Cabling TANDBERG V IDEO P ORTALIf communication cannot be established between the PC/terminal and the TANDBERG Video Portal’s Data port the following should be checked 3. Connecting to the Data port Command Interface using Telnet 4.1.2. Command types 4. The TANDBERG Video Portal Commands4.1.1. Command format NOTE! The Data port Command Interface is not case sensitiveXconf telnet mode on 4.2. The commandsXconf telnet mode Dialplan Entry 1..64 ServiceId 4.2.1. System Configuration CommandsCommand alplan Dialplan Entry 1..64 Enabled On/Off Dialplan Entry 1..64 Name S 0distinguished c xConfiguration Dialplan Entry 1 Prefix c xConfiguration Dialplan Entry 2 Property 2 Name avmode c xConfiguration Dialplan Entry 4 Prefix H323Gatekeeper Authentication Mode Auto/Off or Ethernet H323CallSetup H323GatekeeperNOTE! The Video Portal needs to reboot before the changes will apply H323CallSetup Mode Direct/GatekeeperNOTE! Changes become effective after reboot Xconf H323Gatekeeper Authenticationc xConfiguration H323Gatekeeper Authentication Mode Off c xConfiguration H323Gatekeeper Authentication IDServices Service 1..64 ServiceFile S 0 Loadlimit Services Sessionc xConfiguration IP Address Services Service 1..64 Enabled On/Off Services Service 1..64 Name S 0c xConfiguration SIP Interface Server Type Auto SIP Interface Transport Default TCP/UDP/TLSc xConfiguration SIP Mode On c xConfiguration SIP Interface Server Addressc xConfiguration SNMP HostIPAddr 3 c xConfiguration SNMP SystemContactc xConfiguration SNMP SystemLocation c xConfiguration SNMP HostIPAddr 1 c xConfiguration SNMP HostIPAddr 2c xConfiguration Options 1 Key 115201SS7-1-55C3EBB7 4.2.2. General Video Portal CommandsCommand ExternalManager NTP Options c xConfiguration ExternalManager AddressDisk 4.2.3. System Status CommandsCommand Dialplan Disk ExampleMacAddress 000E0C5CB57D Speed 100full *s/end Ethernet ExternalManager Feedback 1Ethernet MacAddress SpeedAddress Port 1719 *s/end H323Gatekeeper IPH323Gatekeeper Status Address PortAddress SubnetMask Gateway 10.31.0.1 DNS Server Address Port Last Update Last CorrectionNTP Options NameSystemLoad Service SystemLoad SystemUnitService OptionsPRI TemperatureCelcius TemperatureFahrenheit Configuration Telephony VideoTelephonyConfiguration Telephony VideoTelephony Hardware Version EP ProductType Uptime Software Version Name ReleaseDateSyslog Level Mask Volume 4.2.4. Debug Commands4.2.5. Special Xcommand Commands CommandDefaultValuesSet Level 1 CheckDisk ClearDialplanEntries ClearServiceEntries DefaultValuesSetExample restore all default factory setting xCommand DefaultValuesSet Parameter DialplanEntryNumber Example Dial DialplanEntryDelete DialplanEntrySwap DisconnectCallParameters OK Result parameter Session ID S 1 ExampleExpression 1 .. 15 S 0, 256 XPath expression OK Result parameters OK Result parameters ID 1 ERROR Result parametersID 1 ERROR Result parameters EraseDisk FeedbackDeregister FeedbackRegisterParameters ServiceEntryNumberr OptionKeyAdd OptionKeyDelete RestoreDefaultServicesServiceEntryDelete Example Delete Option Key nr. 1 xCommand OptionKeyDeleteExample Swap Service nr. 10 ServiceEntrySwapExample Delete Service nr. 10 xCommand ServiceEntryDelete Parameters ServiceEntryNumberr ServiceEntryNumber2rLicense General User CommandsAbout Help or ? Licence Relkey Xfeedback helpxhistory ? XhistoryExamples xhistory call