Lantronix XPort AR - Manual

Contents XPort AR User Guide 7 Figures Figure 2-1. Sample Hardware Address ................................................................................................ 13 Figure 2-2. Product Label ......................................................................................................

Contents XPort AR User Guide 8 Figure 11-2. XML Example With Multiple Named Values .................................................................. 136 Figure 11-3. XML Example With Multiple Items ................................................................................. 136 Figure 11-4. XM...

XPort AR User Guide 9 1: Using This Guide Purpose and Audience 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 chap...

1: Using This Guide XPort AR User Guide 10 Additional Documentation The following guides are available on the product CD or the Lantronix Web site ( www.lantronix.com ): XPort AR Getting Started Provides the steps for getting the XPort AR evaluation board up and running. XPort AR Integration Guide P...

XPort AR User Guide 11 2: Description and Specifications This chapter summarizes the XPort AR device server’s features and basic information needed before getting started. Features The XPort AR is designed with additional features above and beyond the original XPort, including: ‹ The Evolution OS op...

2: Description and Specifications XPort AR User Guide 12 ‹ Time/attendance clocks and terminals Protocol Support The XPort AR device server contains a full-featured TCP/IP stack. Supported protocols include: ‹ ARP, IP, UDP, TCP, ICMP, BOOTP, DHCP, Auto IP, Telnet, FTP, TFTP, HTTP, SSH, SSL, SNMP, an...

2: Description and Specifications XPort AR User Guide 13 Web Manager : Through a web browser, configure the XPort AR’s settings using the Lantronix Web Manager. (See 4:Configuration Using Web Manager .) Command Mode: There are two methods to accessing Command Mode: making a Telnet connection or conn...

2: Description and Specifications XPort AR User Guide 14 Product Information Label The product information label on the underside of the unit contains the following information about the specific unit: ‹ Bar code ‹ Serial number ‹ Product ID (name) ‹ Part number ‹ Hardware address (MAC address) Figu...

XPort AR User Guide 15 3: Using DeviceInstaller This chapter covers the steps for viewing the XPort AR device server’s properties and device details. Accessing XPort AR using DeviceInstaller Note: Make note of the MAC address. It is needed to locate the XPort AR using DeviceInstaller. ‹ Follow the i...

XPort AR User Guide 17 4: Configuration Using Web Manager This chapter describes how to configure the XPort AR using Web Manager, Lantronix’s browser-based configuration tool. The unit’s configuration is stored in nonvolatile memory and is retained without power. All changes take effect immediately,...

4: Configuration Using Web Manager XPort AR User Guide 18 Network Settings Click the Network link on the left navigation bar to display the Network menu. The sub-menus displayed allow for the configuration of the general network settings, protocol stack, DNS, SNMP, FTP, TFTP, IP address filter, and ...

4: Configuration Using Web Manager XPort AR User Guide 19 2. Enter or modify the following fields: BOOTP Client Select On or Off. Overrides the configured IP address, network mask, gateway, hostname, and domain. Note: When DHCP is set to On, the system automatically uses DHCP, regardless if BOOTP Cl...

4: Configuration Using Web Manager XPort AR User Guide 20 Figure 4-3. Protocol Stack 2. Enter or modify the following fields: TCP Send RSTs TCP contains six control bits, with one or more defined in each packet. RST is one of the control bits. The RST bit is responsible for telling the receiving TCP...

4: Configuration Using Web Manager XPort AR User Guide 21 Note: Both the IP and MAC addresses are required for the ARP cache. Current State Clear Select Clear to remove all entries in the ARP table. Remove Removes a specific entry from the ARP table. 3. Click Submit after each modified field. Change...

4: Configuration Using Web Manager XPort AR User Guide 22 Peer IP Address Enter the IP address assigned to the peer (when requested during negotiation). Network Mask Enter the network mask. Auth. Mode Choose the authentication mode. Select None when no authentication is required. Select PAP for Pass...

4: Configuration Using Web Manager XPort AR User Guide 23 Figure 4-6. SNMP Configuration 2. Enter or modify the following fields: SNMP Agent Select On to enable SNMP. Read Community Enter the SNMP read-only community string. Write Community Enter the SNMP read/write community string. System Contact ...

4: Configuration Using Web Manager XPort AR User Guide 24 Figure 4-7. FTP Configuration 2. Enter or modify the following fields: FTP FTP Server Select On to enable the FTP server. Username Enter the username to use when logging in via FTP. Password Enter the password to use when logging in via FTP. ...

