PortMaster Command Line Reference

[Top] [Table Of Contents] [Prev] [Next] [Index]

This chapter describes how to use the command line interface to configure asynchronous ports. Detailed command definitions follow a command summary table. A summary table for the modem table commands also appears in this chapter, followed by a description of the commands.

Asynchronous ports can be configured as login, device, or network ports, or any combination of these.

Examples in this chapter are from a PortMaster 2R, which uses the indicator S0 for the first asynchronous port. Some PortMaster models use this same designation for the first asynchronous port, while others use the designation C0. See Table 1-1, "Configurable Ports Available for Each PortMaster Model," on page 1-1 for the range of asynchronous ports available on each PortMaster model.

Note ¯ After making any configuration changes to an asynchronous port, you must use the reset s0 command for the changes to take effect.

Displaying Asynchronous Port Information

To display information about your configuration, use the following commands:

show S0-see page 2-34
show all-see page 2-21
ifconfig-see page 2-9
show sessions-see page 2-38
For general information about command line interface commands, refer to Chapter 1, "Introduction."

Summary of Asynchronous Commands

The asynchronous port commands in Table 5-1 configure asynchronous serial ports. Commands marked with a leading bullet (·) can be used only if the port is configured for a dedicated network connection with the set network hardwired command.

`Table 5-1 Asynchronous Port Configuration`
	Command Syntax
	add modem ModemName(short) ModemName(long) Speed String	- see page 5-5
	attach S0	- see page 5-6
	delete modem ModemName(short)	- see page 5-8
	reset S0	- see page 2-15
	save ports	- see page 2-18
	save S0	- see page 2-18
	set S0\|all access on\|off	- see page 5-9
·	set S0 address Ipaddress	- see page 5-10
	set S0\|all cd on\|off	- see page 5-11
·	set S0 compression on\|off\|stac\|vj	- see page 5-13
	set S0\|all databits 5\|6\|7\|8	- see page 5-14
·	set S0 destination Ipaddress [Ipmask]	- see page 5-15
	set S0 device Device [network dialin\|dialout\|twoway]	- see page 5-16
	set S0\|all dialback_delay Seconds	- see page 5-17
	set S0\|all dtr_idle on\|off	- see page 5-18
	set S0 extended on\|off	- see page 5-19
	set S0\|all group Group	- see page 5-20
	set S0\|all hangup on\|off	- see page 5-21
	set S0\|all host default\|prompt\|[1\|2\|3\|4]Ipaddress	- see page 5-22
	set S0\|all idletime Number [minutes\|seconds]	- see page 5-23
	set S0\|all ifilter Filtername	- see page 5-25
·	set S0 ipxnet Ipxnetwork	- see page 5-26
	set S0\|all login [network dialin\|dialout\|twoway]	- see page 5-27
·	set S0\|all map Hex	- see page 5-28
	set S0\|all message String	- see page 5-30
	set S0\|all modem-type ModemName	- see page 5-31
·	set S0\|all mtu MTU	- see page 5-32
·	set S0 netmask Ipmask	- see page 5-33
	set S0\|all network dialin\|dialout\|twoway	- see page 5-34
	set S0\|all network hardwired	- see page 5-35
·	set S0\|all ofilter Filtername	- see page 5-36
	set S0 ospf on\|off	- see page 11-9
	set S0\|all override xon\|rts\|speed\|parity\|databits on\|off	- see page 5-37
	set S0\|all parity even\|none\|odd\|strip	- see page 5-38
	set S0\|all prompt String	- see page 5-39
·	set S0 protocol slip\|ppp\|x75-sync	- see page 5-40
	set S0 route-filter incoming\|outgoing Filtername	- see page 10-8
·	set S0\|all rip on\|off\|broadcast\|listen	- see page 10-19
	set S0\|all rts/cts on\|off	- see page 5-41
	set S0\|all security on\|off	- see page 5-42
	set S0\|all service_device netdata\|portmaster\|rlogin\|telnet [Tport]	- see page 5-43
	set S0\|all service_login netdata\|portmaster\|rlogin\|telnet [Tport]	- see page 5-44
	set S0\|all speed [1\|2\|3]300\|600\|1200\|2400\|4800\|9600\| 19200\|38400\|57600\|76800\|115200	- see page 5-45
	set S0\|all stopbits 1\|2	- see page 5-46
	set S0\|all termtype String	- see page 5-47
	set S0 twoway Device [network dialin\|dialout\|twoway]	- see page 5-48
	set S0 username\|autolog String	- see page 5-49
	set S0\|all xon/xoff on\|off	- see page 5-50
	show all	- see page 2-21
	show S0	- see page 2-34

