background image

TANDBERG 3G Gateway 

                                                  Data port Command Interface User Guide

 

 

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 .. 3> 

 

ERROR Result parameters: 

 

Cause: <1…> 

Cause code specifying why the command was not accepted by the system 

 

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: 

 

ID: <1 .. 3> 

ID for the registration. If this parameter is omitted the system uses the first 

vacant ID. 

 

URL(r): <S: 0, 256> 

The URL to post feedback to. 

 

Expression: 1 .. 15: <S: 0, 256> 

XPath expression 

 

OK Result parameters: 

 

ID: <1 .. 3> 

 
ERROR Result parameters: 

 

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 

D1320203       

                                                                                                                       35 

Summary of Contents for D1320203

Page 1: ...TANDBERG 3G Gateway Data port Command Interface User Guide TANDBERG 3G Gateway Data port Command Interface User Guide Software version R 3 D1320203 TANDBERG D1320203 1 ...

Page 2: ... 2 2 TROUBLESHOOTING 4 3 CONNECTING TO THE DATA PORT COMMAND INTERFACE USING TELNET 6 4 THE TANDBERG 3G GATEWAY COMMANDS 7 4 1 INTRODUCTION 7 4 1 1 Command format 7 4 1 2 Command types 8 4 2 THE COMMANDS 8 4 2 1 System Configuration Commands 9 4 2 2 General 3G Gateway Commands 20 4 2 3 System Status Commands 25 4 2 4 Debug Commands 32 4 2 5 Special Commands 33 4 3 INDEX COMMANDS 38 D1320203 2 ...

Page 3: ...et 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 3G Gateway 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 3G Gateway Data port Command Interface pl...

Page 4: ...ice 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 3G Gateway s RS 232 port an...

Page 5: ...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 3G Gateway 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 directions1 1 It requires a null modem cable t...

Page 6: ...rk interface supporting the TCP IP protocol When connected to the 3G Gateway 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 3G Gateway Release R3 0 SW Release Date 2007 03 13 NOTE If the TANDBERG 3G Gateway has been protected with an IP password you will be prompted to enter this password b...

Page 7: ...uration 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 para...

Page 8: ... in bold Xconf telnet mode on OK When issuing a Parameter Setting Command without a parameter the 3G Gateway 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 com...

Page 9: ...e 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 matched 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...

Page 10: ...ar 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 ...

Page 11: ...Configuration Dialplan Entry 1 Property 5 Value 0 c xConfiguration Dialplan Entry 1 Property 6 Name allowredirectdid c xConfiguration Dialplan Entry 1 Property 6 Value 0 c xConfiguration Dialplan Entry 1 Property 7 Name usesubnumber c xConfiguration Dialplan Entry 1 Property 7 Value 0 Example of an IVR Dialplan for mobile to H323 calls Note For IVR ServiceId 2 avmode equals 1 2 3 4 or 5 for Audio ...

Page 12: ...Note For TMS ServiceId 3 c xConfiguration Dialplan Entry 3 Enabled On c xConfiguration Dialplan Entry 3 Name TMS corp dir c xConfiguration Dialplan Entry 3 NetType H323 c xConfiguration Dialplan Entry 3 Prefix 90372001 c xConfiguration Dialplan Entry 3 Suffix c xConfiguration Dialplan Entry 3 ServiceId 4 c xConfiguration Dialplan Entry 3 Property 1 Name tmsaddress c xConfiguration Dialplan Entry 3...

Page 13: ...ok c xConfiguration Dialplan Entry 4 Property 6 Name entry2_nettype c xConfiguration Dialplan Entry 4 Property 6 Value H323 c xConfiguration Dialplan Entry 4 Property 7 Name entry2_bnumber c xConfiguration Dialplan Entry 4 Property 7 Value 90372001 c xConfiguration Dialplan Entry 4 Property 8 Name entry3_label c xConfiguration Dialplan Entry 4 Property 8 Value Manual Dial c xConfiguration Dialplan...

Page 14: ... changes will apply Ethernet speed parameters 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 3G Gateway 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 gate...

Page 15: ...bles or disables access to HTTPS services NOTE Changes become effective after reboot Without https no web GUI is available HTTPS Mode On Off Example of HTTPS feedback c xConfiguration HTTPS Mode Off IP Configures the LAN interfaces when static IP address allocation is used NOTE The 3G Gateway needs to reboot before the changes will take effect IP Assignment DHCP Static or IP Address IPAddr or IP A...

Page 16: ...NI ATT Euro Japan or ISDN PRI SwitchType NI ATT Euro Japan or ISDN PRI Interface LowChannel 1 31 or ISDN NationalPrefix S 0 4 or ISDN InternationalPrefix S 0 4 Parameters sub commands Within ISDN different bearer capabilities are used to signal the type of date Voice Data H320 H324M which is used by switches and other equipment to determine what to do with the data or the call compand neglect etc ...

Page 17: ...tel Experimental or SIP Interface Transport Default TCP UDP TLS 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 Example of SIP feedback c xConfiguration SIP Mode On ...

Page 18: ...ost 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 c xConfiguration SNMP SystemContact c xConfiguration SNMP SystemLocation c xConfiguration SNMP HostIPAddr 1 127 0 0 1...

Page 19: ...BERG 3G Gateway Data port Command Interface User Guide Telnet Enables or disables telnet interface on the 3G Gateway Telnet Mode On Off Example of Telnet feedback c xConfiguration Telnet Mode On D1320203 19 ...

Page 20: ...s the address of the NTP server NTP Address S 0 64 sub commands 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 3G Gateway needs to reboot before the changes will take effect Options 1 64 Key S 0 90 sub commands Key Option key for e g BRI PRI or SS7 trunks VP call package Example of Options feedback...