4: Configuration Using Web Manager XPort AR User Guide 25 2. Enter or modify the following fields: TFTP TFTP Server Select On to enable the FTP server. Allow TFTP File Creation Enable the automatic creation of files stored by the TFTP server. 3. In the Current TFTP Configuration and Statistics table...

4: Configuration Using Web Manager XPort AR User Guide 26 supported. For more information on DeviceInstaller, see Using DeviceInstaller on page 15 . To configure the query port server: 1. Click Network Æ Query Port from the navigation menu. The Query Port window opens to display the current configur...

4: Configuration Using Web Manager XPort AR User Guide 27 Figure 4-11. Line 1 Configuration 2. Enter or modify the following fields: Status Displays the whether the current line is enabled. To change the status, select Enabled or Disabled from the pull-down menu. Baud Rate Select the XPort AR’s baud...

4: Configuration Using Web Manager XPort AR User Guide 28 Figure 4-12. Line 1 Command Mode 2. Enter or modify the following fields: Always Select Yes to enable the XPort AR’s command mode. Use Serial String Select Yes to start command mode based on a serial string. Use CP Group Select Yes to start c...

4: Configuration Using Web Manager XPort AR User Guide 29 accept mode, disconnect mode, packing mode, start and stop characters, and modem emulation. Note: The following section describes the steps to configure Tunnel 1; these steps also apply to Tunnel 2 menu options . Figure 4-13. Tunnel 1 Serial ...

4: Configuration Using Web Manager XPort AR User Guide 30 2. Enter or modify the following fields: Buffer Size Enter the buffer size used for the tunneling of data received. Read Timeout Enter the time, in milliseconds, for tunneling wait for serial data Wait for Read Timeout Select Enabled to cause...

4: Configuration Using Web Manager XPort AR User Guide 31 2. Enter or modify the following fields: Mode Select Disabled to turn off connect mode. Any Character enables connect mode upon receiving a character. Start Character enables connect mode upon receiving the start character. Select DSR Active ...

4: Configuration Using Web Manager XPort AR User Guide 33 On Connection Specifies the value to set the CP or CP Group when a connection is established. On Disconnection Specifies the value used when the connection is closed. 3. Click Submit . Changes are applied immediately to the XPort AR. Disconne...

4: Configuration Using Web Manager XPort AR User Guide 34 To configure the tunnel’s packing mode: 1. Select Tunnel 1 Æ Packing Mode from the navigation menu. The Tunnel 1 Packing Mode window displays. Figure 4-18. Tunnel 1 Packing Mode 2. Enter or modify the following fields: Mode Select Disabled to...

4: Configuration Using Web Manager XPort AR User Guide 35 Figure 4-19. Tunnel 1 Start/Stop Chars 2. Enter or modify the following fields: Start Character Enter the start character in either ASCII or hexadecimal notation. Stop Character Enter the start character in either ASCII or hexadecimal notatio...

4: Configuration Using Web Manager XPort AR User Guide 36 2. Enter or modify the following fields: Echo Pluses Select On to echo “+++” when entering modem command mode Echo Commands Select On to echo the modem commands to the console. Verbose Response Codes Select On to send modem response codes out...

4: Configuration Using Web Manager XPort AR User Guide 37 2. Enter or modify the following fields: Encrypt Key Enter the value for each byte. From the pull-down menu, select the format for the byte as either character, hexadecimal, or decimal notation. Note: Any empty trailing bites that are not spe...

4: Configuration Using Web Manager XPort AR User Guide 38 2. Enter or modify the following fields: Encrypt Key Enter the value for each byte. 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. ...

4: Configuration Using Web Manager XPort AR User Guide 39 Current Configuration CP Indicates the Configurable Pin number. Pin # Indicates the hardware pin number associated with the CP. Configured As Displays the CPs configuration. A CP configured as Input is set to read input. A CP configured as Ou...

4: Configuration Using Web Manager XPort AR User Guide 40 CPM: Groups The CP Groups page allows for the management of CP groups. Create a CP group and add 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....

4: Configuration Using Web Manager XPort AR User Guide 42 SSH Settings Secure Shell (SSH) is a protocol used to access a remote computer over an encrypted channel. It is a protocol for managing the security of data transmission over the Internet. It provides encryption, authentication, and message i...

