TANDBERG D1320202 User Manual

TANDBERG GW Data port Command Interface User Guide

TANDBERG 3G GW

Data port Command Interface User Guide

Software version R2

D1320202

TANDBERG

TANDBERG GW 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..................................................................................................................................................

2.1. HARDWARE AND CABLING............................................................................................................4

2.2. TROUBLESHOOTING ......................................................................................................................5

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

4.2. THE COMMANDS ...........................................................................................................................8

4.2.1. System Configuration Commands ...........................................................................................9

4.2.2. General GW Commands........................................................................................................14

4.2.3. System Status Commands ...................................................................................................... 21

4.2.4. Debug Commands .................................................................................................................27

4.2.5. Special Commands ................................................................................................................27

4.3. INDEX COMMANDS .....................................................................................................................32

TANDBERG GW Data port Command Interface User Guide

1. 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 the RS-232 connection.

If, after reading this manual, you require additional information concerning the use of the TANDBERG GW Data port Command Interface, please contact your local TANDBERG dealer who will be able to supply you with relevant information for special applications.

2). Three Telnet sessions can be connected to the GW at the same time in addition to

TANDBERG GW 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, 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. 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 other device 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 GW’s RS-232 port and the DTE.

The figure below illustrates the recommended cable-wiring scheme for connecting the GW to a PC through RS-232.

TANDBERG GW PC

DCE, 9 pin DTE, 9 pin

1 CD 1 CD 2 RD 2 RD 3 TD 3 TD 4 DTR 4 DTR 5 GND 5 GND 6 DSR 6 DSR 7 RTS 7 RTS 8 CTS 8 CTS 9 RI 9 RI

DTR and RTS are ignored. DSR, CD, and CTS are always asserted, while RI is not used.

TANDBERG GW Data port Command Interface User Guide

2.2. Troubleshooting

If communication cannot be established between the PC/terminal and the TANDBERG GW’s Data port the following should be checked:

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

• 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

It requires a null-modem cable to perform this test

TANDBERG GW Data port Command Interface User Guide

3. 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.0 customer SW Release Date: 2006-03-28

NOTE! If the TANDBERG 3GW is protected by an IP password you will be prompted to enter this password before you can access the Data port Command Interface via Telnet.

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. 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 Gateway Service 1 ServiceType ?

*h xConfiguration Gateway Service [1..100] ServiceType: <None/DiD/IVR/Phonebook>

Numbers 1-100 and None/DiD/IVR/Phonebook are parameters of the configuration (Xconf) command. Parameters

are arguments upon which the command will operate. 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 two major classes:

• Parameter Configuration Commands, Xconf.

• Status Commands, Xstat.

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

Xconf telnet mode: "on"

*c xConfiguration Telnet Mode: On

When issuing a Parameter Setting Command without a parameter, the GW will return the command with the current setting. E.g.:

Xconf telnet mode

*c xConfiguration Telnet Mode: On

Status Commands

are commands that list different sets of system parameters. Status

commands are automatically called when corresponding parameters are being changed.

4.2. The commands

The commands are divided into five groups: System Configuration Commands, General GW Commands, System Status Commands, Debug Commands and Special Commands.

TANDBERG GW Data port Command Interface User Guide

4.2.1. System Configuration Commands

Command: Description: H323Gatekeeper

H323CallSetup

Sets gatekeeper parameters.

NOTE! H.323 services must be set before the GW can be registered to a gatekeeper.

H323Gatekeeper Address <IPAddr>

H323Gatekeeper Authentication Mode <Auto/off>

H323Gatekeeper Authentication ID: <S: 0, 50>

Or H323Gatekeeper Authentication Password: <S: 0, 50>

---

sub-commands:

• Authentication Mode configures the use of authentication

against a gatekeeper.

• Authentication ID Configures the user name used within an

authentication challenge

• Authentication Password sets the password used within the

authentication process.

NOTE! Authentication Password is write only.

Example of H323Gatekeeper feedback:

Xconf H323Gatekeeper Authentication *c xConfiguration H323Gatekeeper Authentication Mode: Off *c xConfiguration H323Gatekeeper Authentication ID: ""

Configures for direct or via gatekeeper calling

H323CallSetup Mode: <Direct/Gatekeeper>

Example of H323CallSetup feedback: *c xConfiguration H323CallSetup Mode: Direct

Configures the LAN interfaces when static IP address allocation is used.

NOTE! The GW needs to reboot before the changes will take effect.

IP Assignment: <DHCP/Static>

IP Address <IPAddr>

IP Address Subnetmask <Subnetmask>

IP Address Gateway <IPAddr>

IP Address DNS Server [1..5] Address <IPAddr>

IP Address DNS Domain Name <S: 0, 64>

---

parameters:

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. This function should be used when the GW 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.

• Address: Sets the static IP address for the given LAN interface.

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

• Gateway: Sets the gateway IP address. If a gateway is located on

the LAN and the GW 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 GW is in DHCP mode)

• Domain Name: Sets the domain name string of which the

gateway is part of. Minimum 0, maximum 64 characters.

Example of IP Address feedback:

*c xConfiguration IP Address: "127.0.0.1"

Ethernet

Sets LAN port speed. NOTE! The GW needs to reboot before the 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 GW will automatically negotiate with the network and use the best available setting.

Example of Ethernet feedback: *c xConfiguration Ethernet Speed: Auto

ISDN

Defines various ISDN protocol settings.

ISDN IncomingBearerCapability: <UDI/All>

ISDN OutgoingBearerCapability: <H324m/UDI>

ISDN BRI SwitchType: <NI/ATT/Euro/Japan>

ISDN PRI SwitchType: <NI/ATT/Euro/Japan>

or ISDN PRI Interface LowChannel: <1..31>

---

Parameters:

sub-commands:

+ 22 hidden pages