TANDBERG D1392602 Network Card User Manual
Contents
1. D1392602 16 TANDBERG Video Portal Data port Command Interface User Guide Or SIP Interface Transport Default lt TCP UDP TLS gt sub commands e Mode Specifies whether the system uses a default SIP proxy e Address Specifies the IPv4 address or FQDN of the SIP proxy e Type Specifies the type of the SIP proxy e Transport Default Determines which transport type will be used for SIP calls to and from the traversal server Example of SIP feedback c xConfiguration SIP Mode On c xConfiguration SIP Interface Server Address 127 0 0 1 c xConfiguration SIP Interface Server Type Auto c xConfiguration SIP Interface Transport Default UDP SNMP Configures the SNMP Note For more information about SNMP please read the TANDBERG SNMP application note NMP Mode lt On Off ReadOnly TrapsOnly gt A NMP CommunityName lt S 0 16 gt A NMP SystemContact S 0 70 gt A NMP SystemLocation S 0 70 gt A No NO MO MO NMP HostIPAddr 1 3 lt IPAddr gt parameters e Mode On Off ReadOnly TrapsOnly gt Community Name Text string of maximum 16 characters System Contact Text string of maximum 70 characters System Location Text string of maximum 70 characters Host IP Addr The IP addresses of max 3 SNMP trap hosts sub commands e Mode enables or sets the mode of SNMP support e Community Name is used to authenticate SNMP requests SNMP requests must2. DefaultValuesSet Level 1 3 gt Example restore all default factory setting xCommand DefaultValuesSet r Result status OK r end OK D1392602 27 TANDBERG Video Portal Data port Command Interface User Guide Dial This command establishes a dial out to an end point Parameters e CalledParty lt S 0 60 gt End point to be connected with the service e CallingParty lt S 0 605 Service telephone number e NetType AII H324m H323 SIP Nettype of the end point to be called e CallType Tlph Vtlph Call type is either voice Tlph or voice and video Vtlph OK Result parameter e Session ID lt S 1 50 gt Example xCommand Dial CalledParty 0612345678 CallingParty 0207947123 Nettype H324m Calltype Vtlph r Result status OK Dial dial 904023 5 r end OK DialplanEntryDelete This command deletes the indicated entry of a dialplan Parameter e DialplanEntryNumber lt 1 64 gt Example xCommand DialplanEntryDelete 1 r Result status OK r end OK DialplanEntrySwap This command swaps two dial plan entries in the dial plan list Parameters e DialplanEntryNumber lt 1 64 gt e DialplanEntryNumber2 lt 1 64 gt Example xCommand DialplanEntrySwap 1 3 r Result status OK r end OK DisconnectCall This command disconnects a call either via the Session ID or the Call Leg ID Parameter e CallID S 0 505 Either the Call leg
3. ContentStreamer 256 0x0100 Transcoder 512 0 0200 Mux 1024 0x0400 Cuil 2048 0 0800 volume message volume mask default 0 Medium 1 0x01 High 2 0x02 Show timestamp 4 0x04 Show IP address 8 0x08 Show Process 16 0x10 Show Session ID 32 0x20 For instance to view the logging of the H324m Transcoder and IVider components the mask value equals 1 512 32 545 4 2 5 Special Xcommand Commands Command Description Boot Reboots the system D1392602 26 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 Example xCommand ClearDialplanEntries r Result status OK r end OK ClearServiceEntries This command deletes all uploaded Services at once Example xCommand ClearServiceEntries r Result status OK r end OK DefaultValuesSet This command is used to restore factory default settings Issuing this command with no parameters will restore all settings except network settings and option keys
4. audio video or an audio only call is being setup depending on the capabilities choice of the initiating endpoint i e when an audio 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 under 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 Dialpla
5. c xConfiguration Dialplan Entry 3 Name TMS corp dir c xConfiguration Dialplan Entry 3 NetType H323 c xConfiguration Dialplan Entry 3 Prefix 90372001 n c xConfiguration Dialplan Entry 3 Suffix c xConfiguration Dialplan Entry 3 Serviceld 4 c xConfiguration Dialplan Entry 3 Property 1 Name c xConfiguration Dialplan Entry 3 Property 1 Value c xConfiguration Dialplan Entry 3 Property 2 Name c xConfiguration Dialplan Entry 3 Property 2 Value c xConfiguration Dialplan Entry 3 Property 3 Name c xConfiguration Dialplan Entry 3 Property 3 Value Example of a Menu Dialplan for H323 calls Note For TMS Serviceld 4 c xConfiguration Dialplan Entry 4 Enabled On c xConfiguration Dialplan Entry 4 Name Menu c xConfiguration Dialplan Entry 4 NetType H323 tmsaddress 10 47 1 10 allowredirectphonebook DUO DTMFInfoScreen E On D1392602 TANDBERG Video Portal Data port Command Interface User Guide c xConfiguration Dialplan Entry 4 Prefix 90370010 nn c xConfiguration Dialplan Entry 4 Suffix c xConfiguration Dialplan Entry 4 Serviceld 3 c xConfiguration Dialplan Entry 4 Property 1 Name c xConfiguration Dialplan Entry 4 Property 1 Value c xConfiguration Dialplan Entry 4 Property 2 Name c xConfiguration Dialplan Entry 4 Property 2 Value c xConfiguration Dialplan Entry 4 Property 3 Name c xConfiguration Dialplan Entry 4 Property 3 Value c xConf
6. Address feedback c xConfiguration IP Address 127 0 0 1 Loadlimit Sets the processor load percentage at which calls should be routed to another Video Portal LoadLimit lt 0 100 gt Example of Loadlimit feedback c xConfiguration LoadLimit 85 Services Displays all configured uploaded ivr file services used in dial plans Services Service 1 64 Enabled lt On Off gt Services Service 1 64 Name S 0 30 gt Services Service 1 64 ServiceFile S 0 1285 sub commands Enabled lt On Off gt Enable the service Name lt S 0 30 gt Specifies the name of the service ServiceFile S 0 128 Specifies which ivr file is used as definition of this service Logging lt On Off gt Enables the service logging functionality Example of Service feedback c xConfiguration Services Service 1 Enabled On c xConfiguration Services Service 1 Name Direct Inwards Dialing c xConfiguration Services Service 1 ServiceFile tandberg services did ivr c xConfiguration Services Service 1 Logging On Session Sets a timeout time for sessions like telnet ssh etc Session TimeOut lt 0 65535 gt Example of Session feedback c xConfiguration Session TimeOut 10000 SIP Configures the SIP Proxy Mode and Address settings SIP Mode lt On Off gt or SIP Interface Server Address lt S 0 255 gt or SIP Interface Server Type lt Auto NortelMicrosoft Cisco Alcatel Experimental gt
7. ID or the Session ID D1392602 28 TANDBERG Video Portal Data port Command Interface User Guide EraseDisk Example xCommand DisconnectCall ABCD123456 r Result status OK r end OK 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 e ID 1 3 ID for the registration to deregister OK Result parameters D 1 3 ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xCommand feedbackderegister id 1 r Result status OK ID 2 r end OK FeedbackRegister Command used to instruct the system to return XML feedback over HTTP S to specific URLs What parts of the Status and Configuration XML documents to monitor are specified by XPath expressions The system supports issuing feedback to 3 different URLs The system allows a total of 20 XPath expressions to be registered with a maximum of 15 for a single URL Parameters e ID 1 3 ID for the registration If this parameter is omitted the system uses the first vacant ID e URL r lt S 0 2565 The URL to post feedback to e Expression 1 15 S 0 256 XPath expression OK Result parameters e D 1 3 ERROR Result par
8. 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 entryS_bnumber c xConfiguration Dialplan Entry 4 Property 16 Value 90370018 Ethernet Sets LAN port speed NOTE The Video Portal needs to reboot before the changes will apply Ethernet speed parameters e speed auto 10half 10full 100half 100full The speed is either set to auto or manually from 10mb half duplex to 100mb full duplex When set to auto the Video Portal will automatically negotiate with the network and use the best available setting Example of Ethernet feedback c xConfiguration Ethernet Speed Auto H323CallSetup Configures for direct or via gatekeeper calling H323CallSetup Mode lt Direct Gatekeeper gt Example of H323CallSetup feedback c xConfiguration H323CallSetup Mode Direct H323Gatekeeper Sets gatekeeper parameters NOTE H 323 services must be set before the Video Portal can be registered to a gatekeeper H323Gatekeeper Address lt IPAddr gt H323Gatekeeper Authentication Mode lt Auto Off gt H323Gatekeeper Authentication ID S 0 50 gt Authentication Password S 0 50 gt sub commands e Authentic
9. Server 1 Address 127 0 0 1 Server 2 Address 127 0 0 1 Server 3 Address 127 0 0 1 Server 4 Address 127 0 0 1 Server 5 Address 0 0 0 0 Domain Name s end NTP Returns the IP address of the NTP server Status format lt Status gt lt Address gt lt Port gt lt Last Update gt lt Last Correction gt Parameters e Status indicates whether the NTP server is active or not e Address the IP address of the NTP server e Port is default 123 e LastUpdate indicates the last update date and time e Last Correction the time correction in seconds Example of NTP feedback s NTP status Active Address 131 188 3 220 Port 123 LastUpdate 2006 04 10 15 21 14 LastCorrection 1 s end Options Display all installed option keys D1392600 23 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 status Active Serviceld 1 Enabled On Name Direct Inwards Dialing ServiceFile usr local ividerengine services did ivr Logging Off InstallId 5 s end s Service 2 status Active Serviceld 2 Enabled On Name ServiceFile usr local ividerengine services ivr ivr Logging Off InstallId
10. 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 examp
11. after stripping both prefix and suffix is called remainder See also the useremainder option in a DID service e Serviceld Select one of the services as configured in the Services menu item Each dial plan has the following service specific fields e Property User configurable arguments used within a service e 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 the 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
12. 7 s end s Service 3 status Active Serviceld 3 Enabled On Name TMS Corporate Directory ServiceFile usr local ividerengine services tmscorpdir ivr Logging Off InstallId 9 s end SystemLoad Returns the current system load in percentage SystemLoad Status format SystemLoad lt 1 100 gt SystemUnit Displays information regarding the physical system SystemUnit D1392602 24 TANDBERG Video Portal Data port Command Interface User Guide Status format lt ProductType gt lt Uptime gt lt Software Version gt Name gt ReleaseDate gt Configuration Telephony gt VideoTelephony gt lt Hardware Version gt SerialNumber gt MainBoard gt AdditionalBoard gt Configuration PRI gt TemperatureCelcius gt TemperatureFahrenheit gt Parameters ProductType the name of the product e g Video Portal Uptime the time the system is running since the last reboot in seconds e Software o Version the unique name of the software o Name o ReleaseDate the time and date of the build of this software o Configuration e Telephony the amount of supported voice channels e VideoTelephony the amount of supported video channels e Hardware o Version software ID o SerialNumber software serial number o MainBoard the ID of the main board o AdditionalBoard indicates extra boards in the box o Configuration e PRI the amount of PRIs in the target system BRI the amou
13. SystemUnit feedback c xConfiguration SystemUnit Name Telnet Enables or disables telnet interface on the Video Portal Telnet Mode lt On Off gt Example of Telnet feedback c xConfiguration Telnet Mode On D1392602 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 ExternalManager Path S 0 2555 Or ExternalManager Address lt S 0 64 gt sub commands e Path e Address the IP address of the manager Example of ExternalManager feedback c xConfiguration ExternalManager Path tms public external management SystemManagementService asmx c xConfiguration ExternalManager Address NTP This command sets the address of the NTP server NTP Address S 0 64 gt sub commands e Address the IP address of the server Example of NTP feedback c xConfiguration NTP Address 131 188 3 220 Options View and adapt option keys NOTE The Video Portal needs to reboot before the changes will take effect Options 1 64 Key S 0 90 gt sub commands e Key Option key for e g BRI PRI or SS7 trunks VP call package Example of Options feedback c xConfiguration Options 1 Key 115201SS7 1 55C3EBB7 c xConfigurat
14. 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 TIN TRODU CEION Er 3 2 CONNECTING TO THE DATA PORT COMMAND INTERFACE THROUGH THE RS 232 PORT 4 2 1 HARDWARE CABLING ass reete teer e terere tenir BID 4 22 TROUBLESHOOTING 221525333 ecrit reete te ta eed bea ave et Det ini 4 3 CONNECTING TO THE DATA PORT COMMAND INTERFACE USING TELNET 6 4 THE TANDBERG VIDEO PORTAL COMMANDS eee ee ee eese eese seen nest etn oeste tese 7 4 1 INTRODUCTION i eoi RANG GG AIN GN NAPARAN DAN e BANG dete de HDI 7 4I ei e e e ete duce epe teme pee un 7 42 Command types esed ie tte td e Rh epe e Ue eR ede odia dents 7 4 2 TAF COMMANDS 8 4 2 1 System Configuration Commands eese esee 9 4 2 2 General Video Portal 5 19 42 3 System Status Commands eee sete een ceres 20 424 iDebug Commands adii due a e e eet poe et te eb e ue e edad teed 26 42 5 Special Commidnds su e e tet Ee eT TERMS HU e ans apes tue ea 26 4 3 INDEX COMMANDS dotem Nt tim OI UBI 32 D1392602 2 TANDBERG Video Portal Dat
15. a 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 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 othe
16. ameters D1392602 29 TANDBERG Video Portal Data port Command Interface User Guide e Cause 1 Cause code specifying why the command was not accepted by the system e 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 OptionKeyA dd Command used to set new option keys Parameters e Key r S 0 90 gt option key NOTE Always reboot the system after adding option keys for the option key to take effect Example Xcommand OptionKeyAdd 115201P1 1 6A96DAA4 r Result status OK r end OK OptionKeyDelete Command used to delete option keys Parameters e Key r S 0 90 gt option key Example Delete Option Key nr 1 xCommand OptionKeyDelete 1 r Result status OK r end OK RestoreDefaultServices Command used to restore the factory default services Example Xcommand RestoreDefaultServices r Result status OK r end OK ServiceEntryDelete Command used to delete services from the Video Portal Parameters e ServiceEntryNumber r lt 1 100 gt D1392602 30 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 nu
17. ation Mode configures the use of authentication against a gatekeeper e Authentication ID Configures the user name used within an authentication challenge e Authentication Password sets the password used within the authentication process NOTE Authentication Password is write only Example of H323Gatekeeper feedback D1392602 14 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 HTTP Mode lt On Off gt Example of HTTP feedback c xConfiguration HTTP Mode On HTTPS Enables or disables access to HTTPS services NOTE Changes become effective after reboot Without https no web GUI is available HTTPS Mode lt On Off gt Example of HTTPS feedback c xConfiguration HTTPS Mode Off IP Configures the LAN interfaces when static IP address allocation is used NOTE The Video Portal needs to reboot before the changes will take effect IP Assignment lt DHCP Static gt IP Address lt IPAddr gt IP Address Subnetmask lt Subnetmask gt Address Gateway lt IPAddr gt Address DNS Server 1 5 Address lt IPAddr gt IP Address DNS Domain Name S 0 645 param
18. eters e DNS Server Number identifying one of 5 DNS servers which can be configured If this parameter is omitted the command applies to the first configuration 1 sub commands e Assignment Selects between DHCP Dynamic Host Configuration Protocol or static IP address allocation When DHCP is selected the Video Portal will automatically receive all the necessary information from the DHCP server This function should be used when the Video Portal is connected to a LAN using DHCP When using this mode IP address and IP subnet mask are not used because the DHCP server supplies these parameters e Address Sets the static IP address for the given LAN interface e Subnetmask Sets the subnet mask variable Subnet mask defines the network class If the setting is 255 255 255 0 the local network will support up to 256 nodes denoting a class C network If the setting is 255 255 0 0 the local network is a class B network with 65536 addressable nodes D1392602 15 TANDBERG Video Portal Data port Command Interface User Guide e 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 e Domain Name Sets the domain name string of which the gateway is part of Minimum 0 maximum 64 characters Example of IP
19. have this password in order to receive a response from the SNMP agent in the Video Portal e System Contact Used to identify the system contact via SNMP tools such as HPOpenView or TANDBERG Management Suite e System Location Used to identify system location via SNMP tools such as HPOpenView or TANDBERG Management Suite e Host IP Addr identifies the IP address of the SNMP manager Up to three different SNMP Trap Hosts can be defined Your LAN administrator should provide the correct values for these fields Example of SNMP feedback c xConfiguration SNMP Mode On c xConfiguration SNMP CommunityName public D1392602 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 1 SSH Enables or disables SSH interface on the Video Portal SSH Mode lt On Off gt Example of SSH feedback c xConfiguration SSH Mode On SystemUnit Sets the Video Portal name and password SystemUnit Name S 0 50 gt or SystemUnit Password lt S 0 16 gt Parameters e Name Text string of maximum 50 characters e Password Text string of maximum 16 characters sub commands e Name sets the name of the Video Portal e Password sets the password of the Video Portal Example of
20. iguration Dialplan Entry 4 Property 4 Name c xConfiguration Dialplan Entry 4 Property 4 Value c xConfiguration Dialplan Entry 4 Property 5 Name c xConfiguration Dialplan Entry 4 Property 5 Value c xConfiguration Dialplan Entry 4 Property 6 Name c xConfiguration Dialplan Entry 4 Property 6 Value c xConfiguration Dialplan Entry 4 Property 7 Name c xConfiguration Dialplan Entry 4 Property 7 Value c xConfiguration Dialplan Entry 4 Property 8 Name c xConfiguration Dialplan Entry 4 Property 8 Value c xConfiguration Dialplan Entry 4 Property 9 Name c xConfiguration Dialplan Entry 4 Property 9 Value c xConfiguration Dialplan Entry 4 Property 10 Name c xConfiguration Dialplan Entry 4 Property 10 Value c xConfiguration Dialplan Entry 4 Property 11 Name c xConfiguration Dialplan Entry 4 Property 11 Value c xConfiguration Dialplan Entry 4 Property 12 Name c xConfiguration Dialplan Entry 4 Property 12 Value c xConfiguration Dialplan Entry 4 Property 13 Name c xConfiguration Dialplan Entry 4 Property 13 Value entry3 nettype entry3 bnumber 90370003 entry4 label Support entry4 nettype allowredirectep 0 entryl label Secretary entryl nettype H323 entryl bnumber 554046 entry2 label Phone Book entry2 nettype H323 entry2 bnumber 90372001 entry3 label Manual Dial H323 H323 entry4 bnumber 554046 D1392602 TANDBERG Video
21. ion Options 2 Key 115201P1 1 6A96DAA4 c xConfiguration Options 3 Key 115201P1 2 1811D4FA c xConfiguration Options 4 Key 115201P1 3 79828C53 c xConfiguration Options 5 Key 115201P1 4 B5E5BD4A D1392602 19 TANDBERG Video Portal 4 2 3 System Status Commands Data port Command Interface User Guide Command Description Dialplan Shows the dialplan configuration Example s Dialplan 1 Entry DialplanEntryld 1 Enabled On Name H323 SIP NetType H323 Prefix 9047123456 Suffix Serviceld 2 Property Name nettype Value SIP Property Name avmode Value 5 Property Name prefix Value Property Name suffix Value 10 47 8 106 Property Name allowredirectivr Value 0 Property Name DTMFInfoScreen Value On s end OK Disk Diaplays information regarding the internal harddrive Disk Status format Status gt lt CheckDisk gt Parameters e Status is either OK or ERROR Example of Disk feedback s Disk status OK CheckDisk Disk present CheckDisk Disk mounted CheckDisk Can read and write file on disk s end e CheckDisk indicates whether a disk is present mounted and can be read or written to D1392602 20 TANDBERG Video Portal Data port Command Interface User Guide Ethernet Displays the configuration of the Ethernet interface Ethernet Status format MacAddress gt Speed Parameter
22. itive 4 1 2 Command types The commands can be divided into three major classes e Parameter Configuration Commands Xconf e Status Commands Xstat D1392602 7 TANDBERG Video Portal Data port Command Interface User Guide e User Commands Xcom Parameter Configuration Commands are commands that set a system parameter to a specific value E g The command Xconf telnet mode 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 20 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 C
23. ively useremainder equals O or 1 for No and Yes respectively c xConfiguration Dialplan Entry 1 Enabled On c xConfiguration Dialplan Entry 1 Name H324m SIP c xConfiguration Dialplan Entry 1 NetType H324m D1392602 TANDBERG Video Portal Data port Command Interface User Guide c xConfiguration Dialplan Entry 1 Prefix 207947133 nn c xConfiguration Dialplan Entry 1 Suffix c xConfiguration Dialplan Entry 1 Serviceld 1 c xConfiguration Dialplan Entry 1 Property 1 Name c xConfiguration Dialplan Entry 1 Property 1 Value c xConfiguration Dialplan Entry 1 Property 2 Name c xConfiguration Dialplan Entry 1 Property 2 Value c xConfiguration Dialplan Entry 1 Property 3 Name c xConfiguration Dialplan Entry 1 Property 3 Value c xConfiguration Dialplan Entry 1 Property 4 Name c xConfiguration Dialplan Entry 1 Property 4 Value c xConfiguration Dialplan Entry 1 Property 5 Name c xConfiguration Dialplan Entry 1 Property 5 Value c xConfiguration Dialplan Entry 1 Property 6 Name c xConfiguration Dialplan Entry 1 Property 6 Value c xConfiguration Dialplan Entry 1 Property 7 Name c xConfiguration Dialplan Entry 1 Property 7 Value Example of an IVR Dialplan for mobile to H323 calls Note e For IVR Serviceld 2 nettype SIP avmode 5 prefix john smith suffix Q xyz com useremainder O allowredirectdid O usesubnumber 0 e avmode equal
24. le is shown below the user input is shown in bold Xconf DialPlan Entry 1 NetType h xConfiguration Dialplan Entry 1 64 NetType AII H324m H323 SIP Specifies the type of network to listen for incoming connections Numbers 1 64 and AII 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 lt gt 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 lt IPAddr gt h xConfiguration H323Gatekeeper Authentication Mode lt Auto Off gt h xConfiguration H323Gatekeeper Authentication ID S 0 50 gt h xConfiguration H323Gatekeeper Authentication Password S 0 50 NOTE The Data port Command Interface is not case sens
25. mbers Parameters e ServiceEntryNumber r lt 1 100 gt e ServiceEntryNumber2 r lt 1 100 gt Example Swap Service nr 10 amp 11 xCommand ServiceEntrySwap ServiceEntryNumber 10 ServiceEntryNumber2 11 r Result status OK r end OK D1392602 31 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 help Licence Shows 3 party licences License Available 3rd party licenses Miscellaneous GPL licensed software 2 OpenSSL 3 openssh 4 Less 5 libedit 6 Isof 7 net snmp 8 popt 9 zlib Relkey Sets the release key Relkey 3761349040466652 Shows the release key Relkey S relkey 3761349040466652 Xfeedback The special command xfeedback lets the user register user defined XPath expressions with possible exposure options to monitor changes in the data Whenever there is a change in one or more elements addressed by a registered XPath expression the part of the element structure containing these changes will be returned xfeedback usage xfeedback register lt XPathExpression gt or xfeedback deregister lt index gt or xfeedback list or xfeedback paths Paths shows all expressions which can be registered List shows all
26. n 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 e For DID Serviceld 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 respect
27. nt of BRIs in the target system TemperatureCelcius temperature of the main board in Celcius TemperatureFahrenheit temperature of the main board in Fahrenheit Example of SystemUnit feedback s SystemUnit ProductType TANDBERG Video Portal Uptime 15123 Software Version R3 0Beta2 TEST SW Name test ReleaseDate 2007 03 21 17 54 Configuration Telephony 0 VideoTelephony 0 Hardware Version EP 1 0 SerialNumber 43A00001 MainBoard AdditionalBoard D1392602 25 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 Therefore it is advised to use Telnet instead Syslog Level Mask Volume level log level 0 99 0 turns off log mask bitmask default 65535 Mask With this Mask the logging of different components can be turned on The mask has to be used as a bit mask H324m 0x0001 ISDN 4 0x0004 RTSP 8 0x0008 IVider 16 0x0010 Engine 64 0 0040 FileStreamer 128 0x0080
28. onfiguration Commands Command Description plan Mapping of a call onto a service or another call Dialplan Entry 1 64 Enabled lt On Off gt Dialplan Entry 1 64 Name lt S 0 30 gt Dialplan Entry 1 64 NetType AII H324m H323 SIP Dialplan Entry 1 64 Prefix S 0 1285 Dialplan Entry 1 64 Suffix S 0 64 gt Dialplan Entry 1 64 Serviceld lt 0 64 gt Dialplan Entry 1 64 Property 1 16 Name S 0 32 gt Dialplan Entry 1 64 Property 1 16 Value S 0 64 gt Dialplan Entry 1 64 Source 1 8 ID 0 655355 Dialplan Entry 1 64 Source 1 8 Path S 0 1285 sub commands Each dial plan has the following general fields i e Dialplan entry details e Enabled If the box is checked the service becomes available e Name The name of the dial plan as represented in the Dialplan Configuration overview e 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 e Prefix Number to which the first part of the inbound number bnr is matched The prefix is specified in the dial plan entry The prefix is stripped from the inbound number e 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
29. r device capable of serial communication To DTE 2 RD jRecivedaa ToDTE D From DTE o Ground e 8 crs Clartosnd TODTE 9 RI JjRingindcaor 2 DTR KG cd 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 DCE 9 pin CD HD TD DTR GND DSR RTS CTS e e 6 0o e 6 6 6 1 2 3 4 5 6 8 9 o 6066 6 66 6 O O UK gt DTR and RTS are ignored DSR CD and CTS are always asserted while RI is not used 22 Troubleshooting D1392602 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 e Verify that the serial cable is a straight through 9 pin to 9 pin cable e 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 e 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 requires a null modem cable to perform this test D1392602 5 TANDBERG
30. registered expressions note deregistration with index 0 will deregister all registered expressions Examples D1392602 32 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 NOTE If the Video Portal is registered with a Video Portal the call history can only be shown on the respective Video Portal xhistory usage xhistory call 1 255 Examples xhistory call 1 Call 1 typezVtlph protocol H323 direction Incoming LogTag 1 GatewayCallLogTag 0 RemoteNumber 9047123456789 Q931Rate 64 DisconnectCauseValue 16 Duration 67 l end OK D1392602 33
31. s e MacAddress The mac address of the Ethernet interface e Speed The speed of the interface possible values are Auto l1Ohalf 10full 100half 100full Example of Ethernet feedback s Ethernet MacAddress 00 0E 0C 5C B5 7D Speed 100full s end ExternalManager Displays the configuration of the external management system e g TMS ExternalManager Status format Address Protocol lt URL gt Parameters e Address The IP address of the external management system e Protocol the protocol used to access the management system e URL the URL on the management system that should be opened by the Video Portal in case of status updates Example of ExternalManager feedback s ExternalManager Address Protocol HTTP URL tms public external management SystemManagementService asmx s end Feedback 1 3 Lists the URL and feedback expressions registered for the given Feedback ID Feedback Parameters e status on off Indicates if there is HTTP feedback registered for a given Feedback ID ref command FeedbackRegister Example of feedback s Feedback 1 status Off s end s Feedback 1 status On URL http 10 47 14 185 8000 Expression status call status Synced Expression D1392602 21 TANDBERG Video Portal Data port Command Interface User Guide Expression Expression Expression Expression Expression Expression Expression Expression Expre
32. s 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 c xConfiguration Dialplan Entry 2 Enabled On c xConfiguration Dialplan Entry 2 Name H324m H323 c xConfiguration Dialplan Entry 2 NetType H324m c xConfiguration Dialplan Entry 2 Prefix 207947132 nn c xConfiguration Dialplan Entry 2 Suffix c xConfiguration Dialplan Entry 2 Serviceld 2 c xConfiguration Dialplan Entry 2 Property 1 Name c xConfiguration Dialplan Entry 2 Property 1 Value nettype H323 D1392602 TANDBERG Video Portal Data port Command Interface User Guide c xConfiguration Dialplan Entry 2 Property 2 Name c xConfiguration Dialplan Entry 2 Property 2 Value c xConfiguration Dialplan Entry 2 Property 3 Name c xConfiguration Dialplan Entry 2 Property 3 Value c xConfiguration Dialplan Entry 2 Property 4 Name c xConfiguration Dialplan Entry 2 Property 4 Value c xConfiguration Dialplan Entry 2 Property 5 Name c xConfiguration Dialplan Entry 2 Property 5 Value c xConfiguration Dialplan Entry 2 Property 6 Name c xConfiguration Dialplan Entry 2 Property 6 Value avmode ay prefix nn suffix wer allowredirectivr O DTMFInfoScreen On Example of an TMS Corporate Directory Dialplan for H323 calls Note For TMS Serviceld 3 c xConfiguration Dialplan Entry 3 Enabled On
33. ssion Expression Expression Expression Expression s end nn nn H323Gatekeeper Displays the status of the connection with the gatekeeper H323Gatekeeper Status format Status Address Port Parameters e Status indicates whether the Video Portal is registered with the gatekeeper e Address the IP address of the connected gatekeeper e Port the gatekeeper port the Video Portal is connected with Example of H323Gatekeeper feedback s H323Gatekeeper status Registered Address 10 47 9 1 Port 1719 s end IP Displays the IP configuration of the Video Portal IP Status format Address lt SubnetMask gt lt Gateway gt lt DNS Server 1 Address gt Server 2 Address gt Server 3 Address gt Server 4 Address gt Server 5 Address gt Domain D1392602 22 TANDBERG Video Portal Data port Command Interface User Guide Name Parameters e Address the IP address of the Video Portal e SubnetMask the subnetmask used for the connected network e Gateway the gateway to route traffic to an IP number outside the connected network e DNS Server 1 5 Address the IP numbers of maximum 5 DNS servers e 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 1 DNS
Download Pdf Manuals
Related Search