Product Information Label ____________________________________________ 14 3: Using DeviceInstaller Accessing XPort AR using DeviceInstaller _______________________________ 16 Viewing the XPort AR’s Current Configuration ____________________________ 16 4: Configuration Using Web Manager Accessing Web Manager through a Web Browser _________________________ 18 Network Settings ___________________________________________________ 19...
Page 4
SSH Server’s Host Keys __________________________________________________ 56 SSH Server’s Authorized Users ____________________________________________ 57 SSH Client Known Hosts _________________________________________________ 58 SSH Client User Configuration _____________________________________________ 59 SSL Settings ______________________________________________________ 60 XML Configuration__________________________________________________ 61 Import System Configuration ______________________________________________ 61 XPort AR User Guide...
This guide provides the information needed to configure, use, and update the XPort AR™. It is intended for software developers and system integrators who are embedding the XPort AR in their designs. Summary of Chapters The remaining chapters in this guide include:...
1: Using This Guide Additional Documentation The following guides are available on the product CD or the Lantronix Web site (www.lantronix.com): XPort AR Getting Provides the steps for getting the XPort AR evaluation Started board up and running. XPort AR Integration...
− External interrupts, including one non-maskable − Timer input Applications The XPort AR 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 Universal Power Supply (UPS) management units...
PoE provides power to network devices over an Ethernet connection if the required hardware is available. The XPort AR passes PoE through the RJ45 to a connector on the bottom. To enable PoE, take the connections and design a PoE circuit and regulator to provide power for the device connected to the XPort AR.
Without the need to disable any features or functionality, the Evolution OS™ provides the XPort AR the highest level of 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.
Provide the ability to run popular M2M protocols over a secure SSH connection In addition to keeping data safe and accessible, the XPort AR has robust defenses to hostile Internet attacks such as denial of service (DoS), which can be used to take down the network.
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 AR: TCP Port 22: SSH Server (Command Mode configuration)
2. Click on the XPort AR folder. The list of Lantronix XPort AR devices available displays. 3. Expand the list of XPorts by clicking the + symbol next to the XPort AR icon. Select the XPort AR unit by clicking on its IP address to view its configuration.
Page 17
Non-configurable field. Displays the XPort AR’s status as online, offline, unreachable (the XPort AR is on a different subnet), or busy (the XPort AR is currently performing a task). Telnet Enabled Displays whether Telnet is enabled on this XPort AR.
Internet Explorer 5.5. and above, Mozilla Suite, Mozilla Firefox, or Opera). 2. Enter the IP address of the XPort AR in the address bar. The XPort AR’s built-in security requires you to log in with your user name and password.
DNS, SNMP, FTP, TFTP, IP address filter, and the query port. Network Configuration To configure the network’s general configuration: 1. Click Network Configuration from the navigation menu. The Network Configuration window displays. XPort AR User Guide...
Select On, Off, or Renew. Overrides the configured IP address, network mask, gateway, hostname, and domain. IP Address Enter the XPort AR’s static IP address. The static address is used when BOOTP and DHCP are both set to Off. Network Mask Enter the XPort AR’s network mask.
3. In the Current Running Configuration table, delete currently stored fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. Changes to the following settings require a reboot for the changes to take effect: DHCP, BOOTP, IP address, network mask, gateway, MAC address, and DHCP client ID.
Interface Select the Line’s interface from the pull-down menu. The default is RS232. Baud Rate Select the XPort AR’s baud rate from the pull-down menu. The default is 9600. Parity Select the XPort AR’s parity from the pull-down menu. The default is None.
Prefix a decimal character with \ or a hexadecimal character with 0x, or provide a single printable character. The default Xoff char is 0x13. 3. Click Submit. Changes are applied immediately to the XPort AR. Line 1 Command Mode Setting Command Mode enables the CLI on the serial line.
Binary, or Decimal notation. 3. In the Current Configuration table, clear currently stored fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. Tunnel 1 and Tunnel 2 Settings Select the Tunnel 1 or Tunnel 2 link on the left menu bar to display the Tunnel menu.
Select the method used to start a tunnel in Accept mode. Choices are: Disabled = do not accept an incoming connection. Enabled = accept an incoming connection. (default) Any Character = start waiting for an incoming connection when any character is read on the serial line. XPort AR User Guide...
The password can have up to 31 characters and must contain only alphanumeric characters and punctuation. When set, the password sent to the XPort AR must be terminated with one of the following: (a) 0x10 (LF), (b) 0x00, (c) 0x13 0x10 (CR LF), or (d) 0x13 0x00.
Character is received. Select Timeout to send data after the specified time has elapsed. Timeout Enter a time, in milliseconds, for the XPort AR to send the queued data. Threshold Send the queued data when the number of queued bytes reaches the threshold.
3. In the Current Configuration table, reset currently stored fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. Connect Mode Connect mode defines how the unit makes an outgoing connection.
Select Modem Emulation to use modem emulation on this tunnel. Remote Address Enter the remote address to which the XPort AR will connect. Enter an IP address or DNS name. Remote Port Enter the remote port number.
3. Click Submit. Changes are applied immediately to the XPort AR. Start and Stop Characters The XPort AR can be configured to start a tunnel when it receives a specific start character from the serial port. The XPort AR can also be configured to disconnect upon receiving the stop character.
Select On to forward (tunnel) the start character. Echo Stop Character Select On to forward (tunnel) the stop character. 3. Click Submit. Changes are applied immediately to the XPort AR. Disconnect Mode Disconnect mode is disabled by default. When enabled, disconnect mode runs in the background of an active connection to determine when a disconnection is required.
Asserted to disconnect an active connection when the Modem Control pin (DSR) is de-asserted on the serial line.. Timeout Enter a time, in milliseconds, for the XPort AR to disconnect on a timeout (if specified as the Mode). Flush Serial Data Select Enabled to flush the serial data buffer on a disconnection.
Enter the value for each byte of the decrypt key. From the pull-down menu, select the format for the byte as either character, hexadecimal, or decimal notation. All trailing bytes not specified are set to 0. 3. Click Submit. Changes are applied immediately to the XPort AR. XPort AR User Guide...
4: Configuration Using Web Manager Protocol Stack Configuration To configure the XPort AR’s network stack protocols: 1. Click Network Protocol Stack from the navigation menu. The Protocol Stack window displays the settings for TCP, ICMP, and ARP. Figure 4-14. Protocol Stack 2.
XPort AR. Configurable Pin Manager The XPort AR has 11 Configurable Pins (CPs). CPs can be grouped together using the Configurable Pin Manager (CPM). Each CP is associated to an external hardware pin. CPs can trigger an outside event (such as sending an email message or starting Command Mode).
Configured As Displays the CPs configuration. A CP configured as Input is set to read input. A CP configured as Output drives data out of the XPort AR. Peripheral is a setting assigned by the XPort AR. Binary A value of 1 means asserted. 0 means de-asserted. I indicates the CP is inverted.
Page 38
4. To change a CP’s value: a) Select the CP from the drop-down list. b) Enter the CP’s value. c) Click Submit. Changes are applied immediately to the XPort AR. 5. To change a CP’s configuration: a) Select the CP from the drop-down list.
CPs to it. A group, based on its state, triggers outside events (such as sending email messages). Only an enabled group can be used as a trigger. To configure the XPort AR’s CP groups: 1. Click CPM Groups from the navigation menu. The CPM: Groups window displays.
Page 40
2. To create a CP group: a) Enter a group name in the Create Group field. b) Click Submit. Changes are applied immediately to the XPort AR. 3. To delete a CP group: a) Select the CP group from the Delete Group drop-down list.
Displays the current Secondary Server address. Select Delete to remove this value. 3. Click Submit. Changes are applied immediately to the XPort AR. 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).
4: Configuration Using Web Manager The XPort AR supports two types of PPP authorization: Password Authentication Protocol (PAP) and Challenge Handshake Protocol (CHAP). Both of these authentication methods require the configuration of a username and password. It also supports no authentication scheme when no authentication is required during link negotiation.
PPP interface. Auth. Password Enter the password for use if authentication is used on the PPP interface. 3. Click Submit. Changes are applied immediately to the XPort AR SNMP Configuration To configure SNMP: 1. Click Network SNMP from the navigation menu. The SNMP window opens and displays the current SNMP configuration.
Secondary TrapDest IP Enter the secondary SNMP trap host. 3. In the Current Configuration table, delete and clear currently stored fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. FTP Configuration To configure FTP: 1. Click Network FTP from the navigation menu.
4: Configuration Using Web Manager 4. Click Submit. Changes are applied immediately to the XPort AR. TFTP Configuration To configure TFTP: 1. Click Network TFTP from the navigation menu. The TFTP window opens to display the current configuration. Figure 4-21. TFTP Configuration 2.
Enter the IP address’ network mask in dotted notation. 3. In the Current State table, click Remove to delete fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. Syslog The Syslog page shows the current configuration, status, and statistics for the syslog.
It also defines the actions Web servers and browsers should take in response to different commands. Select the HTTP link on the left menu bar to display the HTTP menu. The sub- menus allow for HTTP configuration, HTTP authentication administration, or RSS configuration. XPort AR User Guide...
1. Click HTTP Statistics from the navigation menu. The HTTP Statistics window displays. Figure 4-24. HTTP Statistics HTTP Configuration To configure HTTP: 1. Click HTTP HTTP Configuration from the navigation menu. The HTTP Configuration window opens. XPort AR User Guide...
%U - URL path info %r - first line of request (same as '%m %U%q <version>') %s - return status 2. Click Submit. Changes are applied immediately to the XPort AR. HTTP Authentication To configure HTTP authentication settings: 1. Click HTTP Authentication from the navigation menu.
Rich Site Summary (RSS) is a method of feeding online content to Web users. Instead of actively searching for XPort AR configuration changes, RSS feeds permit viewing only relevant and new information regarding changes made to the XPort AR via an RSS publisher. The RSS feeds are also stored to the filesystem’s cfg_log.txt file.
3. In the Current Configuration table, view and clear currently stored fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. Command Line Interface Settings Select the CLI link on the left menu bar to display the Command Line Interface menu.
3. Click Submit. Changes are applied immediately to the XPort AR. Email Configuration The XPort AR allows for the configuration of four email alerts relating to the Configuration Pins (CPs). Select the Email link on the left menu bar to display the Email menu and statistics.
4: Configuration Using Web Manager Figure 4-30. Email Statistics To configure XPort AR’s email settings: 1. Click Email Configuration from the navigation menu. The Email Configuration window opens and displays the current Email configuration. XPort AR User Guide...
EHLO (Extended Hello). Server Port Enter the SMTP server port number. The default is a random port number. Local Port Enter the local port to use for email alerts. Priority Select the priority level for the email alert. XPort AR User Guide...
Select the SSH link on the left menu bar to display the SSH menu over an encrypted channel. The sub-menus allow for the configuration of the SSH server (when the XPort AR acts as the server) and the SSH client (when the XPort AR acts as the client).
Select the key type. DSA is more secure than RSA. Note: One set of RSA keys and one set of DSA keys are accepted. 3. Click Submit. Changes are applied immediately to the XPort AR. 4. To create new keys, select the following option buttons: Create New Keys Key Type Select RSA or DSA.
Enter the username for an authorized user. Required when the Password is specified. Password Enter the password for SSH login to the XPort AR. Required when the Username is specified. Public RSA Key Browse and locate the RSA public key for this authorized user.
These fields are not required for communication. They protect against Man-In-The-Middle (MITM) attacks. 3. In the Current Configuration table, delete currently stored fields as necessary. 4. Click Submit. Changes are applied immediately to the XPort AR. SSH Client User Configuration To configure the SSH client’s users: 1.
Select the size of the key. Note: Large bit keys require more time to generate. 4. Click Submit. Changes are applied immediately to the XPort AR. 5. In the Current Configuration table, delete currently stored fields as necessary. 6. Click Submit. Changes are applied immediately to the XPort AR.
5. Click Submit. Changes are applied immediately to the XPort AR. XML Configuration The XPort AR allows for the configuration of units using an XML configuration file. Export a current configuration for use on other XPort ARs or import a saved configuration file.
4. Select from the list of checkboxes the groups to import. If no groups are selected, all the groups will be imported. 5. Click Import. The settings for the groups selected are applied to the XPort AR. Export System Configuration To export and store an XPort AR’s configuration:...
To view the XCR data (without storing it), select Export ECR data to browser. b) To export to a file on the XPort AR filesystem, select Export XCR data to the filesystem. In the text box, enter the name for the file. The system will create the file and store it in the root directory of the XPort AR.
Filesystem Configuration on page 64.) Filesystem Configuration The XPort AR uses a flash filesystem to store files. Use the Filesystem option to view current file diagnostics or modify files. Figure 4-39. Filesystem To compact or format the XPort AR’s filesystem: 1.
4: Configuration Using Web Manager To browse the XPort AR’s filesystem: 1. Click Filesystem Browse from the navigation menu. The Filesystem Browser window opens and displays the current filesystem configuration. Figure 4-40. Filesystem Browser 2. Click on a filename to view the contents.
4: Configuration Using Web Manager Create File Enter a filename and click Create. The XPort AR creates the empty file (0 bytes) and stores it in the current directory. Directory Enter a folder name and click Create. The XPort AR creates the folder and stores it in the current directory.
3. Click Submit. Changes are applied immediately to the XPort AR. Diagnostics Configuration The XPort AR has several tools for diagnostics and statistics. Select the Diagnostics link on the left menu bar to display the Diagnostics menu. The sub- menus allow for the configuration or viewing of MIB2 statistics, IP socket information, ping, traceroute, DNS lookup, memory, buffer pools, processes, and hardware.
4: Configuration Using Web Manager Figure 4-42. Diagnostics: Hardware 2. Enter or modify the following field: CPU Speed Enter the XPort AR’s CPU speed. Accepted values are between 25 and 120 MHz. Click Submit. The CPU speed is updated immediately (no reboot required).
IP Sockets To display open network sockets on the XPort AR: 1. Click Diagnostics IP Sockets from the navigation menu. The IP Sockets window opens and displays all of the open network sockets on the XPort AR. XPort AR User Guide...
4: Configuration Using Web Manager Figure 4-44. IP Sockets Ping To ping a remote device or computer: 2. Click Diagnostics Ping from the navigation menu. The Diagnostics: Ping window opens. Figure 4-45. Diagnostics: Ping XPort AR User Guide...
Enter the number of ping packets XPort AR should attempt to send to the Host. The default is 3. Timeout Enter the time, in seconds, for the XPort AR to wait for a response from the host before timing out. The default is 5 seconds.
“@”) to look up the Mail Exchange (MX) record IP address. 3. Click Submit. The results of the lookup display in the window. Memory To display memory statistics for the XPort AR: 1. Click Diagnostics Memory from the navigation menu. The Diagnostics: Memory window displays.
4: Configuration Using Web Manager Buffer Pools Several parts of the XPort AR system use private buffer pools to ensure deterministic memory management. To display the XPort AR’s buffer pools: 1. Click Diagnostics Buffer Pools from the navigation menu. The Diagnostics: Buffer Pools window opens.
The Adobe SVG plug-in is required to view the CPU Load Graph. System Configuration The XPort AR System window allows for rebooting the device, restoring factory defaults, uploading new firmware, configuring the short and long name, and viewing the current system configuration.
XPort AR’s home page. Restore Factory Defaults Click Factory Defaults to restore the XPort AR to the original factory settings. All configurations will be lost. The XPort AR automatically reboots upon setting back to the defaults.
Otherwise, the connection is terminated. Note: RFC1334 defines both CHAP and PAP. Use the XPort AR’s 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.
(TCP or UDP). When enabled, Connect Mode is always on. Enter the remote station as an IP address or DNS name. The XPort AR will not make a connection unless it can resolve the address. For DNS names, after 4 hours of an active connection, the XPort AR will re-evaluate the address.
For Connect Mode using UDP, if the remote address or port is not configured, then the XPort AR accepts packets from any device on the network. It will send packets to the last device that sent it packets. As a result, it is advised to configure the remote address and port.
The Packing Mode threshold. When the buffer fills to a specified amount of data (and the timeout has not elapsed), the XPort AR packs the data and sends it out. The send character. Similar to a start or stop character, the XPort AR packs the data until it sees the send character.
6: Tunneling Modem Emulation The XPort AR supports Modem Emulation mode for devices that send out modem signals. There are two different modes supported: Command Mode: sends back verbal response codes. Data Mode: information transferred in is also transferred out.
Repeat last valid command. All of these commands behave like a modem. For commands that are valid but not applicable to the XPort AR, an “OK” message is sent (but the command is silently ignored). The XPort AR attempts to make a Command Mode connection as per the IP/DNS/port numbers defined in Connect Mode.
6: Tunneling Statistics The XPort AR logs statistics for tunneling. The Dropped statistic displays connections ended by the remote location. The Disconnected statistic displays connections ended by the XPort AR. XPort AR User Guide...
To configure the SSH settings, there are two instances that require configuration: when the XPort AR 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. Use the SSH client for tunneling in Connect Mode.
It is most commonly used with HTTP (thus forming HTTPS). On the XPort AR, configure an SSL certificate for the HTTP server to listen on the HTTPS port. This certificate can be created elsewhere and uploaded to the device.
Page 85
When uploading the certificate and the private key, ensure the private key is not compromised in transit. To upload a new certificate, see Upload Certificate on page 61. To create a new self- signed certificate, see Create New Self-Signed Certificate on page 61. XPort AR User Guide...
8: Using Email The XPort AR has a Simple Mail Transfer Protocol (SMTP) client. SMTP is a TCP/IP protocol used in sending and receiving email. Its objective is to send email efficiently and reliably. There are three ways to send an email from the XPort AR: 1.
8: Using Email Priority Levels The default priority level for the XPort AR’s emails is Normal priority. The XPort AR has 5 configurable priority levels; certain recipient systems have filters based on these priority levels. Configurable priority levels are: Priority...
Page 88
Use the Show Log command to display the email log. When the system sends an email, the following information is logged: 1. Messages the XPort AR sends to the SMTP server. 2. Messages from the SMTP server to the XPort AR.
9: Configuration Pin Manager There are 11 configurable pins on the XPort AR. All CPs (except for 5) are shared by some other function on the XPort AR. Some of the CPs are assigned to serial port 1 (dtr/dsr for modem control and rts/cts for hardware flow control), others to serial port 2 (dtr/dsr for modem control, rts/cts for hardware flow control, and tx/rx groups as well).
(a value of 1 indicates a high voltage). The state shows the assertion level. To configure a group’s value: 1. If using the Web Manager: a) Click CPM Groups from the navigation menu. The CPM Groups window displays b) To create a CP group: XPort AR User Guide...
Page 91
9: Configuration Pin Manager i. Enter a group name in the Create Group field. ii. Click Submit. Changes are applied immediately to the XPort AR. c) To delete a CP group: i. Select the CP group from the Delete Group drop-down list.
XML configuration record (XCR). An XCR can be imported or exported via the CLI, a Web browser, FTP, the XPort AR’s filesystem. An XCR being imported or exported can contain many configuration settings or just a few. For example, it might change all of the configurable parameters for an XPort AR, or it may only change the baud rate for a single serial line.
The background image file. The background is tiled. Command Mode Customize the XPort AR’s Command Mode by changing its short name and long name. The short name is used for show commands: (enable)# show XPort The long name appears in the Product Type field:...
2. Click in the Upload New Firmware section, click Browse. A pop-up window displays; locate the firmware file. 3. Click Upload to install the firmware on the XPort AR. The device automatically reboots upon the installation of new firmware. XPort AR User Guide...
If you are experiencing an error that is not described in this user guide, or if you are unable to fix the error, you may: Check our online knowledge base at http://www.lantronix.com/support. Contact Technical Support in the US: Phone: 800-422-7044 (US only) or 949-453-7198...
0111 1000 1001 1010 1011 1100 1101 1110 1111 Scientific Calculator Another simple way to convert binary to hexadecimals is to use a scientific calculator, such as the one available on Windows’ operating systems. For example: XPort AR User Guide...
Page 97
1. On the Windows’ Start menu, click Programs Accessories Calculator. 1. On the View menu, select Scientific. The scientific calculator displays. 2. Click Bin (Binary), and type the number you want to convert. 3. Click Hex. The hexadecimal value displays. XPort AR User Guide...
Compliance Information (according to ISO/IEC Guide 22 and EN 45014) Manufacturer’s Name & Address: Lantronix 15353 Barranca Parkway, Irvine, CA 92618 USA Declares that the following product: Product Name Model: Device Server PRODUCT NAME Conforms to the following standards or other normative documents:...
If the product is not under warranty, the customer may have Lantronix repair the unit on a fee basis or return it. No services are handled at the customer's site under this warranty. This warranty is voided if the customer uses the product in an unauthorized or improper way, or in an environment for which it was not designed.
Need help?
Do you have a question about the XPort AR and is the answer not in the manual?
Questions and answers