Page 21: ...d international messages Law audio standard Either ALAW or ULAW An a law algorithm is a standard companding i e compressing and expanding algorithm used in European digital communication systems to optimize i e modify the dynamic range of an analog signal for digitizing The µ law algorithm is similar to a law and used in North American and Japanese systems LinkSet Mode Enable or disable linksets L...

Page 22: ...figuration SS7 OPC 0 c xConfiguration SS7 NetworkIndicator National0 c xConfiguration SS7 Law ALaw c xConfiguration SS7 LinkSet 1 Mode Off c xConfiguration SS7 LinkSet 1 DPC 0 c xConfiguration SS7 LinkSet 1 Link 1 Mode Off c xConfiguration SS7 LinkSet 1 Link 1 Trunk 0 c xConfiguration SS7 LinkSet 1 Link 1 Timeslot 0 c xConfiguration SS7 LinkSet 1 Link 1 SLC 0 c xConfiguration SS7 LinkSet 1 Link 2 ...

Page 23: ... Trunk 4 CircuitIdentificationCode 0 c xConfiguration SS7 Route 1 DPC 0 c xConfiguration SS7 Route 1 Priority 0 c xConfiguration SS7 Route 1 LinkSet Off c xConfiguration SS7 Route 2 DPC 0 c xConfiguration SS7 Route 2 Priority 0 c xConfiguration SS7 Route 2 LinkSet Off c xConfiguration SS7 Route 3 DPC 0 c xConfiguration SS7 Route 3 Priority 0 c xConfiguration SS7 Route 3 LinkSet Off c xConfiguratio...

Page 24: ...er Guide c xConfiguration SS7 Route 7 DPC 0 c xConfiguration SS7 Route 7 Priority 0 c xConfiguration SS7 Route 7 LinkSet Off c xConfiguration SS7 Route 8 DPC 0 c xConfiguration SS7 Route 8 Priority 0 c xConfiguration SS7 Route 8 LinkSet Off D1320203 24 ...

Page 25: ... 2 type BChannel status Idle s end s BRI 2 ready False Layer1Alarm On Layer2Alarm On s end s BRI 3 ready False Layer1Alarm On Layer2Alarm On s end s BRI 4 ready False Layer1Alarm On Layer2Alarm On s end 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 Pro...

Page 26: ...tus OK CheckDisk Disk present CheckDisk Disk mounted CheckDisk Can read and write file on disk s end Ethernet Displays the configuration of the Ethernet interface Ethernet Status format MacAddress Speed Parameters MacAddress The mac address of the Ethernet interface Speed The speed of the interface possible values are Auto 10half 10full 100half 100full Example of Ethernet feedback s Ethernet MacAd...

Page 27: ... Feedback ID Feedback Parameters 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 Expression Expression Expression Expression Expression Expression Expression Expression Expression Expres...

Page 28: ...ver 5 Address Domain Name Parameters Address the IP address of the 3G Gateway 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 3G Gateway is part of Example of IP feedback s IP Address 10 31 0 5 SubnetMask 255 25...

Page 29: ...orrection 1 s end Options Display all installed option keys Options Parameters Example of Options feedback s Options Option 1 Key 115201P1 1 43F072FC Description 1 trunk s end PRI 1 4 Displays the status of the PRI line PRI Parameters PRI 1 4 indicating the status of the different PRI lines Example of PRI feedback s PRI 1 ready True BChannelsTotal 30 BChannelsFree 30 Channel 1 type BChannel status...

Page 30: ...Idle Channel 24 type BChannel status Idle Channel 25 type BChannel status Idle Channel 26 type BChannel status Idle Channel 27 type BChannel status Idle Channel 28 type BChannel status Idle Channel 29 type BChannel status Idle Channel 30 type BChannel status Idle Channel 31 type BChannel status Idle s end Service Shows the status of configured default services Example Xstatus service 1 s Service 1...

Page 31: ... supported video channels 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 PRI the amount of PRIs in the target system BRI the amount of BRIs in the target system TemperatureCelcius temperature of the main board in Celcius TemperatureFahrenheit temperature of the main board ...

Page 32: ... 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 1 0x0001 ISDN 4 0x0004 RTSP 8 0x0008 IVider 16 0x0010 Engine 64 0x0040 FileStreamer 128 0x0080 ContentStreamer 256 0x0100 Transcoder 512 0x0200 Mux 1024 0x0400 Cuil 2048 0x0800 volume message volume m...

Page 33: ...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 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 DefaultValuesSet Level 1 3 Example restore all default facto...

Page 34: ...K DialplanEntryDelete This command deletes the indicated entry of a dialplan Parameter DialplanEntryNumber 1 64 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 DialplanEntryNumber 1 64 DialplanEntryNumber2 1 64 Example xCommand DialplanEntrySwap 1 3 r Result status OK r end OK DisconnectC...

Page 35: ...m 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 ID 1 3 ID for the registration If this parameter is omitted the system...

Page 36: ... to delete option keys Parameters Key r S 0 90 option key Example Delete Option Key nr 1 xCommand OptionKeyDelete 1 r Result status OK r end OK ServiceEntryDelete Command used to delete services from the 3G Gateway Parameters ServiceEntryNumber r 1 100 Example Delete Service nr 10 xCommand ServiceEntryDelete 10 r Result status OK r end OK ServiceEntrySwap Command used to swap service numbers Param...

Page 37: ...TANDBERG 3G Gateway Data port Command Interface User Guide r Result status OK r end OK D1320203 37 ...

Page 38: ...pt 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...

Page 39: ...tor all configuration changes Xhistory The special command xhistory presents the status of the last 255 calls made to or from the 3G Gateway via a cyclic buffer mechanism NOTE If the 3G Gateway 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 l Call 1 type Vtlph protocol H323 direction In...

Reviews: