TANDBERG GW Data port Command Interface User Guide TANDBERG 3G GW Data port Command Interface User Guide Software version R2 D1320202 TANDBERG 1
TANDBERG GW Data port Command Interface User Guide Table of Contents 1. INTRODUCTION...........................................................................................................................3 2. CONNECTING TO THE DATA PORT COMMAND INTERFACE THROUGH THE RS232 PORT..................................................................................................................................................4 2.1. 2.2. HARDWARE AND CABLING.................................................
TANDBERG GW 1. Data port Command Interface User Guide Introduction The TANDBERG GW Data port Command Interface User Guide contains guidelines on how to use the textual command interface supported by the GW. 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 GW 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, D-sub connector located on the front of the GW. 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 GW 2.2. Data port Command Interface User Guide Troubleshooting If communication cannot be established between the PC/terminal and the TANDBERG GW’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 GW RS-232 port.
TANDBERG GW 3. Data port Command Interface User Guide Connecting to the Data port Command Interface using Telnet The TANDBERG 3GW has one LAN port. The GW’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 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 TANDBERG TANDBERG 3G Gateway Release R2.
TANDBERG GW Data port Command Interface User Guide 4. The TANDBERG 3G Gateway 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 3G Gateway. A command may be followed by a set of parameters and sub-commands. This chapter gives a description of all valid commands for the 3G Gateway. 4.1.1.
TANDBERG GW • 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 gateway. If the command is syntactically correct the GW returns OK, otherwise the GW returns ERROR. When the parameter is successfully changed, the GW will return the command with the new value. An example is shown below (the user input is shown in bold).
TANDBERG GW Data port Command Interface User Guide 4.2.1. System Configuration Commands Command: H323Gatekeeper Description: Sets gatekeeper parameters. NOTE! H.323 services must be set before the GW can be registered to a gatekeeper.
TANDBERG GW Data port Command Interface User Guide • 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: • Assignment: Selects between DHCP (Dynamic Host Configuration Protocol) or static IP address allocation. When DHCP is selected the GW will automatically receive all the necessary information from the DHCP server.
TANDBERG GW Data port Command Interface User Guide 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). • IncomingBearerCapability: sets the ISDN bearer capability of the incoming 3G calls. In some situations the non correct UDI bearer is used in stead of the right H324M capability.
TANDBERG GW Data port Command Interface User Guide SNMP SystemLocation: or SNMP HostIPAddr [1..3]: --parameters: • Mode: < On/Off/ReadOnly/TrapsOnly > • Community Name: Text string of maximum 16 characters.
TANDBERG GW Data port Command Interface User Guide sub-commands • Name, sets the name of the 3G Gateway • Password, sets the password of the 3G gateway Example of SystemUnit feedback: *c xConfiguration SystemUnit Name: "" 13
TANDBERG GW Data port Command Interface User Guide 4.2.2. General GW Commands Command: Gateway Description: This command is used to configure the 3G gateway dialling rules, like for example direct inward dialling, H323 call prefixes and dial in numbers. It is possible to define 100 services, each with the parameters: • Description indicates the user applied name of the service • InNetType indicates the dial in for this particular service configuration.
TANDBERG GW Data port Command Interface User Guide Example of Gateway feedback: *c xConfiguration Gateway Service 1 Description: "" *c xConfiguration Gateway Service 1 ServiceType: DiD *c xConfiguration Gateway Service 1 InNetType: H324m/3G *c xConfiguration Gateway Service 1 InPrefix: 6789"" *c xConfiguration Gateway Service 1 InPostfix: "" *c xConfiguration Gateway Service 1 OutNetType: H324m/3G *c xConfiguration Gateway Service 1 OutPrefix: "5" *c xConfiguration Gateway Service 1 OutPostfix: "" *c xCon
TANDBERG GW Data port Command Interface User Guide NOTE! The GW needs to reboot before the changes will take effect. Options [1 .. 64] Key: --sub-commands: • Key: Option key for e.g. BRI, PRI or SS7 trunks.
TANDBERG GW Data port Command Interface User Guide LinkSet [1 .. 2] Link [1 .. 2] Timeslot: <1 .. 31> LinkSet [1 .. 2] Link [1 .. 2] SLC: <0 .. 15> Trunk [1 .. 4] Mode: Trunk [1 .. 4] DPC: <0 .. 16383> Trunk [1 .. 4] CircuitIdentificationCode: <0 .. 16383> Route [1 .. 8] DPC: <0 .. 16383> Route [1 .. 8] Priority: <1 .. 4> Route [1 ..
TANDBERG GW Data port Command Interface User Guide in the 3G Gateway User Manual.
TANDBERG GW Data port Command Interface User Guide *c xConfiguration SS7 Trunk 3 Mode: Off *c xConfiguration SS7 Trunk 3 DPC: 0 *c xConfiguration SS7 Trunk 3 CircuitIdentificationCode: 0 *c xConfiguration SS7 Trunk 4 Mode: Off *c xConfiguration SS7 Trunk 4 DPC: 0 *c xConfiguration SS7 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
TANDBERG GW VideoPortal Data port Command Interface User Guide Registers the 3G Gateway with the VideoPortal NOTE! The GW needs to reboot before the changes will take effect. Mode or System [1 .. 2] IP Address --sub-commands: • Mode: If Mode = On the 3G Gateway is registered with 1 or 2 video portals • Address: IP address of the Video Portal the 3G Gateway is to be registered to.
TANDBERG GW Data port Command Interface User Guide 4.2.3. System Status Commands Command: SystemUnit Description: Displays information regarding the physical system SystemUnit Status format: Name> ReleaseDate> Configuration Telephony:> VideoTelephony:> SerialNumber> MainBoard> AdditionalBoard> Configuration: PRI> TemperatureCelcius> TemperatureFahrenheit> --Parameters: • ProductType, the name of the product, e.g.
TANDBERG GW Ethernet Data port Command Interface User Guide Telephony: 0 VideoTelephony: 0 Hardware: Version: "3GW 1.
TANDBERG GW Data port Command Interface User Guide • • DNS Server [1.. 5] Address, the IP numbers of maximum 5 DNS servers Domain, the name of the domain the gateway 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: 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.
TANDBERG GW Data port Command Interface User Guide Example of ExternalManager feedback: *s ExternalManager: Address: "" Protocol: HTTP URL: "tms/public/external/management/SystemManagementService.asmx" *s/end BRI [1..4] Displays the status of the BRI lines BRI Parameters: • BRI [1..
TANDBERG GW Data port Command Interface User Guide Channel 15 (type=BChannel, status=Idle): / Channel 16 (type=DChannel, status=NA): / Channel 17 (type=BChannel, status=Idle): / Channel 18 (type=BChannel, status=Idle): / Channel 19 (type=BChannel, status=Idle): / Channel 20 (type=BChannel, status=Idle): / Channel 21 (type=BChannel, status=Idle): / Channel 22 (type=BChannel, status=Idle): / Channel 23 (type=BChannel, status=Idle): / Channel 24 (type=BChannel, status=Idle): / Channel 25 (type=BChannel, stat
TANDBERG GW Data port Command Interface User Guide Example of GatewayCall feedback: *s GatewayCall 1 (status=Inactive): / *s/end OK *s GatewayCall 1 (status=Active): CallRef 1: 1 CallRef 2: 2 *s/end OK xstat gatewaycall 1 *s GatewayCall 1 (status=Active): CallRef 1: 1 CallRef 2: 3 *s/end OK SystemLoad Returns the current system load in percentage. SystemLoad Status format: SystemLoad <1..100> Call [1 .. 360] Displays the session legs within gateway calls.
TANDBERG GW Data port Command Interface User Guide LastCorrection: 1 *s/end 4.2.4. Debug Commands Command: Syslog Desription: Enables a real-time log of Bonding, H.221 and H.323, H324m, ISDN, RTSP, IVider, SIP and IVider Engine activity. 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 [0..
TANDBERG GW Data port Command Interface User Guide 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): The URL to post feedback to. • Expression: 1 .. 15: XPath expression OK Result parameters: • ID: <1 ..
TANDBERG GW Data port Command Interface User Guide Example: Xcommand OptionKeyAdd 115201P1-1-6A96DAA4 *r Result (status=OK): / *r/end OptionKeyDelete OK Command used to delete option keys. Parameters: • Key(r): option key Example (Delete Option Key nr. 1): xCommand OptionKeyDelete 1 *r Result (status=OK): / *r/end ServiceEntryDelete OK Command used to delete services from the 3G Gateway. Parameters: • ServiceEntryNumber(r): <1..100> Example (Delete Service nr.
TANDBERG GW Data port Command Interface User Guide or: xfeedback list (note: deregistration with index=0 will deregister all registered expressions) Examples: "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 the3G Gateway, via a cyclic buffer mechanism.
TANDBERG GW Data port Command Interface User Guide 31
TANDBERG GW 4.3. Data port Command Interface User Guide Index Commands boot, 27 BRI [1..4], 24 Call [1..90], 26 DefaultValuesSet, 27 E1, 11 Ethernet, 10, 22 externalManager, 15 ExternalManager, 23 Feedback [1 3], 25 FeedbackDeregister, 28 FeedbackRegister, 27, 29 Gateway, 14 GatewayCall [1..30], 25 H323CallSetup, 9 h323gatekeeper, 9 H323Gatekeeper, 23 help, 29 HTTP, 11 HTTPS, 11 IP, 22 ISDN, 10 PRI [1..