4: Configuration Using Web Manager XPort AR User Guide 43 4. To create new keys, select the following option buttons: Create New Keys Key Type Select RSA or DSA . Bit Size Select the size of the key. Large bit keys require more time to generate. Note: Certain SSH clients require RSA host keys to be ...

4: Configuration Using Web Manager XPort AR User Guide 44 SSH Client Known Hosts To configure the SSH client’s known hosts: 1. Click SSH Æ Client Known Hosts from the navigation menu. The SSH Client: Known Hosts window displays. Figure 4-27. SSH Client: Known Hosts 2. Enter or modify the following f...

4: Configuration Using Web Manager XPort AR User Guide 46 SSL Settings Secure Socket 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 we...

4: Configuration Using Web Manager XPort AR User Guide 47 3. Click Submit . Changes are applied immediately to the XPort AR. 4. To create a new self-signed certificate, enter the following information: Create New Self-Signed Certificate Country Enter the 2-letter country code. State/Province Enter t...

4: Configuration Using Web Manager XPort AR User Guide 48 Figure 4-31. Command Line Interface Configuration 2. Enter or modify the following fields: Telnet Access Select On to enable Telnet access. Telnet is enabled by default. Telnet Port Enter the Telnet port to use for Telnet access. The default ...

4: Configuration Using Web Manager XPort AR User Guide 49 Figure 4-32. HTTP Statistics HTTP Configuration To configure HTTP: 1. Click HTTP Æ HTTP Configuration from the navigation menu. The HTTP Configuration window opens. Figure 4-33. HTTP Configuration

4: Configuration Using Web Manager XPort AR User Guide 50 2. Enter or modify the following fields: HTTP Server Select On to enable the HTTP server. HTTP Port Enter the port for the HTTP server to use. The default is 80. HTTPS Port Enter the port for the HTTPS server to use. The default is 443. The H...

4: Configuration Using Web Manager XPort AR User Guide 51 Figure 4-34. HTTP Authentication 2. Enter or modify the following fields: URI Enter the Uniform Resource Identifier (URI). Realm Enter the domain, or realm, used for HTTP. Required with the URI field. Auth Type Select the authentication type....

4: Configuration Using Web Manager XPort AR User Guide 52 To configure HTTP RSS settings: 1. Click HTTP Æ RSS from the navigation menu. The HTTP RSS window opens and displays the current RSS configuration. Figure 4-35. HTTP RSS 2. Enter or modify the following fields: RSS Feed Select On to enable RS...

4: Configuration Using Web Manager XPort AR User Guide 54 Export System Configuration To export and store an XPort AR’s configuration: 1. Click XML Æ Export from the navigation menu. The XML: Export System Configuration window opens. Figure 4-37. Export System Configuration 2. Use one of the followi...

4: Configuration Using Web Manager XPort AR User Guide 55 4. Click Export. The groups display if exporting the data to the browser. If exporting to the filesystem, the files are stored on the filesystem. (To view these files or store them elsewhere, see Filesystem Configuration on page 56 .) Email C...

4: Configuration Using Web Manager XPort AR User Guide 56 2. Enter or modify the following fields: To Enter the email address to which the email alerts will be sent. CC Enter the email address to which the email alerts will be CC’ed. From Enter the email address to list in the From field of the emai...

4: Configuration Using Web Manager XPort AR User Guide 58 3. Click the X next to a filename to delete the file or directory. A directory can only be deleted if it is empty. 4. Enter or modify the following fields: Note: Changes apply to the current directory view. To make changes within other folder...

4: Configuration Using Web Manager XPort AR User Guide 59 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 statistic...

4: Configuration Using Web Manager XPort AR User Guide 60 Figure 4-43. 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-44. Diagnostics: Ping 3. Enter or modify the following fields: Host Enter the...

4: Configuration Using Web Manager XPort AR User Guide 61 Traceroute To use traceroute from the XPort AR: 1. Click Diagnostics Æ Traceroute from the navigation menu. The Diagnostics: Traceroute window opens. Figure 4-45. Diagnostics: Traceroute 2. Enter or modify the following fields: Traceroute Ent...

