Multi-Tech Systems MTS2SA-T-R, MTS2SA-T User Manual

MultiConnect Adapter
Serial-to-Serial Adapter with IP
User Guide
MultiConnect Adapter User Guide Serial-to-Serial Adapter (MTS2SA-T & MTS2SA-T-R)
PN S000354A, Version A
Copyright
This publication may not be reproduced, in whole or in part, without prior expressed written permission from Multi-Tech Systems, Inc. All rights reserved. Copyright © 2004, by Multi-Tech Systems, Inc.
Multi-Tech Systems, Inc. makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose. Furthermore, Multi-Tech Systems, Inc. reserves the right to revise this publication and to make changes from time to time in the content hereof without obligation of Multi-Tech Systems, Inc. to notify any person or organization of such revisions or changes.
Revisions
Revision Level Date Description
A 07/12/04 Initial release for Serial-to-Serial adapter.
Trademarks
MultiConnect, Multi-Tech, Multi-Tech Systems, Inc., and the Multi-Tech logo. All other products or technologies are the trademarks or registered trademarks of their respective holders.
Patents
This device is covered by one or more of the following patents: 6,031,867; 6,012,113; 5,628,030; 5,450,425. Other patents pending.
Multi-Tech Systems, Inc. MultiConnect Adapters User Guide (S000344B) 2
Table of Contents
Table of Contents
Chapter 1 – Product Description & Specifications.................................................................................. 6
Product Description ................................................................................................................................... 6
Applications ...............................................................................................................................................6
Types of Adapters Available...................................................................................................................... 7
Package Contents ..................................................................................................................................... 7
Handling Precautions ................................................................................................................................ 7
Specifications ............................................................................................................................................ 8
LED Indicators ......................................................................................................................................... 10
RS-232 9-Pin Connector Pinout .............................................................................................................. 10
Chapter 2 – Installation............................................................................................................................. 11
Attaching the MultiConnect to a Fixed Location...................................................................................... 11
Serial-to-Serial Adapter Installation......................................................................................................... 12
Connecting the Cables ............................................................................................................................ 12
Connecting the Power ............................................................................................................................. 13
Chapter 3 – Managing and Configuring the MultiConnect Adapter..................................................... 14
Two Ways to Login .................................................................................................................................. 14
Login Using TTY ..................................................................................................................................14
Login Using Telnet through the PPP Interface .................................................................................... 14
About Command Mode and Data Mode.................................................................................................. 14
Chapter 4 – Command Line Interface (CLI) ............................................................................................ 15
General Notes ......................................................................................................................................... 15
General Setup Commands...................................................................................................................... 16
IP Setup Commands ............................................................................................................................... 23
Serial Setup Commands.......................................................................................................................... 27
PPP Setup Commands............................................................................................................................ 42
HTTP Server Commands ........................................................................................................................ 47
SMTP Client Commands ......................................................................................................................... 49
POP3 Client Commands ......................................................................................................................... 52
FTP Client Commands ............................................................................................................................55
SNTP Client Commands ......................................................................................................................... 57
Chapter 5 – Setting Country or Region Codes Using the CLI .............................................................. 61
Chapter 6 – Prerequisite Configurations ................................................................................................ 62
Chapter 7 – Telnet Dialout........................................................................................................................ 65
Introduction.............................................................................................................................................. 65
Prerequisites............................................................................................................................................ 65
Scenario 1 – Manual Dialout ...................................................................................................................67
Scenario 2 – Auto Dialout........................................................................................................................ 69
Scenario 3 – Auto Dialout in RAW Mode ................................................................................................ 71
Chapter 8 – Auto Dial-in Feature ............................................................................................................. 73
Introduction.............................................................................................................................................. 73
Prerequisites............................................................................................................................................ 73
Scenario 1 – Manual Serial Dial-in .......................................................................................................... 74
Scenario 2 – Serial Auto Dial-in in Telnet Mode ..................................................................................... 76
Scenario 3 – Auto Dial-in Session in RAW Mode ...................................................................................78
Scenario 4 – Serial Tunneling Mode ....................................................................................................... 79
Chapter 9 – Modem (Transparent) Mode ................................................................................................ 81
Introduction.............................................................................................................................................. 81
Scenario 1 – MultiConnect IP as a Modem ............................................................................................. 82
Scenario 2 – Serial Tunneling in Transparent Mode...............................................................................83
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 3
Table of Contents
Chapter 10 – Modem Mode AT Commands, S-Registers, Result Codes............................................. 85
Escape Code Sequence +++ .................................................................................................................. 85
Command Organization........................................................................................................................... 85
Command Types ..................................................................................................................................... 86
Command Detail...................................................................................................................................... 88
FastConnect Commands....................................................................................................................... 114
V.92 Commands (+P and –Q Commands) ........................................................................................... 115
S-Registers............................................................................................................................................ 118
Result Codes ......................................................................................................................................... 127
Chapter 11 – Point-to-Point Protocol .................................................................................................... 132
Introduction............................................................................................................................................ 132
Components of PPP .............................................................................................................................. 132
Prerequisites for Establishing a PPP Session....................................................................................... 132
Adding Users and Passwords............................................................................................................ 132
Setting Passwords .............................................................................................................................133
Deleting Users ...................................................................................................................................133
Notes..................................................................................................................................................133
PPP Configuration ................................................................................................................................. 133
PPP Interface Related Parameters ....................................................................................................... 134
Enabling/Disabling Authentication ..................................................................................................... 134
Authentication Type - Protocol........................................................................................................... 134
User Name & Password for Remote Peer Authentication .................................................................134
IPCP Mode......................................................................................................................................... 134
Show Commands............................................................................................................................... 134
Serial Interface Related Parameters ..................................................................................................... 135
Connect Type..................................................................................................................................... 135
Modem Settings - For Modem Connection Only ...............................................................................135
Chapter 12 – HTTP Server ...................................................................................................................... 136
Introduction............................................................................................................................................ 136
Setup and Configuration........................................................................................................................ 137
Prerequisite for Enabling the HTTP Server .......................................................................................137
Mandatory Setup for HTTP Server ....................................................................................................137
Configuration Modes ............................................................................................................................. 138
Host Configuration Mode.......................................................................................................................138
The Parameter List ............................................................................................................................138
The Embedded HTML Page .............................................................................................................. 140
CGI Scripts......................................................................................................................................... 140
File Naming and File Size Conventions.............................................................................................140
Uploading the Web Page and Parameter List ...................................................................................141
Monitoring and Configuring the Host through a Browser ...................................................................... 142
Technical Information ............................................................................................................................ 142
Parameter Value Display on the Fly ..................................................................................................142
Parameter Value Manipulation from the Browser..............................................................................142
Serial Device Parameter Updating Process ......................................................................................142
Chapter 13 – SMTP Client....................................................................................................................... 143
Introduction............................................................................................................................................ 143
Setup and Configuration Prerequisites.................................................................................................. 144
Scenario 1 – Sending a Text Email from the Command Prompt .......................................................... 145
Scenario 2 – Sending a Text Email from the Interactive Mode............................................................. 146
Scenario 3 – Sending a Text Email Using Configuration and Interactive Mode ................................... 147
Scenario 4 – Sending a Text Email Using No Configuration................................................................. 148
Scenario 5 – Sending a Mime Encoded Binary Attachment Using Command Prompt......................... 149
Scenario 6 – Sending a Mime Encoded Binary Attachment Using the Command Prompt................... 150
Scenario 7 – Sending a Mime Encoded Binary Attachment Using Configuration and Interactive Mode151
Scenario 8 – Sending a Mime Encoded Binary Email with Attachment Using Interactive Mode.......... 152
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 4
Table of Contents
Chapter 14 – POP3 Client ....................................................................................................................... 153
Introduction............................................................................................................................................ 153
Setup and Configuration Prerequisites.................................................................................................. 153
Optional Configuration for Deleting Emails from the Server.............................................................. 154
Scenario 1 – Retrieving Emails ............................................................................................................. 155
Scenario 2 – Retrieving the Number of Emails and the Total Email Size ............................................. 155
Scenario 3 – Retrieving the Email List .................................................................................................. 156
Scenario 4 – Retrieving Emails Headers............................................................................................... 156
Scenario 5 – Retrieving First t Lines .....................................................................................................157
Scenario 6 – Deleting an Email on the Server ......................................................................................157
Scenario 7 – Retrieving the Unique Email ID ........................................................................................ 157
Error Messages.................................................................................................................................. 158
Scenario 8 – Sending a Mime Encoded Binary Email Using Interactive Mode..................................... 159
Chapter 15 – FTP Client.......................................................................................................................... 160
Introduction............................................................................................................................................ 160
FTP Client Features...........................................................................................................................160
Command to List Directory Contents or to Send/Receive Files ........................................................160
Prerequisites ...................................................................................................................................... 161
Scenario 1 - Listing Directory Contents.................................................................................................162
Scenario 2 - Listing Directory Contents.................................................................................................162
Scenario 3 - Listing Directory Contents.................................................................................................163
Scenario 4 - Listing Directory Contents.................................................................................................163
Scenario 5 - Sending a File to the FTP Server ..................................................................................... 164
Scenario 6 - Sending a File to the FTP Server ..................................................................................... 164
Scenario 7 - Sending a File to the FTP Server ..................................................................................... 165
Scenario 8 - Receiving a File from the FTP Server............................................................................... 165
Scenario 9 - Receiving a File from the FTP Server............................................................................... 166
Scenario 10 - Receiving a File from the FTP Server............................................................................. 167
Chapter 16 – SNTP Client ....................................................................................................................... 168
Introduction............................................................................................................................................ 168
Features.............................................................................................................................................168
Prerequisites.......................................................................................................................................... 168
Scenario 1 - Updating Time from the NTP Server ................................................................................ 170
Scenario 2 - Updating Time from the NTP Server ................................................................................ 170
Appendix A – Flash Upgrade ................................................................................................................. 171
Introduction............................................................................................................................................ 171
Prerequisites.......................................................................................................................................... 171
Prerequisite 1 – Required Tool (TFTP Client) ................................................................................... 171
Prerequisite 2 – Serial Port Configuration .........................................................................................172
Prerequisite 3 – Enabling TFTP Server.............................................................................................172
Serial Flash Upgrade Scenario ............................................................................................................. 172
Appendix B – Regulatory Information .................................................................................................. 173
Appendix C – Warranty and Service ..................................................................................................... 174
Multi-Tech Warranty Statement ......................................................................................................... 174
Repair Procedures for U.S. and Canadian Customers...................................................................... 174
Repair Procedures for International Customers (Outside U.S.A. and Canada) ................................ 174
Repair Procedures for International Distributors ...............................................................................175
Replacement Parts ............................................................................................................................175
Index ......................................................................................................................................................... 176
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 5
Chapter 1 – Product Description and Specifications
Chapter 1 – Product Description &
Specifications
Product Description
The MultiConnect serial-to-serial adapter enables installed serial devices to connect to the Internet for remote monitoring, control and configuration.
Internet-Enable Any Device. The MultiConnect adapter provides the powerful ability to IP-enable serial
devices allowing more options for data acquisition, device management, and industrial control than would otherwise be available.
Simply install the MultiConnect between a serial device and an analog, ISDN, or wireless modem to send and receive data over the Internet. It can also serve as a single Web page in response to a Web browser request.
Reduces Development Time. MultiConnect can make your existing and next generation serial device
IP-ready without requiring hardware changes to its design. MultiConnect actually provides faster time-to­market because it relieves the burden and expense of writing and maintaining Internet applications. The complete, ready-to-integrate MultiConnect adapter allows you to enhance your product while you focus on developing its core features.
Management and Configuration. MultiConnect has several means of management and configuration
built into the design. It supports remote configuration, which means you can have central site setup and control of the remote adapters via the command line interface or telnet.
Applications
The MultiConnect adapters will IP-enable any device to provide remote monitoring, control and configuration of any system. The solution is ideal for the following applications:
Appliances
ATM terminals
Credit card and check verification systems
Data collection
Gas pumps
Industrial and medical remote monitoring systems
Point-of-sale terminals
Remote diagnostics
Remote metering
Security systems
Ticketing machines
Vending/gaming machines
And more…..
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 6
Chapter 1 – Product Description and Specifications
Types of Adapters Available
Product Adapter Description Region
MTS2SA-T Serial-to-Serial + IP (External Power) Global MTS2SA-T-R Serial-to-Serial + IP (RS-232 Power) Global
Note: The RS-232–powered adapters are powered through the DSR pin of the
RS-232 cable.
Package Contents
One MultiConnect Adapter
One universal power supply with power cord included with the externally powered adapters
One RS-232 cable included with the RS-232 Serial-to-Serial Adapter
Two mounting brackets
Four adhesive-backed rubber feet (table-top mounting)
One Quick Start Guide
One MultiConnect CD
Handling Precautions
All devices must be handled with certain precautions to avoid damage due to the accumulation of static charge. Although input protection circuitry has been incorporated into the devices to minimize the effect of this static buildup, proper precautions should be taken to avoid exposure to electrostatic discharge during handling and mounting.
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 7
Chapter 1 – Product Description and Specifications
Specifications
Category Description Memory
Flash Memory Protocols Supported
Serial Interface Data Formats Data Rates Flow Control Management Security System Software
LEDs Ethernet Power Requirements With External Power (MTS2SA-T) Power Consumption
Operating Temperature Storage Temperature
Physical Dimensions
Certifications Safety Certifications:
8 MEG 2 MEG ARP, DHCP, FTP, HTTP, ICMP, IP, POP3, PPP, SMTP, TCP, Telnet, TFTP, and UDP Standard DCE serial Serial, binary, asynchronous 300; 1200; 2400; 4800; 9600; 19200; 38400; 57600; 115200; 230400 bps RTS/CTS (hardware) Serial; Telnet Username and password authentication using local database Flash ROM standard: downloadable from a TCP/IP host (TFTP) or Xmodem via Serial ACT (Activity) and STS (Status) IEEE 802.3
@ 9V DC: Typical 240mA Maximum 250mA
With RS-232 Power (MTS2SA-T-R) Power Consumption
@ 5V DC: Typical 95mA Maximum 105mA @ 10V DC: Typical 50mA Maximum 60mA @ 15V DC: Typical 35mA Maximum 45mA @ 20V DC: Typical 28mA Maximum 38mA @ 25V DC: Typical 24mA Maximum 34mA
32° to +120°F (0° to 50°C); humidity range 25-85% (non-condensing)
-40°C to +85°C
3.5" w x 2.1" h x 0.98" d; 3.4 oz.
8.8 cm x 5.3 cm x 6 cm; 96 g
UL60950 cUL60950 EN60950 ACA TS001 / AS 3260
EMC Safety Approvals:
FCC Part 15 Class A EN55022 EN55024
CE Marked
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 8
Category Description Intelligent Features
High performance 10/100BaseT Ethernet bridge Half duplex or full duplex support on the WAN interface 256 frame buffer Stores 10,000 MAC addresses Automatically learns MAC addresses Serial interface supports DTE speeds to 230K bps External and RS-232 power options High performance processor runs ARP, DHCP, FTP, HTTP, ICMP, IP,
POP3, PPP, SMTP, SNMP, SNMP, TCP, Telnet, TFTP, UDP protocols Command line interface Flash memory to update firmware with the latest enhancements Flexible IP protocol stack Compact, rugged industrial chassis design Desktop or panel mounting Two-year warranty
Software Features
Internet Applications
DHCP Client:
Telnet Server:
Telnet Client:
Terminal Server:
TFTP Server:
SMTP Client:
POP3 Client:
HTTP Server:
Functional Features
Command Line Configuration over Serial or Ethernet
Username and Password Authentication Using Local Database
Remote Transparent Bridging
Point-to-Point Protocol (PPP)
Chapter 1 – Product Description and Specifications
Request IP address for Ethernet Interfaces
Command Line Configuration Auto Dial-out Feature Command line via custom port (other than standard port 23)
Connect to remote Telnet Server Serial Auto Dial-in Feature
Network to Serial Connectivity Serial to Network Connectivity
Flash Upgrade
The email client embedded in the MultiConnect sends email to the configured recipients.
The email client embedded in the MultiConnect receives email from the POP3 Server. This feature is useful for field upgrades. Firmware upgrades can be sent as attachments.
To host Web pages on behalf of the serial device for monitoring and configuration of the serial device.
Serial - TTY Ethernet - Telnet
The Username and Password can be created using commands. The User database authenticates the Users before access to
command mode of the MultiConnect adapter is enabled.
Ethernet to Serial Bridging
Negotiations Bridging Control Protocol
- 802.3 MAC Type
CCP Compression
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 9
Chapter 1 – Product Description and Specifications
LED Indicators
Name Description ACT Activity – Lit when data is being transmitted or received. STS Status – Blinks to indicate that the unit is functioning.
RS-232 9-Pin Connector Pinout
Pin 1
Pin 6
Pin 5
Pin 9
Pins for the Serial-to-Serial Adapter when Power Is Supplied Externally
Pin Description 1 DCD 2 RX Data 3 TX Data 4 DTR 5 Ground 6 DSR 7 RTS 8 CTS 9 RI
Pins for the Serial-to-Serial Adapter when Power Is Supplied Through the RS-232 Pin
Pin Description 1 DCD 2 RX Data 3 TX Data 4 DTR 5 Ground 6 Power 7 RTS 8 CTS 9 RI
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 10
Chapter 2 – Installation
Chapter 2 – Installation
Attaching the MultiConnect to a Fixed Location
The MultiConnect adapter is design to be used on the desktop or to be panel-mounted. To attach the bracket for panel-mounting, following these steps:
1. Typically, the MultiConnect adapter is mounted against a flat surface with two mounting screws. Drill the mounting holes at the desired location. The mounting holes must separated by 4 -7/16 inches center-to-center.
2. To attach the brackets to the MultiConnect, slide the mounting brackets into the corresponding slots on the back of the MultiConnect chassis.
3. Attach the adapter to the surface with two screws.
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 11
Serial-to-Serial Adapter Installation
Chapter 2 – Installation
Connecting the Cables
Serial-to-Serial Adapter
Back shown with External Power Option
1. Plug one end of the RS-232 cable into the front of the Serial-to-Serial adapter.
Plug the other end into the RS-232 connector on the modem
that is setup with an Internet connection.
2. Plug one end of the other RS-232 cable into the back of the Serial-to-Serial adapter.
Plug the other end into the RS-232 connector on the serial
device you want connected to the Internet.
Front
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 12
Chapter 2 – Installation
Connecting the Power
The adapters are powered in one of two ways:
Through the DSR Pin of the RS-232 Cable Adapters powered this way are shipped with an RS-232 cable that has a power pin instead of a DSR pin.
Through an External Power Supply Adapters powered this way are shipped with a universal power supply and its accompanying power cord and an RS-232 cable that has a DSR pin instead of a power pin.
Connecting the External Power
1. Plug the power supply cable with attached transformer block into the power connector on the
back of the MultiConnect adapter.
2. Plug the AC cord receptacle into the transformer block. Plug the other end into a power outlet.
One end of RS-232 Shown Here
Plug Power Supply Cable with Transformer into the Back of the Adapter
Plug AC Cord into Transformer Block and Outlet
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 13
Chapter 3 – Managing and Configuring the MultiConnect Adapter
Chapter 3 – Managing and
Configuring the MultiConnect
Adapter
Two Ways to Login
Login Using TTY
Use TTY to configure your MultiConnect IP for the first time. Configure the host serial port
using the defaults listed below:
Baud: 115.2K Data: 8 Parity: N Stop: 1 Flow-Control: None
Press the Enter key three times to get to the Login prompt or send three carriage returns.
At the Login prompt, type admin.
At the Password prompt, type admin.
Important: The user name and password are case sensitive. They must be typed in lowercase
letters.
Login Using Telnet through the PPP Interface
Open the PPP interface on the modem port.
Upon successful establishment of a Telnet session, the MultiConnect IP displays the Login
prompt. At the Login prompt, type admin.
At the Password prompt, type admin.
After a successful login, the MultiConnect IP enters Command Mode. In Command Mode,
the MultiConnect IP can be configured and managed using the Command Line Interface (CLI) command set.
About Command Mode and Data Mode
In Command Mode, a # sign designates the prompt. If you type the word Help at the command
prompt, a complete list of commands displays.
If you type the word Usage at the command prompt, a list of the command semantics displays.
In Data Mode, the # sign is not displayed.
To leave Command Mode, exit your terminal or Telnet session or type the word Exit at the
command prompt.
Note: See the Restore command and IP Escape String command.
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 14
Chapter 4 – Command Line Interface (CLI)
Chapter 4 – Command Line Interface
(CLI)
The MultiConnect commands are grouped based on the functionality.
General Setup Commands
IP Setup Commands
Serial Setup Commands
PPP Setup Commands
HTTP Setup Commands
SMTP Setup Commands
POP3 Setup Commands
FTP Client Setup Commands
SNTP Client Setup Commands
General Notes
Required command parameters are indicated between < >.
Optional command parameters are indicated between [ ].
Parameter choices are delineated by /.
Upon successful execution of a command, the “OK” string is echoed to the client.
When an unsuccessful command is executed, an appropriate error message is displayed
followed by an "ERROR" string.
All the commands are case sensitive (they must be typed in lower case).
PPP is enabled on the modem interface S1.
All serial-related applications such as dial-in and dial-out are with respect to the serial
interface S0.
The PPP interface is the modem interface S1.
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 15
Chapter 4 – Command Line Interface (CLI)
General Commands – Setup
General Setup Commands
General setup of a MultiConnect IP is port-independent (physical S0, S1 etc.). The following command set is used to set the global configuration of MultiConnect IP.
Command Syntax dialout serial s0
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax Exit
Description
Default Value
Success
Manual Telnet dialout (Internet-to-serial connectivity). Invoked from the command shell. NA OK
“Usage: dialout serial <serial port> Type ‘dialout ?’ for more information”
2. Invalid argument
Possible argument(s) are: Serial
1. When invoked from Serial Shell
This command is not supported through serial dial-in
Exits the command parser, unlocks the configurations, terminates session. NA OK
Command Syntax Help
Description
Default Value
Success
Command Syntax restore default-config
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax restore session
Description
Default Value
Success
Error 1. Too few arguments
Provides the first level of commands in MultiConnect IP. NA OK
Restores the factory defaults.
Note: All previous configurations will be lost upon invoking this command.
The changes are made permanent only if save config is invoked. NA OK
”Possible arguments are default-config and session
2. Invalid argument
Invalid argument “invalid string”
Valid arguments are default-config and session
On Telnet dialout, the control is transferred to the command parser passing
the escape sequence “+++ inet”. Invoking “restore session” would resume
the Telnet dialout exiting the command parser. NA OK
Possible arguments are default-config and session
2. ERROR: Session not opened
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 16
Command Syntax reset modem
Description
Default Value
Success
At will, reset the built-in modem. NA OK
Error 1. Too few arguments Possible argument(s) are modem
Command Syntax save
Description
Default Value
Success
Command to Save the configuration to the flash and reboot. NA OK
Command Syntax telnet <dial-ip-addr> [<port>]
Description
Manual serial dial-in (device port to modem port connectivity).
Invoked from the command shell.
Default Value
Success
NA
OK
Error 1. Too few arguments
2. Invalid IP address/Port
“(Error: hostp = “configured host“. Error: hostp=“configured IP address“
3. When invoked from Command shell connected through
This command is not supported through Telnet
Command Syntax Usage
Description
Default Value
Success
Provides the command semantics for all the commands.
NA
OK
Command Syntax user add <user-name> [<passwd>]
Description
Add the user name and the password to the group.
Notes: Default Groups: admin, users
Default Users: admin, ipmodule Only Admin can configure the MultiConnect IP
Default Value
Success
NA OK
Error 1. Too few arguments
“Too few arguments. Possible value(s) are username followed by
password“
2. Unable to add the user name: “user ‘username‘ exists“
Command Syntax user delete <user-name>
Description
Default Value
Success
Delete the user name from the group. NA OK
Error 1. Too few arguments
“Too few arguments. Possible value(s) are username followed by
password“
2. Unable to delete the user name: “user ‘username‘ does not exist“
Chapter 4 – Command Line Interface (CLI)
General Commands – Setup
Telnet
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 17
Chapter 4 – Command Line Interface (CLI)
Command Syntax user password <username> <new password>
Description
Default Value
Success
Change the password for a user.
NA
OK
Error 1. Too few arguments
“Too few arguments. Possible value(s) are username followed by
password”
2. Unable to change the password
“Password does not match Unable to change user <username> password”
Command Syntax set operation-mode <modem/ipmodule>
Description modem - In the modem mode, the target functions like a modem
ipmodule - In the ipmodule mode, all the functional features of MultiConnect IP can be achieved.
Default Value
Success
Ipmodule OK
Error 1. Too few arguments
"Too few arguments. Possible argument(s) are modem and ipmodule
2. Invalid string "Invalid argument "string" Valid argument(s) are modem and ipmodule
Command Syntax set boot-messages <enable/disable>
Description enable - Prints the boot-messages during module boot-up.
disable - Suppresses the boot-messages during module boot-up.
Default Value
Success
Enable OK
Error 1. Too few arguments
"Too few arguments. Possible argument(s) are disable and enable
2. Invalid string "Invalid argument "string" Valid argument(s) are disable and enable
Command Syntax set date <DD/MM/YYYY>
Description
Default Value
Success
Sets the system date.
Jan 1 1970
OK
Error 1. Too few arguments
Usage: set date DD/MM/YYYY
Type 'set date ?' for more information
Error: Date in DD/MM/YYYY format
Too few arguments. Possible argument(s) are
ip ppp date serial login time
General Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 18
Chapter 4 – Command Line Interface (CLI)
Command Syntax set login
Description
Prompts the Login for the command shell when enabled, and doesn't when
disabled.
Default Value
Success
Enable
OK
Error 1. Too few arguments
"Usage: set login <enable/disable>
Type 'set login ?' for more information"
2. Invalid string
"error: set login <enable/disable>"
Command Syntax set login auto-dialout-login <enable/disable>
Description
Default Value
Success
Enables/Disables authentication for Telnet auto-dialout.
Disable
OK
Error 1. Too few arguments
"Usage: set login auto-dialout-login <enable/disable>
Type 'set login auto-dialout-login ?' for more information"
2. Invalid string
"error: set login auto-dialout-login <enable/disable>"
Command Syntax set time <HH:MM:SS>
Description
Default Value
Success
Sets the system time.
00:00:00
OK
Error 1. Too few arguments
Usage: set date HH:MM:SS
Type 'set date ?' for more information
Error: Time in HH:MM:SS format
Too few arguments. Possible argument(s) are
ip login serial date ppp time
Command Syntax set watchdog <enable/disable>
Description
Enables/Disables the watchdog timer. The timer value is set to 6.5 seconds. This is the upper threshold value.
Note: Watchdog timer comes into effect only after reboot. Hence,
invoking this command calls for a reboot on save.
Default Value
Success
Enable OK
Error 1. Too few arguments
"Usage: set watchdog <enable/disable> Type 'set watchdog <enable/disable> ?' for more information"
2. Invalid string "error: set watchdog <enable/disable>"
General Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 19
Command Syntax show buildrun
Description Command Line Configuration - History.
Upon invoking any command, either through Telnet or Serial TTY, the command is added to the buildrun file. This is very useful in case of version updates.
Default Value
Success
NA OK
Error 1. Too few arguments
"Too few arguments. Possible argument(s) are serial date statistics users buildrun ip sys-info configuration ppp time
2. Invalid argument
Invalid argument "string". Valid arguments are serial date statistics users buildrun ip sys-info configuration ppp time
Command Syntax show configuration
Description
Default Value
Success
Displays the MultiConnect IP configuration. NA OK
Error 1. Too few arguments
“Too few arguments. Possible argument(s) are:
2. Invalid argument
Valid arguments are:
Chapter 4 – Command Line Interface (CLI)
General Commands – Setup
General Commands – Show
serial ppp sys-info device-parameter configuration recv-mail time date http users buildrun statistics send-mail
serial ppp sys-info device-parameter configuration recv-mail time date http users buildrun statistics send-mail
Command Syntax show date
Description
Default Value
Success
Shows the system date. NA OK
Error 1. Too few arguments
Too few arguments. Possible argument(s) are:
ip statistics users configuration ppp sys-info date serial time
2. Invalid argument
Invalid argument "Invalid string". Valid arguments are
ip statistics users configuration ppp sys-info date serial time
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 20
Command Syntax show statistics
Description
Default Value
Success
Displays MultiConnect IP statistics. NA OK
Error 1. Too few arguments
“Too few arguments. Possible argument(s) are:
2. Invalid argument
Command Syntax show sys-info
Description
Displays the system related information.
Hardware information
System Uptime
Memory Utilization
Flash Memory Map
Default Value
Success
NA OK
Error 1. Too few arguments
Too few arguments. Possible argument(s) are:
2. Invalid argument
Invalid argument "Invalid string". Valid arguments are:
Command Syntax show time
Description
Default Value
Success
Displays the system time. NA OK
Error 1. Too few arguments
Too few arguments. Possible argument(s) are
2. Invalid argument
Invalid argument "Invalid string" Valid arguments are:
Chapter 4 – Command Line Interface (CLI)
General Commands – Show
ip statistics users configuration ppp sys-info date serial time
Valid arguments are:
ip statistics users configuration ppp sys-info date serial time
ip statistics users configuration ppp sys-info date serial time
ip statistics users configuration ppp sys-info date serial time
serial ip sys-info configuration ppp time date statistics users
serial ip sys-info configuration ppp time date statistics users
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 21
Command Syntax show users
Description
Default Value
Success
Error 1. Too few arguments
Chapter 4 – Command Line Interface (CLI)
General Commands – Show
Displays the configured users. NA OK
“Too few arguments. Possible argument(s) are:
serial ip sys-info configuration ppp time date statistics users
2. Invalid argument
Valid arguments are:
serial ip sys-info configuration ppp time date statistics users
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 22
IP Setup Commands
Command Syntax set ip dns <enable/disable>
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax set ip hostname <hostname>
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax set ip pri-dns <ip addr>
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax set ip sec-dns <ip addr>
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax set ip syslogd <enable/disable>
Description
Default Value
Success
Error 1. Too few arguments
Enables/disables the DNS client. Enabled OK
“Usage: set ip dns <enable/disable> Type ‘set ip dns ?’ for more information”
2. Invalid string
Type ‘set ip dns ?’ for more information”
Sets the host name of the MultiConnect IP. “MultiConnectIP” OK
“Usage: set ip hostname <hostname> Type ‘set ip hostname ?’ for more information”
Sets the primary DNS IP address to 0.0.0.0.
0.0.0.0
OK
“Usage: set ip pri-dns <ip addr>
Type ‘set ip pri-dns ?’ for more information”
2. Invalid IP Address
“error: Invalid IP address
Type ‘set ip pri-dns ?’ for more information”
Sets the secondary DNS IP address to 0.0.0.0.
0.0.0.0
OK
“Usage: set ip sec-dns <ip addr>
Type ‘set ip sec-dns ?’ for more information”
2. Invalid IP Address
“error: Invalid IP address
Type ‘set ip sec-dns ?’ for more information”
Enables/Disables syslogd.
Disable
OK
“Usage: set ip syslogd <enable/disable>
Type ‘set ip syslogd ?’ for more information”
Chapter 4 – Command Line Interface (CLI)
IP Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 23
Command Syntax set ip syslogd-server <ip addr>
Description
Default Value
Success
Sets the remote syslog server's IP address.
0.0.0.0 OK
Error 1. Too few arguments
“Usage: set ip syslogd-server <ip_addr> Type ‘set ip syslogd-server ?’ for more information”
2. Invalid IP address
“error: Invalid IP address Type ‘set ip syslogd-server ?’ for more information”
Command Syntax set ip tcp-keepalive <t mins>
Description
Sets the TCP keep-alive timeout for the MultiConnect IP.
't' : range from 3-120 minutes
Default Value
Success
3 minutes OK
Error 1. Too few arguments
“Usage: set ip tcp-keepalive <t mins> Type ‘set ip tcp-keepalive ?’ for more information”
2. Invalid IP address
“error: Invalid value, rante [3-120] mins Type ‘set ip tcp-keepalive ?’ for more information”
Command Syntax set ip telnet <enable/disable>
Description
Enables/disables the Telnet Server. This is a global setting, which will
enable/disable the Telnet Server in the MultiConnect IP.
Note: Upon disabling Telnet server, the administrator cannot configure the
MultiConnect IP over the built-in Modem interface (wherein PPP has
acquired IP Address). The only option is to connect through a terminal
application over the Serial port.
Default Value
Success
Enabled
OK
Error 1. Too few arguments
Too few arguments. Possible argument(s) are
set ip telnet<enable/disable>
Type : set ip telnet ? for more information)
2. Multiple matches
telnet telnet-port
3. Invalid String
Invalid argument "invalid string"
Valid arguments are
auto-dialout escape-string inactivity inactivity-timeout escape-monitor raw-mode
Possible value(s) are enable or disable
Chapter 4 – Command Line Interface (CLI)
IP Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 24
Chapter 4 – Command Line Interface (CLI)
Command Syntax set ip telnet auto-dialout <enable/disable>
Description
Enables Telnet connectivity between the MultiConnect IP and the remote device. This flag enables/disables the Telnet Auto dialout globally.
Default Value
Success
Enabled OK
Error 1. Too few arguments
“Usage: set ip telnet auto-dialout <enable/disable> Type ‘set ip telnet auto-dialout ?’ for more information”
2. Invalid String Type ‘set ip telnet auto-dialout ?’ for more information”
Command Syntax set ip telnet escape-string <string>
Description
The Telnet Server scans for this escape sequence and transfers the control
to the command parser.
By default, the Telnet Server scans for “+++inet”.
Default Value
Success
+++ inet
OK
Error 1. Too few arguments
“Usage: set ip telnet escape-string <string>
Type ‘set ip telnet escape-string ?’ for more information”
2. Multiple matches
escape-monitor escape-string
Command Syntax set ip telnet escape-monitor <enable/disable>
Description
Default Value
Success
Enables/disables the ‘‘monitor’’ flag that scans for the escape sequence.
Enabled
OK
Error 1. Too few arguments
“Usage: set ip telnet escape-monitor <enable/disable>
Type ‘set ip telnet escape-monitor ?’ for more information”
2. Multiple matches
escape-monitor escape-string
3. Invalid String
Type ‘set ip telnet escape-monitor ?’ for more information”
Command Syntax set ip telnet inactivity <enable/disable>
Description
Default Value
Success
Enables/disables the inactivity functionality. Disable OK
Error 1. Too few arguments
“Usage: set ip telnet inactivity <enable/disable> Type ‘set ip telnet inactivity ?’ for more information”
2. Multiple matches
inactivity inactivity-timeout
3. Invalid String
Type ‘set ip telnet inactivity ?’ for more information”
IP Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 25
Command Syntax set ip telnet inactivity-timeout <t secs>
Description
If the Telnet session is inactive for ‘t’ secs, the connection is terminated.
This functionality is applicable only if “set telnet inactivity” is enabled. (Refer
to ’set ip telnet inactivity’ command).
Default Value
Success
5 min
OK
Error 1. Too few arguments
“Usage: set ip telnet inactivity-timeout <t secs>
Type ‘set ip telnet inactivity-timeout ?’ for more information”
2. Multiple matches
inactivity and inactivity-timeout
3. Invalid timeout value
“error: ‘t secs range : 0 – 300
Type ‘set ip telnet inactivity-timeout ?’ for more information”
Command Syntax set ip telnet-port <port_num >
Description
This Telnet-port corresponds to the port number that the MultiConnect IP
will wait on for configuring the box.
Default port number is TCP 23. You have the option to change this number.
Note: Invoking this command terminates the current Telnet session.
Default Value
Success
23
OK
Error 1. Too few arguments
“Usage: set ip telnet-port <port-num>
Type ‘set ip telnet-port ?’ for more information”
2. Invalid port-num
“error: Invalid port number
Type ‘set ip telnet-port ?’ for more information”
Command Syntax set ip telnet raw-mode <enable/disable>
Description
This is a global setting of raw-mode for the Telnet application. This setting is applicable for both Telnet auto-dialout, serial auto-dial-in.
Default Value
Success
Disabled OK
Error 1. Too few arguments
“Usage: set ip telnet raw-mode <enable/disable> Type ‘set ip telnet raw-mode ?’ for more information”
2. Invalid String
ERROR
Chapter 4 – Command Line Interface (CLI)
IP Commands – Setup
Command Syntax set ip tftp <enable/disable >
Description
Enables/disables the TFTP Server. When the TFTP Server is enabled, the
network administrator can upload the firmware to the flash.
Default Value
Success
Enabled
OK
Error 1. Too few arguments
“Usage: set ip tftp <enable/disable>
Type ‘set ip tftp ?’ for more information”
2. Invalid string
error: Invalid string
Type ‘set ip tftp ?’ for more information”
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 26
Chapter 4 – Command Line Interface (CLI)
Serial Commands – Setup
Serial Setup Commands
Command Syntax set serial auto-telnet <enable/disable>
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax set serial <serial-interface> escape-monitor <enable/disable>
Description
Default Value
Success
Error 1. Too few arguments
Command Syntax set serial <serial-interface> escape-string <string>
Description
Default Value
Success
Error 1. Too few arguments
This command globally enables serial auto dial-in support.
Notes:
This feature provides a Telnet session to the serial device connected to S0
through the IP-enabled modem port (S1)
Also, Telnet can be used only after PPP is up and has acquired an IP
address on the modem's (S1) port.
Disabled
OK
“Usage: set serial auto-telnet <enable/disable>
Type ‘set serial auto-telnet ?’ for more information”
2. Invalid string
error: Invalid string
Type ‘set serial auto-telnet ?’ for more information
Sets a ‘‘monitor’’ flag that enables/disables the scanning of escape
sequence.
Enable
OK
“Usage: set serial s0/s1 escape-monitor <enable/disable>
Type ‘set serial s0/s1escape-monitor ?’ for more information”
2. Multiple matches
escape-monitor escape-string
3. Invalid string
error: Invalid string
Type ‘set serial s0/s1 escape-monitor ?’ for more information”
The Telnet client scans for this escape sequence and transfers the control to
the command parser.
By default, the Telnet client scans for “+++inet”.
+++ inet<serial-interface> OK
“Usage: set serial s0/s1 escape-string <string> Type ‘set serial s0/s1 escape-string ?’ for more information”
2. Multiple matches
escape-monitor escape-string
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 27
Command Syntax hangup [serial interface]
Valid serial interface – Modem port S1
Description
When this command is issued, the established live link is brought down.
This command is only valid only for modem port (S1)
Default Value
-
Success If physical link is brought down, OK and
Physical link is successfully brought down messages are given
Error 1. Too few arguments
"Usage: hangup [S1]
Type 'hangup [S1] ?' for more information"
2. “error: Link could not be brought down”
message is given when link could not be brought down
Command Syntax linkup [serial interface]
Valid serial interface – Modem port S1
Description
Establishes a physical link and PPP on the modem port.
This command is relevant only when the serial interface is a dialing end
with dialing-trig-mode configured as "command"
Default Value
Success
-
If physical link is established
OK and
CONNECT 14400 LAPM COMPRESSED
(i.e., CONNECT message from the modem)
are given
Error 1. Too few arguments
"Usage: linkup [S1]
Type 'linkup [S1]' for more information"
2. “error: Link cannot be brought up”
message is given when dialing-trig-mode is not "command”
3. “error: Link is not established”
message is given when link is not established (in case PPP fails to get the
logical link up)
4. “error: Link is already up”
message is given when link is established and this command will not
tear down and bring up the link
5. “error: NO CARRIER / NO DIALTONE / NO ANSWER”
or any error return code from the modem
Chapter 4 – Command Line Interface (CLI)
Serial Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 28
Chapter 4 – Command Line Interface (CLI)
Command Syntax set serial [s0] auto-dialin <enable/disable>
Description
Enables/disables the device port to Internet connectivity for the serial port
S0. This command is valid only for device port S0
Default Value
Success
Disabled
OK
Error 1. Too few arguments
“Usage: set serial s0 auto-dialin <enable/disable>
Type ‘set serial s0 auto-dialin ? for more information”
2. Multiple matches
auto-dialin auto-dialin-protocol auto-dialout-protocol auto-dialin-ipaddress auto-dialout auto-dialin-port auto-dialout-port
3. Invalid string
“error: Invalid string
Type ‘set serial s0 auto-dial-in ? for more information”
4. If “set serial s1 auto-dialin <enable/disable>” is given
“error: Command not supported on the modem port s1”
Command Syntax set serial [s0] auto-dialin-ipaddress <ipaddr>
Description
Specifies the auto dial-in IP address.
Note: When a connection is established from serial, a session is
established to the IP address mentioned above.
This command is valid only for device port S0.
Default Value
Success
NULL
OK
Error 1. Too few arguments
“Usage: set serial s0 auto-dialin-ipaddress <ipaddr>
Type ‘set serial s0 auto-dialin-ipaddress ? for more information”
2. Multiple matches
auto-dialin auto-dialin-protocol auto-dialout-protocol auto-dialin-ipaddress auto-dialout auto-dialin-port auto-dialout-port
3. Invalid IP Address
“error: Invalid IP address
Type ‘show serial s0 auto-dialin-ipaddress ? for more information”
4. If “set serial s1 auto-dialin-ipaddress 192.168.2.2” is given
“error: Command not supported on the modem port s1”
Serial Commands – Setup
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 29
Chapter 4 – Command Line Interface (CLI)
Command Syntax set serial [s0] auto-dialin-port [port_num]
Description
Command to specify the auto dial-in port number.
Note: [port_num] is optional here. If port_num is not specified, the standard
port 23 of the Telnet protocol shall be used.
This command is valid only for device port S0
Default Value
Success
23
OK
Error 1. Too few arguments
“Usage: set serial s0 auto-dialin-port [port_num]
Type ‘set serial s0 auto-dialin-port ? for more information”
2. Multiple matches
auto-dialin auto-dialin-protocol auto-dialout-protocol auto-dialin-ipaddress auto-dialout auto-dialin-port auto-dialout-port
3. Invalid port
“error: Invalid port number
Type ‘set serial s0 auto-dialin-port ? for more information”
4. If “set serial s1 auto-dialin-port 23” is given
“error: Command not supported on modem port s1”
Serial Commands – Setup
Command Syntax set serial [s0] auto-dialin-protocol <telnet>
Description
By default, Telnet is the protocol used to establish the serial-to-Internet
connectivity.
Note: This syntax provides for future extensibility (SSH Client, etc.)
This command is valid only for device port S0<ftp protocol setting is not yet
implemented>
Default Value
Success
Error
Telnet
OK
1. Too few arguments
“Usage: set serial s0 auto-dialin-protocol <telnet/ftp>
Type ‘set serial s0 auto-dialin-protocol ? for more information”
2. Multiple matches auto-dialin auto-dialin-protocol auto-dialout-protocol auto-dialin-ipaddress auto-dialout auto-dialin-port auto-dialout-port
3. Invalid protocol selected
“error: Selected protocol not supported Type ‘set serial s0 auto-dialin-protocol ? for more information”
4. If “set serial s1 auto-dialin-protocol telnet” is given
“error: Command not supported on modem port s1”
Multi-Tech Systems, Inc. MultiConnect Serial-to-Serial Adapter User Guide (S000354A) 30
Loading...
+ 151 hidden pages