GW Dataport Command Interface User Guide

ManualsBrandsTANDBERG ManualsNetwork RouterGW Dataport Command Interface D13202

This document is not to be reproduced in whole or in

part without the permission in writing from:

TANDBERG

TANDBERG GW

Dataport Command Interface User Guide

Software version G1.0

TANDBERG

D13202 Rev 01

Summary of content (32 pages)

PAGE 1
TANDBERG GW Dataport Command Interface User Guide Software version G1.
PAGE 2
TANDBERG GW Dataport Command Interface User Guide Table of Contents 1. INTRODUCTION .......................................................................................................................... 3 2. CONNECTING TO THE DATAPORT COMMAND INTERFACE THROUGH THE RS232 PORT. ................................................................................................................................................ 4 2.1. 2.2. 2.3. HARDWARE AND CABLING ...........................................
PAGE 3
TANDBERG GW 1. Dataport Command Interface User Guide Introduction The TANDBERG GW Dataport Command Interface User Guide contains guidelines on how to use the textual command interface supported by the GW. The Dataport 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 Dataport (ref. chapter 2).
PAGE 4
TANDBERG GW 2. Dataport Command Interface User Guide Connecting to the Dataport Command Interface through the RS-232 port. The RS-232 port is a 9-pin, female, D-sub connector located on the back of the GW. The port is configured as a DCE (Data Communications Equipment). The RS-232 port is default set to 9600 baud, 8 databits, none parity and 1 stopbit from factory. The RS-232 port is also referred to as the Dataport. 2.1.
PAGE 5
TANDBERG GW 2.2. Dataport Command Interface User Guide Configuring The Dataport From The Web Interface Click on System Configuration tab and then the Dataport button. The Dataport can be configured by setting baudrate, parity, databits and stopbits. 2.3.
PAGE 6
TANDBERG GW 3. Dataport Command Interface User Guide Connecting to the Datport Command Interface using Telnet The TANDBERG GW has two LAN ports. Connection to the Dataport Command Interface via Telnet should be done through LAN port 1. The GW’s Telnet server provides access to the Dataport Command Interface through a 10/100 base T network interface supporting the TCP/IP protocol.
PAGE 7
TANDBERG GW Dataport Command Interface User Guide 4. The TANDBERG GW Commands 4.1. Introduction Typing ‘?’ or ‘help’ when connected to the Dataport Command Interface will return a list of valid commands. The commands are used to control the functions of the GW. A command may be followed by a set of parameters and sub-commands. This chapter gives a description of the valid commands for the GW. 4.1.1. Command format Typing ‘?’ or ‘help’ after a command will result in a usage text being displayed.
PAGE 8
TANDBERG GW Dataport Command Interface User Guide case where the user is trying to transfer a call from an inactive GW port (the user input is shown in bold). calltransfer 1 999999 *R Invalid gateway id ERROR Parameter Setting Commands are commands that set a system parameter to a specific value. E.g.: The command ippassword sets the valid password needed to establish an IP connection with the GW to a specific value.
PAGE 9
TANDBERG GW Dataport Command Interface User Guide 4.2.1. System Configuration Commands Command: defvalues set Description: This command is used to restore factory default settings. Issuing this command with no parameters will restore all settings except network settings and option key. To reset all values to factory defaults the optional parameter all or *factory should be added.
PAGE 10
TANDBERG GW Dataport Command Interface User Guide Example of ipaddress feedback: *P ipaddress 1 static 10.0.5.98 *P ipaddress 1 subnetmask 255.255.0.0 *P ipaddress 1 gateway 10.0.0.1 ipassignment 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.
PAGE 11
TANDBERG GW Dataport Command Interface User Guide best available setting. Example of ipspeed feedback: *P ipspeed 1 auto ipqos Configures the different Quality of Service (QoS) algorithms supported by the TANDBERG GW. QoS are used to set priority on QoS enabled IP networks.
PAGE 12
TANDBERG GW Dataport Command Interface User Guide Example of ipqos feedback: *P ipqos prectlph audio auto *P ipqos diffstlph audio 0 *P ipqos precvtlph audio auto *P ipqos precvtlph signalling auto *P ipqos precvtlph video auto *P ipqos precvtlph data auto *P ipqos diffsvtlph audio 0 *P ipqos diffsvtlph signalling 0 *P ipqos diffsvtlph video 0 *P ipqos diffsvtlph data 0 *P ipqos mode precedence *P ipqos tos off *P ipqos rsvp off isdnprot Defines various ISDN protocol settings.
PAGE 13
TANDBERG GW Dataport Command Interface User Guide --parameters: • profile number: p1/p2/p3/p4/p5/p6. The GW can hold as many as six profiles (p1, p2 and p3 are predefined and can not be changed). • call prefix: The prefix number for this profile. • profile name: The profile’s name. Textstring of maximum 8 characters. • network: auto/h320/h323 NOTE! This parameter will be overridden by the GW, ref. command calltransfer.
PAGE 14
TANDBERG GW Dataport Command Interface User Guide prichan low <1..23/31> or prichan high <1..23/31> or prichan search --parameters: • PRI interface: a/b/c/d. Letters identifying the different PRI interfaces. o a: PRI interface 1 o b: PRI interface 2 o c: PRI interface 3 o d: PRI interface 4 sub-commands: • max: Sets a limit on the number of channels that will be available for incoming and outgoing calls. Values: 1-23 for T1 PRI, 1-30 for E1 PRI.
PAGE 15
TANDBERG GW Dataport Command Interface User Guide o euro - Euro ISDN Example of prinet feedback: *P prinet att prinumbrange Defines the PRI number range for the various PRI interfaces. prinumbrange --parameters: • PRI interface: a/b/c/d. Letters identifying the different PRI interfaces. o a: PRI interface 1 o b: PRI interface 2 o c: PRI interface 3 o d: PRI interface 4 prinumbtrunk Enables or disables the use of PRI trunk groups.
PAGE 16
TANDBERG GW Dataport Command Interface User Guide *P services http on *P services https on *P services snmp on *P services ftp on sendnum Enables/disables broadcast of the local unit’s number during H.320 call setup. NOTE! The transfer of the local number to a remote system or the prevention thereof is dependent on the feature set supported by the network or networks between the GW and the endpoint. sendnum --Example of sendnum feedback: *P sendnum on snmp Configures the snmp mib.
PAGE 17
TANDBERG GW Dataport Command Interface User Guide Example of sport feedback: *P sport 9600 n 8 1 systemname Sets the GW name. systemname --Parameters: • name: Textstring of maximum 16 characters.
PAGE 18
TANDBERG GW Dataport Command Interface User Guide 4.2.2. General GW Commands Command: calltransfer Description: Disconnects the h323 terminal of a GW call and reconnects to another h323 terminal, by either specifying a telephone number or by referring to a directory entry. calltransfer or calltransfer <11..l99> - (get number from directory) --parameters: • gwid: 1..16. Identifier referring to a GW call.
PAGE 19
TANDBERG GW Dataport Command Interface User Guide disc --parameters: • gwid: 1..16. Identifier referring to a GW call. gwdid Sets ISDN DID (Direct Inwards Dialling) parameters. When DID is enabled the GW will strip of the last digits in the ISDN incoming number and use this extracted number to dial the h323 terminal. The number of digits to strip of the incoming number and use as h323 number can be specified.
PAGE 20
TANDBERG GW Dataport Command Interface User Guide gwh323service servprefix or gwh323service maxbw or gwh323service isdncallprefix or gwh323service restrict or gwh323service description parameters: • id: 1..20. Identificator referring to a specific h323service. • bw: 64/128/192/256/320/384/512/768/1152/1472/1920 sub-commands: • servprefix: Sets the service prefix for this h323 service.
PAGE 21
TANDBERG GW Dataport Command Interface User Guide or gwsettings duovideo or gwsettings encryption sub-commands: • natvid: Sets natural video support to on or off. • customformats: Sets custom format support to on or off • duovideo: Sets duovideo support to on or off • encryption: Sets encryption support to on or off.
PAGE 22
TANDBERG GW Dataport Command Interface User Guide 4.2.3. System Status Commands Command: callhistory Description: Used to list call related information for the last 20 calls. callhistory [logid] Status format: callhistory --Parameters: • logid: 1..20. Id referring to a disconnected call. The last disconnected call will have id 1.
PAGE 23
TANDBERG GW chanstat Dataport Command Interface User Guide Used to list channel status information for the PRI interface. chanstat [pri interface] [channel] Status format: chanstat : --Parameters: • PRI interface: a/b/c/d. Letters identifying the different PRI interfaces. o a: PRI interface 1 o b: PRI interface 2 o c: PRI interface 3 o d: PRI interface 4 • channel: 1..31(E1-PRI), 1..
PAGE 24
TANDBERG GW Dataport Command Interface User Guide • • h323 callid: The call id of the h323 terminal h323 termnumber: The number of the h323 terminal Example of gwcalls feedback: *S gwcalls 1 1 22222222 2 66666666 h323gkstatus Returns current gatekeeper status. h323gkstatus Status format: h323gkstatus --Parameters: • ipaddress: The IP address of the gatekeeper that the GW is currently registered to. • port: The IP port on the gatekeeper used to connect to the GW.
PAGE 25
TANDBERG GW Dataport Command Interface User Guide off 0 ipcallstatistics Returns IP dynamic information for all active ip calls. ipcallstatistics Status format: ipcallstatistics --Parameters: • callid: 1..16/32. Identifier referring to a call. • protocol: h323. • chantype: audio/video/data/duo. • direction: incoming/outgoing. • rate: Actual call rate in kilobits. • sent: Number of IP packets sent.
PAGE 26
TANDBERG GW Dataport Command Interface User Guide • • • • • PRI interface: a/b/c/d. Letters identifying the different PRI interfaces. o a: PRI interface 1 o b: PRI interface 2 o c: PRI interface 3 o d: PRI interface 4 status: disabled / red alarm / blue alarm/ yellow alarm / synced / active total numb. of channels: Total number of ISDN B channels. B chans free: Total number of free B channels, i.e. B channels currently not in use. H0 chans free: Total number of free H0 channels, i.e.
PAGE 27
TANDBERG GW Dataport Command Interface User Guide • • vidres: unknown / cif / qcif / sqcif / 4cif / sif / 4sif / vga / svga / xga duores: cif / qcif / sqcif / 4cif / sif / 4sif / vga / svga / xga Example of statout feedback: *S statout 1 outgoing synced norestrict h323-768 g722 h263 cif unknown *S statout 2 outgoing synced norestrict bonding-30b g722 h263 cif unknown Returns the current system load in percentage. systemload Status format: systemload <1..
PAGE 28
TANDBERG GW Dataport Command Interface User Guide 4.2.4. Debug Commands Command: eventlog Desription: The eventlog records all serious errors registered by the system. The log can be used to identify the cause for errors. The complete eventlog can be downloaded from the embedded FTP server. eventlog [n/all] Parameters • n: Lists the specified number of lines from the end of the eventlog. • all: List all entries in the eventlog The eventlog will be deleted when the system is powered off.
PAGE 29
TANDBERG GW Dataport Command Interface User Guide 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 D13202 Rev 01 146.172.254.249 (40 ms) 146.172.248.5 (40 ms) 146.172.248.9 (40 ms) 146.172.248.1 (40 ms) 146.172.248.62 (40 ms) 217.70.229.33 (40 ms) 213.248.78.1 (40 ms) 213.248.66.89 (40 ms) 213.248.65.25 (50 ms) 213.248.64.10 (150 ms) 12.122.10.49 (170 ms) 12.122.11.170 (170 ms) 213.248.80.6 (170 ms) 12.122.10.54 (170 ms) 213.248.84.70 (170 ms) 12.122.11.205 (170 ms) 12.123.194.33 (170 ms) 12.124.232.
PAGE 30
TANDBERG GW Dataport Command Interface User Guide 4.2.5. Special Commands Command: boot Description: Reboots the system. boot dispparam Lists all parameter settings. dispparam feedback Turns feedback on system changes on / off. feedback [type] --Parameters: • type: parameter/status Example of feedback feedback: *P feedback off help Displays the help menu. help netstat Lists network connections and routing tables.
PAGE 31
TANDBERG GW 4.3. Dataport Command Interface User Guide Parameter Storage Parameters are set by issuing Parameter Setting Commands, ref. chapter 4.1.2. All parameters and their corresponding storage type are listed in the table below. The following definitions are used: level 0: No storage (RAM). Does not survive boot or any of the “defvalues” combinations. level 1: Normal storage (EEPROM). Survives boot, but none of the “defvalues” combinations. level 2: Normal storage (EEPROM).
PAGE 32
TANDBERG GW 4.4.