4: Configuration Using Web Manager XPort AR User Guide 62 2. Enter or modify the following field: Lookup Enter an IP address for reverse lookup to locate the hostname for that IP address. Enter a hostname for forward lookup to locate the corresponding IP address. Enter a domain name (prefixed with “...

4: Configuration Using Web Manager XPort AR User Guide 63 Figure 4-48. Diagnostics: Buffer Pools Processes The XPort AR Processes window displays all the processes currently running on the system. It displays the Process ID (PID), the percentage of total CPU cycles a process used within the last 2 s...

4: Configuration Using Web Manager XPort AR User Guide 64 Note: The Adobe SVG plug-in is required to view the CPU Load Graph. Hardware The Hardware window displays basic hardware information and allows for the modification of the CPU speed. To display the XPort AR’s hardware diagnostics: 1. Click Di...

4: Configuration Using Web Manager XPort AR User Guide 65 Figure 4-51. System To configure the XPort AR’s system settings: 1. Click System from the navigation menu. The System window opens. 2. Configure the XPort AR’s system using the following fields: Reboot Device Click Reboot to reboot the XPort ...

XPort AR User Guide 66 5: Configuration Using Telnet or Serial Port Configure the XPort AR so that it can communicate on a network with your serial device. For example, set the way the unit responds to serial and network traffic, how it handles serial packets, and when to start or close a connection...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 67 Navigating the Command Line Interface Commands at the root level (top level) of the CLI do not affect current configuration settings. Commands within the Enable menu (and its sub-menus) modify the XPort AR’s configuration. Items wit...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 68 XPort AR CLI Level Hierarchy

5: Configuration Using Telnet or Serial Port XPort AR User Guide 69 Root Configuration Menu Top level root commands do not alter the configuration of the XPort AR. Clrscrn Clears the screen. Enable Displays the Enable level prompt. Within this menu, changes can be written to the XPort AR. For the li...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 70 Enable Menu The following sections describe the configurable parameters within the Enable configuration menu. Auto show interfaces Displays interface statistics. Auto show processes Continuously displays thread runtime information. ...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 74 Write Store and apply current configuration into permanent memory. Xcr dump Display the XML configuration to the console. For more information on XML, see XML on page 134 . Xcr dump <group list> Display a specified XML configu...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 75 Cc <email address> Enter the email address to which the alert email is CC’ed. Separate multiple addresses with a semi-colon. Chem 2 Displays the Chem 2 menu for configuration. Chem 3 Displays the Chem 3 menu for configuration....

5: Configuration Using Telnet or Serial Port XPort AR User Guide 78 Configure Menu The following sections describe the configurable parameters within the Configure menu. Arp <ip address> <mac address> Address Resolution Protocol (ARP) maps an IP address to a device’s MAC address. The arp...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 80 Hostname <string> Set the system hostname. If 1 Display the Interface 1 menu. For more information on serial port configuration, see Interface 1 Level Menu on page 88 . Ip domain name <string> Set the default domain name...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 88 Snmp-server enable traps Enable traps on the SNMP server. Snmp-server host <ip address> Set the primary SNMP trap host. Snmp-server host <ip address> <ip address> Set the primary and secondary SNMP trap hosts. Snmp...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 89 Dhcp renew Force DHCP to renew. Exit Exit the Interface menu and returns to the Enable menu (see Enable Menu on page 70 ). IP address <ip address/bits> Set the IP address and netmask. Enter the netmask in CIDR notation. IP add...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 91 PPP Menu The following section describes the configurable parameters within the Point-to-Point Protocol (PPP) configuration menu. For more information on PPP, see Point-to-Point Protocol (PPP) on page 119 . Note: The following secti...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 92 Ppp enable Enables PPP. Show Displays the current PPP configuration. Username <username> password <password> Sets the PPP authentication username and password. Write Store and apply current configuration into permanent m...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 93 Disable <group> Disable a group and make all CPs available. Enable <group> Enable a disabled CP group. Exit Exit the CPM menu and return to the Enable menu (see Enable Menu on page 70 ). Get <group> Display the val...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 94 Show history Show previously-entered commands. Write Write runtime configuration to permanent storage. Device Menu The following section describes the configurable parameters within the Device configuration menu. Clrscrn Clears the ...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 95 Short name <name> Set the XPort AR’s short name, displayed in Command Mode and the Web Manager. The string is a maximum 8 characters. Show Displays system information. Show buffer pool Displays information on buffer pools. Sho...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 96 Dvt eeprom Configure non-destructive DVT of Electrically-Erasable Programmable Read-Only Memory (EEPROM). EEPROM is a non-volatile storage chip used in computers and other devices. Dvt ethernet <host> <port> Configure no...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 97 Cp <source file> <destination file> Create a copy of an existing file. The first string parameter is the original file, the second string parameter is the name for the copied file. Dump <file> Display the contents ...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 103 Xoff <character definition> Sets the xoff character. Xon <character definition> Sets the xon character. SSH Menu The following sections describe the configurable parameters within the SSH configuration menus. For more i...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 106 No host user <user> Remove a host user. Show Show SSH settings. Show client server <server> Show client server RSA and DSA keys. Show client user <user> Show information for a client user. Show host dsa Show the f...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 107 Show history Displays previously-entered commands. Show ssl Displays the SSL certificate information. Ssl Adds a SSL certificate and private key. Ssl <certificate> <private> Adds a SSL certificate and private key. Ssl g...

5: Configuration Using Telnet or Serial Port XPort AR User Guide 118 Write Stores and apply current configuration into permanent memory.

7: Tunneling XPort AR User Guide 123 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. It is possi...

7: Tunneling XPort AR User Guide 124 The XPort AR 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. Note: Configure either the IP address using the address on its own (&...

XPort AR User Guide 125 8: SSH and SSL Security The XPort AR supports Secure Shell (SSH) and Secure Sockets Layer (SSL). These security protocols are configurable through the Web Manager (see SSH Settings on page 42 and SSL Settings on page 46 ) and Command Mode (see SSH Menu on page 103 and SSL Men...

8: SSH and SSL Security XPort AR User Guide 126 b) 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 very long key generation time....

XPort AR User Guide 128 9: 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. Via the Web Manag...

9: Using Email XPort AR User Guide 129 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 XPriority...

XPort AR User Guide 131 10: 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 s...

10: Configuration Pin Manager XPort AR User Guide 132 State A value of 1 means asserted. 0 means de-asserted. I indicates the CP is inverted. Groups Indicates the number of groups in which the CP is a member. Active In Group A CP can be a member of several groups. However, it may only be active in o...

XPort AR User Guide 134 11: XML The XPort AR supports configuration using Extensible Markup Language (XML). XML’s main purpose is to assist the transmission of data across different systems. Two things are required for XML: ‹ It must be well-formed. The XML structure must adhere to general XML forma...

11: XML XPort AR User Guide 135 The XPort AR’s schema (or template), is structured as following: The ELEMENT tag ‹ The XML document element is known as a <configrecord>; this is the root element. ‹ Within each <configrecord> are the configuration groups, contained within the <configgr...

11: XML XPort AR User Guide 136 Figure 11-2. XML Example With Multiple Named Values <?xml version=”1.0” standalone=”yes”?> <configgroup name = "ssh server"> <configitem name = "host rsa keys"> <value name = "public key"></value> <value name = ...

11: XML XPort AR User Guide 137 Configure an XPort AR with XML using the following steps: 1. Configure an XPort AR with the desired settings using the Web Manager (see Configuration Using Web Manager on page 17 ) or the Command Mode (see Configuration Using Telnet or Serial Port on page 66 ). 2. Exp...

XPort AR User Guide 150 12: Branding the XPort AR The XPort AR’s Web Manager and Command Mode (CLI) are customizable. Web Manager Customization Customize the Web Manager’s appearance by modifying the following files: Note: To view these files, open the http Æ config folder using the Filesystem Brows...

XPort AR User Guide 151 13: Updating Firmware Obtaining Firmware Obtain the most up-to-date firmware and release notes for the unit from the Lantronix Web site (http://www.lantronix.com/) or by using anonymous FTP (ftp://ftp.lantronix.com/). Loading New Firmware Reload the firmware using the XPort A...

XPort AR User Guide 152 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-7...

XPort AR User Guide 153 B: Binary to Hexadecimal Conversions Many of the unit’s configuration procedures require you to assemble a series of options (represented as bits) into a complete command (represented as a byte). The resulting binary value must be converted to a hexadecimal representation. Us...

XPort AR User Guide 155 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 standard...

XPort AR User Guide 156 Warranty Lantronix warrants each Lantronix product to be free from defects in material and workmanship for a period of TWO YEARS after the date of shipment. During this period, if a customer is unable to resolve a product problem with Lantronix Technical Support, a Return Mat...