XPort Pro
User Guide
Part Number 900-560
Revision & 0DrFK 201
Copyright & Trademark
© 2011 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.
Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of The Open
Group. Windows 95, Windows 98, Windows 2000, and Windows NT are trademarks of Microsoft
Corp.
Warranty
For details on the Lantronix warranty replacement policy, please go to our web site at
www.lantronix.com/support/warranty
Contacts
Lantronix Corporate Headquarters
167 Technology Drive
Irvine, CA 92618, USA
Phone:949-453-3990
Fax:949-450-7249
Technical Support
Online: www.lantronix.com/support
.
Sales Offices
For a current list of our domestic and international sales offices, go to the Lantronix web site at
www.lantronix.com/about/contact
Disclaimer
Note: This product has been designed to comply with the limits for a Class A digital
device pursuant to B digital device pursuant to Part 15 of FCC and EN55022:1998 Rules
when properly enclosed and grounded. These limits are designed to provide reasonable
protection against radio interference in a residential installation. This equipment
generates, uses, and can radiate radio frequency energy, and if not installed and used in
accordance with this guide, may cause interference to radio communications. See
“Appendix - Compliance” on page 145 for additional information.
The information in this guide may change without notice. The manufacturer assumes no
responsibility for any errors that may appear in this guide.For the latest revision of this product
document, please check our online documentation at www.lantronix.com/support/
documentation.html.
.
XPort Pro User Guide 2
Revision History
Date Rev. Comments
September 2009 A Initial Document
December 2010 B Updated for firmware version 5.2.0.0R20. Added support for Modbus
protocol, configurable MTU, and additional VIP tunnel connect
protocols; as well as improvements to SNMP, logging, and SSL.
March 2011 C Updated SDRAM information.
XPort Pro User Guide 3
Table of Contents
List of Figures _____________________________________________________________9
List of Tables _____________________________________________________________11
1: About This Guide 13
Chapter and Appendix Summaries ____________________________________________13
Additional Documentation ___________________________________________________14
2: Introduction 15
Key Features _____________________________________________________________15
Applications ______________________________________________________________15
Protocol Support ______________________________________________________16
Evolution OS™ ___________________________________________________________16
Additional Features ________________________________________________________16
Modem Emulation ______________________________________________________16
Web-Based Configuration and Troubleshooting _______________________________17
Command-Line Interface (CLI) ____________________________________________17
VIP Access ___________________________________________________________17
SNMP Management ____________________________________________________17
XML-Based Architecture and Device Control _________________________________17
Really Simple Syndication (RSS) __________________________________________17
Enterprise-Grade Security _______________________________________________17
Terminal Server/Device Management ______________________________________18
Troubleshooting Capabilities ____________ _________________________________18
Configuration Methods _____________________________________________________18
Addresses and Port Numbers ________________________________________________19
Hardware Address _____________________________________________________19
IP Address ___________________________________________________________19
Port Numbers _________________________________________________________19
Product Information Label ___________________________________________________19
3: Using DeviceInstaller 21
Accessing XPort Pro Using DeviceInstaller _____________________________________21
Device Details Summary ____________________________________________________21
4: Configuration Using Web Manager 23
Accessing Web Manager ___________________________________________________23
Device Status Page ____________________________________________________24
Web Manager Page Components _____________________________________________25
Navigating the Web Manager ________________________________________________26
XPort Pro User Guide 4
5: Network Settings 28
Network 1 (eth0) Interface Status _____________________________________________28
Network 1 (eth0) Interface Configuration _______________________________________29
Network 1 Ethernet Link ____________________________________________________31
6: Line and Tunnel Settings 32
Line Settings _____________________________________________________________32
Line Statistics _________________________________________________________32
Line Configuration _____________________________________________________33
Line Command Mode ___________________________________________________35
Tunnel Settings __________________________________________________________ 36
Tunnel – Statistics _____________________________________________________37
Tunnel – Serial Settings _________________________________________________39
Tunnel – Packing Mode _________________________________________________40
Tunnel – Accept Mode __________________________________________________43
Tunnel – Connect Mode _________________________________________________46
Connecting Multiple Hosts ____________________________________________50
Host List Promotion _________________________________________________50
Tunnel – Disconnect Mode _______________________________________________51
Tunnel – Modem Emulation ______________________________________________52
7: Terminal and Host Settings 55
Terminal Settings _________________________________________________________55
Line Terminal Configuration ______________________________________________55
Network Terminal Configuration ___________________________________________57
Host Configuration ________________________________________________________58
8: Configurable Pin Manager 59
Overview __ ______________________________________________________________59
Default Groups ________________________________________________________59
Custom Groups _______________________________________________________59
CPM: CP (Configurable Pins) ________________________________________________59
View CPs ____________________________________________________________60
CPM: Groups ____________________________________________________________62
View Groups __________________________________________________________62
9: Service Settings 66
DNS Settings _____________________________________________________________66
PPP Settings ____________________________________________________________ 67
SNMP Settings ___________________________________________________________69
FTP Settings ____________________________________________________________70
TFTP Settings ___________________________________________________________71
XPort Pro User Guide 5
Syslog Settings ___________________________________________________________72
HTTP Settings ____________________________________________________________73
HTTP Statistics ________________________________________________________73
HTTP Configuration ____________________________________________________74
HTTP Authentication ___________________________________________________76
RSS Settings _____________________________________________________________77
LPD Settings _____________________________________________________________78
LPD Statistics _________________________________________________________78
LPD Configuration _____________________________________________________79
10: Security Settings 81
SSH Settings _____________________________________________________________81
SSH Server Host Keys _________________________________________________82
SSH Server Authorized Users ____________________________________________83
SSH Client Known Hosts ________________________________________________85
SSH Client User _______________________________________________________86
SSL Settings _____________________________________________________________88
SSL Cipher Suites _____________________________________________________88
SSL Certificates _______________________________________________________89
SSL RSA or DSA ______________________________________________________89
SSL Certificates and Private Keys _________________________________________89
SSL Utilities __________________________________________________________90
OpenSSL ___ ______________________________________________________90
Steel Belted Radius _________________________________________________90
FreeRadius ________________________________________________________90
SSL Configuration _____________________________________________________91
11: Modbus 94
CP Control via Modbus __________________________________________________94
Serial Transmission Mode _______________________________________________96
Modbus Statistics _________________________________________________________97
Modbus Configuration ______________________________________________________98
12: Maintenance and Diagnostics Settings 99
Filesystem Settings ________________________________________________________99
Filesystem Statistics ____________________________________________________99
Filesystem Browser ___________________________________________________100
Protocol Stack Settings ____________________________________________________103
TCP Settings ________________________________________________________103
IP Settings __________________________________________________________104
ICMP Settings ________________________________________________________105
ARP Settings ________________________________________________________106
XPort Pro User Guide 6
SMTP Settings _______________________________________________________107
IP Address Filter _________________________________________________________108
Query Port _____________________________________________________________109
Diagnostics __ ___________________________________________________________110
Hardware ___ ________________________________________________________110
MIB-II Statistics _______________________________________________________111
IP Sockets __________________________________________________________112
Ping __ _____________________________________________________________112
Traceroute __ ________________________________________________________114
Log ___ _____________________________________________________________115
Memory _____________________________________________________________117
Buffer Pools _________________________________________________________117
Processes ___________________________________________________________118
System Settings _________________________________________________________120
13: Advanced Settings 122
Email Settings ___________________________________________________________122
Email Statistics _______________________________________________________122
Email Configuration ___________________________________________________123
Command Line Interface Settings ____________________________________________125
CLI Statistics _________________________________________________________125
CLI Configuration _____________________________________________________125
XML Settings ____________________________________________________________127
XML: Export Configuration ______________________________________________127
XML: Export Status ____________________________________________________129
XML: Import Configuration ______________________________________________130
Import Configuration from External File _________________________________131
Import Configuration from the Filesystem _______________________________132
Import Line(s) from Single Line Settings on the Filesystem __________________ 134
14: VIP Settings 136
Obtaining a Bootstrap File __________________________________________________136
Importing the Bootstrap File ________________________________________________136
Enabling VIP ____________________________________________________________137
Configuring Tunnels to Use VIP _____________________________________________137
Virtual IP (VIP) Statistics ___________________________________________________137
Virtual IP (VIP) Counters ___________________________________________________138
Virtual IP (VIP) Configuration _______________________________________________138
15: Branding the XPort Pro 139
Web Manager Customization _______________________________________________139
Short and Long Name Customization _________________________________________139
XPort Pro User Guide 7
16: Updating Firmware 141
Obtaining Firmware _______________________________________________________141
Loading New Firmware ____________________________________________________141
Appendix - Technical Support 142
Technical Support US ______________________________________________142
Technical Support Europe, Middle East, Africa ___________________________142
Appendix - Binary to Hexadecimal Conversions 143
Converting Binary to Hexadecimal ________________________________________143
Conversion Table __________________________________________________143
Scientific Calculator ________________________________________________144
Appendix - Compliance 145
Index 147
XPort Pro User Guide 8
List of Figures
Figure 2-1 Sample Hardware Address ________________________________________________19
Figure 2-2 Product Label___________________________________________________________20
Figure 4-1 Web Manager Home Page ________________________________________________24
Figure 4-2 Components of the Web Manager Page ______________________________________25
Figure 5-1 Network 1 (eth0) Interface Status ___________________________________________28
Figure 5-2 Network 1 (eth0) Interface Configuration______________________________________29
Figure 5-4 Network 1 Ethernet Link __________________________________________________31
Figure 6-1 Line 1 Statistics _________________________________________________________32
Figure 6-4 Line 1 Command Mode ___________________________________________________35
Figure 6-6 Tunnel 1 Statistics _______________________________________________________38
Figure 6-7 Tunnel 1 Serial Settings___________________________________________________39
Figure 6-8 Tunnel 1 Packing Mode (Mode = Disable) ____________________________________40
Figure 6-9 Tunnel 1 Packing Mode (Mode = Timeout) ____________________________________41
Figure 6-10 Tunnel 1 Packing Mode (Mode = Send Character) _____________________________41
Figure 6-12 Tunnel 1 Accept Mode___________________________________________________44
Figure 6-14 Tunnel 1 Connect Mode _________________________________________________47
Figure 6-16 Host 1, Host 2, Host 3 Exchanged__________________________________________50
Figure 6-17 Tunnel 1 Disconnect Mode _______________________________________________51
Figure 6-20 Tunnel 1 Modem Emulation_______________________________________________53
Figure 7-1 Terminal on Line 1 Configuration ___________________________________________55
Figure 7-3 Terminal on Network Configuration __________________________________________57
Figure 7-5 Host Configuration_______________________________________________________58
Figure 8-1 CPM: CPs _____________________________________________________________60
Figure 8-4 CPM: Groups___________________________________________________________62
Figure 8-5 CPM Groups Current Configuration__________________________________________63
Figure 8-6 CPM: Group Status ______________________________________________________63
Figure 9-1 DNS Settings ___________________________________________________________66
Figure 9-2 PPP Configuration Settings ________________________________________________68
Figure 9-4 SNMP Configuration _____________________________________________________69
Figure 9-6 FTP Configuration _______________________________________________________70
Figure 9-7 TFTP Configuration ______________________________________________________71
Figure 9-9 Syslog ________________________________________________________________72
Figure 9-11 HTTP Statistics ________________________________________________________73
Figure 9-12 HTTP Configuration_____________________________________________________74
Figure 9-14 HTTP Authentication ____________________________________________________76
Figure 9-16 RSS _________________________________________________________________78
Figure 9-18 LPD Statistics _________________________________________________________79
Figure 9-19 LPD Configuration ______________________________________________________79
Figure 10-1 SSH Server: Host Keys __________________________________________________82
Figure 10-3 SSH Server: Authorized Users ____________________________________________84
Figure 10-5 SSH Client: Known Hosts ________________________________________________ 85
Figure 10-7 SSH Client: Users ______________________________________________________86
Figure 10-10 SSL ________________________________________________________________91
Figure 11-5 Modbus Statistics_______________________________________________________97
Figure 11-6 Modbus Configuration ___________________________________________________98
Figure 12-1 Filesystem Statistics ____________________________________________________99
Figure 12-2 Filesystem Browser ____________________________________________________101
Figure 12-4 TCP Protocol _________________________________________________________103
Figure 12-6 IP Protocol __________________________________________________________104
Figure 12-8 ICMP Protocol ________________________________________________________105
XPort Pro User Guide 9
Figure 12-10 ARP Protocol Page ___________________________________________________106
Figure 12-12 SMTP______________________________________________________________107
Figure 12-14 IP Address Filter Configuration __________________________________________108
Figure 12-16 Query Port Configuration_______________________________________________109
Figure 12-17 Diagnostics: Hardware_________________________________________________110
Figure 12-18 MIB-II Network Statistics _______________________________________________111
Figure 12-20 IP Sockets __________________________________________________________112
Figure 12-21 Diagnostics: Ping_____________________________________________________112
Figure 12-23 Diagnostics: Traceroute________________________________________________114
Figure 12-25 Diagnostics: Log _____________________________________________________115
Figure 12-26 Diagnostics: Log (Filesystem) ___________________________________________115
Figure 12-27 Diagnostics: Log (Line 1)_______________________________________________116
Figure 12-28 Diagnostics: Memory __________________________________________________117
Figure 12-29 Diagnostics: Buffer Pools_______________________________________________118
Figure 12-30 Diagnostics: Processes ________________________________________________119
Figure 12-31 System_____________________________________________________________120
Figure 13-1 Email Statistics _______________________________________________________122
Figure 13-2 Email Configuration ____________________________________________________123
Figure 13-4 CLI Statistics _________________________________________________________125
Figure 13-5 CLI Configuration______________________________________________________126
Figure 13-7 XML: Export Configuration ______________________________________________128
Figure 13-9 XML: Export Status ____________________________________________________129
Figure 13-11 XML: Import Configuration______________________________________________130
Figure 13-12 XML: Import Configuration from External File _______________________________131
Figure 13-13 XML: Import from Filesystem ___________________________________________132
Figure 13-14 XML: Import Configuration from Filesystem ________________________________133
Figure 13-15 XML: Import Line(s) from Single Line Settings on the Filesystem________________134
Figure 14-1 VIP Status ___________________________________________________________137
Figure 14-2 VIP Counters _________________________________________________________138
Figure 14-4 VIP Configuration Page _________________________________________________138
Figure 15-1 System Branding ______________________________________________________140
Figure 16-1 Update Firmware ______________________________________________________141
XPort Pro User Guide 10
List of Tables
Table 4-3 Summary of Web Manager Pages ___________________________________________26
Table 5-3 Network 1 (eth0) Interface Configuration ______________________________________29
Table 5-5 Network 1 Ethernet Link ___________________________________________________31
Table 6-2 Line 1 Configuration ______________________________________________________33
Table 6-3 Line 1 Configuration ______________________________________________________33
Table 6-5 Line 1 Command Mode____________________________________________________35
Table 6-11 Tunnel Packing Mode ____________________________________________________41
Table 6-13 Tunnel Accept Mode_____________________________________________________44
Table 6-15 Tunnel Connect Mode____________________________________________________48
Table 6-18 Tunnel Disconnect Mode _________________________________________________51
Table 6-19 Modem Emulation Commands and Descriptions _______________________________52
Table 6-21 Tunnel Modem Emulation_________________________________________________54
Table 7-2 Terminal on Line 1 Configuration ____________________________________________56
Table 7-4 Terminal on Network Configuration __________________________________________57
Table 7-6 Host Configuration _______________________________________________________58
Table 8-2 CPM CPs Current Configuration_____________________________________________61
Table 8-3 CPM CPs Status_________________________________________________________61
Table 8-7 Group Status____________________________________________________________64
Table 9-3 PPP Configuration _______________________________________________________68
Table 9-5 SNMP _________________________________________________________________69
Table 9-8 TFTP Server ____________________________________________________________71
Table 9-10 Syslog ________________________________________________________________72
Table 9-13 HTTP Configuration _____________________________________________________74
Table 9-15 HTTP Authentication_____________________________________________________76
Table 9-17 RSS__________________________________________________________________78
Table 9-20 LPD Configuration_______________________________________________________80
Table 10-2 SSH Server Host Keys Settings ____________________________________________82
Table 10-4 SSH Server Authorized User Settings _______________________________________84
Table 10-6 SSH Client Known Hosts _________________________________________________85
Table 10-8 SSH Client Users _______________________________________________________87
Table 10-9 Supported Cipher Suites__________________________________________________88
Table 10-11 SSL _________________________________________________________________92
Table 11-1 6 Byte Header of Modbus Application Protocol ________________________________94
Table 11-2 Modbus Local Slave Functions - Query ______________________________________94
Table 11-3 Modbus Local Slave Functions - Response ___________________________________95
Table 11-4 Modbus Transmission Modes______________________________________________96
Table 11-7 Modbus Configuration____________________________________________________98
Table 12-3 Filesystem Browser_____________________________________________________102
Table 12-5 TCP Settings__________________________________________________________103
Table 12-7 IP Settings____________________________________________________________104
Table 12-9 ICMP Settings_________________________________________________________105
Table 12-11 ARP Settings_________________________________________________________106
Table 12-13 SMTP Settings _______________________________________________________107
Table 12-15 IP Address Filter Settings _______________________________________________108
Table 12-19 Requests for Comments (RFCs)__________________________________________111
Table 12-22 Diagnostics: Ping _____________________________________________________113
Table 12-24 Diagnostics: Traceroute ________________________________________________114
Table 12-32 System _____________________________________________________________120
Table 13-3 Email Configuration_____________________________________________________123
Table 13-6 CLI Configuration ______________________________________________________126
XPort Pro User Guide 11
Table 13-8 XML Export Configuration________________________________________________128
Table 13-10 XML Export Status ____________________________________________________130
Table 13-16 XML: Import Line(s) from Single Line Settings _______________________________135
Table 14-3 VIP Counters__________________________________________________________138
Table 18-1 Binary to Hexadecimal Conversion Table____________________________________143
XPort Pro User Guide 12
1: About This Guide
This guide provides the information needed to configure, use, and update the XPort Pro™. It is
intended for software developers and system integrators who are embedding the XPort Pro in their
designs.
Chapter and Appendix Summaries
A summary of each chapter is provided below.
Chapter Description
Chapter 2: Introduction Main features of the product and the protocols it supports.
Includes technical specifications.
Chapter 3: Using DeviceInstaller Instructions for viewing the current configuration using
DeviceInstaller.
Chapter 4: Configuration Using Web Manager Instructions for accessing Web Manager and using it to
configure settings for the device.
Chapter 5: Network Settings Instructions for using the web interface to configure
Ethernet settings.
Chapter 6: Line and Tunnel Settings Instructions for using the web interface to configure line and
tunnel settings.
Chapter 7: Terminal and Host Settings Instructions for using the web interface to configure terminal
and host settings.
Chapter 8: Configurable Pin Manager Information about the Configurable Pin Manager (CPM) and
how to set the configurable pins to work with a device.
Chapter 9: Service Settings Instructions for using the web interface to configure settings
for DNS, SNMP, FTP, and other services.
Chapter 10: Security Settings Instructions for using the web interface to configure SSH
and SSL security settings.
Chapter 11: Modbus Instructions for using the web interface to configure
Modbus.
Chapter 12: Maintenance and Diagnostics Settings Instructions for using the web interface to maintain the
device, view statistics, files, and logs, and diagnose
problems.
Chapter 13: Advanced Settings Instructions for using the web interface to configure email,
CLI, and XML settings.
Chapter 14: VIP Settings Information about Virtual IP (VIP) features available on the
device and instructions for using the web interface to
configure the VIP settings.
Chapter 15: Branding the XPort Pro Instructions for customizing the device.
Chapter 16: Updating Firmware Instructions for obtaining the latest firmware and updating
the device.
Appendix - Technical Support Instructions for contacting Lantronix Technical Support.
Appendix - Binary to Hexadecimal Conversions Instructions for converting binary values to hexadecimals.
Appendix - Compliance Lantronix compliance information.
XPort Pro User Guide 13
1: About This Guide
Additional Documentation
Visit the Lantronix web site at www.lantronix.com/support/documentation for the latest
documentation and the following additional documentation.
Document Description
XPort Pro Integration Guide Information about the XPort Pro hardware, testing the XPort Pro
using the demonstration board, and integrating the XPort Pro into
your product.
XPort Pro
Command Reference
XPort Pro Universal Demo Board
Quick Start
XPort Pro Universal Demo Board
User Guide
DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to locate
Com Port Redirector
Quick Start and Online Help
Instructions for accessing Command Mode (the command line
interface) using a Telnet connection or through the serial port.
Detailed information about the commands. Also provides details
for XML configuration and status.
Instructions for getting the XPort Pro demonstration board up and
running.
Information for using the XPort Pro on the demo board.
the device and to view its current settings.
Instructions for using the Lantronix Windows-based utility to create
virtual com ports.
Secure Com Port Redirector
User Guide
Instructions for using the Lantronix Windows-based utility to create
secure virtual com ports.
XPort Pro User Guide 14
2: Introduction
The XPort Pro embedded Ethernet Device Server is a complete network-enabling solution in a
13.50 (0.531) X 16.25 (0.640) X 33.90 (1.335) package. This miniature device server empowers
original equipment manufacturers (OEMs) to go to market quickly and easily with Ethernet
networking and web page serving capabilities built into their products. [DIMS = mm (in.)]
This chapter contains the following sections:
Key Features
Applications
Evolution OS™
Additional Features
Configuration Methods
Addresses and Port Numbers
Product Information Label
Key Features
Power Supply: Regulated 3.3V input required. There is a step-down converter to 1.5 volts for
the processor core. All voltages have LC filtering to minimize noises and emissions.
Controller: A Lantronix DSTni-FX 32-bit microprocessor, running at 166 MHz internal bus and
83 MHz external bus.
Memory: 16 MB Flash and 8/16 MB SDRAM. Please contact your sales representative if you
need larger memory sizes.
Ethernet: 10/100 Mbps Ethernet transceiver
Serial Ports: RS232-supporting high-speed serial port with all hardware handshaking signals.
Baud rate is software selectable (300 bps to 921600 bps).
Note: The standard baud rate of 460800 bps is not supported for XPort Pro.
Configurable IO Pins (CPs): Up to three pins are configurable as general purpose I/Os if no
DTR or DCD is used on serial ports. Not 5V tolerant.
Interface Signals: 3.3V-level interface signals.
Temperature Range: Operates over an extended temperature range of -40°C to +85°C.
Applications
The XPort Pro device server connects serial devices such as those listed below to Ethernet
networks using the IP protocol family.
ATM machines
CNC controllers
Data collection devices
XPort Pro User Guide 15
2: Introduction
Universal Power Supply (UPS) management unit
Telecommunications equipment
Handheld instruments
Data display devices
Security alarms and access control devices
Modems
Time/attendance clocks and terminals
Protocol Support
The XPort Pro device server contains a full-featured TCP/IP stack. Supported protocols include:
ARP, IP, UDP, TCP, ICMP, BOOTP, DHCP, AutoIP, Telnet, DNS, FTP, TFTP, HTTP/HTTPS,
SSH, SSL/TLS, SNMP, SMTP, RSS, PPP and Syslog for network communications and
management.
TCP, UDP, TCP/AES, UDP/AES, Telnet, SSH and SSL/TLS for tunneling to the serial port.
TFTP, FTP, and HTTP for firmware upgrades and uploading files.
Evolution OS™
The XPort Pro incorporates The Lantronix Evolution OS™. Key features of the Evolution OS™
include:
Built-in Web server for configuration and troubleshooting from Web-based browsers
CLI configurability
SNMP management
XML data transport and configurability
Really Simple Syndication (RSS) information feeds
Enterprise-grade security with SSL and SSH
Comprehensive troubleshooting tools
Additional Features
Modem Emulation
In modem emulation mode, the XPort Pro can replace dial-up modems. The unit accepts modem
AT commands on the serial port, and then establishes a network connection to the end device,
leveraging network connections and bandwidth to eliminate dedicated modems and phone lines.
XPort Pro User Guide 16
2: Introduction
Web-Based Configuration and Troubleshooting
Built upon Internet-based standards, the XPort Pro enables you to configure, manage, and
troubleshoot through a browser-based interface accessible anytime from anywhere. All
configuration and troubleshooting options are launched from a web interface. You can access all
functions via a Web browser, for remote access. As a result, you decrease downtime (using the
troubleshooting tools) and implement configuration changes (using the configuration tools).
Command-Line Interface (CLI)
Making the edge-to-enterprise vision a reality, the XPort Pro with the Evolution OS™ uses
industry-standard tools for configuration, communication, and control. For example, the Evolution
OS™ uses a Command Line Interface (CLI) whose syntax is very similar to that used by data
center equipment such as routers and hubs.
VIP Access
Virtual IP Access is the Lantronix technology that solves the access-through-firewall problem. With
VIP Access, the XPort Pro can act as a ManageLinx DSC and provide direct access to your
equipment behind a firewall.
SNMP Management
The XPort Pro supports full SNMP management, making it ideal for applications where device
management and monitoring are critical. These features allow networks with SNMP capabilities to
correctly diagnose and monitor XPort Pro.
XML-Based Architecture and Device Control
XML is a fundamental building block for the future growth of M2M networks. The XPort Pro
supports XML-based configuration setup records that make device configuration transparent to
users and administrators. The XML is easily editable with a standard text or XML editor.
Really Simple Syndication (RSS)
The XPort Pro supports Really Simple Syndication (RSS) for streaming and managing on-line
content. RSS feeds all the configuration changes that occur on the device. An RSS aggregator
then reads (polls) the feed. More powerful than simple email alerts, RSS uses XML as an
underlying Web page transport and adds intelligence to the networked device, while not taxing
already overloaded email systems.
Enterprise-Grade Security
Evolution OS™ provides the XPort Pro the highest level of networking security possible. This ‘data
center grade’ protection ensures that each device on the M2M network carries the same level of
security as traditional IT networking equipment in the corporate data center.
By protecting the privacy of serial data transmitted across public networks, users can maintain
their existing investment in serial technology, while taking advantage of the highest data-protection
levels possible.
SSH and SSL are able to do the following:
Verify the data received came from the proper source
Validate that the data transferred from the source over the network has not changed when it
arrives at its destination (shared secret and hashing)
XPort Pro User Guide 17
2: Introduction
Encrypt data to protect it from prying eyes and nefarious individuals
Provide the ability to run popular M2M protocols over a secure SSH or SSL connection
In addition to keeping data safe and accessible, the XPort Pro has robust defenses to hostile
Internet attacks such as denial of service (DoS), which can be used to take down the network.
Moreover, the XPort Pro cannot be used to bring down other devices on the network.
You can use the XPort Pro with the Lantronix Secure Com Port Redirector (SCPR) to encrypt
COM port-based communications between PCs and virtually any electronic device. SCPR is a
Windows application that creates a secure communications path over a network between the
computer and serial-based devices that are traditionally controlled via a COM port. With SCPR
installed at each computer, computers that were formerly “hard-wired” by serial cabling for security
purposes or to accommodate applications that only understood serial data can instead
communicate over an Ethernet network or the Internet.
Terminal Server/Device Management
Remote offices can have routers, PBXs, servers and other networking equipment that require
remote management from the corporate facility. The XPort Pro easily attaches to the serial ports
on a server, Private Branch Exchange (PBX), or other networking equipment to deliver central,
remote monitoring and management capability.
Troubleshooting Capabilities
The XPort Pro offers a comprehensive diagnostic toolset that lets you troubleshoot problems
quickly and easily. Available from the Web Manager, CLI, and XML interfaces, the diagnostic tools
let you:
View critical hardware, memory, MIB-II, buffer pool, and IP socket information.
Perform ping and traceroute operations.
Conduct forward or backup DNS lookup operations.
View all processes currently running on the XPort Pro, including CPU utilization and total
stack space available.
Configuration Methods
After installation, the XPort Pro requires configuration. For the unit to operate correctly on a
network, it must have a unique IP address on the network. There are four basic methods for
logging into the XPort Pro and assigning IP addresses and other configurable settings:
DeviceInstaller: Configure the IP address and related settings and view current settings on the
XPort Pro using a Graphical User Interface (GUI) on a PC attached to a network. See Using
DeviceInstaller (on page 21).
Web Manager: Through a web browser, configure the XPort Pro settings using the Lantronix Web
Manager. See Configuration Using Web Manager (on page 23).
Command Mode: There are two methods for accessing Command Mode (CLI): making a Telnet
connection or connecting a terminal (or a PC running a terminal emulation program) to the unit’s
serial port. (See the XPort Pro Command Reference Guide for instructions and available
commands.)
XPort Pro User Guide 18
XML: The XPort Pro supports XML-based configuration and setup records that make device
configuration transparent to users and administrators. XML is easily editable with a standard text
or XML editor. (See the XPort Pro Command Reference Guide for instructions and commands.)
Addresses and Port Numbers
Hardware Address
The hardware address is also referred to as the Ethernet address or MAC address. The first three
bytes of the Ethernet address are fixed and read 00-20-4A, identifying the unit as a Lantronix
product. The fourth, fifth, and sixth bytes are unique numbers assigned to each unit.
Figure 2-1 Sample Hardware Address
00-20-4A-14-01-18 or 00:20:4A:14:01:18
IP Address
Every device connected to an IP network must have a unique IP address. This address references
the specific unit.
2: Introduction
Port Numbers
Every TCP connection and every UDP datagram is defined by a destination and source IP
address, and a destination and source port number. For example, a Telnet server commonly uses
port number 23.
The following is a list of the default server port numbers running on the XPort Pro:
TCP Port 22: SSH Server (Command Mode configuration)
TCP Port 23: Telnet Server (Command Mode configuration)
TCP Port 80: HTTP (Web Manager configuration)
TCP Port 443: HTTPS (Web Manager configuration)
UDP Port 161: SNMP
TCP Port 21: FTP
UDP Port 69: TFTP
UDP Port 30718: LDP (Lantronix Discovery Protocol) port
TCP/UDP Port 10001: Tunnel 1
Product Information Label
The product information label on the unit contains the following information about the specific unit:
Bar Code
Product ID (name)
Product Revision
XPort Pro User Guide 19
Part Number
Part Number
Product ID (name)
MAC Address
Revision
Hardware Address (MAC Address or Serial Number)
Figure 2-2 Product Label
2: Introduction
XPort Pro User Guide 20
3: Using DeviceInstaller
This chapter covers the steps for locating a device and viewing its properties and details.
DeviceInstaller is a free utility program provided by Lantronix that discovers, configures, upgrades
and manages Lantronix Device Servers. It can be downloaded from the Lantronix website at
www.lantronix.com/support/downloads.html
the IP addres, related settings or for more advanced features, see the DeviceInstaller online help.
Note: AutoIP generates a random IP address in the range of 169.254.0.1 to
169.254.255.254 if no BOOTP or DHCP server is found.
Accessing XPort Pro Using DeviceInstaller
Note: Make note of the MAC address. It is needed to locate the XPort Pro using
DeviceInstaller.
1. Click Start > All Programs > Lantronix > DeviceInstaller > DeviceInstaller.
When DeviceInstaller starts, it will perform a network device search. To perform another
search, click the “Search” button.
2. Expand the XPort Pro folder by clicking the + symbol next to the XPort Pro folder icon. The list
of available Lantronix XPort Pro devices appears.
. For instructions on using DeviceInstaller to configure
3. Select the XPort Pro unit by expanding its entry and clicking on its hardware (MAC) address to
view its configuration.
4. On the right page, click the Device Details tab. The current XPort Pro configuration appears.
This is only a subset of the full configuration; the complete configuration may be accessed via
Web Manager, CLI, or XML.
Device Details Summary
Note: The settings are Display Only in this table unless otherwise noted.
Current Settings Description
Name Name identifying the XPort Pro.
DHCP Device Name Shows the name associated with the XPort Pro’s current IP
Group Configurable field. Enter a group to categorize the XPort Pro.
Comments Configurable field. Enter comments for the XPort Pro. Double-click
Device Family Shows the XPort Pro device family type as “XPort”.
Type Shows the device type as “XPort Pro”.
address, if the IP address was obtained dynamically.
Double-click the field, type in the value, and press Enter to
complete. This group name is local to this PC and is not visible on
other PCs or laptops using DeviceInstaller.
the field, type in the value, and press Enter to complete. This
description or comment is local to this PC and is not visible on
other PCs or laptops using DeviceInstaller.
XPort Pro User Guide 21
3: Using DeviceInstaller
ID
Shows the
XPort Pro ID embedded within the unit.
Hardware Address Shows the XPort Pro hardware (MAC) address.
Firmware Version Shows the firmware currently installed on the XPort Pro.
Extended Firmware Version Provides additional information on the firmware version.
Online Status Shows the XPort Pro status as Online, Offline, Unreachable (the
XPort Pro is on a different subnet), or Busy (the XPort Pro is
currently performing a task).
IP Address Shows the XPort Pro current IP address. To change the IP
address, click the Assign IP button on the DeviceInstaller menu
bar.
IP Address was Obtained Displays “Dynamically” if the XPort Pro automatically received an
IP address (e.g., from DHCP). Displays “Statically” if the IP
address was configured manually.
If the IP address was assigned dynamically, the following fields
appear:
Obtain via DHCP with values of True or False.
Obtain via BOOTP with values of True or False.
Subnet Mask Shows the subnet mask specifying the network segment on which
the XPort Pro resides.
Gateway Shows the IP address of the router of this network. There is no
default.
Number of Ports Shows the number of serial ports on this XPort Pro.
Supports Configurable Pins Shows True, indicating configurable pins are available on the
XPort Pro.
Supports Email Triggers Shows True, indicating email triggers are available on the XPort
Pro.
Telnet Enabled Indicates whether Telnet is enabled on this XPort Pro.
Telnet Port Shows the XPort Pro port for Telnet sessions.
Web Enabled Indicates whether Web Manager access is enabled on this XPort
Pro.
Web Port Shows the XPort Pro port for Web Manager configuration.
Firmware Upgradable Shows True, indicating the XPort Pro firmware is upgradable as
newer versions become available.
XPort Pro User Guide 22
4: Configuration Using Web Manager
This chapter describes how to configure the XPort Pro using Web Manager, the Lantronix
browser-based configuration tool. The unit’s configuration is stored in nonvolatile memory and is
retained without power. All changes take effect immediately, unless otherwise noted. It contains
the following sections:
Accessing Web Manager
Web Manager Page Components
Navigating the Web Manager
Table 4-3 Summary of Web Manager Pages
Accessing Web Manager
Note: You can also access the Web Manager by selecting the Web Configuration tab on
the DeviceInstaller window.
To access Web Manager, perform the following steps:
1. Open a standard web browser. Lantronix supports the latest version of Internet Explorer,
Mozilla Suite, Mozilla Firefox, Safari, Chrome or Opera.
2. Enter the IP address of the XPort Pro in the address bar. The IP address may have been
assigned manually using DeviceInstaller (see the XPort Pro Quick Start Guide) or
automatically by DHCP.
3. Enter your username and password.The factory-default username is “admin” and the factory-
default password is “PASS.” The Device Status web page shown in Figure 4-1 displays
configuration, network settings, line settings, tunneling settings, and product information.
Note: The Logout button is available on any web page. Logging out of the web page
would force re-authentication to take place the next time the web page is accessed.
XPort Pro User Guide 23
4: Configuration Using Web Manager
Device Status Page
The Device Status page is the first page that appears after you log into the Web Manager. It also
appears when you click Status in the Main Menu.
Figure 4-1 Web Manager Home Page
XPort Pro User Guide 24
Web Manager Page Components
Menu Bar
Links to
subpages
Items to
configure
Information
and Help Area
Header
Configuration
and/or
Status Area
Footer
Logout
button
The layout of a typical Web Manager page is below.
Figure 4-2 Components of the Web Manager Page
4: Configuration Using Web Manager
The menu bar always appears at the left side of the page, regardless of the page shown. The
menu bar lists the names of the pages available in the Web Manager. To bring up a page, click it in
the menu bar.
The main area of the page has these additional sections:
At the very top, many pages, such as the one in the example above, enable you to link to
sub pages. On some pages, you must also select the item you are configuring, such as a
line or a tunnel.
XPort Pro User Guide 25
In the middle of many pages, you can select or enter new configuration settings. Some
pages show status or statistics in this area rather than allow you to enter settings.
At the bottom of most pages, the current configuration is displayed. In some cases, you
can reset or clear a setting.
The information or help area shows information or instructions associated with the page.
A Logout link is available at the upper right corner of every web page. In Chrome or
Safari, it is necessary to close out of the browser to logout. If necessary, reopen the
browser to log back in.
The footer appears at the very bottom of the page. It contains copyright information and a
link to the Lantronix home page.
Navigating the Web Manager
The Web Manager provides an intuitive point-and-click interface. A menu bar on the left side of
each page provides links you can click to navigate from one page to another. Some pages are
read-only, while others let you change configuration settings.
Note: There may be times when you must reboot the XPort Pro for the new
configuration settings to take effect. The chapters that follow indicate when a change
requires a reboot.
4: Configuration Using Web Manager
Table 4-3 Summary of Web Manager Pages
Web Manager
Page
Status Shows product information and network, line, and tunneling
CLI Shows Command Line Interface (CLI) statistics and lets you
CPM Shows information about the Configurable Pins Manager (CPM)
Diagnostics Lets you perform various diagnostic procedures. 110
DNS Shows the current configuration of the DNS subsystem and the
Email Shows email statistics and lets you clear the email log, configure
Filesystem Shows file system statistics and lets you browse the file system to
FTP Shows statistics and lets you change the current configuration for
Host Lets you view and change settings for a host on the network. 58
Description See
Page
32
settings.
125
change the current CLI configuration settings.
59
and how to set the configurable pins and pin groups to work with a
device.
66
DNS cache.
122
email settings, and send an email.
99
view a file, create a file or directory, upload files using HTTP, copy
a file, move a file, or perform TFTP actions.
70
the File Transfer Protocol (FTP) server.
HTTP Shows HyperText Transfer Protocol (HTTP) statistics and lets you
change the current configuration and authentication settings.
73
XPort Pro User Guide 26
4: Configuration Using Web Manager
Web Manager Page
(continued)
IP Address Filter Lets you specify all the IP addresses and subnets that are allowed
Line Shows statistics and lets you change the current configuration and
LPD Shows LPD (Line Printer Daemon) Queue statistics and lets you
Modbus Shows the current connection status of the Modbus servers
Network Shows status and lets you configure the network interface. 28
PPP Lets you configure a network link using Point-to-Point Protocol
Protocol Stack Lets you perform lower level network stack-specific activities. 103
Query Port Lets you change configuration settings for the query port. 109
RSS Lets you change current Really Simple Syndication (RSS)
SNMP Lets you change the current Simple Network Management
SSH Lets you change the configuration settings for SSH server host
SSL Lets you upload an existing certificate or create a new self-signed
Syslog Lets you specify the severity of events to log and the server and
System Lets you reboot device, restore factory defaults, upload new
Terminal Lets you change current settings for a terminal. 55
Description See
Page
108
to send data to this device.
32
Command mode settings of a serial line.
78
configure the LPD and print a test page.
94
listening on the TCP ports and lets you configure the Modbus
settings.
67
(PPP) over a serial line.
77
settings.
69
Protocol (SNMP) configuration settings.
81
keys, SSH server authorized users, SSH client known hosts, and
SSH client users.
88
certificate.
72
ports to which the syslog should be sent.
120
firmware, and change the device long and short names.
TFTP Shows statistics and lets you change the current configuration for
the Trivial File Transfer Protocol (TFTP) server.
Tunnel Lets you change the current configuration settings for a tunnel. 36
VIP Lets you configure Virtual IP addresses to be used in Tunnel
Accept Mode and Tunnel Connect Mode.
XML Lets you export XML configuration and status records, and import
XML configuration records.
71
136
127
XPort Pro User Guide 27
5: Network Settings
This chapter describes how to access, view, and configure network settings from the Network web
page. The Network web page contains sub-menus that enable you to view and configure the
Ethernet network interface and link.
This chapter contains the following sections:
Network 1 (eth0) Interface Status
Network 1 (eth0) Interface Configuration
Network 1 Ethernet Link
Network 1 (eth0) Interface Status
This page shows the status of the Ethernet network interface.
To view the network interface status:
1. Click Network on the menu.
2. Then click Network 1, Interface, and Status at the top of the page. The Network 1 (eth0)
Interface Status page appears.
Figure 5-1 Network 1 (eth0) Interface Status
XPort Pro User Guide 28
Network 1 (eth0) Interface Configuration
This page shows the configuration settings for the Ethernet connection and lets you change these
settings.
To view and configure network interface settings:
1. Click Network 1 > Interface > Configuration at the top of the page. The Network 1 (eth0)
Interface Configuration page appears.
Figure 5-2 Network 1 (eth0) Interface Configuration
5: Network Settings
2. Enter or modify the following settings:
Table 5-3 Network 1 (eth0) Interface Configuration
Network 1 Interface
Configuration
Settings
BOOTP Client Select On or Off. At boot up, the device will attempt to obtain an IP address from a
Description
BOOTP server.
Notes:
Overrides the configured IP address, network mask, gateway, hostname, an d
domain.
When DHCP is On, the system automatically uses DHCP, regardless of whether
BOOTP Client is On.
XPort Pro User Guide 29
5: Network Settings
Network 1 Interface
Description
Configuration
Settings
DHCP Client Select On or Off. At boot up, the device will attempt to lease an IP address from a
DHCP server and maintain the lease at regular intervals.
Note: Overrides BOOTP, the configured IP address, network mask, gateway,
hostname, and domain.
IP Address Enter the device static IP address.
You may enter it alone, in CIDR format, or with an explicit mask.
The IP address consists of four octets separated by a period and is used if BOOTP
and DHCP are both set to Off. Changing this value requires you to reboot the device.
Note: When DHCP is enabled, the device tries to obtain an IP address from DHCP. If
it cannot, the device uses an AutoIP address in the range of 169.254.xxx.xxx.
Default Gateway Enter the IP address of the router for this network. Or, clear the field (appears as
<None>). This address is only used for static IP address configuration.
Hostname Enter the device hostname. It must begin with a letter, continue with a sequence of
letters, numbers, and/or hyphens, and end with a letter or number.
Domain Enter the device domain name.
DHCP Client ID Enter the ID if the DHCP server uses a DHCP ID. The DHCP server’s lease table
shows IP addresses and MAC addresses for devices. The lease table shows the
Client ID, in hexadecimal notation, instead of the device MAC address.
Primary DNS IP address of the primary name server. This entry is required if you choose to
configure DNS (Domain Name Server) servers.
Secondary DNS IP address of the secondary name server.
MTU When DHCP is enabled, the MTU size is (usually) provided with the IP address. When
not provided by the DHCP server, or using a static configuration, this value is used.
The MTU size can be from 576 to 1500 bytes.
3. Click Submit to save changes. Some changes to the following settings require a reboot for the
changes to take effect:
BOOTP Client
DHCP Client
IP Address
DHCP Client ID
Note: If DHCP or BOOTP fails, AutoIP intervenes and assigns an addre ss.A new DHCP
negotiation is attempted every 5 minutes to obtain a new IP address. When the DHCP is
enabled, any configured static IP address is ignored.
XPort Pro User Guide 30
Network 1 Ethernet Link
This page shows the current negotiated Ethernet settings and lets you change the speed and
duplex settings.
To view and configure the Ethernet link:
1. Click Network on the menu bar and then click Network 1 > Link at the top of the page. The
Network 1 (eth0) Ethernet Link page appears.
If coming from another Network page, click Network 1 > Link at the top of the page.
5: Network Settings
Figure 5-4 Network 1 Ethernet Link
The Status table shows the current negotiated settings. The Configuration table shows the
current range of allowed settings.
2. Enter or modify the following settings:
Table 5-5 Network 1 Ethernet Link
Network 1-Ethernet Link
Settings
Speed Select the Ethernet link speed. Default is Auto.
Duplex Select the Ethernet link duplex mode. Default is Auto.
Description
3. Click Submit. The changes take effect immediately.
Note: The following section describes the steps to view and configure Line 1 settings;
these steps apply to other line instances of the device.
XPort Pro User Guide 31
6: Line and Tunnel Settings
Note: The number of lines and tunnels
available for viewing and configuration differ
between Lantronix DeviceLinx products. The
screenshots in this manual represent one line
and tunnel, as available, for example, on an
XPort Pro and EDS1100. However, other
device networking products (such as EDS2100,
EDS4100, XPort AR, and EDS8/16/32PR)
support additional lines and tunnels.
This chapter describes how to view and
configure lines and tunnels. It contains the
following sections:
Line Settings
Tunnel Settings
Line Settings
You can view statistics and configure the serial interfaces (referred to as lines) by using the Line
web page. When you click Line from the Main Menu, Line 1 fields display.
The following sub-menus can be used:
Line Statistics—Displays statistics for the serial lines. For example, the bytes received and
transmitted, breaks, flow control, parity errors, etc.
Line Configuration—Enables the change of the name, interface, protocol, baud rates, and
parity, etc.
Line Command Mode—Enables the types of modes, wait time, serial strings, signon
message, etc.
The following sections describe the steps to view and configure Line 1 settings. These instructions
also apply to additional line menu options.
Figure 6-1 Line 1 Statistics
Line Statistics
This read-only web page
shows the status and
statistics for the serial line
selected at the top of this
page.
1. Select Line on the menu
bar. The Line Statistics
page appears.
XPort Pro User Guide 32
6: Line and Tunnel Settings
Line Configuration
This page shows the configuration settings for the serial line selected at the top of the page and
lets you change the settings for that serial line.
To configure Line 1:
1. Click Line 1 > Configuration at the top of the page. The Line 1 Configuration page appears.
Table 6-2 Line 1 Configuration
2. Enter or modify the following settings:
Table 6-3 Line 1 Configuration
Line - Configuration
Settings
Name If the Terminal Login Menu feature is being used, enter the name for the
Interface Select the interface type from the drop-down menu. The default is RS232.
State Indicates whether the current line is enabled. To change the status, select
Protocol Select the protocol from the drop-down menu. The default is Tunnel.
Baud Rate Select the baud rate from the drop-down menu. The default is 9600.
Description
line. Leaving this field blank will disable this line from appearing in the
Terminal Login Menu. The default Name is blank. See Terminal and Host
Settings on page 55 for related configuration information.
Enabled or Disabled from the drop-down menu.
XPort Pro User Guide 33
6: Line and Tunnel Settings
Line - Configuration
Settings (continued)
Parity Select the parity from the drop-down menu. The default is None.
Data Bits Select the number of data bits from the drop-down menu. The default is 8.
Stop Bits Select the number of stop bits from the drop-down menu. The default is 1.
Flow Control Select the flow control from the drop-down menu. The default is None.
Xon Char Specify the character to use to start the flow of data when Flow Control is
Xoff Char Specify the character to use to stop the flow of data when Flow Control is
Gap Timer The driver forwards received serial bytes after the Gap Timer delay from
Threshold The driver will also forward received characters after Threshold bytes have
Description
set to Software. Prefix a decimal character with \ or a hexadecimal
character with 0x, or provide a single printable character. The default Xon
char is 0x11.
set to Software. Prefix a decimal character with \ or a hexadecimal
character with 0x, or provide a single printable character. The default Xoff
char is 0x13.
the last character received. By default, the delay is four character periods at
the current baud rate (minimum 1 ms).
been received.
3. Click Submit.
4. Repeat above steps as desired, according to additional line(s) available for your product.
XPort Pro User Guide 34
6: Line and Tunnel Settings
Note: The CP Group option
displayed in the screenshot is
only supported in XPort Pro
and XPort AR.
Line Command Mode
Setting Command Mode
enables the CLI on the serial
line.
To configure Line 1
Command Mode:
1. Click Line 1 > Command
Mode at the top of the
page. The Line 1
Command Mode page
appears.
Figure 6-4 Line 1 Command Mode
2. Enter or modify the following settings:
Table 6-5 Line 1 Command Mode
Line – Command Mode
Settings
Mode Select the method of enabling Command Mode or choose to disable
Wait Time Enter the wait time for the serial string during boot-up in milliseconds.
Description
Command Mode.
Always = immediately enables Command Mode for the serial line.
Use Serial String = enables Command Mode when the serial string is
read on the serial line during boot time.
Use CP Group = enables Command Mode based on the status of a CP
Group. When the value matches the current value of the group,
Command Mode is enabled on the serial line.
Use both Serial String and CP Group = the serial string and the value of
the CP group must be matched to enable Command Mode.
Disabled = turns off Command Mode.
XPort Pro User Guide 35
6: Line and Tunnel Settings
Line – Command Mode
Settings (continued)
Serial String Enter the serial string characters. Select a string type.
Echo Serial String Select Yes to enable echoing of the serial string at boot-up.
CP Group Enter the name and decimal value of the CP Group. When the value
Signon Message Enter the boot-up signon message. Select a string type.
Description
Text = string of bytes that must be read on the Serial Line during boot
time to enable Command Mode. It may contain a time element in x
milliseconds, in the format {x}, to specify a required delay.
Binary = string of characters representing byte values where each
hexadecimal byte value starts with \0x and each decimal byte value starts
with \.
matches the current value of the group, Command Mode is enabled on the
Serial Line.
Text = string of bytes sent on the serial line during boot time.
Binary = one or more byte values separated by commas. Each byte value
may be decimal or hexadecimal. Start hexadecimal values with 0x.
Note: This string will be output on the serial port at boot, regardless of
whether command mode is enabled or not.
3. Click Submit.
Tunnel Settings
Note: The number of lines and tunnels available for viewing and configuration differ
between Lantronix DeviceLinx products. The screenshots in this manual represent one
line and tunnel, as available, for example, on an XPort Pro and EDS1100. However, other
device networking products (such as EDS2100, EDS4100, XPort AR, and EDS8/16/
32PR) support additional lines and tunnels.
Tunneling allows serial devices to communicate over a network, without “being aware” of the
devices which establish the network connection between them. Tunneling parameters are
configured using the Web Manager or Command Mode Tunnel Menu. See Configuration Using
Web Manager (on page 23) or the XPort Pro Command Reference for the full list of commands.
The XPort Pro supports two tunneling connections simultaneously per serial port. One of these
connections is Connect Mode; the other connection is Accept Mode. The connections on one
serial port are separate from those on another serial port.
Connect Mode: the XPort Pro actively makes a connection. The receiving node on the
network must listen for the Connect Mode’s connection. Connect Mode is disabled by default.
Accept Mode: the XPort Pro listens for a connection. A node on the network initiates the
connection. Accept Mode is enabled by default.
Disconnect Mode: this mode defines how an open connection stops the forwarding of data.
The specific parameters to stop the connection are configurable. Once the XPort Pro
Disconnect Mode observes the defined event occur, it will disconnect both Accept Mode and
Connect Mode connections on that port.
When any character comes in through the serial port, it gets copied to both the Connect Mode
connection and the Accept Mode connection (if both are active).
XPort Pro User Guide 36
6: Line and Tunnel Settings
You can view statistics and configure two tunnels by using the Tunnel web page. When you click
Tunnel from the Main Menu, Tunnel 1 fields display. To go to Tunnel 2, click the Tunnel 2 button.
There are six sub-menus listed at the top of the Tunnel web page that you can use as follows:
Tunnel – Statistics
Tunnel – Serial Settings
Tunnel – Packing Mode
Tunnel – Accept Mode
Tunnel – Connect Mode
Tunnel – Disconnect Mode
Tunnel – Modem Emulation
Tunnel – Statistics
Displays statistics for the available lines. For example, Completed Accepts, Completed Connects,
Disconnects, Dropped Accepts, Dropped Connects, etc. The XPort Pro logs statistics for
tunneling. The Dropped statistic shows connections ended by the remote location. The
Disconnects statistic shows connections ended by the XPort Pro.
To display the tunnel statistics, perform the following steps.
1. Click Tunnel on the menu bar. The Statistics page for Tunnel 1 appears.
XPort Pro User Guide 37
Figure 6-6 Tunnel 1 Statistics
6: Line and Tunnel Settings
XPort Pro User Guide 38
6: Line and Tunnel Settings
Tunnel – Serial Settings
Serial line settings are configurable for the corresponding serial line of the selected tunnel.
Configure the buffer size to change the maximum amount of data the serial port stores. For any
active connection, the device sends the data in the buffer.
The modem control signal DTR on the Line may be continuously asserted or asserted only while
either an Accept Mode tunnel or a Connect Mode tunnel is connected.
To configure serial settings:
1. Click Tunnel > Serial Settings at the top of the page. The Tunnel 1 Serial Settings page
appears.
Figure 6-7 Tunnel 1 Serial Settings
2. View or modify the following settings:
Tunnel - Serial
Settings
Line Settings
(display only)
Protocol
(display only)
DTR Select when to assert DTR.
Description
Current serial settings for the line.
The protocol being used on the line. In this case, Tunnel.
Unasserted = never asserted
TruPort = asserted whenever either a connect or an accept
mode tunnel connection is active with the Telnet Protocol
RFC2217 saying that the remote DSR is asserted.
Asserted while connected = asserted whenever either a
connect or an accept mode tunnel connection is active.
Continuously asserted = asserted regardless of the status
of a tunnel connection.
3. Click Submit.
XPort Pro User Guide 39
6: Line and Tunnel Settings
Tunnel – Packing Mode
Packing Mode takes data from the serial port, packs it together, and sends it over the network.
Packing can be configured based on threshold (size in bytes, timeout (milliseconds), or a single
character.
Size is set by modifying the threshold field. When the number of bytes reaches the threshold, a
packet is sent immediately.
The timeout field is used to force a packet to be sent after a maximum time. The packet is sent
even if the threshold value is not reached.
When Send Character is configured, a single printable character or control character read on the
Serial Line forces the packet to be sent immediately. There is an optional trailing character
parameter which can be specified. It can be a single printable character or a control character.
To configure the Tunnel Packing Mode:
1. Select Tunnel > Packing Mode at the top of the page. The Tunnel 1 Packing Mode page
appears. Depending on the Mode selection, different configurable parameters are presented
to the user. The following figures show the display for each of the three packing modes.
Figure 6-8 Tunnel 1 Packing Mode (Mode = Disable)
XPort Pro User Guide 40
6: Line and Tunnel Settings
Figure 6-9 Tunnel 1 Packing Mode (Mode = Timeout)
Figure 6-10 Tunnel 1 Packing Mode (Mode = Send Character)
2. Enter or modify the following settings:
Table 6-11 Tunnel Packing Mode
Tunnel - Packing Mode
Description
Settings
Mode
Select Disable to disable Packing Mode completely.
Select Timeout to send data after the specified time has
elapsed.
Select Send Character to send the queued data when the send
character is received.
XPort Pro User Guide 41
6: Line and Tunnel Settings
Tunnel - Packing Mode
Settings (continued)
Threshold
(Appears for both Timeout
and Send Character
Modes)
Timeout
(Appears for Timeout
Mode)
Send Character
(Appears for Send
Character Mode)
Trailing Character
(Appears for Send
Character Mode)
3. Click Submit.
Description
Send the queued data when the number of queued bytes reaches
the threshold. When the buffer fills to this specified amount of data
in bytes (and the timeout has not elapsed), the device packs the
data and sends it out; applies only if the Packing Mode is not
Disabled.
Enter a time, in milliseconds, for the device to send the queued
data after the first character was received. Specifies the time
duration in milliseconds; applies only if the Packing Mode is
Timeout.
Enter the send character (single printable or control). Upon
receiving this character, the device sends out the queued data.
The data is packed until the specified send character is
encountered. Similar to a start or stop character, the device packs
the data until it sees the send character. The device then sends the
packed data and the send character in the packet. Applies only if
the Packing Mode is Send Character.
Enter the trailing character (single printable or control). This
character is sent immediately following the send character. This is
an optional setting. If a trailing character is defined, this character is
appended to data put on the network immediately following the
send character.
XPort Pro User Guide 42
6: Line and Tunnel Settings
Tunnel – Accept Mode
Controls how a tunnel behaves when a connection attempt originates from the network. In Accept
Mode, the XPort Pro waits for a connection from the network. The configurable local port is the
port the remote device connects to for this connection. There is no remote port or address. The
default local port is 10001 for serial port 1 and increases sequentially for each additional serial
port, if supported.
Accept Mode supports the following protocols:
SSH (the XPort Pro is the server in Accept Mode). When using this protocol, the SSH
server host keys and at least one SSH authorized user must be configured.
SSL
TCP
AES encryption over TCP
Telnet (The XPort Pro supports IAC codes. It drops the IAC codes when Telnetting and
does not forward them to the serial port).
Accept Mode has the following states:
Disabled (never a connection)
Enabled (always listening for a connection)
Active if it receives any character from the serial port
Active if it receives a specific (configurable) character from the serial port (same start
character as Connect Mode’s start character)
Modem control signal
Modem emulation
To configure the tunnel’s Accept Mode:
1. Click Tunnel > Accept Mode at the top of the page. The Tunnel 1 Accept Mode page
appears.
Note: The CP Output option displayed in the screenshot is only supported in XPort Pro
and XPort AR.
XPort Pro User Guide 43
Figure 6-12 Tunnel 1 Accept Mode
6: Line and Tunnel Settings
2. Enter or modify the following settings:
Table 6-13 Tunnel Accept Mode
Tunnel - Accept Mode
Settings
Mode Select the method used to start a tunnel in Accept mode. Choices are:
Local Port Enter the port number for use as the local port. The defaults are port 10001 for
Protocol Select the protocol type for use with Accept Mode. The default protocol is TCP. If
TCP Keep Alive Enter the time, in seconds, the device waits during a silent connection before
Description
Disabled = do not accept an incoming connection.
Always = accept an incoming connection (default)
Any Character = start waiting for an incoming connection when any
character is read on the serial line.
Start Character = start waiting for an incoming connection when the start
character for the selected tunnel is read on the serial line.
Modem Control Asserted = start waiting for an incoming connection as long
as the Modem Control pin (DSR) is asserted on the serial line until a
connection is made.
Modem Emulation = start waiting for an incoming connection when triggered
by modem emulation AT commands. Connect mode must also be set to
Modem Emulation.
Tunnel 1. Additional tunnels, if supported, increase sequentially.
you select TCP AES you will need to configure the AES keys.
checking if the currently connected network device is still on the network. If the
unit then gets no response after 8 attempts, it drops that connection.
XPort Pro User Guide 44
6: Line and Tunnel Settings
Tunnel - Accept Mode
Settings (continued)
Flush Serial Data Select Enabled to flush the serial data buffer on a new connection.
Block Serial Data
Block Network
Password Enter a password that clients must send to the device within 30 seconds from
Email on Connect Select whether the device sends an email when a connection is made. Select
Email on Disconnect Select whether the device sends an email when a connection is closed. Select
CP Output Identifies a CP or CP Group whose value should change when a connection is
Description
Select On to block, or not tunnel, serial data transmitted to the
Select On to block, or not tunnel, network data transmitted to the
opening a network connection to enable data transmission.
The password can have up to 31 characters and must contain only alphanumeric
characters and punctuation. When set, the password sent to the device must be
terminated with one of the following: (a) 0x0A (LF), (b) 0x00, (c) 0x0D 0x0A (CR
LF), or (d) 0x0D 0x00.
None if you do not want to send an email. Otherwise, select the Email profile to
use for sending.
None if you do not want to send an email. Otherwise, select the Email profile to
use for sending.
established and dropped.
Connection value—Specifies the value to set the CP Group to when a
connection is established.
Disconnection value—Specifies the value to set the CP Group to when the
connection is closed.
device.
device.
3. Click Submit.
4. Repeat these steps to configure additional tunnels as applicable.
XPort Pro User Guide 45
6: Line and Tunnel Settings
Note: While in the “Any Character” or “Start
Character” connection modes, the XPort Pro
waits and retries the connection if the
connection cannot be made. Once it makes
a connection and then disconnects, it will
not reconnect until it sees another character
or the start character again (depending on
the configured setting).
Tunnel – Connect Mode
Connect Mode defines how the device makes an outgoing connection. When enabled, Connect
Mode is always on and attempting a network connection if the connection mode condition warrants
it. For Connect Mode to function, it must:
Be enabled
Have a remote host configured
Have a remote port is configured
Enter the remote host address as an IP address or DNS name. The XPort Pro device will make a
connection only if it can resolve the address. For DNS names, the XPort Pro will re-evaluate the
address after being established for 4 hours. If re-evaluation results in a different address, it will
close the connection.
Connect Mode supports the following protocols:
TCP
AES encryption over TCP and UDP
When setting AES encryption, both the encrypt key and the decrypt key must be specified.
The encrypt key is used for data sent out. The decrypt key is used for receiving data. Both of
the keys may be set to the same value.
SSH
To configure SSH, the SSH client username must be configured. In Connect Mode, the XPort
Pro is the SSH client. Ensure the XPort Pro SSH client username is configured on the remote
SSH server before using it with the XPort Pro.
SSL
UDP
Is only available in Connect Mode because it is a connectionless protocol. For Connect Mode
using UDP, the XPort Pro accepts packets from any device on the network. It will send
packets to the last device that sent it packets.
Telnet
Note: The Local Port in Connect Mode is independent of the port configured in Accept
Mode.
There are six different connect modes:
Disable
No connection is attempted.
Always
A connection is always attempted.
Any Character
A connection is attempted if it detects any
character from the serial port.
Start Character
XPort Pro User Guide 46
A connection is attempted if it detects a specific and configurable character from the serial
port.
6: Line and Tunnel Settings
Modem Control Asserted
A connection is attempted when the modem control pin is asserted in the serial line.
Modem Emulation
A connection is attempted by an ATD command.
To configure Tunnel 1 Connect Mode:
1. Select Tunnel > Connect Mode at the top of the page. The Tunnel 1 Connect Mode page
appears.
Note: The CP Output option displayed in the screenshot is only supported in XPort Pro
and XPort AR.
Figure 6-14 Tunnel 1 Connect Mode
XPort Pro User Guide 47
2. Enter or modify the following settings:
Table 6-15 Tunnel Connect Mode
6: Line and Tunnel Settings
Tunnel – Connect Mode
Description
Settings
Mode Select the method to be used to attempt a connection to a remote host or
device. Choices are:
Always = a connection is attempted until one is made. If the connection gets
disconnected, the XPort Pro retries until it makes a connection. (default)
Disable = an outgoing connection is never attempted.
Any Character = a connection is attempted when any character is read on
the serial line.
Start Character = a connection is attempted when the start character for the
selected tunnel is read on the serial line.
Modem Control Asserted = a connection is attempted as long as the
Modem Control pin (DSR) is asserted, until a connection is made.
Modem Emulation = a connection is attempted when triggered by modem
emulation AT commands.
Local Port Enter the port for use as the local port. A random port is selected by default.
Once you have configured a number, click the Random link in the Current
Configuration to switch back to random.
Host
Click <None> in the Host field to configure the Host parameters.
VIP = Enabling the VIP directs the tunnel to connect to a remote Lantronix
Virtual IP identified by the VIP Name. When VIP is enabled, the Host 2 field
displays. Default is Disabled.
VIP Name = Displays configured VIP name, used only if VIP is enabled.
Address = Enter the remote Host Address as an IP address or DNS name. It
designates the address of the remote host to connect to. Displays configured
IP address or DNS address, used only if VIP is disabled.
Port = Enter the port for use as the Host Port. It designates the port on the
remote host to connect to. Displays configured Port.
Protocol = Select the protocol type for use with Connect Mode. The default
protocol is TCP. Additional fields may need to be completed depending on
protocol chosen for the host.:
For SSH, also enter an SSH Username.
For SSL, there are no additional fields to complete.
Note: If security is a
concern, it is highly
recommended that SSH
be used. When using SSH,
both the SSH Server Host
Keys and SSH Server
Authorized Users must be
configured.
For TCP, TCP AES and Telnet, use the TCP Keep Alive field to adjust
the value.
For TCP AES, enter the AES Encrypt and AES Decrypt Keys. Both of
keys may be set to the same value.
For UDP, there are no additional fields to complete. In this mode, the
device accepts packets from any device on the network and sends
packets to the last device that sent it packets.
For UDP AES, enter the AES Encrypt and AES Decrypt Keys.
SSH Username = Displays configured username, used only if SSH protocol
is selected.
TCP Keep Alive = Default is 45000 milliseconds. Enter zero to disable and
blank the value to restore the default.
AES Encrypt/Decrypt Key = Displays presence of key, used only if protocol
with AES is selected.
XPort Pro User Guide 48
6: Line and Tunnel Settings
Tunnel – Connect Mode
Description
Settings (continued)
Reconnect Timer Enter the reconnect time in milliseconds. The device attempts to reconnect after
this amount of time after failing a connection or exiting an existing connection.
This behavior depends upon the Disconnect Mode.
Note:
When you configure Tunnel - Connect Mode, you can specify a number
of milliseconds to attempt to reconnect after a dropped connection has
occurred. The default is 1500 milliseconds.
The Reconnect Timer only applies if a Disconnect Mode is configured.
With a Disconnect Mode set, the device server maintains a connection
until the disconnect mode condition is met (at which time the device server
closes the connection). If the tunnel is dropped due to conditions beyond
the device server, the device server attempts to re-establish a failed
connection when the specified reconnect interval reaches its limit.
Any network-side disconnect is considered an error and a reconnect is
attempted without regard to the Connect Mode settings. Simultaneous
Connect Mode connections require some Disconnect Mode
configurations or the connections will never terminate. See Tunnel –
Disconnect Mode on page 51 for more information about the parameters.
If Disconnect Mode is disabled and the network connection is dropped,
then the re-establishment of a tunnel connection is governed by the
configured Connect Mode settings.
Flush Serial Data Select whether to flush the serial line when a connection is made. Choices are:
Enabled = flush the serial line when a connection is made.
Disabled = do not flush the serial line. (default)
Block Serial Select Enabled to block (not tunnel) serial data transmitted to the device. This
is a debugging tool that causes serial data sent to the device to be ignored.
Block Network Select Enabled to block (not tunnel) network data transmitted to the device.
This is a debugging tool that causes network data sent to the device to be
ignored.
Email on Connect Select whether the device sends an email when a connection is made. Select
None if you do not want to send an email. Otherwise, select the Email profile to
use.
Email on Disconnect Select whether the device sends an email when a connection is closed. Select
None if you do not want to send an email. Otherwise, select the Email profile to
use.
CP Output Identifies a CP or CP Group whose value should change when a connection is
established and when it is dropped.
Connection value—Specifies the value to set the CP Group to when a
connection is established.
Disconnection value—Specifies the value to set the CP Group to when the
connection is closed.
3. Click Submit. The host is configured. A second host appears underneath the newly
configured host.
4. Repeat these steps to configure additional hosts as necessary. XPort Pro supports
configuration of up to sixteen hosts.
XPort Pro User Guide 49
Connecting Multiple Hosts
Figure 6-16 Host 1, Host 2, Host 3 Exchanged
Note: The CP Output option displayed in the
screenshot is only supported in XPort Pro and XPort AR.
If more than one host is
configured, a Host Mode option
appears. Host Mode controls
how multiple hosts will be
accessed. For XPort Pro, the
Connect Mode supports up to
sixteen Hosts. Hosts may be
accessed sequentially or
simultaneously:
Sequential – Sequential
host lists establish a
prioritized list of tunnels. The
host specified as Host 1 will
be attempted first. If that
fails, it will proceed to Host
2, 3, etc, in the order they
are specified. When a
connection drops, the cycle
starts again with Host 1 and
proceeds in order.
Establishing the host order
is accomplished with host
list promotion (see Host List
Promotion on page 50).
Sequential is the default
Host Mode.
6: Line and Tunnel Settings
Simultaneous – A tunnel
will connect to all hosts
accepting a connection.
Simultaneous connections
occur at the same time to all
listed hosts. The device can
support a maximum of 64
total aggregate connections.
Host List Promotion
This feature allows Host IP promotion of individual hosts in the overall sequence.
To promote a specific Host:
1. Click the icon in the desired Host field, for example Host 2 and Host 3.
2. The selected Host(s) exchanges its place with the Host above it.
3. Click Submit. The hosts change sequence.
XPort Pro User Guide 50
6: Line and Tunnel Settings
Tunnel – Disconnect Mode
Relates to the disconnect of a tunnel. Disconnect Mode ends Accept Mode and Connect Mode
connections. When disconnecting, the XPort Pro shuts down connections gracefully.
The following settings end a connection:
The XPort Pro receives the stop character.
The timeout period has elapsed and no activity is going in or out of the XPort Pro. Both
Accept Mode and Connect Mode must be idle for the time frame.
The XPort Pro observes the modem control inactive setting.
Note: To clear data out of the serial buffers upon a disconnect, enable “Flush Serial Data”.
To configure the tunnel Disconnect Mode:
1. Click Tunnel > Disconnect Mode at the top of the page. The Tunnel 1 Disconnect Mode page
appears.
Figure 6-17 Tunnel 1 Disconnect Mode
2. Enter or modify the following settings:
Table 6-18 Tunnel Disconnect Mode
Tunnel – Disconnect Mode
Settings
Stop Character Enter the stop character in ASCII, hexadecimal, or decimal
Modem Control Select Enabled to disconnect when the modem control pin is not
Timeout Enter a time, in milliseconds, for the device to disconnect on a
Flush Serial Data Select Enabled to flush the serial data buffer on a disconnection.
Description
notation. Select <None> to disable.
asserted on the serial line.
Timeout. The value 0 (zero) disables the idle timeout.
3. Click Submit.
XPort Pro User Guide 51
6: Line and Tunnel Settings
Tunnel – Modem Emulation
A tunnel in Connect Mode can be initiated using modem commands incoming from the Serial Line.
This page enables you to configure the modem emulation settings when you select Modem
Emulation as the Tunnel Connect Mode type.
The Modem Emulation Command Mode supports the standard AT command set. For a list of
available commands from the serial or Telnet login, enter AT?. Use ATDT, ATD, and ATDP to
establish a connection. All of these commands behave like a modem. For commands that are valid
but not applicable to the XPort Pro, an “OK” message is sent (but the command is silently ignored).
The XPort Pro attempts to make a Command Mode connection as per the IP/DNS/port numbers
defined in Connect Mode. It is possible to override the remote address, as well as the remote port
number.
The following table lists and describes the available commands.
Table 6-19 Modem Emulation Commands and Descriptions
Command Description
+++ Switches to Command Mode if entered from serial port during connection.
AT? Help.
ATDT<Address Info> Establishes the TCP connection to socket (<ipaddress>:<port>).
ATDP<Address Info> See ATDT.
ATD Like ATDT. Dials default Connect Mode remote address and port.
ATD<Address Info> Sets up a TCP connection. A value of 0 begins a command line interface
session.
ATO Switches to data mode if connection still exists. Vice versa to '+++'.
ATEn Switches echo in Command Mode (off - 0, on - 1).
ATH Disconnects the network session.
ATI Shows modem information.
ATQn Quiet mode (0 - enable results code, 1 - disable results code.)
ATVn Verbose mode (0 - numeric result codes, 1 - text result codes.)
ATXn Command does nothing and returns OK status.
ATUn Accept unknown commands. (n value of 0 = off. n value of 1 = on.)
AT&V Display current and saved settings.
AT&F Reset settings in NVR to factory defaults.
AT&W Save active settings to NVR.
ATZ Restores the current state from the setup settings.
ATS0=n Accept incoming connection.
N value of 0—Disable
N value of 1—Connect automatically
N value of 2+—Connect with ATA command.
ATA Answer incoming connection (if ATS0 is 2 or greater).
XPort Pro User Guide 52
6: Line and Tunnel Settings
Table 6-19 Modem Emulation Commands and Descriptions (continued)
Command (continued) Description
A/ Repeat last valid command.
For commands that can take address information (ATD, ATDT, ATDP), the destination address
can be specified by entering the IP Address, or entering the IP Address and port number. For
example, <ipaddress>:<port>. The port number cannot be entered on its own.
For ATDT and ATDP commands less than 255 characters, the XPort Pro replaces the last
segment of the IP address with the configured Connect Mode remote station address. It is possible
to use the last two segments also, if they are under 255 characters. For example, if the address is
100.255.15.5, entering “ATDT 16.6” results in 100.255.16.6.
When using ATDT and ATDP, enter 0.0.0.0 to switch to the Command Line Interface (CLI). Once
the CLI is exited by using the CLI exit command, the XPort Pro reverts to modem emulation mode.
By default, the +++ characters are not passed through the connection. Turn on this capability
using the modem echo pluses command.
To configure modem emulation:
1. Select Tunnel > Modem Emulation at the top of the page. The
Tunnel 1 Modem Emulation page appears.
Figure 6-20 Tunnel 1 Modem Emulation
2. Enter or modify the following settings:
XPort Pro User Guide 53
Table 6-21 Tunnel Modem Emulation
6: Line and Tunnel Settings
Tunnel- Modem
Description
Emulation Settings
Echo Pluses Select Enabled to echo +++ when entering modem Command Mode.
Echo Commands Select Enabled to echo the modem commands to the console.
Verbose Response Select Enabled to send modem response codes out on the serial line.
Response Type Select the type of response code: Text or Numeric.
Error Unknown
Commands
Incoming
Connection
Select whether an ERROR or OK response is sent in reply to unrecognized AT
commands. Choices are:
Enabled = ERROR is returned for unrecognized AT commands.
Disabled = OK is returned for unrecognized AT commands. Default is Disabled.
Select whether Incoming Connection requests will be disabled, answered
automatically, or answered manually. Default is Disabled.
Connect String Enter the connect string. This modem initialization string prepares the modem for
communications. It is a customized string sent with the “CONNECT” modem
response code.
Display Remote IP Selects whether the incoming RING sent on the Serial Line is followed by the IP
address of the caller. Default is Disabled.
3. Click Submit.
XPort Pro User Guide 54
7: Terminal and Host Settings
This chapter describes how to view and configure the Terminal Login Connect Menu and
associated Host configuration. It contains the following sections:
Terminal Settings
Host Configuration
The Terminal Login Connect Menu feature allows the XPort Pro device to present a menu of
predefined connections when the device is accessed via telnet, ssh, or a serial port. From the
menu, a user can choose one of the presented options and the device automatically makes the
predefined connection.
The Terminal page controls whether a Telnet, SSH, or serial port connection presents the CLI or
the Login Connect Menu. By default, the CLI is presented when the device is accessed. When
configured to present the Login Connect Menu, the hosts configured via the Hosts page, and
named serial lines are presented.
Terminal Settings
This page shows configuration settings for each terminal connection method. You can configure
whether each serial line or the telnet/SSH server presents a CLI or a Login Connect menu when a
connection is made.
Line Terminal Configuration
To configure a line to support an attached terminal:
1. Click Terminal on the menu and then select the line that is connected to the terminal you want
to configure. The default is Line 1. Configuration is automatically selected. The Terminal on
Line 1 Configuration page appears.
Figure 7-1 Terminal on Line 1 Configuration
2. Enter or modify the following settings:
XPort Pro User Guide 55
Table 7-2 Terminal on Line 1 Configuration
7: Terminal and Host Settings
Terminal on Line
Description
Configuration Settings
Terminal Type Enter text to describe the type of terminal. The text will be sent to a host via IAC.
Note: IAC means, “interpret as command.” It is a way to send commands over
the network such as send break or start echoing.
Login Connect Menu Select the interface to display when the user logs in. Choices are:
Enabled = shows the Login Connect Menu.
Disabled = shows the CLI
Exit Connect Menu Select whether to display a choice for the user to exit the Login Connect Menu
and reach the CLI. Choices are:
Enabled = a choice allows the user to exit to the CLI.
Disabled = there is no exit to the CLI.
Send Break Enter a Send Break control character, e.g., <control> Y, or blank to disable.
When the Send Break control character is received from the network on its way to
the serial line, it is not sent to the line; instead, the line output is forced to be
inactive (the break condition).
Break Duration Enter how long the break should last in milliseconds.
Echo Applies only to Connect Mode Telnet connections, not to Accept Mode. Only
disable Echo if your terminal echoes, in which case you will see double of each
character typed.
3. Click Submit to save changes.
XPort Pro User Guide 56
7: Terminal and Host Settings
Network Terminal Configuration
To configure menu features applicable to CLI access via the network:
1. Click Terminal > Network at the top of the page. Configuration is automatically selected. The
Terminal on Network Configuration page appears.
Figure 7-3 Terminal on Network Configuration
2. Enter or modify the following settings:
Table 7-4 Terminal on Network Configuration
Terminal on Network
Configuration Settings
Terminal Type Enter text to describe the type of terminal. The text will be sent to a host via IAC.
Login Connect Menu Select the interface to display when the user logs in. Choices are:
Exit Connect Menu Select whether to display a choice for the user to exit the Login Connect Menu
Echo Applies only to Connect Mode Telnet connections, not to Accept Mode. Only
Description
Note: IAC means, “interpret as command.” It is a way to send commands over
the network such as send break or start echoing.
Enabled = shows the Login Connect Menu.
Disabled = shows the CLI
and reach the CLI. Choices are:
Enabled = a choice allows the user to exit to the CLI.
Disabled = there is no exit to the CLI.
disable Echo if your terminal echoes, in which case you will see double of each
character typed.
3. Click Submit to save changes.
XPort Pro User Guide 57
Host Configuration
This Host web page is where you may view and modify current settings for a remote host.
To configure a remote host, perform the following steps.
1. Click Host on the menu and then click the desired host at the top of the web page.
Configuration is automatically selected. (Host 1 is the default.) Host Configuration page
appears.
7: Terminal and Host Settings
Figure 7-5 Host Configuration
2. Enter or modify the following settings:
Table 7-6 Host Configuration
Host Settings Description
Name Enter a name for the host. This name appears on the Login Connect Menu. To leave
a host out of the menu, leave this field blank.
Protocol Select the protocol to use to connect to the host. Choices are:
Telnet
SSH
Note: SSH keys must be loaded or created on the SSH page for the SSH protocol to
work.
SSH Username Appears if you selected SSH as the protocol. Enter a username to select a pre-
configured Username/Password/Key (configured on the SSH: Client Users page), or
leave it blank to be prompted for a username and password at connect time.
Remote Address Enter an IP address for the host to which the device will connect.
Remote Port Enter the port on the host to which the device will connect.
3. Click Submit to save changes.
XPort Pro User Guide 58
8: Configurable Pin Manager
The Configurable Pin Manager is responsible for assignment and control of the configurable pins
(CPs) available on the XPort Pro. There are three configurable pins on the XPort Pro.
You can configure the CPs by making them part of a group. A CP Group may consist of one or
more CPs. This increases flexibility when incorporating the XPort Pro into another system.
This chapter contains the following sections:
Overview
CPM: CP (Configurable Pins)
CPM: Groups
Overview
Each CP is associated with an external hardware pin. CPs can be configured and used as digital
inputs or outputs.
When used as input, device functionality can be triggered based on the state of a CP. For
example, an email can be sent when a CP is asserted to a preconfigured level. When used as an
output, logic levels of the CP can be manipulated when a preconfigured event occurs on the
device server, such as when a tunnel connection is accepted.
CPs are configured and manipulated within a group. Each group is named and is referenced in the
feature that is triggering a CP or being triggered by a CP. Sophisticated use of CPs can be
accommodated by adding more than one CP into a group.
Default Groups
XPort Pro has several predefined CP groups used to assign a CP to a needed function. For
instance, when working with an RS485 driver that requires a signal to be asserted when in half–
duplex mode, the CP that is driving that signal (chosen by the engineer designing the circuit) is
added to the default group named Line1_RS485_HDpx. The XPort Pro asserts the CP at the
correct time via the default group.
Custom Groups
The email, tunneling, and CLI features can interact with CPs. This is accomplished by creating a
custom group and adding CPs of your choice into that group. Once a CP group is created and
populated with one or more CPs, actions can be triggered when the CPs match a specified value.
CPs can be placed in any bit position within a group, allowing for sophisticated use of the available
CPs.
CPM: CP (Configurable Pins)
Each CP is associated with an external hardware pin. CPs can trigger an outside event, like
sending an email message or starting Command Mode on a serial Line.
The CPM web page is used to experimentally configure the state of the CPs. CPs can be changed
to be a digital input or a digital output, and whether it is asserted high or low. Changes made on
this page do not persist through a reboot.
XPort Pro User Guide 59
8: Configurable Pin Manager
Rules for configuring a CP are as follows. A CP:
Can be in any number of groups.
Can be only in one active group. Two groups with the same CP cannot be enabled at the
same time.
Becomes locked and is not configurable if it is in an enabled group. Disable the group to
change the CP configuration.
When you are ready to permanently configure the CPs, use the CPM Groups web page. See CPM:
Groups on page 62.
View CPs
1. Click CPM on the menu bar and then CPs at the top of the page. The CPM: CPs page
appears.
Figure 8-1 CPM: CPs
The Current Configuration table shows the current settings for each CP.
XPort Pro User Guide 60
Table 8-2 CPM CPs Current Configuration
8: Configurable Pin Manager
CPM – CPs Current
Description
Configuration
CP Indicates the configurable pin number.
Ref Indicates the hardware pin number associated with the CP.
Configured As Shows the CP configuration. A CP configured as Input is set to read
input. A CP configured as Output drives data out of the device.
Value Indicates the current status of the CP:
1 = asserted
0 = de-asserted
Inv = the CP logic is inverted
Groups Indicates the number of groups in which the CP is a member.
Active In Group Shows the group in which the CP is active. A CP can be a member of
several groups. However, it may only be active in one group.
2. Click a CP number (CP column) in the Current Configuration table to display the status of that
pin. The CP Status table shows the information about the CP.
Table 8-3 CPM CPs Status
CPM – CPs Status Description
Name Shows the CP number.
State Shows the current enable state of the CP.
Type Indicates whether the CP is set for input or output.
Value Shows the last bit in the CP current value.
Bit Visual display of the 32 bit placeholders for a CP.
Level A “+” symbol indicates the CP is asserted (the voltage is high).
A “-“indicates the CP voltage is low.
I/O Indicates the current status of the pin:
I = input
O = output
<blank> = unassigned
Logic An “I” indicates the CP is inverted.
Binary Shows the assertion value of the corresponding bit.
CP# Shows the CP number.
Groups Lists the groups in which the CP is a member.
Note: To modify a CP, all groups in which it is a member must be disabled.
To change a CP output value:
1. Select the CP number (in CP column) from the current configuration table.
2. Enter the CP value in the CP Status table.
3. Click Set. The changed CP value appears in the current configuration table.
XPort Pro User Guide 61
To change a CP configuration:
1. Select the CP number (in CP column) from the current configuration table.
2. Select the CP configuration from the Type drop-down list in the CP Status table.
3. (If necessary) Select the Assert Low checkbox.
4. Click Change.
Note: These changes to a CP are not saved in FLASH. Instead, these settings ar e used
when the CP is added to a CP Group. When the CP Group is saved, its CP settings are
saved with it. Thus, a particular CP may be defined as “Input” in one group but as
“Output” in another. Only one group containing a particular CP may be enabled at once.
CPM: Groups
The CP Groups page allows for the adding, removing and managing of CP groups. Groups can be
created or deleted. CPs can be added to or removed from groups. A group, based on its state,
can trigger outside events such as sending email messages. Only an enabled group can be a
trigger.
8: Configurable Pin Manager
View Groups
1. Click CPM on the menu bar and then Groups at the top of the page. The CPM: Groups page
appears.
Figure 8-4 CPM: Groups
XPort Pro User Guide 62
8: Configurable Pin Manager
2. The Current Configuration table shows the current settings for each CP group.
Figure 8-5 CPM Groups Current Configuration
CPM – Groups Current
Configuration
Group Name Shows the CP group’s name.
State Indicates whether the group is enabled or disabled.
CP Info Indicates the number of CPs assigned to this particular group.
Description
To display the status of a
specific group:
1. Click CPM > Groups.
2. Click the CP group name in
the Current Configuration
table.
Figure 8-6 CPM: Group Status
XPort Pro User Guide 63
Table 8-7 Group Status
8: Configurable Pin Manager
CPM – Groups Page
Group Status
Name Shows the CP Group name.
State Shows the current state of the CP group. Locked groups are Lantronix
Value Shows the CP group’s current value.
Bit Displays the individual bit positions for the available CPs.
Level Indicates the voltage level of the CP. A plus sign (+) indicates the CP bit
I/O Indicates the current status of the pin:
Logic Indicates the logic level of the CP. An "I" indicates the CP is inverted.
Binary Shows the assertion value of the corresponding bit. An X means that
CP# Shows the configurable pin number and its bit position in the CP group.
Description
default groups and cannot be deleted. Use the button in this field to
enable or disable the group.
is asserted (the voltage is high). A minus sign (-) indicates the CP
voltage is low.
I = input
O = output
<blank> = unassigned
A blank field indicates that the CP is not inverted.
the group is disabled or the bit is unassigned in the group
To create a custom CP group:
1. Click CPM > Groups.
2. Enter a group name in the Create Group field.
3. Click Submit.
To add a CP to a Group
1. Click CPM > Groups.
2. Click a specific Group Name to select it. The Group Status information for the group appears
in a table below the current configuration.
3. Select a CP from the drop-down list. beneath the Group Status table.
4. Select a bit position from the drop-down list.
5. Select Input or Output from the drop-down list.
6. Check the Assert Low checkbox to specify negative logic (inverted assertion), as desired.
This box is unchecked by default.
7. Click Add to complete adding the CP to the group.
To delete a custom CP group:
1. Click CPM > Groups.
2. Select a custom CP Group Name from the drop-down list beside the current configuration
table.
3. Click the red X next to the corresponding Name in the Group Status table.
XPort Pro User Guide 64
8: Configurable Pin Manager
To enable or disable a CP group:
1. Click CPM > Groups.
2. Select the Group name in the table representing the group you wish to enable. The Group
Status information for this group appears in a table below.
3. Click Enable to enable, as appropriate.
4. Click Disable to disable, as appropriate.
To set a CP group’s value:
1. Create a custom group and add a CP to it.
2. Click CPM > Groups.
3. Select the custom group from the current configuration table.
4. Enter a Group Status Value.
5. Click Set.
To remove a CP from a Group:
1. Click CPM > Groups.
2. Select a the group in the Group Name column that contains the CP to be removed.
3. Select the CP from the drop-down list beside the Remove button.
4. Click Remove.
XPort Pro User Guide 65
9: Service Settings
This chapter describes the available services and how to configure each. It contains the following
sections:
DNS Settings
PPP Settings
SNMP Settings
FTP Settings
TFTP Settings
Syslog Settings
HTTP Settings
RSS Settings
LPD Settings
DNS Settings
The primary and secondary domain name system (DNS) addresses come from the active
interface. The static addresses from the Network Interface Configuration page may be overridden
by DHCP or BOOTP. The DNS web page enables you to view the status and cache.
When a DNS name is resolved using a forward lookup, the results are stored in the DNS cache
temporarily. The XPort Pro checks this cache when performing forward lookups. Each item in the
cache eventually times out and is removed automatically after a certain period, or you can delete it
manually.
To view the DNS status:
1. Click DNS on the menu bar. The DNS page appears.
Figure 9-1 DNS Settings
XPort Pro User Guide 66
To find a DNS Name or IP Address:
1. Enter either a DNS name or an IP address.
2. Click Lookup.
When a DNS name is resolved, the results appear in the DNS cache.
When an IP address is resolved, the results appear in a text below the Lookup field.
To clear cache entries:
1. Click Remove All to remove all listed cache entries.
2. Click Delete next to a specirfic cache entry to remove only that one.
PPP Settings
Point-to-Point Protocol (PPP) establishes a direct connection between two nodes. It defines a
method for data link connectivity between devices using physical layers (such as serial lines).
The XPort Pro supports two types of PPP authentication: Password Authentication Protocol (PAP)
and Challenge Handshake Authentication Protocol (CHAP). Both of these authentication methods
require the configuration of a username and password.
9: Service Settings
PAP authentication offers a straightforward method for the peer to determine its identity. Upon the
link establishment, the user ID and password are repeatedly sent to the authenticator until it is
acknowledged or the connection is terminated. However, PAP is not a strong authentication
process. There is no protection against trial-and-error attacks. The peer is responsible for the
frequency of the authentication communication attempts.
CHAP is a more secure method than PAP. It works by sending a challenge message to the
connection requestor. Using a one-way hash function, the requestor responds with its value. If the
value matches the server’s own calculations, authentication is provided. Otherwise, the connection
is terminated.
Note: RFC1334 defines both CHAP and PAP.
The XPort Pro also supports authentication scheme of “None” when no authentication is required
during link negotiation.
Since the XPort Pro does not support Network Address and Port Translation (NAPT), static routing
table entries must be added to the serial-side and network-side devices (both of which are external
devices).
Use the XPort Pro Web Manager or CLI to configure a network link using PPP over a serial line.
Turn off Connect Mode, Accept Mode, and Command mode before enabling PPP. The XPort Pro
device acts as the server side of the PPP link; it can require authentication and assign an IP
address to the peer. Upon PPP configuration, IP packets are routed between Ethernet and PPP
interfaces.
The XPort Pro does not perform network address translation (NAT) between the serial-side
network interface and the Ethernet/WLAN network interface. Therefore, to pass packets through
the XPort Pro, a static route must be configured on both the PPP Peer device and the remote
device it wishes to communicate with. The static route in the PPP Peer device must use the PPP
Local IP Address as its gateway, and the static route in the remote device must use the network
interface IP Address of the XPort Pro as its gateway.
XPort Pro User Guide 67
9: Service Settings
Note: The following section describes the steps to configure PPP 1 (PPP on serial line
1); these steps also apply to any line instance of the device.
To configure PPP:
1. Click PPP on the menu bar and Line1 at the top of the page. The PPP on Line 1 –
Configuration page appears.
Figure 9-2 PPP Configuration Settings
2. Enter or modify the following settings:
Table 9-3 PPP Configuration
PPP Configuration Settings Description
Local IP Address Enter the IP address assigned to the device’s PPP interface.
Peer IP Address Enter the IP address assigned to the peer (when requested during
negotiation).
Authentication Mode Choose the authentication mode:
None = no authentication is required
PAP = Password Authentication Protocol
CHAP = Challenge Handshake Authentication Protocol
MS-CHAP = Microsoft Challenge-Handshake Authentication
Protocol
MS-CHAPV2 = Microsoft Challenge-Handshake Authentication
Protocol Version 2
Username Enter a username if authentication is to be used on the PPP
interface. The peer must be configured to use the same username.
Password Enter a password if authentication is to be used on the PPP
interface. The peer must be configured to use the same password.
3. Click Submit.
XPort Pro User Guide 68
SNMP Settings
Simple Network Management Protocol (SNMP) is a network management tool that monitors
network devices for conditions that need attention. The SNMP service responds to SNMP
requests and generates SNMP Traps.
This page is used to configure the SNMP agent.
To configure SNMP:
1. Click SNMP on the menu bar. The SNMP page opens and shows the current SNMP
configuration.
9: Service Settings
Figure 9-4 SNMP Configuration
2. Enter or modify the following settings:
Table 9-5 SNMP
SNMP Settings Description
State Select Enabled to enable SNMP.
Read Community Enter the SNMP read-only community string.
Write Community Enter the SNMP read/write community string.
System Contact Enter the name of the system contact.
System Name Enter the system name.
System Description Enter the system description.
System Location Enter the system location.
Traps State Select Enabled to enable the transmission of SNMP Traps.
The Cold Start trap is sent on device boot up, and the
Linkdown trap is sent when the device is rebooted from
software control.
Traps Primary Destination Enter the primary SNMP trap host.
XPort Pro User Guide 69
SNMP Settings (continued) Description
Traps Secondary
Destination
3. Click Submit.
FTP Settings
The FTP web page shows the current File Transfer Protocol (FTP) configuration and various
statistics about the FTP server.
To configure FTP:
1. Click FTP on the menu bar. The FTP page opens to display the current configuration.
9: Service Settings
Enter the secondary SNMP trap host.
Figure 9-6 FTP Configuration
2. Enter or modify the following settings:
FTP Settings Description
State Select Enabled to enable the FTP server.
Admin Username Enter the username to use when logging in via FTP.
Admin Password Enter the password to use when logging in via FTP.
3. Click Submit.
XPort Pro User Guide 70
TFTP Settings
In the TFTP web page, you can configure the server and view the statistics about the Trivial File
Transfer Protocol (TFTP) server.
To configure TFTP:
1. Click TFTP on the menu bar. The TFTP page opens to display the current configuration.
9: Service Settings
Figure 9-7 TFTP Configuration
2. Enter or modify the following settings:
Table 9-8 TFTP Server
TFTP Settings Description
State Select Enabled to enable the TFTP server.
Allow TFTP File Creation Select whether to allow the creation of new files stored on the
TFTP server.
Allow Firmware Update Specifies whether or not the TFTP Server is allowed to accept
a firmware update for the device. An attempt to update
firmware is recognized based on the name of the file.
Note: TFTP cannot authenticate the client, so the device is
open to malicious update.
Allow XCR Import Specifies whether the TFTP server is allowed to accept an
XML configuration file for update. An attempt to import
configuration is recognized based on the name of the file.
Note: TFTP cannot authenticate the client, so the device is
open to malicious update.
3. Click Submit.
XPort Pro User Guide 71
Syslog Settings
The Syslog web page shows the current configuration and statistics of the system log.
To configure the Syslog
Note: The syslog file is always saved to local storage, but it is not retained through
reboots. Saving the syslog file to a server that supports remote logging services (see RFC
3164) allows the administrator to save the complete syslog history. The default port is 514.
1. Click Syslog on the menu bar. The Syslog page opens to display the current configuration.
9: Service Settings
Figure 9-9 Syslog
2. Enter or modify the following settings:
Table 9-10 Syslog
Syslog Settings Description
State Select to enable or disable the syslog.
Host Enter the IP address of the remote server to which system logs are sent
for storage.
Local Port Enter the number of the local port on the device from which system logs
are sent.
Remote Port Enter the number of the port on the remote server that supports logging
services. The default is 514.
Severity Log Level From the drop-down box, select the minimum level of system message
the device should log. This setting applies to all syslog facilities. The
drop-down list is in descending order of severity (e.g., Emergency is
more severe than Alert.)
3. Click Submit.
XPort Pro User Guide 72
HTTP Settings
Hypertext Transfer Protocol (HTTP) is the transport protocol for communicating hypertext
documents on the Internet. HTTP defines how messages are formatted and transmitted. It also
defines the actions web servers and browsers should take in response to different commands.
HTTP Authentication enables the requirement of usernames and passwords for access to the
XPort Pro device.
This page has three links at the top for viewing statistics and for viewing and changing
configuration and authentication settings.
HTTP Statistics—Viewing statistics such as bytes received and transmitted, bad requests,
authorizations required, etc.
HTTP Configuration—Configuring and viewing the current configuration.
HTTP Authentication—Configuring and viewing the authentication.
HTTP Statistics
To view HTTP statistics:
This page shows various statistics about the HTTP server.
1. Click HTTP on the menu bar and then Statistics at the top of the page. The HTTP Statistics
page appears.
9: Service Settings
Figure 9-11 HTTP Statistics
Note: The HTTP log is a scrolling log, with the last Max Log Entries cached and
viewable. You can change the maximum number of entries that can be viewed on the
HTTP Configuration Page.
XPort Pro User Guide 73
9: Service Settings
HTTP Configuration
On this page you may change HTTP configuration settings.
To configure HTTP:
1. Click HTTP on the menu bar and then Configuration at the top of the page. The HTTP
Configuration page opens.
Figure 9-12 HTTP Configuration
2. Enter or modify the following settings:
Table 9-13 HTTP Configuration
HTTP Configuration
Settings
State Select Enabled to enable the HTTP server.
Port Enter the port for the HTTP server to use. The default is 80.
Secure Port Enter the port for the HTTPS server to use. The default is 443. The HTTP
Description
server only listens on the HTTPS Port when an SSL certificate is
configured.
XPort Pro User Guide 74
9: Service Settings
HTTP Configuration
Description
Settings (continued)
Secure Protocols Select to enable or disable the following protocols:
SSL3 = Secure Sockets Layer version 3
TLS1.0 = Transport Layer Security version 1.0. TLS 1.0 is the successor
of SSL3 as defined by the IETF.
TLS1.1 = Transport Layer Security version 1.1
The protocols are enabled by default.
Note: A server certificate and associated private key need to be installed in
the SSL configuration section to use HTTPS.
Max Timeout Enter the maximum time for the HTTP server to wait when receiving a
request. This prevents Denial-of-Service (DoS) attacks. The default is 10
seconds.
Max Bytes Enter the maximum number of bytes the HTTP server accepts when
receiving a request. The default is 40 kB (this prevents DoS attacks).
Logging State Select Enabled to enable HTTP server logging.
Max Log Entries Sets the maximum number of HTTP server log entries. Only the last Max
Log Entries are cached and viewable.
Log Format Set the log format string for the HTTP server. Follow these Log Format
rules:
%a - remote IP address (could be a proxy)
%b - bytes sent excluding headers
%B - bytes sent excluding headers (0 = '-')
%h - remote host (same as '%a')
%{h}i - header contents from request (h = header string)
%m - request method
%p - ephemeral local port value used for request
%q - query string (prepend with '?' or empty '-')
%t - timestamp HH:MM:SS (same as Apache '%(%H:%M:%S)t' or
'%(%T)t')
%u - remote user (could be bogus for 401 status)
%U - URL path info
%r - first line of request (same as '%m %U%q <version>')
%s - return status
Authentication
Timeout
The timeout period applies if the selected authentication type is either
Digest or SSL/Digest. After this period of inactivity, the client must
authenticate again.
3. Click Submit.
XPort Pro User Guide 75
9: Service Settings
HTTP Authentication
HTTP Authentication enables you to require usernames and passwords to access specific web
pages or directories on the XPort Pro's built-in web server.
To configure HTTP authentication settings:
1. Click HTTP on the menu bar and then Authentication at the top of the page. The HTTP
Authentication page opens.
Figure 9-14 HTTP Authentication
2. Enter or modify the following settings:
Table 9-15 HTTP Authentication
HTTP Authentication
Settings
URI Enter the Uniform Resource Identifier (URI).
Realm Enter the domain, or realm, used for HTTP. Required with the
Description
Note: The URI must begin with ‘/’ to refer to the filesystem.
URI field.
XPort Pro User Guide 76
9: Service Settings
HTTP Authentication
Settings (continued)
Auth Type Select the authentication type:
Username
Description
None = no authentication is necessary.
Basic = encodes passwords using Base64.
Digest = encodes passwords using MD5.
SSL = the page can only be accessed over SSL (no password
is required).
SSL/Basic = the page is accessible only over SSL and
encodes passwords using Base64.
SSL/Digest = the page is accessible only over SSL and
encodes passwords using MD5.
Note: When changing the parameters of Digest or SSL Digest
authentication, it is often best to close and reopen the browser to
ensure it does not attempt to use cached authentication
information.
Enter the Username used to access the URI. More than one
Username per URI is permitted.
Click Submit and enter the next Username as necessary.
Password Enter the Password for the Username.
3. Click Submit.
4. To delete the URI and users, click Delete in the current configuration table.
Note: The URI, realm, username, and password are user-specified, free-form fields. The
URI must match the directory created on the XPort Pro file system.
RSS Settings
Really Simple Syndication (RSS) (sometimes referred to as Rich Site Summary) is a method of
feeding online content to Web users. Instead of actively searching for XPort Pro configuration
changes, RSS feeds permit viewing only relevant and new information regarding changes made to
the XPort Pro via an RSS publisher. The RSS feeds may also be stored to the file system
cfg_log.txt file.
To configure RSS settings:
1. Click RSS on the menu bar. The RSS page opens and shows the current RSS configuration.
XPort Pro User Guide 77
Figure 9-16 RSS
2. Enter or modify the following settings:
Table 9-17 RSS
RSS Settings Description
RSS Feed Select On to enable RSS feeds to an RSS publisher.
Persistent Select On to enable the RSS feed to be written to a file (cfg_log.txt)
and to be available across reboots.
Max Entries Sets the maximum number of log entries. Only the last Max Entries
are cached and viewable.
9: Service Settings
3. Click Submit.
4. In the Current Status table, view and clear stored RSS Feed entries, as necessary.
LPD Settings
The XPort Pro device acts as a print server if a printer gets connected to one of its serial ports.
Clicking the Line Printer Daemon (LPD) link in the Main Menu displays the LPD web page. The
LPD web page has three sub-menus for viewing print queue statistics, changing print queue
configuration, and printing a test page. Because the LPD lines operate independently, you can
specify different configuration settings for each.
LPD Statistics
This read-only page shows various statistics about the LPD server.
To view LPD statistics:
1. Click LPD on the menu bar and then select the line and Statistics at the top of the page. The
LPD page shows LPD statistics.
XPort Pro User Guide 78
9: Service Settings
Figure 9-18 LPD Statistics
LPD Configuration
Here you can change LPD configuration settings.
To configure LPD settings:
1. Click LPD on the menu bar, select the LPD line and click Configuration. The LPD
Configuration page appears.
Figure 9-19 LPD Configuration
XPort Pro User Guide 79
2. Enter or modify the following settings:
Table 9-20 LPD Configuration
9: Service Settings
LPD Configuration
Settings
Banner Select Enabled to print the banner even if the print job does not
Binary Select Enabled for the device to pass the entire file to the printer
Start of Job Select Enabled to print a "start of job" string before sending the print
End of Job Select Enabled to send an "end of job" string.
Formfeed Select Enabled to force the printer to advance to the next page at
Convert Newlines Select Enabled to convert single newlines and carriage returns to
SOJ String If Start of Job (above) is enabled, enter the string to be sent to the
EOJ String If End of Job (above) is enabled, enter the string to send at the end
Queue Name To change the name of the print queue, enter a new name. The
Description
specify to do so. Selected by default.
unchanged. Otherwise, the device passes only valid ASCII and valid
control characters to the printer. Valid control characters include the
tab, linefeed, formfeed, backspace, and newline characters. All
others are stripped. Disabled by default.
data.
the end of each print job.
DOS-style line endings.
printer at the beginning of a print job. The limit is 100 characters.
Indicate whether the string is in text or binary format.
of a print job. The limit is 100 characters. Indicate whether the string
is in text or binary format.
name cannot have white space in it and is limited to 31 characters.
The default is LPDQueueX (for line number X)
3. Click Submit.
XPort Pro User Guide 80
10: Security Settings
The XPort Pro device supports Secure Shell (SSH) and Secure Sockets Layer (SSL). SSH is a
network protocol for securely accessing a remote device. SSH provides a secure, encrypted
communication channel between two hosts over a network. It provides authentication and
message integrity services.
Secure Sockets Layer (SSL) is a protocol that manages data transmission security over the
Internet. It uses digital certificates for authentication and cryptography against eavesdropping and
tampering. It provides encryption and message integrity services. SSL is widely used for secure
communication to a web server. SSL uses certificates and private keys.
Note: The XPort Pro supports SSLv3 and its successors, TLS1.0 and TLS1.1. An
incoming SSlv2 connection attempt is answered with an SSlv3 response. If the initiator
also supports SSLv3, SSLv3 handles the rest of the connection.
This chapter contains the following sections:
SSH Server Host Keys
SSH Server Authorized Users
SSH Client Known Hosts
SSH Client User
SSL Cipher Suites
SSL Certificates
SSL RSA or DSA
SSL Certificates and Private Keys
SSL Utilities
SSL Configuration
SSH Settings
SSH is a network protocol for securely accessing a remote device over an encrypted channel. This
protocol manages the security of internet data transmission between two hosts over a network by
providing encryption, authentication, and message integrity services.
Two instances require configuration: when the XPort Pro is the SSH server and when it is an SSH
client. The SSH server is used by the CLI (Command Mode) and for tunneling in Accept Mode.
The SSH client is for tunneling in Connect Mode.
To configure the XPort Pro as an SSH server, there are two requirements:
Defined host keys: both private and public keys are required. These keys are used for the
Diffie-Hellman key exchange (used for the underlying encryption protocol).
Defined users: these users are permitted to connect to the XPort Pro SSH server.
This page has four links at the top for viewing and changing SSH server host keys, SSH server
authorized keys, SSH client known hosts, and SSH client users.
XPort Pro User Guide 81
10: Security Settings
SSH Server Host Keys
To configure the SSH server host keys:
1. Click SSH on the menu bar and SSH Server: Host Keys at the top of the page. The SSH
Server Host Keys page appears.
Figure 10-1 SSH Server: Host Keys
2. Enter or modify the following settings:
Table 10-2 SSH Server Host Keys Settings
SSH Server: Host Keys
Settings
Upload Keys
Private Key Enter the path and name of the existing private key you want to upload or use
Public Key Enter the path and name of the existing public key you want to upload or use
Key Type Select a key type to use:
Description
the Browse button to select the key. Be sure the private key will not be
compromised in transit. This implies the data is uploaded over some kind of
secure private network.
the Browse button to select the key.
RSA = use this key with SSH1 and SSH2 protocols.
DSA = use this key with the SSH2 protocol.
Note: RSA is more secure.
XPort Pro User Guide 82
10: Security Settings
SSH Server: Host Keys
Settings (continued)
Create New Keys
Key Type Select a key type to use for the new key:
Bit Size Select a bit length for the new key:
Description
RSA = use this key with the SSH1 and SSH2 protocols.
DSA = use this key with the SSH2 protocol.
512
768
1024
Using a larger bit size takes more time to generate the key. Approximate times
are:
10 seconds for a 512 bit RSA Key
15 seconds for a 768 bit RSA Key
1 minute for a 1024 bit RSA Key
30 seconds for a 512 bit DSA Key
1 minute for a 768 bit DSA Key
2 minutes for a 1024 bit DSA Key
Note: Some SSH clients require RSA host keys to be at least 1024 bits long.
This device generates keys up to 1024 bits long. It can work with larger keys
(up to 2048 bit) if they are imported or otherwise created.
3. Click Submit.
Note: SSH keys may be created on another computer and uploaded to the XPort Pro.
For example, use the following command using Open SSH to create a 1024-bit DSA key
pair: ssh-keygen –b 1024 –t dsa
SSH Keys from other programs may be converted to the required XPort Pro format. Use Open
SSH to perform the conversion.
To convert from RFC-4716 format: ssh-keygen –i
For more options, look at the help from Open SSH: ssh-keygen ?
1. If the keys do not exist, select the Key Type and the key’s Bit Size from the Create New Keys
section. Click Submit to create new private and public host keys.
Note: Generating new keys with a large bit size results in longer key generation times.
2. Click SSH >SSH Server: Authorized Users at the top of the page. The SSH Server:
Authorized Users page appears.
3. Enter the Username and Password for authorized users.
4. If available: locate the Public RSA Key or the Public DSA Key file by clicking Browse.
Configuring a public key results in public key authentication; this bypasses password queries.
Note: When uploading the security keys, ensure the keys are not compromised in
transit.
SSH Server Authorized Users
On this page you can change SSH server settings for Authorized Users. SSH Server Authorized
Users are accounts on the XPort Pro that can be used to log into the XPort Pro using SSH. For
XPort Pro User Guide 83
10: Security Settings
instance, these accounts can be used to SSH into the CLI or open an SSH connection to a device
port. Every account must have a password.
The user's public keys are optional and only necessary if public key authentication is required.
Using public key authentication allows a connection to be made without the password being
asked.
Under Current Configuration, User has a Delete User link, and Public RSA Key and Public
DSA Key have View Key and Delete Key links. If you click a Delete link, a message asks whether
you are sure you want to delete this information. Click OK to proceed or Cancel to cancel the
operation.
To configure the SSH server for authorized users:
1. Click SSH on the menu bar and then Server Authorized Users at the top of the page. The
SSH Server: Authorized Users page appears.
Figure 10-3 SSH Server: Authorized Users
2. Enter or modify the following settings:
Table 10-4 SSH Server Authorized User Settings
SSH Server:
Authorized Users
Settings
Username Enter the name of the user authorized to access the SSH server.
Password Enter the password associated with the username.
Public RSA Key Enter the path and name of the existing public RSA key you want
Public DSA Key Enter the path and name of the existing public DSA key you want
Description
to use with this user or use the Browse button to select the key. If
authentication is successful with the key, no password is required.
to use with this user or use the Browse button to select the key. If
authentication is successful with the key, no password is required.
3. Click Submit.
XPort Pro User Guide 84
10: Security Settings
SSH Client Known Hosts
On this page you can change SSH client settings for known hosts.
Note: You do not have to complete the fields on this page for communication to occur.
However, completing them adds another layer of security that protects against Man-InThe-Middle (MITM) attacks.
To configure the SSH client for known hosts:
1. Click SSH on the menu bar and then Client Known Hosts at the top of the page. The SSH
Client: Known Hosts page appears.
Figure 10-5 SSH Client: Known Hosts
2. Enter or modify the following settings:
Table 10-6 SSH Client Known Hosts
SSH Client:
Known Hosts Settings
Server Enter the name or IP address of a known host. If you enter a server name,
Public RSA Key Enter the path and name of the existing public RSA key you want to use
Public DSA Key Enter the path and name of the existing public DSA key you want to use
Description
the name should match the name of the server used as the Remote
Address in Connect mode tunneling.
with this known host or use the Browse button to select the key.
with this known host or use the Browse button to select the key.
Note: These settings are not required for communication. They protect against Man-In-
The-Middle (MITM) attacks.
3. Click Submit.
4. In the Current Configuration table, delete currently stored settings as necessary.
XPort Pro User Guide 85
10: Security Settings
SSH Client User
On this page you can change SSH client settings for users. To configure the XPort Pro as an SSH
client, an SSH client user must be both configured and also exist on the remote SSH server.
SSH client known users are used by all applications that play the role of an SSH client, specifically
tunneling in Connect Mode. At the very least, a password or key pair must be configured for a
user. The keys for public key authentication can be created elsewhere and uploaded to the device
or automatically generated on the device. If uploading existing keys, be sure the private key will
not be compromised in transit. This implies the data is uploaded over some kind of secure private
network.
Note: If you are providing a key by uploading a file, make sure that the key is not
password protected.
To configure the SSH client users:
1. Click SSH on the menu bar and then SSH Client Users at the top of the page. The SSH
Client: Users page appears.
Figure 10-7 SSH Client: Users
XPort Pro User Guide 86
2. Enter or modify the following settings:
Table 10-8 SSH Client Users
10: Security Settings
SSH Client: Users
Description
Settings
Username Enter the name that the device uses to connect to a SSH server.
Password Enter the password associated with the username.
Remote Command Enter the command that can be executed remotely. Default is shell, which tells the
SSH server to execute a remote shell upon connection. This command can be
changed to anything the remote host can perform.
Private Key Enter the name of the existing private key you want to use with this SSH client user.
You can either enter the path and name of the key, or use the Browse button to
select the key.
Public Key Enter the path and name of the existing public key you want to use with this SSH
client user or use the Browse button to select the key.
Note: If the user public key is known on the remote SSH server, the SSH server
does not require a password. The Remote Command is provided to the SSH server
upon connection. It specifies the application to execute upon connection. The default
is a command shell.
Note: Configuring the SSH client’s known hosts is optional. It prevents Man-In-The-
Middle (MITM) attacks
Key Type Select the key type to be used. Choices are:
RSA = use this key with the SSH1 and SSH2 protocols.
DSA = use this key with the SSH2 protocol.
Create New Keys
Username Enter the name of the user associated with the new key.
Key Type Select the key type to be used for the new key. Choices are:
RSA = use this key with the SSH1 and SSH2 protocols.
DSA = use this key with the SSH2 protocol.
Bit Size Select the bit length of the new key:
512
768
1024
Using a larger Bit Size takes more time to generate the key. Approximate times are:
10 seconds for a 512 bit RSA Key
15 seconds for a 768 bit RSA Key
1 minute for a 1024 bit RSA key
30 seconds for a 512 bit DSA key
1 minute for a 768 bit DSA key
2 minutes for a 1024 bit DSA key
Note: Some SSH clients require RSA host keys to be at least 1024 bits long. This
device generates keys up to 1024 bits long. It can work with larger keys (up to 2048
bit) if they are imported or otherwise created.
3. Click Submit.
4. In the Current Configuration table, delete currently stored settings as necessary.
XPort Pro User Guide 87
SSL Settings
Secure Sockets Layer (SSL) is a protocol for managing the security of data transmission over the
Internet. It provides encryption, authentication, and message integrity services. SSL is widely used
for secure communication to a web server.
Certificate/Private key combinations can be obtained from an external Certificate Authority (CA)
and downloaded into the unit. Self-signed certificates with associated private key can be
generated by the device server itself.
For more information regarding Certificates and how to obtain them, see SSL Certificates and
Private Keys (on page 89).
SSL uses digital certificates for authentication and cryptography against eavesdropping and
tampering. Sometimes only the server is authenticated, sometimes both server and client. The
XPort Pro can be server and/or client, depending on the application. Public key encryption
systems exchange information and keys and set up the encrypted tunnel.
Efficient symmetric encryption methods encrypt the data going through the tunnel after it is
established. Hashing provides tamper detection.
Applications that can make use of SSL are Tunneling, Secure Web Server, and WLAN interface.
The XPort Pro supports SSlv3 and its successors, TLS1.0 and TLS1.1.
10: Security Settings
Note: An incoming SSlv2 connection attempt is answered with an SSlv3 response. If the
initiator also supports SSLv3, SSLv3 handles the rest of the connection.
SSL Cipher Suites
The SSL standard defines only certain combinations of certificate type, key exchange method,
symmetric encryption, and hash method. Such a combination is called a cipher suite. Supported
cipher suites include the following:
Table 10-9 Supported Cipher Suites
Certificate Key Exchange Encryption Hash
DSA DHE 3DES SHA1
RSA RSA 128 bits AES SHA1
RSA RSA Triple DES SHA1
RSA RSA 128 bits RC4 MD5
RSA RSA 128 bits RC4 SHA1
RSA 1024 bits RSA 56 bits RC4 MD5
RSA 1024 bits RSA 56 bits RC4 SHA1
RSA 1024 bits RSA 40 bits RC4 MD5
Whichever side is acting as server decides which cipher suite to use for a connection. It is usually
the strongest common denominator of the cipher suite lists supported by both sides.
XPort Pro User Guide 88
10: Security Settings
SSL Certificates
The goal of a certificate is to authenticate its sender. It is analogous to a paper document that
contains personal identification information and is signed by an authority, for example a notary or
government agency.
The principles of Security Certificate required that in order to sign other certificates, the authority
uses a private key. The published authority certificate contains the matching public key that allows
another to verify the signature but not recreate it.
The authority’s certificate can be signed by itself, resulting in a self-signed or trusted-root
certificate, or by another (higher) authority, resulting in an intermediate authority certificate. You
can build up a chain of intermediate authority certificates, and the last certification will always be a
trusted-root certificate.
An authority that signs another certificates is also called a Certificate Authority (CA). The last in
line is then the root-CA. VeriSign is a famous example of such a root-CA. Its certificate is often
built into web browsers to allow verifying the identity of website servers, which need to have
certificates signed by VeriSign or another public CA. Since obtaining a certificate signed by a CA
that is managed by another company can be expensive, it is possible to have your own CA. Tools
exist to generate self-signed CA certificates or to sign other certificates.
A certificate request is a certificate that has not been signed and only contains the identifying
information. Signing it makes it a certificate. A certificate is also used to sign any message
transmitted to the peer to identify the originator and prevent tampering while transported.
When using HTTPS, SSL Tunneling in Accept mode, and/or EAP-TLS, the XPort Pro needs a
personal certificate with a matching private key to identify itself and sign its messages. When using
SSL Tunneling in Connect mode and/or EAP-TLS, EAP-TTLS or PEAP, the XPort Pro needs the
authority certificate that can authenticate users with which it wishes to communicate.
SSL RSA or DSA
As mentioned above, the certificates contain a public key. Different key exchange methods require
different public keys and thus different styles of certificate. The XPort Pro supports key exchange
methods that require a RSA-style certificate and key exchange methods that require a DSA-style
certificate. If only one of these certificates is stored in the XPort Pro, only those key exchange
methods that can work with that style certificate are enabled. RSA is sufficient in most cases.
SSL Certificates and Private Keys
You can obtain a certificate by completing a certificate request and sending it to a certificate
authority that will create a certificate/key combo, usually for a fee. Or generate your own. A few
utilities exist to generate self-signed certificates or sign certificate requests. The XPort Pro also
has the ability to generate its own self-signed certificate/key combo.
You can use XML to export the certificate in PEM format, but you cannot export the key. Hence the
internal certificate generator can only be used for certificates that are to identify that particular
XPort Pro.
Certificates and private keys can be stored in several file formats. Best known are PKCS12, DER
and PEM. Certificate and key can be in the same file or in separate files. The key can be encrypted
with a password or not. The XPort Pro currently only accepts separate PEM files. The key needs
to be unencrypted.
XPort Pro User Guide 89
10: Security Settings
SSL Utilities
Several utilities exist to convert between the formats.
OpenSSL
Open source set of SSL related command line utilities. It can act as server or client. It can
generate or sign certificate requests. It can convert all kinds of formats. Executables are available
for Linux and Windows. To generate a self-signed RSA certificate/key combo use the following
commands in the order shown:
openssl req –x509 –nodes –days 365 –newkey rsa:1024 –keyout
mp_key.pem –out mp_cert.pem
Note: Signing other certificate requests is also possible with OpenSSL. See
www.openssl.org
Steel Belted Radius
Commercial radius server by Juniper Networks that provides a GUI administration interface. It also
provides a certificate request and self-signed certificate generator. The self-signed certificate has
extension .sbrpvk and is in the PKCS12 format. OpenSSL can convert this into a PEM format
certificate and key by using the following commands in the order shown:
or www.madboa.com/geek/openssl for more information.
openssl pkcs12 -in sbr_certkey.sbrpvk -nodes -out sbr_certkey.pem
The sbr_certkey.pem file contains both certificate and key. If loading the SBR certificate into XPort
Pro as an authority, you will need to edit it.
1. Open the file in any plain text editor.
2. Delete all info before the following: “----- BEGIN CERTIFICATE-----“
3. Delete all info after the following: “----- END CERTIFICATE-----“
4. Save as sbr_cert.pem. SBR accepts trusted-root certificates in the DER format.
5. Again, OpenSSL can convert any format into DER by using the following commands in the
order shown:
openssl x509 -inform pem -in mp_cert.pem -outform der -out
mp_cert.der
Note: With SBR, when the identity information includes special characters such as
dashes and periods, SBR changes the format it uses to store these strings and becomes
incompatible with the current XPort Pro release. We will add support for this and other
formats in future releases. Free Radius—Linux open-source Rad ius server. It is versat ile,
but complicated to configure.
FreeRadius
Free Radius is a Linux open-source Radius server. It is versatile, but complicated to configure.
XPort Pro User Guide 90
SSL Configuration
To configure SSL settings:
1. Click SSL from the main menu. The SSL page appears.
Figure 10-10 SSL
10: Security Settings
XPort Pro User Guide 91
10: Security Settings
2. Enter or modify the following settings:
Table 10-11 SSL
SSL Settings Description
Upload Certificate
New Certificate This certificate identifies the device to peers. It is used for HTTPS and SSL
Tunneling.
Enter the path and name of the certificate you want to upload, or use the
Browse button to select the certificate.
RSA or DSA certificates with 512 to 1024 bit public keys are allowed.
The format of the file must be PEM. The file must start with “-----BEGIN
CERTIFICATE-----“ and end with “-----END CERTIFICATE-----“. Some
Certificate Authorities add comments before and/or after these lines. Those
need to be deleted before upload.
New Private Key Enter the path and name of the private key you want to upload, or use the
Browse button to select the private key. The key needs to belong to the
certificate entered above.
The format of the file must be PEM. The file must start with “-----BEGIN
RSA PRIVATE KEY-----” and end with “-----END RSA PRIVATE KEY-----”.
Read DSA instead of RSA in case of a DSA key. Some Certificate
Authorities add comments before and/or after these lines. Those need to be
deleted before upload.
Upload Authority Certificate
Authority One or more authority certificates are needed to verify a peer's identity. It is
used for SSL Tunneling. These certificates do not require a private key.
Enter the path and name of the certificate you want to upload, or use the
Browse button to select the certificate.
RSA or DSA certificates with 512 to 1024 bit public keys are allowed.
The format of the file must be PEM. The file must start with “-----BEGIN
CERTIFICATE-----” and end with “-----END CERTIFICATE-----”. Some
Certificate Authorities add comments before and/or after these lines. Those
need to be deleted before upload.
Create New Self-Signed Certificate
Country (2 Letter Code) Enter the 2-letter country code to be assigned to the new self-signed
certificate.
Examples: US for United States and CA for Canada
State/Province Enter the state or province to be assigned to the new self-signed certificate.
Locality (City) Enter the city or locality to be assigned to the new self-signed certificate.
Organization Enter the organization to be associated with the new self-signed certificate.
Example: If your company is called Widgets, and you are setting up a web
server for the Sales department, enter Widgets for the organization.
Organization Unit Enter the organizational unit to be associated with the new self-signed
certificate.
Example: If your company is setting up a web server for the Sales
department, enter Sales for your organizational unit.
XPort Pro User Guide 92
10: Security Settings
SSL Settings (continued) Description
Common Name Enter the same name that the user will enter when requesting your web
site.
Example: If a user enters
http://www.widgets.abccompany.com to
access your web site, the Common Name would be
www.widgets.abccompany.com.
Expires Enter the expiration date, in mm/dd/yyyy format, for the new self-signed
certificate.
Example: An expiration date of May 9, 2010 is entered as 05/09/2010.
Key length Select the bit size of the new self-signed certificate. Choices are:
512 bits
768 bits
1024 bits
The larger the bit size, the longer it takes to generate the key. Approximate
times are:
10 seconds for a 512-bit RSA key
30 seconds for a 768-bit RSA key
1 minute for a 1024-bit RSA key
30 seconds for a 512-bit DSA key
2 minutes for a 768-bit DSA key
6 minute for a 1024-bit DSA key
Type Select the type of key:
RSA = Public-Key Cryptography algorithm based on large prime
numbers, invented by Rivest Shamir and Adleman. Used for encryption
and signing.
DSA = Digital Signature Algorithm also based on large prime numbers,
but can only be used for signing. Developed by the US government to
avoid the patents on RSA.
3. Click Submit.
XPort Pro User Guide 93
11: Modbus
Modbus ASCII/RTU based serial slave devices can be connected via the ethernet through an
existing Modbus TCP/IP network. Any device having access to a given Modbus implementation
will be able to perform full range of operations that the implementation supports. Modbus/TCP
use a reserved TCP port of 502 and include a single byte function code (1=255) preceded by a 6
byte header:
Transaction ID (2 bytes) Identification of request/response transaction - copied by slave
Protocol ID (2 bytes) 0 - Modbus protocol
Length (2 bytes) Number of following bytes includes the unit identifier
Address (1 byte) Identification of remove slave
CP Control via Modbus
Default groups are mapped to Modbus registers. CPs added to groups will result in the CP being
read and written based on the reading or writing to the register which maps to that CP group.
Default Modbus group names include:
Modbus_Ctl_In
Modbus_Ctl_Out
Table 11-1 6 Byte Header of Modbus Application Protocol
Note: Refer to Chapter 8: CPM: Groups on page 62 for instr uctions on adding a CP to a
Group.
When the Modbus slave address is set to 0xFF, the message is addressed to the internal default
groups and thus processed by the XPort Pro. The Modbus 'local slave' supported functions are
listed in the table below.
Table 11-2 Modbus Local Slave Functions - Query
Name Number Address
Hi [0]
Read Coils 0x01 0x00 0x00-0x02
Read Input
status
Read Holding
Registers
Read Input
Registers
0x02 0x00 0x00-0x02
0x03 0x00 0x00-0x02
0x04 0x00 0x00-0x02
Address
Lo [1]
Starting CP
CP1 – CP3
Starting CP
CP1 – CP3
Starting CP
CP1 – CP3
Starting CP
CP1 – CP3
Data Hi
[2]
0x00 0x01-0x03
0x00 0x01-0x03
0x00 0x01-0x03
0x00 0x01-0x03
Data Lo
[3]
No of CPs to
output
No of CPs to
output
No of CPs to
output
No of CPs to
output
Bytes
Value [5]
Count [4]
N/A N/A
N/A N/A
N/A N/A
N/A N/A
XPort Pro User Guide 94
11: Modbus
Name Number Address
Hi [0]
Force Single Coil 0x05 0x00 0x00-0x02
Preset Single
Register
Force Multiple
Coils
Preset Multiple
Registers
Read/Write 4X
Registers
0x06 0x00 0x00-0x02
0x0F 0x00 0x00-0x02
0x10 0x00 0x00-0x02
0x17 0x00 0x00-0x02
0x00 0x01-0x03
Address
Lo [1]
Output CP
CP1 – CP3
CP1 – CP3
Starting CP
CP1 – CP3
Starting CP
CP1 – CP3
Starting CP
CP1 – CP3 to
read
Quantity to
write
Data Hi
[2]
0xff (set CPx
to 1) or
0x00 (set CPx
to 0)
0x00 0x00 or 0x01 N/A N/A
0x00 0x01-0x03
0x00 0x01-0x03
0x00 0x01-0x03
0x02-0x06
(Quantity to
write) * 2
Data Lo
[3]
0x00 N/A N/A
No of CPs to
set
No of CPs to
set
Quantity to
read
Max [6]..
0x00, 0x0Y
0x00 ,0x0Y
0x00, 0x0Y
Y = 0 or 1
Bytes
Value [5]
Count [4]
0x01 0B00000xyz
CP values ,Lo
CP# in low bit
0x02-0x06
(No of CPs
to set) * 2
0x00 0x00-0x02
Max [6]..
0x00, 0x0Y
0x00 ,0x0Y
0x00, 0x0Y
Y = 0 or 1
Starting CP
CP1 – CP3 to
write
Table 11-3 Modbus Local Slave Functions - Response
Name Number Byte
Count
Read
Coils
Read
Input
status
Read
Holding
Registers
Read
Input
Registers
Force
Single
Cell
Preset
Single
Register
0x01 0x01 0B00000xyz
0x02 0x01 0B00000xyz
0x03 0x02-0x06 0x00 Starting CP
0x04 0x02-0x06 0x00 Starting CP
0x05 Echo query Echo query Echo query Echo
0x06 Echo query Echo query Echo query Echo
Data [0] Data [1] Data
[2]
N/A N/A N/A N/A N/A
CP output
values ,Lo CP#
in high bit
N/A N/A N/A N/A N/A
CP output
values ,Lo CP#
in high bit
0x00 Next CP or
Value
0x00 or 0x01
0x00 Next CP or
Value
0x00 or 0x01
query
query
Data [3] Data
Data [5]
[4]
End CP value
0x00 or 0x01
End CP value
0x00 or 0x01
N/A N/A N/A
N/A N/A N/A
0x00 End CP value
0x00 or 0x01
0x00 End CP value
0x00 or 0x01
XPort Pro User Guide 95
11: Modbus
Name Number Byte
Count
Force
Multiple
Coil
Preset
Multiple
Registers
Read/
Write 4X
Registers
0x0F Echo query Echo query Echo query Echo
0x10 Echo query Echo query Echo query Echo
0x17 0x02-0x06
(Quantity of
Read) * 2
Serial Transmission Mode
Evolution products can be set up to communicate on standard Modbus networks using either RTU
or ASCII. Users select the desired mode and serial port communication parameters (baud rate,
parity mode, etc) during the line configuration.
RTU ASCII
Address: 8 bits (0 to 247 decimal, 0 is used
for broadcast)
Function: 8 bits (1 to 255, 0 is not valid)
Data: N X 8 bits (N=0 to 252 bytes)
CRC Check: 16 bits
Data [0] Data [1] Data
Data [3] Data
[2]
N/A N/A N/A
query
N/A N/A N/A
query
Max [6]..
0x00, 0x0Y
0x00 ,0x0Y
0x00, 0x0Y
Y = 0 or 1
Table 11-4 Modbus Transmission Modes
Address: 2 CHARS
Function: 2 CHARS
Data: N CHARS (N=0 to 252 CHARS)
LRC Check: 2 CHARS
Data [5]
[4]
The Modbus web pages allow you to check Modbus status and make configuration changes. This
chapter contains the following sections:
Modbus Statistics
Modbus Configuration
XPort Pro User Guide 96
Modbus Statistics
This read-only web page displays the current connection status of the Modbus servers listening on
the TCP ports. When a connection is active, the remote client information is displayed as well as
the number of PDUs that have been sent and received. Additionally, a Kill link will be present
which can be used to kill the connection.
To view modbus statistics:
1. Click Modbus on the menu bar and click Statistics at the top of the page. The Modbus
Statistics page appears.
11: Modbus
Figure 11-5 Modbus Statistics
XPort Pro User Guide 97
Modbus Configuration
This web page shows the current negotiated Modbus settings and allows configuration changes.
To view and configure the Modbus Server:
1. Click Modbus on the menu bar and then click Configuration at the top of the page. The
Modbus Configuration page appears.
11: Modbus
Figure 11-6 Modbus Configuration
2. Enter or modify the following settings:
Table 11-7 Modbus Configuration
Modbus Configuration
Settings
TCP Server State If On, the Modbus server is active on TCP 502.
Additional TCP Server Port If present, is used in addition to TCP port 502.
Response Timeout The number of milliseconds to wait for a response on the serial
RSS Trace Input If On, each PDU received on the Modbus serial line creates a
Description
side. The device returns exception code 11 to the network
master controller if the slave serial device fails to reply within
this time out.
non-persistent descriptive item in the RSS feed.
3. Click Submit. The changes take effect immediately.
Note: The serial line protocol must also be configured for Modbus, in addition to
configuring the Modbus server. See Chapter 6: Line and Tunnel Settings on page 32 for
details.
XPort Pro User Guide 98
12: Maintenance and Diagnostics Settings
This chapter describes maintenance and diagnostic methods and contains the following sections:
Filesystem Settings
Protocol Stack Settings
IP Address Filter
Query Port
Diagnostics
System Settings
Filesystem Settings
The XPort Pro uses a flash filesystem to store files. Use the Filesystem option to view current file
statistics or modify files. There are two subsections: Statistics and Browse.
The Statistics section of the Filesystem web page shows current statistics and usage information
of the flash filesystem. In the Browser section of the Filesystem web page, you can create files
and folders, upload files, copy and move files, and use TFTP.
Filesystem Statistics
This page shows various statistics and current usage information of the flash filesystem.
Figure 12-1 Filesystem Statistics
XPort Pro User Guide 99
12: Maintenance and Diagnostics Settings
To view filesystem statistics or to compact or format the filesystem:
1. Back up all files as necessary.
2. Click Filesystem on the menu bar. The Filesystem page opens and shows the current
filesystem statistics and usage.
3. To compact the files, click Compact in the Actions row.
Note: The compact should not be needed under normal circumstances as the system
manages this automatically.
4. Back up all files before you perform the next (Format) step, because all user files get erased in
that step.
5. Click Format in the Actions row. The configuration gets retained.
Filesystem Browser
To browse the filesystem:
1. Click Filesystem on the menu bar and then Browse at the top of the page. The Filesystem
Browser page opens.
XPort Pro User Guide 100
Loading...