Ref: 99980020
Title: Gateway Server Commands
Date: 1/1/88
Copyright 3Com Corporation, 1991. All rights reserved.
.br;Gateway Server Commands
Command descriptions are presented in alphabetical order. The
following table contains a summary of the GS command available on
the GS/1-X.25, GS/1-IP, GS/3, and GS/3-IP. Some commands are
available only on specific GSs, as indicated in the table.
Some of the GS commands results in the new information being save
on disk. However, it is necessary to reset the GS for the new
parameters to become effective. A message is displayed stating
that a reset is required for the newly entered parameters to take
effect.
In the GS command descriptions, the minimum privilege level lists
the lowest privilege level required to execute the command. The
availability indicates the GSs on which the command is available.
The descriptions include the syntax of each command, examples
showing how the command is used, and a list of possible system
responses and error messages.
GATEWAY SERVER COMMAND SUMMARY
------------------------------------------------------------------
Command Description Availability
------------------------------------------------------------------
LineDefault Specify X.25 line parameters GS/1-IP only
ListeN Place port in Listening mode* GS/1-IP only
LocalX25 Specify X.25 address of X.25 lines GS/1-IP only
Name Assign logical name to address GS/1-X.25 and
GS/3
ReBoot Reset the Gateway Server GS/1-IP only
REMOTE Access another server in remote GS/1-X.25 and
mode* GS/1-IP
RemoteX25 Define network addresses of accessible GS/1-IP only
remote networks via X.25 networks
RouTe Add or remove entries from routing GS/1-IP and
table GS/3-IP
SET Set system parameters All GSs
SETDefault Make permanent changes to All GSs
system parameters
SHow Display parameters, statistics, etc. All GSs
UNName Remove logical name GS/1-X.25 and
GS/3
ZeroArp Clear the ARP table GS/1-IP and
GS/3-IP
ZeroStats Set statistics to zero All GSs
The next tables lists the Connection Service commands supported
by the GS/1-X.25 and their syntax.
GS/1-X.25 Connection Service Command Summary
------------------------------------------------------------------
Command Description
------------------------------------------------------------------
Broadcast Send message to user device(s)
Connect Request virtual circuit
DEFine Define macro command file
DEQueue Remove port from connection queue
DisConnect Terminate virtual circuit
DO Execute macro
Echo Echo a string on the terminal
Listen Place port in Listening mode
Name Assign logical name to address
Pause Pause for specified number of seconds
ReaD Read and save default port
configuration parameters; read
statistics report from diskette
REMOTE Execute network management commands
on another server
REMoteSET Set remote device parameters
REMoteSHow Display remote device parameters
RESume Return to Data Transfer mode
ROtary Assign ports to rotary
SAve Save configuration on diskette
SET Set active parameters
SETDefault Specify default or fixed parameters;
specify and save Internet addresses
SHow Display parameters, statistics, etc.
SWitch Change to different session
Transmit Transmit string to remote device
UNDefine Remove macro definition
UNName Remove name
UNSave Remove configuration file
ZeroStats Set value of busiest minutes and
busiest sample data statistics to 0
GS/1-X.25 Connection Service Command Syntax
------------------------------------------------------------------
Command Syntax
------------------------------------------------------------------
Broadcast broadcast (
)
Connect connect ()[,][ECM][Q]
DisConnect disconnect ()[]
DO do
Echo echo
Listen listen ()
Name name = [,]
Pause pause []
ReaD read ()
REMOTE remote
REMoteSET remoteset = ...
REMoteSHow remoteshow
RESume resume []
ROtary rotary ![+|-]=![-!],...
SAve save ()
SET set =...
SETDefault setdefault () [param-name> = ]...
SHow show ()...
UNDefine undefine
UNName unname
UNSave unsave
ZeroStats zerostats
.h1;LineDefault Command
.br;SYNTAX
.br;LineDefault {Level1|Level2|Level3} =
.br;Availability
.br;GS/1-IP only
.br;Minimum Privilege Level
.br;Global Network Manager
.br;DESCRIPTION
This command changes the values of the serial line parameters at
Level 1 (physcial), Level 2 (X.25 Level 2, LAPB), and Level 3
(X.25 Level 3, packet level). The parameters available for the
LineDefault command are listed below, grouped by X.25 levels.
You can modify any of these parameters on a per-line basis, using
the format given above.
** NOTE **
The eight lines supported by a Gateway Server are numbered
zero through seven.
Levels 1, 2, and 3 refer to the physical, data link, and packet
levels of the X.25 protocol. Level 1, the physical layer, is
concerned with transmitting raw bits over the serial lines; it
deal with how zeros (0) and one (1) are represented, time
aspects, etc. In the case of the GS/1-IP, the only Level 1
parameter concerned is the baud rate of the lines.
Level 2, the data link layer, takes the raw transmission facility
provided by the physical layer and transforms it into a line that
appears free of tranmission errors to the packet level. Its job
is to provide reliable communication between DTE (data terminal
equipment) and DCE (data circuit-terminating equipment). It
accomplishes this task by breaking the input data into frames of
data, transmitting the frames sequentially, and processing the
acknowledgements sent back by the receiver.
The command related to Level 2 affect the selection of the
various counters, timers, and Level 2 window and station (DTE/
DCE) that are relevant to the data ink layer of X.25. LAPB (Link
Access Procedure - Balanced) is the type of X.25 line access
procedure used on the GS/1-IP.
Level 3, the packet layer, is concerned with the format and the
meaning of the data field contained within each of the above
frames. Level 3 provides for virtual circuit management and for
the routing of X.25 packets across PDNs. The command related to
Level 3 on the GS/1-IP affect the selection of the various
counters, timers, Level 3 window, packet size, and virtual
circuit management.
.br;X.25 Level1 Parameters:
.br;BAud={1200|1800|2400|3600|4800|7200|9600|19.2K|38K|56K|64K|}
.br;X.25 Level2 Parameters:
.br;DTEdce = {DTE|DCE}
.br;N2 = 1 -1000
.br;T1 = 100 - 1000000
.br;T3 = 100 - 1000000
.br;Window = 1 - 7
.br;X.25 Level3 Parameters;
.br;AcceptReverse = {ON|OFF}
.br;BeginningLCN = 1 - 4095
.br;ClearRETries = 1 - 10
.br;IncomingBARred - {ON|OFF}
.br;MakeReverse = {ON|OFF}
.br;NumberLCN = 1 - 128
.br;OutgoingBARred = {ON|OFF}
.br;Packetsize = {16|32|64|128|256|512|1024}
.br;ResetRETries = 1 - 10
.br;T10 = 100 - 1000000
.br;T11 = 100 - 1000000
.br;T12 = 100 - 1000000
.br;T13 = 100 - 1000000
.br;T20 = 100 - 1000000
.br;T21 = 100 - 1000000
.br;T22 = 100 - 1000000
.br;T23 = 100 - 1000000
.br;Window = 1-7
.br;EXAMPLE 1
.br;LineDefault level1 0 ba = 9600
.br;This example sets the serial line baud rate of a GS/1-IP port
to 9600 bps.
.br;EXAMPLE 2
.br;LineDefault level2 2 T1 = 3000
.br;This example sets the Level T1 timeout to 3000 milliseconds
(i.e., 2 seconds).
.br;NORMAL RESPONSE
.br;The following messages appears, followed by a new prompt.
.br;"data saved"
.br;"The new parameter value will be effective after ReBoot."
.br;ERROR MESSAGES
.br;"Bad parameter value"
.br;"BAud rate must be one of:
.br;1200,1800,2400,3600,4800,7200,9600,19.2K,38K,56K,64K"
.br;"Can't - diskette write protected"
.br;"Can't save -- sytem error"
.br;"ClearRETries out of range"
.br;"Data not save"
.br;"DISKIO read error"
.br;"DISKIO seek error"
.br;"DISKIO write error"
.br;"Drive door open or diskette missing"
.br;"Insufficient privilege"
.br;"Invalid LineDefault syntax"
.br;" out of range"
.br;"Line not yet activated via LocalX25 command"
.br;"Missing equal sign"
.br;"Missing value"
.br;"N2 out of range"
.br;"Packet size must be one of: 16, 32, 64, 128, 256, 512, 1024"
.br;" out of range"
.br;"ResetRETries out of range"
.br;"T1 out or range"
.br;"Window out of range"
In the case of ambiguity between the default and current values
when error messages are displayed for this command, the error
message references the default configurations. When trying to
diagnose such errors, the appropriate default configuration
should be examined, not the current values.
.h1;ListeN Command
.br;SYNTAX
.br;ListeN
.br;Availability
.br;GS/1-IP only
.br;MINIMUM PRIVILEGE LEVEL
.br;User
.br;DESCRIPTION
If the auxiliary port is in Command mode, the ListeN command puts
the port in Listening mode.
When the auxiliary port is in Command mode, the main CPU polls
the port to watch for activity. Placing the port in Listening
mode relieves the main CPU of this task, thereby increasing
packet forwarding speed.
The ListeN command is available on the GS/1-IP auxiliary port
only. It is not available in remote mode.
.br;EXAMPLE
.br;listen
.br;This example puts the auxiliary port in Listening mode.
.br;NORMAL RESPONSE
A single "at" sign (@) appears on the terminal attached to the GS/
1-IP auxiliary port.
.h1;LocalX25 Command
.br;SYNTAX
.br;LocalX25
.br;AVAILABILITY
.br;GS/1-IP only
.br;MINIMUM PRIVILEGE LEVEL
.br;Global Network Manager
.br;DESCRIPTION
.br;The LocalX25 command defines the X.25 address of each GS/1-
IP serial line.
.br; ** NOTE **
The eight lines supported by a Gateway Server are numbered
zero through seven.
You must specify one of the following after specifying the X.25
serial line number:
1. The address of the local X.25 line leading to the host.
2. p for a private line (e.g., a leased line that is not part of
an X.25 network)
3. n to disable the line, thereby making fewer lines available
to the network
If you use option 1 (X25 address), the LocalX25 command assigns
the specified X.25 address to the given line. Options 1 and 2
also enable the referenced line, if it was not enabled.
The GS/1-IP uses the local X.25 addresses of the individual lines
when it sends packets from one of the serial lines. The
referenced local X.25 address is used as the source X.25 address
in the X.25 packet header at call establishment to notify the
destination X.25 device that the packet came from this GS/1-IP.
.br;EXAMPLE 1
.br;localx25 1 311041500224
This example enables serial line 1 and assigns it the X.25
address 311041500224.
.br;EXAMPLE 2
.br;local25 2 none
.br;This example disables serial line 2 on the GS/1-IP.
.br;NORMAL RESPONSE
.br;The following messages appear, followed by a new prompt.
.br;"data saved"
.br;"The new parameter value will be effective after ReBoot."
.br;ERROR MESSAGES
.br;"Can't - diskette write protected"
.br;"Can't save -- system error"
.br;"Data not saved"
.br;"DISKIO read error"
.br;"DISKIO seek error"
.br;"DISKIO write error"
.br;"Drive door open or diskette missing"
.br;"Illegal line number entered"
.br;"Insufficient privilege"
.br;"Invalid command"
.br;"Invalid LocalX25 syntax"
.br;"IPADDRess must be defined first"
.br;"Line is currently in use to reach a remote net"
.br;"X25 address cannot exceed 15 characters"
.br;Name Command
.br;SYNTAX
.br;Name = [,]
.br;AVAILABILITY
.br;GS/1-X.25 and GS/3
.br;MINIMUM PRIVILEGE LEVEL
.br;Local Network Manager
.br;DESCRIPTION
The Name command assigns a logical name to either a physical
address or another logical name. The address or name you specify
after the equal sign can represent a single port, a local rotary
(a port number in the range from 128 to 135), or a global rotary
(up to eight addresses separated by commas). The maximum
permitted length of the address (or address list) specified in
the Name command is 120 characters.
Gateway Servers can be set during system generation to
differentiate or not to differentiate between upper- and
lowercase in names.
You can remove names using the UNName command.
The specified name typically represents only the first field in
the three-part clearinghouse name (the local name). The default
strings for the second and third fields (domain and organization)
are set remotely with the SETDefault command. These default
strings are automatically assumed if the Name command is entered
with only a local name. All the servers supported by an NCS
share the same default domain and organization strings.
You can use the Name command to specify all three fields of a
clearinghouse name on a server running the XNS protocols. In
this case, the newly defined domain and organization strings can
be difference from the default strings defined for the server; if
the strings are different, the name does not appear in the
display generated by the SHow CHName command (refer to the
description of the SHow command).
If the Name command cannot be completed because the diskette is
write-protected, the system puts a protective lock on the name
database. The database will not be available again until the GS
is rebooted with a diskette that is not write-protected.
Each Gateway Server running the XNS protocols can support up to
64 names.
.br;EXAMPLE
.br;name modem = %080002001991!1
This example assigns the clearinghouse name "modem" to port 1 on
the device whose Ethernet address is %080002001992.
.br;NORMAL RESPONSE
If the command is successful, the system responds with a new
prompt.
.br;ERROR MESSAGES
.br;"Bad command: not a NameServer"
.br;"Clearinghouse name in use"
.br;"Clearinghouse name table is full"
.br;"Insufficient privilege"
.br;"Invalid Name syntax"
.br;"Invalid syntax"
.br;ReBoot Command
.br;SYNTAX
.br;ReBoot
.br;AVAILABILITY
.br;GS/1-IP only
.br;MINIMUM PRIVILEGE LEVEL
.br;Global Network Manager
.br;DESCRIPTION
This command reboots the GS/1-IP from either the auxiliary port
or remotely. This has the same effect as pressing the Reset
switch on the front panel of the GS/1-IP. This is typically used
after changing the default values of some of the GS/1-IP
parameters so that the new parameter values may take effect.
In order to reboot via this command, the MCPU20 board on the GS/1-
IP must be configured for automatic reboot.
.br;EXAMPLE
.br;reboot
.br;This example resets the Gateway Server.
.br;NORMAL RESPONSE
.br;There is no immediate response.
If the command is executed remotely, the message, "timeout
failure" appears on the remote terminal. This is not an error.
The remote GS/1-IP has already started rebooting and did not
complete its remote transaction.
.br;ERROR MESSAGES
.br;"Insufficient privilege"
.h1;REMOTE Command
.br;SYNTAX
.br;REMOTE
.br;AVAILABILITY
.br;GS/1-IP and GS/1-X.25
.br;MINIMUM PRIVILEGE LEVEL
.br;Global Network Manager
.br;DESCRIPTION
The REMOTE command gives you access to a network management port
on the specified Communications Server, Network Control Server,
Internetwork Bridge, or remote Gateway Server. These servers and
Internetwork Bridges running the TCP/IP protocols can be accessed
from a GS/1-IP.
** NOTE **
When accessing a server running the TCP/IP protocols from a
GS/1-IP, you must use the explicit Internet address of the
server; the server's logical name cannot be used.
Bridge servers and Internetwork Bridges running the XNS protocols
can be accessed from a GS/1-X.25. To access a server or
Internetwork Bridge running the XNS protocols, specify its
Ethernet address or a clearinghouse name.
The GS/1 and GS/1-IP do not support the REMOTE command (i.e., you
cannot remote to another server from a GS/3 or GS/3-IP).
However, any GS can be accessed remotely from a server that
supports the REMOTE command and that is running the same
protocols as the GS.
While remote mode is in effect, the prompt is the string
"Remote:". To exit remote mode, press the Break key. When you
remote from a GS/1-IP, you can also exit remote mode by typing
"exit" followed by the Return key.
For the GS/1-X.25, the REMOTE command is not available in remote
mode. For the GS/1-IP, the GS commands ListeN and REMOTE are not
available in remote mode. All other GS commands are available
from broth the local or remote console. To display a list of
available commands, enter a question mark (?) in response to the
remote prompt.
Since the GS/1-X.25, GS/3, and GS/3-IP do not support the
auxiliary port to function as a local console port, the Gateway
Server commands can only be entered from a remote terminal.
During remote mode, the output of some commands that cause long
screen displays (such as SHow X25Connections on a remotely
accessed Communications Server) may be truncated.
.br;EXAMPLE 1
.br;remote 192.9.200.200
.br;show x25linestatus
.br;
In this example, you can obtain remote mode access to a GS/1-IP
with the Internet address 192.9.200.200, show the line status of
the GS/1-IP lines, and then exit remote mode by pressing the
Break key.
.br;EXAMPLE 2
.br;remote 192.9.201.202
.br;show allsessions
.br;
In this example, you obtain remote mode access to a
Communications Server with the Internet address 192.9.201.202,
list all sessions on that server, and then exit remote mode by
pressing the Break key.
.br;NORMAL RESPONSE
.br;The prompt "Remote:" appears.
.br;ERROR MESSAGES
.br;"Address cannot be broadcast or loopback"
.br;"Can't - no memory"
.br;"Can't remote -- mandatory parameter(s) have not been loaded"
.br;"Insufficient privilege"
.br;"Invalid address syntax"
.br;"Invalid syntax"
.br;"Invalid REMOTE syntax"
.br;"No memory resource"
.br;"No response"
.br;"Timeout failure"
.br;"Unknown errors"
In addition, if a server accessed in remote mode is inoperative,
all commands entered generate the message "Timeout failure".
.br;RemoteX25 Command
.br;SYNTAX
.br;RemoteX25 ...
.br;AVAILABILITY
.br;GS/1-IP only
.br;MINIMUM PRIVILEGE LEVEL
.br;Global Network Manager
.br;DESCRIPTION
Use this command to add or delete the IP network numbers of
accessible remote networks and the X.25 addresses of the lines
leading to these remote networks.
* Netid is the network number of the remote network
* Private for a private line (e.g., a leased line that is not
part of an X.25 network)
* In the case of the add option, one or all line numbers
(separated by blank spaces) may be specified on one command
line.
** NOTE **
The eight lines supported by a Gateway Server are numbered
zero through seven.
Before executing this command, activate the individual serial
lines using the LocalX25 command.
The delete option deletes accesses defined via the RemoteX25 Add
command, as shown in the example below. Specifying line numbers
is not necessary, because all accesses to the referenced remote
network via either the indicated X.25 address or private line (as
applicable) are deleted.
remotex25 delete netid
This does not remove accessibility of the reference network via
some other X.25 (or private) address, if such an access was also
available.
** NOTE **
Include the specific X.25 address for each remote access you
wish to delete. If you do not include an X.25 address in the
RemoteX25 Delete command, all accesses for the referenced
network are deleted. Otherwise, indicate the specific X.25
address for each individual remote access you wish to delete.
.br;EXAMPLE 1
.br;remotex25 add 192.9.200.0 311041400144 0 2
This example indicates that network 192.9.200.0 is accessible via
X.25 address 311041400144 using lines 0 and 2 of the GS/1-IP.
.br;EXAMPLE 2
.br;remotex25 delete 192.9.201.0 311071300144
This example removes the access to network 192.9.201.0 via X.25
address 311071300144 on the GS/1-IP.
.br;NORMAL RESPONSE
.br;The following messages appear, followed by a new prompt.
.br;"data saved"
.br;"The new parameter value will be effective after ReBoot."
.br;ERROR MESSAGES
.br;"Cannot use the RemoteX25 command to delete the local
network"
.br;"Can't - diskette write protected"
.br;"Can't save -- system error"
.br;"Data not saved"
.br;"DISKIO read error"
.br;"DISKIO write error"
.br;"Drive door open or diskette missing"
.br;"Illegal class of Internet address"
.br;"Illegal line number entered"
.br;"Incompatible subnet mask: must contain subnet field"
.br;"Insufficient privilege"
.br;"Invalid RemoteX25 syntax"
.br;"IPADDRess must be defined first"
.br;"Line not yet activated via LocalX25 command"
.br;"Maximum of 129 network addresses exceeded"
.br;"Network id not found"
.br;"Remote Net cannot have same netid as Local Net"
.br;"Using network address "
.br;"X25 address cannot exceed 15 characters"
In the case of ambiguity between the default and current values
when error messages are displayed for this command, the error
message references the default configuration. When trying to
diagnose such errors, the appropriate default configurations
should be examined, not the current values.
.h1;RouTe Command
.br;SYNTAX
.br;RouTe
.br;AVAILABILITY
.br;GS/1-IP and GS/3-IP
.br;MINIMUM PRIVILEGE LEVEL
.br;Global Network Manager
.br;DESCRIPTION
This command adds or removes static routing table entries to
distant networks. Distant networks are reached via GSs on either
the local network or one of the remote networks.
Specify the following parameters:
The network number of the distant network
that is to be reached via this command.
The IP address of the GS through which the
distant network can be reached. This assumes
that the used in the RouTe Add
command has been properly configured. That
is, it should know how to forward Internet
datagrams to the referenced distant network.
The number of intermediate gateways between
the GS and the distant network. The hop
count should be a number between 2 and 15.
When selecting a new static route, the GS only accepts gateway
addresses in the field that belong to a local or remote
network. Once the command is entered, the route takes effect
immediately and is saved on the GS system diskette. When the GS
is rebooted, it will be configured with the routes defined on the
system diskette.
On Gateway Servers, up to 30 entries may be added to the routing
table.
The RouTe Delete command deletes addresses from the static
routing table and takes effect immediately. Deletions are saved
on the Gateway Server diskette and remain effective when the GS
is rebooted.
.br;EXAMPLE 1
.br;route add 128.12.0.0 192.202.009.233 2
This example creates a static routing table entry that forwards
all packets for the network 128.12.0.0 to gateway
192.202.009.233, with a hop count of two.
.br;EXAMPLE 2
.br;remote 192.255.9.146
.br;route delete 128.12.00.0 192.255.009.123
.br;
In this example, a static routing table entry is remotely deleted
from a GS with the address 192.255.9.146 that once forwarded
packets for the destination network 128.12.0.0 to gateway
192.255.009.123, and then remote mode is left by pressing the
Break key.
.br;NORMAL RESPONSE
The message "data saved" appears, followed by a new prompt. The
new parameter value will be effective after reboot.
.br;ERROR MESSAGES
.br;"Can't - diskette write protected"
.br;"Can't save -- system error"
.br;"Data not saved"
.br;"DISKIO read error"
.br;"DISKIO seek error"
.br;"DISKIO write error"
.br;"Drive door open or diskette missing"
.br;"Gateway cannot be broadcast or loopback address"
.br;"Gateway cannot be this gateway's Internett address"
.br;"Gateway IP address format error"
.br;"Gateway must be on direct attached net"
.br;"Illegal hop count"
.br;"Insufficient privilege"
.br;"Invalid RouTe syntax"
.br;"No such route defined"
.br;"Remote Net address format error"
.br;"Routing table full"
.br;"Using remote net "
.h1;SET Command
.br;SYNTAX
.br;SET =
.br;AVAILABILITY
.br;GS/1-X.25, GS/1-IP, GS/3, AND GS/3-IP
.br;MINIMUM PRIVILEGE LEVEL
.br;User
.br;DESCRIPTION
The SET comand is used to modify the current value of the given
parameter. The SET command changes the parameter in the active
parameter table only, not in the default table on the diskette.
The new value takes effect immediately, but remains in effect
only until the GS is rebooted. To change a default parameter
value on diskette, use SETDefault.
Specify only one parameter in each SET command.
In addition, the command "set ?" prints a list or parameters
available for the SET command.
For the GS/1-IP, use the SET command to specify the following
parameters. For the GS/1-X.25, GS/3, and GS/3-IP, only the DATE
parameter is supported.
DATE Level3DAta
ExtendedARP* Level3TRace*
Level2TRace* PRIvilege**
Spaces are allowed, but not required, before and after the equal
sign.
If the network on which the Gateway Server is attached includes
an NCS, the NCS automatically sets the system clock on each
server in the network, including the Gateway Server. Setting the
date on the Gateway Server is unnecessary if the NCS is present
on the local network. If no NCS is present, set the DATE on the
GS after each system boot.
.br;EXAMPLE
.br;set earp = off
.br;THis example disables the Extended ARP parameter for a GS/1-
IP.