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. 2.2. HARDWARE AND CABLING ........................................................................................................... 4 TROUBLESHOOTING ....................................................
TANDBERG Video Portal 1. Data port Command Interface User Guide 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).
TANDBERG Video Portal 2. Data port Command Interface User Guide 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.
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: • • • 1 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.
TANDBERG Video Portal 3. Data port Command Interface User Guide 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.
TANDBERG Video Portal 4. The TANDBERG Video Portal Commands 4.1. Introduction Data port Command Interface User Guide 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.
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).
TANDBERG Video Portal Data port Command Interface User Guide 4.2.1. System Configuration Commands Command: alplan Description: Mapping of a call onto a service or another call. Dialplan Entry [1..64] Enabled: Dialplan Entry [1..64] Name: Dialplan Entry [1..64] NetType: Dialplan Entry [1..64] Prefix: Dialplan Entry [1..64] Suffix: Dialplan Entry [1..64] ServiceId: <0..64> Dialplan Entry [1..64] Property [1..
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.
TANDBERG Video Portal Data port Command Interface User Guide *c xConfiguration Dialplan Entry 1 Prefix: "207947133" *c xConfiguration Dialplan Entry 1 Suffix: "" *c xConfiguration Dialplan Entry 1 ServiceId: 1 *c xConfiguration Dialplan Entry 1 Property 1 Name: "nettype" *c xConfiguration Dialplan Entry 1 Property 1 Value: "SIP" *c xConfiguration Dialplan Entry 1 Property 2 Name: "avmode" *c xConfiguration Dialplan Entry 1 Property 2 Value: "5" *c xConfiguration Dialplan Entry 1 Property 3 Name: "prefix"
TANDBERG Video Portal Data port Command Interface User Guide *c xConfiguration Dialplan Entry 2 Property 2 Name: "avmode" *c xConfiguration Dialplan Entry 2 Property 2 Value: "4" *c xConfiguration Dialplan Entry 2 Property 3 Name: "prefix" *c xConfiguration Dialplan Entry 2 Property 3 Value: "" *c xConfiguration Dialplan Entry 2 Property 4 Name: "suffix" *c xConfiguration Dialplan Entry 2 Property 4 Value: "" *c xConfiguration Dialplan Entry 2 Property 5 Name: "allowredirectivr" *c xConfiguration Dialplan
TANDBERG Video Portal Data port Command Interface User Guide *c xConfiguration Dialplan Entry 4 Prefix: "90370010" *c xConfiguration Dialplan Entry 4 Suffix: "" *c xConfiguration Dialplan Entry 4 ServiceId: 3 *c xConfiguration Dialplan Entry 4 Property 1 Name: "allowredirectep" *c xConfiguration Dialplan Entry 4 Property 1 Value: "0" *c xConfiguration Dialplan Entry 4 Property 2 Name: "entry1_label" *c xConfiguration Dialplan Entry 4 Property 2 Value: "Secretary" *c xConfiguration Dialplan Entry 4 Propert
TANDBERG Video Portal Data port Command Interface User Guide *c xConfiguration Dialplan Entry 4 Property 14 Name: "entry5_label" *c xConfiguration Dialplan Entry 4 Property 14 Value: "Menu" *c xConfiguration Dialplan Entry 4 Property 15 Name: "entry5_nettype" *c xConfiguration Dialplan Entry 4 Property 15 Value: "H323" *c xConfiguration Dialplan Entry 4 Property 16 Name: "entry5_bnumber" *c xConfiguration Dialplan Entry 4 Property 16 Value: "90370018" Ethernet Sets LAN port speed.
TANDBERG Video Portal Data port Command Interface User Guide Xconf H323Gatekeeper Authentication *c xConfiguration H323Gatekeeper Authentication Address: “abc.def.ghi.jkl” *c xConfiguration H323Gatekeeper Authentication Mode: Off *c xConfiguration H323Gatekeeper Authentication ID: "" HTTP Enables or disables access to HTTP services. NOTE! Changes become effective after reboot.
TANDBERG Video Portal Data port Command Interface User Guide • • Gateway: Sets the gateway IP address. If a gateway is located on the LAN and the Video Portal needs to reach nodes through this gateway, the gateway address can be set using the gateway variable (the IP address of the gateway will be set automatically if the Video Portal is in DHCP mode) Domain Name: Sets the domain name string of which the gateway is part of. Minimum 0, maximum 64 characters.
TANDBERG Video Portal Data port Command Interface User Guide or SIP Interface Transport Default: --sub-commands: • Mode: Specifies whether the system uses a default SIP proxy. • Address: Specifies the IPv4 address or FQDN of the SIP proxy. • Type: Specifies the type of the SIP proxy. • Transport Default: Determines which transport type will be used for SIP calls to and from the traversal server.
TANDBERG Video Portal Data port Command Interface User Guide *c xConfiguration SNMP SystemContact: "" *c xConfiguration SNMP SystemLocation: "" *c xConfiguration SNMP HostIPAddr 1: "127.0.0.1" *c xConfiguration SNMP HostIPAddr 2: "127.0.0.1" *c xConfiguration SNMP HostIPAddr 3: "127.0.0.
TANDBERG Video Portal Data port Command Interface User Guide 4.2.2. General Video Portal Commands Command: Description: ExternalManager This command sets the path and address of the TMS server. A message is sent to TMS when the Video Portal starts up to signal TMS that the Video Portal is ready.
TANDBERG Video Portal Data port Command Interface User Guide 4.2.3. System Status Commands Command: Description: Dialplan Shows the dialplan configuration. Example: *s Dialplan 1: Entry: DialplanEntryId: 1 Enabled: On Name: "H323 - SIP" NetType: H323 Prefix: "9047123456" Suffix: "" ServiceId: 2 Property: Name: "nettype" Value: "SIP" Property: Name: "avmode" Value: "5" Property: Name: "prefix" Value: "" Property: Name: "suffix" Value: "@10.47.8.
TANDBERG Video Portal Ethernet Data port Command Interface User Guide Displays the configuration of the Ethernet interface Ethernet Status format: < MacAddress> --Parameters: • MacAddress, The mac address of the Ethernet interface • Speed, The speed of the interface, possible values are Auto/10half/10full/100half/100full.
TANDBERG Video Portal Data port Command Interface User Guide Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" Expression: "" *s/end H323Gatekeeper Displays the status of the connection with the gatekeeper.
TANDBERG Video Portal Data port Command Interface User Guide Name> --Parameters: • Address, the IP address of the Video Portal • SubnetMask, the subnetmask used for the connected network • Gateway, the gateway to route traffic to an IP number outside the connected network • DNS Server [1.. 5] Address, the IP numbers of maximum 5 DNS servers • Domain, the name of the domain the Video Portal is part of. Example of IP feedback: *s IP: Address: "10.31.0.5" SubnetMask: "255.255.248.0" Gateway: "10.31.0.
TANDBERG Video Portal Data port Command Interface User Guide Options Parameters: ---Example of Options feedback: *s Options: Option 1: Key: "115201P1-1-43F072FC" Description: "1 trunk" *s/end Service Displays all configured/uploaded services. Service Status format: Service [1..64] Example of Service feedback: *s Service 1 (status=Active): ServiceId: 1 Enabled: On Name: "Direct Inwards Dialing" ServiceFile: "/usr/local/ividerengine/services/did.
TANDBERG Video Portal Data port Command Interface User Guide Status format: Name> ReleaseDate> Configuration Telephony:> VideoTelephony:> SerialNumber> MainBoard> AdditionalBoard> Configuration: PRI> TemperatureCelcius> TemperatureFahrenheit> --Parameters: • ProductType, the name of the product, e.g.
TANDBERG Video Portal Data port Command Interface User Guide Configuration: PRI:41 TemperatureCelcius: NA TemperatureFahrenheit: NA *s/end 4.2.4. Debug Commands Command: Desription: Syslog Enables a real-time log of Bonding, H.221 and H324m, ISDN, RTSP, IVider, and IVider Engine activity. Note! H323 and SIP logging is presented using the following command: tsh –a H323 (SIP). Note! Logging via the serial port is limited by the speed of the serial port, which might result in loss of logging data.
TANDBERG Video Portal Data port Command Interface User Guide Example: xCommand Boot *r Result (status=OK): / *r/end OK CUIL reboot request, restarting CheckDisk This command shows the presence and the status of the internal harddisk. Example: xCommand CheckDisk *r Result (status=OK): CheckDisk: "Disk present" CheckDisk: "Disk mounted" CheckDisk: "Can read and write file on disk" *r/end OK ClearDialplanEntries This command deletes all dial plans.
TANDBERG Video Portal Dial Data port Command Interface User Guide This command establishes a dial out to an end point Parameters: • CalledParty: End point to be connected with the service. • CallingParty: Service telephone number. • NetType: Nettype of the end point to be called. • CallType: Call type is either voice (Tlph), or voice and video (Vtlph). OK Result parameter: • Session ID:
TANDBERG Video Portal Data port Command Interface User Guide Example: xCommand DisconnectCall ABCD123456 *r Result (status=OK): *r/end OK EraseDisk This command wipes all the data from the internal harddisk Example: xCommand EraseDisk *r Result (status=OK): *r/end OK FeedbackDeregister Command used to deregister XML feedback over HTTP(S). Parameters: • ID: <1 .. 3> ID for the registration to deregister. OK Result parameters: • ID: <1 ..
TANDBERG Video Portal Data port Command Interface User Guide • • Cause: <1…> Cause code specifying why the command was not accepted by the system Description Textual description of the cause code. Example: xCommand feedbackregister url:http://10.47.14.185:8000 expression.1:status/call expression.2:status/conference *r Result (status=OK): ID: 2 *r/end OK OptionKeyAdd Command used to set new option keys.
TANDBERG Video Portal Data port Command Interface User Guide Example (Delete Service nr. 10): xCommand ServiceEntryDelete 10 *r Result (status=OK): / *r/end OK ServiceEntrySwap Command used to swap service numbers. Parameters: • ServiceEntryNumber(r): <1..100> • ServiceEntryNumber2(r): <1..100> Example (Swap Service nr.
TANDBERG Video Portal Data port Command Interface User Guide General User Commands About Shows following system information: Software version: R3.0 Portions of this software are licensed under 3rd party licenses. See the CD accompanying this product for details. Help or ? Displays the help menu.
TANDBERG Video Portal Data port Command Interface User Guide "xfeedback register status/call" - to monitor call changes "xfeedback register status/call--" - to monitor only call state changes "xfeedback register configuration" - to monitor all configuration changes Xhistory The special command xhistory presents the status of the last 255 calls, made to or from the Video Portal,via a cyclic buffer mechanism.