Asynchronous Port Types

Asynchronous port types are described in Table 5-2. The first three options can be combined with the last three options. A port configured as a network hardwired port cannot be combined with another port type.

`Asynchronous Port Types`
Port Type	Description
login	The port allows a user to log in and establish a terminal session to a host on the network.
device	The port allows a user to access a shared device-for example, a printer or modem-via a host on the network, which can originate a connection to the port.
twoway	The port allows both inbound and outbound connections-user login and shared modem device connections, in this case.
network hardwired	The port provides a permanent network connection-for example, a WAN link over a dedicated point-to-point asynchronous leased line.
network dialin	The port allows a dial-in network user to establish a network connection using SLIP or PPP.
network dialout	The port allows network users to dial out to remote locations-the Internet or another office, for example-defined in the location table.
network twoway	The port allows both inbound and outbound connections-network dial-in and network dial-out connections, in this case.

Asynchronous Commands

These commands affect the asynchronous ports of the PortMaster. Table 1-1, "Configurable Ports Available for Each PortMaster Model," on page 1-1 lists the range of asynchronous ports available on each PortMaster model.

add modem

This command adds modem details and configuration information to the modem table.

add modem ModemName(short) ModemName(long) Speed String

ModemName(short)
Abbreviated name used to identify the modem. Up to a maximum of 16 characters.

ModemName(long)
Long name that includes modem information-for example, the manufacturer or model name. Enclose the name in quotation marks. Up to a maximum of 64 characters.

Speed
The DTE speed in bits per second.

String
The initialization send/expect string for the modem. Enclose the string in quotation marks. Use a \r for a carriage return, and a caret (^) to separate the send and expect characters in the string. The PortMaster expects OK, as shown in the example.

ModemName(short)	Abbreviated name used to identify the modem. Up to a maximum of 16 characters.
ModemName(long)	Long name that includes modem information-for example, the manufacturer or model name. Enclose the name in quotation marks. Up to a maximum of 64 characters.
Speed	The DTE speed in bits per second.
String	The initialization send/expect string for the modem. Enclose the string in quotation marks. Use a \r for a carriage return, and a caret (^) to separate the send and expect characters in the string. The PortMaster expects OK, as shown in the example.

on	Turns access override on.
off	Turns access override off. This is the default.

on	Monitors presence of the DCD signal.
off	Does not monitor presence of the DCD signal. This is the default.

Asynchronous Port	Effect of DCD Assertion
Type	DCD Low-Not Asserted	DCD High-Asserted
login	The port is unavailable.	The PortMaster initiates authentication and displays a login prompt.
device	The port is unavailable.	The port is available for the device service.
twoway	The port is available for device services.	The port attempts to establish an inbound connection and disable the device service.
network hardwired	The port is unavailable.	The port attempts to establish a network connection.
network dialin	The port is unavailable.	The PortMaster initiates authentication and displays a login prompt.
network dialout	The transition of DCD from asserted to not asserted resets the port.	The port is unaffected. However, a change in DCD to not asserted resets the port.
network twoway	The port is available for network dial-in.	The port attempts to establish a network connection and disable the network dial-in.

on	Enables compression. The PortMaster tries to negotiate both Van Jacobson and Stac LZS compression on PortMaster 3 and Office Router products, or Van Jacobson compression only on other PortMaster products. This is the default.
off	Disables compression.
stac	Enables Stac LZS data compression only. Stac LZS compression is supported only on PortMaster 3 and Office Router products.
vj	Enables Van Jacobson TCP/IP header compression only.

5	5 data bits.
6	6 data bits.
7	7 data bits.
8	8 data bits. This is the default.

Ipaddress	IP address or 39-character hostname of the remote router.
Ipmask	IP netmask in dotted decimal notation.

Device	Designation for the shared host device-usually a printer or modem-for example, /dev/ttyp0 or /dev/network.
dialin	In addition to allowing device sharing, the port accepts dial-in-only network connections. The remote system is required to enter a username and password. Dial-in connections to the network are controlled by the RADIUS server or the user table.
dialout	In addition to allowing device sharing, the port becomes available for dialing to remote destinations and initiating network connections to those destinations. Dial-out connections from the network are controlled by the location table.
twoway	In addition to allowing device sharing, the port accepts dial-in connections to the network, as well as being available for dial-out to remote destinations.

