Page 1
MSS Reference Manual For the Lantronix MSS Family of Device Servers...
Page 2
Copyright 2000, Lantronix. All rights reserved. No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. Printed in the United States of America. The revision date for this manual is 30 January, 2001 .
This manual provides the complete command set for all products in the MSS family. These commands can be entered at the command line to configure the MSS to best meet your needs. While most basic MSS features can be configured using EZWebCon or ThinWeb Manager, the command line interface allows you to customize some of the more advanced features.
The MSS has a reduced command set from the EPS, ETS, and MPS product lines. Change commands replace the Set/Define Server and Set/Define Port commands used in the earlier products.
The comprehensive Index can be used to find specific information. For installation and setup information, refer to your Installation Guide . It is provided in printed form, and you can find HTML and PDF versions on the distribution CD-ROM and on the Lantronix web site (www.lantronix.com).
2: Command Reference This chapter describes all commands that can be used with the MSS. The commands are listed in alphabetical order, excluding the Ports and Server parameters, which apply only to the MSS4. For example, Change Server Bootgateway is considered the same command as Change Bootgateway and is alphabetized according to the latter.
Ethernet port. If no valid PC card is detected at startup, the MSS uses the 10/100BASE-T (or, for the MSS4, the 100BASE-FX) network connection. When 802.11 is disabled, the MSS will ignore an installed 802.11 card and will only look for a compatible wired Ethernet connection.
Change 80211 Reset command. Restrictions Requires privileged user status. Only applies to the MSS-VIA and certain MSS4 models. Errors If you enter a command that is not applicable to the 802.11 card currently in use, you will receive an Error message.
CHANGE 80211 ESSID NONE Configures the ESSID, which tells the MSS the name of the Extended Service Set (ESS) to which it belongs. Setting an ESSID ensures that the MSS will stay on the desired network subsegment. Any configuration changes you make will not take place until you issue the Change 80211 Reset command.
CARD CHANGE 80211 MACADDRESS Configures which of the two available MAC addresses the MSS will use on the network—its own or that of the attached 802.11 wireless networking PC card. The MSS MAC address, which is the same as its hardware address, is printed on bottom label of the MSS.
Error message. Parameters Card Instructs the MSS to use the MAC address of the wireless PC card that is inserted into one of its PC card slots. Instructs the MSS to use its own internal MAC address.
SPAIN FRANCE Sets the regulatory region under which you will operate the MSS. Users in the United States can leave this at the default setting (FCC). Other users should set it to correspond with their region. Any configuration changes you make will not take place until you issue the Change 80211 Reset command.
Only applies to the MSS-VIA and certain MSS4 models. Parameters Reset Resets the MSS to make all 802.11 changes take effect immediately. This command should be entered anytime you make an 802.11 configuration change. It also clears out any previous errors and starts over with the current 802.11 parameters.
(in ad-hoc mode) that have been programmed with the same WEP key as the MSS. All wireless network traffic the MSS sends will be encrypted with its WEP key and any encrypted wireless network traffic the MSS receives will be decrypted with its WEP key. Disabling WEP causes the MSS to ignore its WEP key and only receive and transmit unencrypted network traffic.
Determines whether the MSS will receive unencrypted data while WEP is enabled. Allows reception of encrypted traffic while WEP is enabled. The MSS will accept unencrypted wireless network frames, as well as frames encrypted with its WEP key. This is the default setting once WEP has been enabled.
Detects the baud rate used for an incoming connection to the specified port and then changes its own baud rate at login time to match that of the remote device. When Autobaud is enabled, you may have to press Return several times to help the MSS determine the proper speed.
Change Autostart Command Reference In the absence of the Portlist parameter, the configuration will affect the MSS4’s Note: current port only. PortList Specify a particular port or group of ports. Port numbers are specified with integers between 1 and 4, and should be separated with commas (for lists) or dashes (for ranges).
Page 23
Command Reference Change Autostart PortList Specify a particular port or group of ports. Port numbers are specified with integers between 1 and 4, and should be separated with commas (for lists) or dashes (for ranges). Character Sets a character that will cause a login event. Users will get the benefit of Autostart without having to hit Return or enable Autostart for extended periods of time.
Backward command was entered. Any key can be specified unless it conflicts with MSS line editing or the Break or Forward keys. The key you specify will be stripped from the data stream, so while it won’t interfere with remote operating systems, you will lose any functionality that key would have on local programs.
Specify a particular port or group of ports. Port numbers are specified with integers between 1 and 4, and should be separated with commas (for lists) or dashes (for ranges). Local The MSS processes the Break key and returns the user to local mode. 2-15...
Change Buffering Command Reference Remote The MSS ignores the Break key and passes it to the remote host. Only applicable if the session protocol supports Break events. Telnet supports Break events, but Rlogin, raw TCP, and UDP do not. None Disables the Break key.
Another option is to set a one- or two-character trigger, specified through the Character parameter, that will cause the MSS to transmit the data. You can also specify whether the trigger characters will be sent to the host as part of the serial data or whether they should be discarded through the Save parameter.
Page 28
Defines the timeout as the time since the current “character burst” was started. None Clears previous timeout settings, so the transmission takes place whenever the MSS decides to send the data. Character Sets a trigger that transmits any accumulated data as soon as the specified one or two byte character sequence is detected in the data stream.
As soon as a valid connection is established, normal data flow will occur between the MSS and the connected host. See Hostlist on page 2-58 for more information on hostlists.
Page 30
(forms a passive UDP connection with any host where once a packet is received, the MSS will communicate with only that host until 120 seconds of inactivity have occurred and will then return to the initial state of accepting a UDP packet from any host.)
Command Reference Change DHCP 2.14 Change DHCP DISABLED CHANGE SERVER DHCP ENABLED Enables or disables querying for a DHCP host at system boot time. Restrictions Requires privileged user status. Errors Configuring an IP address will automatically disable DHCP. Enabling DHCP will remove the IP address saved in non-volatile memory (NVR).
DISABLED CHANGE PORT PortList DTRWAIT ENABLED If enabled, the MSS will not assert the DTR signal on the specified serial port until a user logs into the port, or until a network connection is made to the port. Restrictions Requires privileged user status.
Command Reference Change Flow Control PortList Specify a particular port or group of ports. Port numbers are specified with integers between 1 and 4, and should be separated with commas (for lists) or dashes (for ranges). Defaults Disabled 2.18 Change Flow Control CTSRTS CHANGE PORT PortList FLOW CONTROL NONE...
Forward command was entered. Any key can be specified unless it conflicts with MSS line editing or the Break or Forward keys. The key you specify will be stripped from the data stream, so while it won’t interfere with remote operating systems, you will lose any functionality that key would have on local programs.
Command Reference Change Inactive Logout Parameters Server MSS4 only. Secondary Configures a gateway to be used when the primary gateway is unavailable. IPaddress Specify a host using the numeric IP address format. Specifying an IP address of 0.0.0.0 removes the previously-defined gateway. See Also Change Subnet Mask, page 2-47.
Permits or denies incoming Telnet, Rlogin, and LAT connections and enforces password protection. The Show Server command shows the status of incoming connection parameters. Restrictions Requires privileged user status. The MSSLite, MSS-VIA, and the MSS4 do not support LAT or the Both parameter. Parameters Server MSS4 only.
Change Loginpass, page 2-31. 2.24 Change IPAddress IPaddress CHANGE SERVER IPADDRESS Sets the MSS’s IP address. The IP address must be set before any TCP/IP functionality is available. The new IP address will take effect immediately. Restrictions Requires privileged user status.
2.26 Change LAT CircTimer timerValue CHANGE LAT CIRCTIMER Specifies the delay between messages sent from the MSS to other network nodes. This parameter should not need to be altered, and should not be altered when there are active sessions. Restrictions Requires privileged user status.
2.27 Change LAT Groups CHANGE LAT GROUPS groupList NONE Specifies the LAT service groups to which the MSS can connect. Groups are numbered from 0 to 255. Restrictions Requires privileged user status. Errors The MSSLite, MSS4, and the MSS-VIA do not support LAT.
Defines a key that will allow you to access local mode from within a session. The Local Switch key functions the same as the Break key. Any key can be specified unless it conflicts with MSS line editing or the Break or Forward keys. The key you specify will be stripped from the data stream, so while it won’t interfere with remote operating systems, you will lose any functionality that key would have on local programs.
ENABLED Causes the MSS to treat any attached serial device as a modem. When enabled, a DSR drop will log out the enabled port and the MSS will drop DTR for three seconds and then raise it when the port logs out. If Autostart is also enabled, the port will not start until DSR is raised.
2.34 Change Name serverName CHANGE SERVER NAME Renames the MSS. The unit’s default name, which is based on its default Ethernet address, is printed on its underside. This name is what will be advertised if WINS is enabled. Restrictions Requires privileged user status.
ENABLED 802_2 Configures the frame types that the MSS will pay attention to during IPX connections. When NetWare routing is enabled with the Change NetWare Routing command, all frame types are enabled regardless of the settings made with this command.
2-35; Show NetWare, page 2-64. 2.37 Change NetWare Internal Network number CHANGE NETWARE INTERNAL NETWORK Changes the MSS’s preset internal network number, which is derived from the unit’s Ethernet address. This number is used for internal NetWare routing. Restrictions Requires privileged user status.
2.39 Change NetWare Routing DISABLED CHANGE NETWARE ROUTING ENABLED Allows the MSS to act as an internal router whenever there are multiple NetWare frame types in use on the LAN. Restrictions Requires privileged user status. The MSSLite, MSS4, and the MSS-VIA do not support Netware.
Specifies whether XON/XOFF characters will be stripped from the data stream. Enabled means that the MSS will both respond to XON/XOFF and send them to the host. Disabled means that we respond to XON/ XOFF but do not send them to the host. Passflow is only useful when XonXoff flow control is set.
CHANGE PORT PortList PASSWORD INCOMING ENABLED Controls whether the MSS will ask users for an incoming password when they attempt to connect to the network socket connection ports (ports 200x and 300x, where x is the number of the desired serial port). See Environment Strings on page B-1 for more information on network socket connections.
CHANGE PORT PortList PASSWORD PROTECT ENABLED Controls whether a password is needed to log into the MSS from a serial port. For models with a dedicated console port (the MSS-Via, MSS485, and the MSSLite A and C), this command will also affect the serial console port.
NONE NONE Specifies a default service for the specified port. The MSS will attempt to use the preferred service for autoconnecting, or when no host name is specified for a TCP (Telnet), Rlogin, SPX, or LAT connection command. Restrictions Requires privileged user status.
CHANGE PRIVPASS “walrus” See Also Set Privileged, page 2-63. 2.48 Change RARP DISABLED CHANGE SERVER RARP ENABLED Controls whether the MSS will query for a RARP host at system boot time. Restrictions Requires privileged user status. Parameters Server MSS4 only. 2-40...
Command Reference Change Retransmit Limit Defaults Enabled 2.49 Change Retransmit Limit ‘ number CHANGE SERVER RETRANSMIT LIMIT Specifies the number of retries attempted if a network message receives no acknowledgment. This number may need to be increased on noisy or heavily-used networks. The rate at which retransmits are sent is protocol and network dependent.
232 networking. Mode When RS-485 Mode is enabled, you must choose either two-wire or four-wire mode. If you do not explicitly set a mode with this command, the MSS will default to four-wire mode. 2Wire Sets the MSS to use two-wire mode.
TXDrive Controls how the MSS drives the TX pin. Always Sets the MSS to drive TX. The MSS will never tristate TX, even if data is not being sent. Auto Sets the MSS to drive TX only when transmitting, and tristate when not transmitting.
Show Server, page 2-65. 2.56 Change SNMPSetComm communityname CHANGE SERVER SNMPSETCOMM Creates an SNMP community name for the MSS and gives that community read/write access. By default, the MSS has a single community (“public”) with read-only access. Restrictions Requires privileged user status.
The Configuration chapter of your Installation Guide 2.57 Change Software filename CHANGE SERVER SOFTWARE Specifies the name of the download file that, when a reload has been requested, the MSS will attempt to load at boot time. Restrictions Requires privileged user status.
TFTP, the name must be resolvable at boot time, otherwise you must use an IP address. The Telnet console is available at the time the MSS attempts to download the startup file. If there is a problem with the download, you can still log into the MSS and determine what went wrong.
CHANGE SERVER SUBNET MASK Sets an IP subnet mask for the MSS. The mask is applied to target IP addresses to determine whether the destination address is on the local network segment. If the address is not on the local segment, the MSS’s gateway host will be accessed to provide the connection.
Controls what happens when users Telnet into the MSS using the default Telnet socket (23). By default, a Telnet session will get a Local> prompt from the MSS. By specifying the Serial option, a Telnet session will connect directly to the MSS’s serial port (port 1 on the MSS4).
2.65 Change Termtype termstring CHANGE PORT PortList TERMTYPE NONE Specifies a terminal type for the desired port. If supported by the network protocol, the MSS reports this string to the remote host. Parameters Port MSS4 only. Specifies a particular port or group of ports.
IP ipaddress PASSIVE Specifies which timeserver the MSS will use to update its internal clock. The MSS can communicate with either Daytime or Network Timeserver Protocol (NTP) servers. For NTP, the MSS can periodically broadcast a message asking for time information and wait for an NTP timeserver to reply, periodically query a specific NTP timeserver, or just listen for NTP broadcasts on the network.
2.68 Change WINS DISABLED CHANGE SERVER WINS ENABLED Allows the MSS to broadcast a WINS name announcement at boot time, and answer broadcast WINS name queries. This setting allows other hosts to locate the MSS. Restrictions Requires privileged user status.
You must reboot after changing the encryption password. This command can be used to configure an MSS to MSS encrypted session. Set the encryption password on both units to be the same password, reboot both units, then telnet either to one of the unit’s local prompts (i.e.
ATA flash card. The MSS contains two modifiable directories—/ram and /flash—and one read-only directory—/rom. For MSS models with one PC card slot, an ATA card can be accessed as /pccard1; for models with two slots, the card in the top slot can be accessed as /pccard1 and the card in the bottom slot as /pccard2.
Page 64
To move a file, specify the filename as file1 and the destination directory as file2. Displays the blocks of free space on the MSS disks. When you add the -i switch, the display includes in the display the number of inodes used versus the number still available.
Page 65
Disk /PCCard1 and /PCCard2 Formats an ATA flash card for use in an MSS PC card slot. An unformatted card can not be used by the MSS. The /pccard1 parameter applies to all MSS products with one PC card slot (MSS-VIA) or the first (top) slot of the MSS4.
Page 66
Sync Forces the MSS to write files to flash immediately. Normally, when the MSS is rewriting files to the Flash disk, it will buffer data before initiating a write sequence. Write sequences are automatically written after 5 seconds of disk inactivity.
An error is returned when the host cannot be accessed. Parameters username Enter a username to display information about that particular MSS user. hostname Enter a hostname to display information about all of the users at the specified host site.
Edits the hostlist used for multihost mode connections. There can be a maximum of 12 hosts in the hostlist. For information on Multihost Mode, which sets up a data pipe between one of the serial devices attached to the MSS and multiple network hosts, see the Using the MSS chapter of your Installation Guide. Restrictions Requires privileged user status.
Change Dedicated, page 2-19; Crypt Password, page 2-52; Show Hostlist, page 2-64 2.77 Initialize DELAY FACTORY INITIALIZE NOBOOT RELOAD Reboots the MSS. Restrictions Requires privileged user status. Errors When Reload or Factory initialization takes place, all user-entered commands are lost; the MSS must be reconfigured. 2-59...
Appendix C, Updating Software. 2.78 LAT serviceName :envString Establishes a connection with a LAT service. If you do not specify a service or hostname, the MSS will attempt a connection to the preferred host or service. Errors Does not apply to MSSLite, MSS-VIA, or the MSS4.
Note: current port only. PortList MSS4 and MSS-Via only. Specify a port number as an integer between 1 and 3 (Via) or 1 and 6 (MSS4). You can not log out multiple ports at once. number Enter a port number.
Rlogin Command Reference 2.83 Rlogin IPaddress username RLOGIN Attempts to log in to a remote host as a local user. Parameters IPaddress Specify a resolvable text host name or a numeric IP address. This parameter is optional if a preferred Telnet service has been defined. username Specify a name to be used as the login name.
2.85 Set Privileged PRIVILEGED OVERRIDE NOPRIVILEGED Changes the port’s privileged status. If you forget the password, you must reset the MSS to its factory defaults. See Note: Initialize on page 2-59 for instructions. Restrictions Secure users may not become the privileged user.
Status Displays, page 7-6. 2.89 Show NetWare SHOW NETWARE Displays NetWare characteristics, including frame types, routing status, and internal network number. Errors Does not apply to MSSLite, MSS-VIA, or the MSS4. See Also Status Displays, page 7-6. 2.90 Show Nodes SHOW NODES Displays information about the desired LAT or SPX service nodes.
Only applies to the MSS-VIA and MSS4. See Also Change RS485, page 2-42. 2.93 Show Server BOOTPARAMS SHOW SERVER COUNTERS CHARACTERISTICS Displays different types of MSS information. If you do not enter a parameter, the MSS will display general server characteristics . 2-65...
Show Services Command Reference Parameters Bootparams Displays MSS parameters that relate to the boot procedure and software loadfile. Counters Displays Ethernet and TCP/IP error information. Characteristics Displays server settings including hardware address, timer limit, password limit, session limit, retransmit limit, IP address, subnet mask, nameserver, gateway, and more.
See Also Status Displays, page 7-6; Change SNMPSetComm, page 2-44. 2.97 Show Users SHOW USERS Displays the current users logged into the MSS, their port usernames, and current connection information. See Also Status Displays, page 7-6. 2.98 Show Version SHOW VERSION Displays operating software version information.
SAP names; the target device must be advertising itself via SAP announcements for the MSS to make a connection. Errors Does not apply to the MSSLite, MSS-VIA and MSS4. Parameters SAPname Enter the target device’s SAP name, for example, MSS_xxxxxx.
Delay Lowers DTR will for the specified delay length, then raises DTR. Enter a delay time from 50 to 3,000 (milliseconds). 2.103 Zero ZERO Resets all counters on the MSS (both serial and Ethernet). Restrictions Requires privileged user status. 2-69...
If you are experiencing an error that is not listed in Appendix B of your Installation Guide, or if you are unable to fix the error, contact your dealer or Lantronix Technical Support at 800-422-7044 (US) or 949- 453-3990. Technical Support is also available via Internet email at support@lantronix.com.
Because of the syntax difference between the commands for the MSS4 and other Note: MSS models, you should read the Command Reference chapter carefully before entering a command. The examples given in the following sections may not apply to your MSS model.
Sets a socket number. For TCP and UDP connections only. The most common socket numbers are 7000 (the MSS remote console port), 200x (for Telnet IAC interpretation), and 300x (for raw TCP/IP), where x is the number of the desired serial port.
To configure a passive UDP session, do not enter a hostname before the environment key(s). If you want the MSS to spoof a connection with whatever host sends a packet, use the S and xxxx keys along with :U. In this state, the MSS will accept a packet from any host, and then wait for either another packet from that host or a timeout of xxx seconds.
2.2.1.11 Y Sets up encrypted mode, a raw TCP socket that encrypts all data using a 56-bit key, for the MSS. This string can be used in conjunction with the encryption password to establish encrypted sessions between two MSS products. To set up an encrypted session, set the encryption password on both MSS units to the same password and reboot both units.
Access Point loses power in the middle of sending a fragmented packet to the MSS. If you entered the Show 80211 command, you might see a screen resembling the following: Figure C-1: Example of Error Bits Local_5>>...
Page 88
Error Bits Show 802.11 Errors 08000000 Fragment reassembly timed out. Failed to receive all the fragments of a fragmented 802.11 packet before the reassembly window expired. Dropped some correctly received fragments. 04000000 Received an 802.11 packet with invalid subtype code. 02000000 Received an 802.11 packet with invalid type code.
Show 802.11 Errors Error Bits 00000080 Authentication with the AP failed because either the unit or the AP sent an incorrect authentication packet. Some APs will erroneously return this error code when the problem is actually "authentication type not allowed". 00000040 Authentication with the AP failed because the AP does not allow the authentication type requested by the unit.
Page 90
Error Bits Show 802.11 Errors 00040000 Unassigned. 00020000 Internal error. May occur on some cards in conjunction with other described error codes. 00010000 The 802.11 card in use is not compatible with the regulatory region to which the unit has been programmed. 00008000 Internal error.
Need help?
Do you have a question about the MSS and is the answer not in the manual?
Questions and answers