on	DTR is on, and any DTR drop is for 500ms. This is the default.
off	DTR is off. Allows bidirectional communications.

on	Turns extended mode on.
off	Turns extended mode off. This is the default.

on	DTR is dropped after the session terminates. This is the default.
off	DTR is not dropped after the session terminates.

default	Uses the default host setting.
prompt	Displays the host prompt before the login prompt. The user is required to enter a valid hostname or Internet address for a host on the network. Entering PPP or SLIP at the prompt returns a login prompt.
Ipaddress	A specified IP address or hostname of a login host or device host.
1\|2\|3\|4	Used to specify alternate hosts, with the primary host being 1. The default is 1.

Number	Timeout value in minutes or seconds. Any value from 0 to 240. The default value is 0.
minutes	Sets the idle time in minutes. This is the default.
seconds	Sets the idle time in seconds.

dialin	In addition to allowing user login, the port accepts dial-in-only network connections. The remote system is required to enter a username and password. Dial-in connections to the network are controlled by the RADIUS server or the user table.
dialout	In addition to allowing user login, the port becomes available for dialing to remote destinations and initiating network connections to those destinations. Dial-out connections from the network are controlled by the location table.
twoway	In addition to allowing user login, the port accepts dial-in connections to the network, as well as being available for dial-out to remote destinations.

dialin	The port accepts dial-in-only network connections. When a DCD signal is detected by the PortMaster system, PPP packets are forwarded, and PAP or CHAP authentication is initiated automatically with no prompt for a username or password. Dial-in connections to the network are controlled by the RADIUS server or the user table.
dialout	The port becomes available for dialing to remote destinations and initiating network connections to those destinations. Dial-out connections from the network are controlled by the location table.
twoway	The port accepts dial-in connections to the network, as well as being available for dial-out to remote destinations.

xon	Software flow control.
rts	Hardware flow control.
speed	Baud rate.
parity	Parity checking.
databits	Number of data bits per byte.
on	Allows the host to override the selected parameter.
off	Does not allow the host to override the selected parameter. The default is that all overrides are off.

even	Set for even parity.
none	Set for no parity bit. This is the default.
odd	Set for odd parity.
strip	Set to strip the parity bit from the data stream when it is received by the PortMaster.

on	Turns on hardware flow control for the port.
off	Turns off hardware flow control for the port. This is the default.

on	Enables security; disables passthrough logins.
off	Disables security; enables passthrough logins. This is the default.

netdata	Allows netdata connections to this port from the network.
portmaster	Provides host device emulation from a host with the in.pmd daemon installed. This is the default.
rlogin	Allow rlogin connections to this port from the network.
telnet	Allow Telnet connections to this port from the network.
Tport	Specifies the TCP port for the connection. Range is from 1 to 65535.

netdata	Uses the netdata login service.
portmaster	Uses the PortMaster login service to connect to in.pmd on the login host. This is the default.
rlogin	Uses remote login to connect to the login host.
telnet	Uses Telnet to connect to the login host.
Tport	Specifies the designated TCP port on the host. Range is from 1 to 65535.

1\|2\|3	Indicates which of the three baud rates is being set: 1, 2, or 3. Default is 1.
300\|600, and so on	Indicates the data terminal equipment (DTE) rate. Default is 9600bps.

twoway	The first use of the keyword twoway sets the port for both user login and device sharing-combining the commands set S0 login and set S0 device. The second use of the keyword twoway sets the port to two-way use for both dial-in from remote users and dial-out to remote locations.
Device	Designation for the device-for example, /dev/ttyp0 or /dev/network.
dialin	In addition to allowing both user login and device sharing, the port accepts dial-in-only network connections. The remote system is required to enter a username and password. Dial-in connections to the network are controlled by the RADIUS server or the user table.
dialout	In addition to allowing both user login and device sharing, the port becomes available for dialing to remote destinations and initiating network connections to those destinations. Dial-out connections from the network are controlled by the location table.

on	Turns on software flow control for the port. This is the default.
off	Turns off software flow control for the port.

Command> show modem att-v34
Short Name:	att-v34
Long Name:	AT&TV.34
Optimal Speed:	115200
Type:	User Defined
Init Script:	Send Command	Wait for Reply
	------------------------------	------------
	AT&FS0=1&W	OK

Command> show table modem
Short Name	Long Name	Type
-------------	------------------------------------	------------
att-v34	AT&TV.34	User
hayes	HayesOptimaV34	User