Instruction/ maintenance manual of the product XPort AR Lantronix
Go to page of 156
Part Number 900-405 Revision B November 2005 XPort AR User Guide.
XPort AR User Guide 2 Copyright & Trademark © 2005, Lantronix. All rights re served. No part of the cont ents of this book may b e transmitted or reproduced in any form or by any means without the written permi ssi on of Lantronix. Printed in the United States of America.
XPort AR User Guide 3 Contents Figures 7 Tables 8 1: Using This Guide 9 Purpose and Audience _______________________________________________ 9 Summary of Chapters _____________________________________.
Contents XPort AR User Guide 4 Line 1 Configuration _____________________________________________________ 26 Line 1 Command Mode ___________________________________________________ 27 Tunnel 1 and Tun.
Contents XPort AR User Guide 5 Buffer Pools____________________________________________________________ 62 Processes _____________________________________________________________ 63 Hardware__________.
Contents XPort AR User Guide 6 SSH Client Configuration ________________________________________________ 126 Secure Sockets Layer: SSL__________________________________________ 126 9: Using Email 128 .
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 Val ues .................................................................. 136 Figure 11-3. XML Example With Multip le Items ..................................................
XPort AR User Guide 9 1: Using This Guide Purpose and Audience This guide provides the inf ormatio n needed to configure, use, and update the XP ort AR™. It is intended for software developers a nd system integrators who a re embedding the XPort AR in their designs.
1: Using This Guide XPort AR User Guide 10 Additional Documentation The following guides are av ailable on th e 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 User Guide 11 2: Description and Specifications This chapter summari zes the XPort AR device server’s features and basic information needed before getting started.
2: Description and Specifications XPort AR User Guide 12 Time/attendance clocks and terminal s Protocol Support The XPort AR device server contains a full-featured TCP/IP stack.
2: Description and Specifications XPort AR User Guide 13 Web Manager : Through a web bro wser, configure the XPort AR’s settings using the Lantronix Web Manager.
2: Description and Specifications XPort AR User Guide 14 Product Information Label The product information label on the under side of the unit contain s the following information about the specific unit: Bar code Serial number Product ID (name) Part number Hardware address (MAC addre ss) Figure 2-2.
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 need ed to locate the XPort AR using DeviceI nstaller.
3: Using DeviceInstaller XPort AR User Guide 16 Extended Firmware Version Provides additional informatio n on the firmware version. Online Status Non-configurable field. Displa y s the XPort AR’s status as online, offline, unreachable (the XPort AR is on a different subnet), or busy (the XPort A R is currently performing a task).
XPort AR User Guide 17 4: Configuration Usi ng Web Manager This chapter describe s how to config ure the XPort AR using Web Manager, Lantronix’s browser-based conf iguration tool. The unit’s configuration is stored in nonvolatile memory and is retained without power.
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 displaye d allow for the config uration of the general network setting s, protocol stack, DNS, SNMP, FTP, TFTP, IP address filter, and the query port.
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 Client is set to On.
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 mo re defin ed i n each packet. RST is one of the control bits. The RST bit is responsible for telling the rece iving T CP stack to immediately end a connection.
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 ent ries in the ARP table. Remove Removes a specific entry from the ARP table.
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.
4: Configuration Using Web Manager XPort AR User Guide 23 Figure 4-6. SNMP Configur ation 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.
4: Configuration Using Web Manager XPort AR User Guide 24 Figure 4-7. FT P Configuration 2. Enter or modify the following fields: FTP FTP Server Select On to enab le the F T P server. Username Enter the username to use when log gin g in via FTP. Password Enter the password to use when loggi ng 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.
4: Configuration Using Web Manager XPort AR User Guide 26 supported. For more information on DeviceInstaller, see Using De viceInstall er on page 15 . To configure the query port serv er: 1. Click Network Æ Query Port from the navigation menu. The Query Port window opens to display the current configuration.
4: Configuration Using Web Manager XPort AR User Guide 27 Figure 4-11. Li ne 1 Configura tion 2. Enter or modify the following fields: Status Displays the whether the current line is en abled. To change the status, select Enabled or Disabled from the pull-down menu.
4: Configuration Using Web Manager XPort AR User Guide 28 Figure 4-12. Line 1 Comman d Mode 2. Enter or modify the following fields: Alw ays Select Yes to enable the XPort AR’s comman d mode. Use Serial String Select Yes to start command mode based on a seria l string .
4: Configuration Using Web Manager XPort AR User Guide 29 accept mode, disconnect mode, packi ng mode, start and stop characters, and modem emulation. Note: The following section describ es the step s to configure Tunnel 1; these st eps also apply to Tunnel 2 menu option s .
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 tunn eling of data received.
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 upo n receiving a character. Start Character enables conn ect mode upon receiving the start character.
4: Configuration Using Web Manager XPort AR User Guide 32 Figure 4-16. T unnel 1 Acc ept Mode 2. Enter or modify the following fields: Mode Select Disabled to disable Accept Mode complete ly.
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 use d when the connection is closed. 3. Click Submit . Changes are applied immediately to the XPort AR.
4: Configuration Using Web Manager XPort AR User Guide 34 To configure the tunnel’s packing mo de: 1. Select Tunnel 1 Æ Packing Mode from the navigation menu. The Tunnel 1 Packing Mode window di splays. Figure 4-18. Tunnel 1 Packing Mode 2. Enter or modify the following fields: Mode Select Disabled to disable Packing Mo de completely.
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 eit her ASCII or hexadecimal notation.
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 mode m command mode Echo Commands Select On to echo the modem commands to the console. Verbose Respon se Codes Select On to send modem respons e codes out on the serial line.
4: Configuration Using Web Manager XPort AR User Guide 37 2. Enter or modify the following fields: Enc r ypt Ke y Enter the value for each byte. From the pull-do wn menu, select the format for the byte as either character, hexadecimal, or decimal notation.
4: Configuration Using Web Manager XPort AR User Guide 38 2. Enter or modify the following fields: Enc r ypt Ke y Enter the value for each byte. From the pull-do wn menu, select the format for the byte as either character, hexadecimal, or decimal notati on.
4: Configuration Using Web Manager XPort AR User Guide 39 Current Configuration CP Indicates the Configurable Pin number. Pin # Indicates the hardware pin number associate d w ith the CP. Configured A s Displays the CPs configuratio n. A CP configured as Input is set to read input.
4: Configuration Using Web Manager XPort AR User Guide 40 CPM: Groups The CP Groups page allows for the man agement of CP group s. Create a CP group and add CPs to it. A group, based on its state, triggers outside events (su ch a s sending email messages).
4: Configuration Using Web Manager XPort AR User Guide 41 Value Displays the CP group’s current value. Bit Visual display of the 32 bit placeh olders for a CP. I/O A “+” symbol indicates the CP’s bit position is asserted (the voltage is high).
4: Configuration Using Web Manager XPort AR User Guide 42 SSH Settings Secure Shell (SSH) is a protocol used to acce ss a remote comput er over a n encrypted channel. It is a protocol for m anaging the security of data transmission over the Internet. It provides encr yption, authentication, and message integ rity services.
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 at least 1024 bits.
4: Configuration Using Web Manager XPort AR User Guide 44 SSH Client Known Hosts To configure the SSH client’s kno wn hosts: 1. Click SSH Æ Client Known Hosts from the navigation menu. The SSH Client: Known Hosts window di spl ays. Figure 4-27. SSH Client: Know n Hosts 2.
4: Configuration Using Web Manager XPort AR User Guide 45 Figure 4-28. SSH Client: Users 2. Enter or modify the following fields: Username Enter the XPort AR’s username for use when connecting to the server. Password Enter the password associated with the username.
4: Configuration Using Web Manager XPort AR User Guide 46 SSL Settings Secure Socket Layer (SSL) is a protoc ol for managing the security of data transmission over the Internet. It prov ides encryption, authenticati on, and message integrity services.
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 certific ate, enter the following informat ion: Create New Self-Signed Certificate Country Enter the 2-letter country code.
4: Configuration Using Web Manager XPort AR User Guide 48 Figure 4-31. Command L i n e Interface Configuration 2. Enter or modify the following fields: Telnet Access Select On to enable Telnet access. Telnet is enable d b y default. Telnet Port Enter the Telnet port to use for Telnet access.
4: Configuration Using Web Manager XPort AR User Guide 49 Figure 4-32. HTTP Statistics HTTP Configuration To configure HTTP: 1. Click HTTP Æ HTTP Configura tion fro m the navigation menu.
4: Configuration Using Web Manager XPort AR User Guide 50 2. Enter or modify the following fields: HTTP Server Select On to enable the HTT P 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.
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 . Require d with the URI field.
4: Configuration Using Web Manager XPort AR User Guide 52 To configure HTTP RSS settings: 1. Click HTTP Æ RSS from the navigatio n 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 RSS feeds to an RSS p ublisher.
4: Configuration Using Web Manager XPort AR User Guide 53 Figure 4-36. Import System Configuration 2. Use one of the following methods to import the XCR file: a) To import an XCR file fr om the filesyste m, select Import XCR file from the filesystem and enter the filename on the XPort AR containin g the file to import.
4: Configuration Using Web Manager XPort AR User Guide 54 Export System Configuration To export and store an XPort AR’s configura tion: 1. Click XML Æ Export from the navigation menu. The X ML: Export System Configuration window op ens. Figure 4-37.
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. (T o view these files or store them elsewhere, see Filesystem Configuration on page 56 .
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 al erts will be sent. CC Enter the email address to which the email al erts will be CC’ed. From Enter the email address to list in the From field of the email alert.
4: Configuration Using Web Manager XPort AR User Guide 57 To compact or format the XPort AR’s filesy stem: 1. Click File syste m from the navigation menu. T he Filesystem windo w ope ns and displays the current filesy stem statistics and usage. 2. To compact the files, cli ck Compact .
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 th e curre nt directory view.
4: Configuration Using Web Manager XPort AR User Guide 59 Diagnostics Configuration The XPort AR has several tools for diagnosti cs and statistics. Select the Diagnostics link on the left menu bar to display the Diagnostics menu.
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 men u. The Diagnostics: Ping window opens. Figure 4-44. Dia gnostics: Ping 3. Enter or modify the following fields: Host Enter the IP address for the XPort AR to ping.
4: Configuration Using Web Manager XPort AR User Guide 61 Traceroute To use traceroute from the XPort AR: 1. Click Diagnostics Æ Trac eroute from the navigation menu. The Diagnostics: Traceroute window opens. Figure 4-45. Dia gnostics: Tra ceroute 2.
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.
4: Configuration Using Web Manager XPort AR User Guide 63 Figure 4-48. Diagnos tics: Buffer Pools Processes The XPort AR Processes window displ ays all the processes curr ently runnin g on the system.
4: Configuration Using Web Manager XPort AR User Guide 64 Note: The Adobe SVG plug-in is required to view the CPU Load Gr aph. Hardware The Hardware window di splays basic hard wa re information and allows for the modification of the CPU speed. To display the XPort AR’s hardware diagnostics: 1.
4: Configuration Using Web Manager XPort AR User Guide 65 Figure 4-51. System To configure the XPort AR’s system setting s: 1. Click System from the navigation men u. The System window opens. 2. Configure the XPort AR’s sys tem using the following fields: Reboot Device Click Reboot to reboot the XPort AR.
XPort AR User Guide 66 5: Configuration Usi ng T elnet or Serial Port Configure the XPort AR so that it can co mmunicate on a network with your serial device. For example, set the way the unit responds to seri al and n etwork traffic, how it handles serial packets, and when to st art 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 m enu (and its sub-menus) modify the XPort AR’s configuration.
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 configu ration of the XPort AR. Clrscrn Clears the screen. Enable Displays the Enable level prompt. Within this menu, cha nges can be written to the XPort AR.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 70 Enable Menu The following sections describ e the configurable parameters within the Enable configuration menu. Auto show interfaces Displays interface statis tics. Auto show processes Continuously displays thread runtim e information.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 71 Clear query port counters Sets to zero the Query Port counters. Clear ssh <session> Ends an active SSH session on the XPort AR. Clear telnet <session> Ends an active Telnet session on the XPort AR.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 72 Line3 Displays the Line 3 menu for serial port 3 configuration. For more informatio n on serial port configuration, see Line Menu on page 99 . No clear interfaces counters Reverts the interface counters to the la st aggregate value.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 73 Show history Displays previously entered comm and s. Show hosts Displays the domain settings. Show interfaces Displays network interface statis tics. Show ip sockets Displays TCP and UDP state information and their a ssociated ports.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 74 Write Store and apply current configuration into permane nt memory. Xcr dump Display the XML configuration to the cons ole. For more information on XML, see XML on page 134 . Xcr dump <group list> Display a specified XML configuration to the console.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 75 Cc <email address> Enter the email address to which the aler t email is CC’ed. Separate multiple addresses with a semi-colo n. Chem 2 Displays the Chem 2 menu for configuration.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 76 No cc Clears the CC field in the email. No clear mail counters Reverts the mail counters to the last aggregate value . No cp send Disable the CP trigger used to send the email. No file Removes the file used for the body of the email.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 77 Priority urgent Sets the email priority level to urgent. Displa ys as urgent priority if recipi ent’s em ail supports email priority settings. Co rresponds to X-Pr iority level 1. Priority very low Sets the email priority level to very low.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 78 Configure Menu The following sections describ e the confi gurable parameters within the Configur e menu. Arp <ip address> <mac address> Address Resolution Protocol (ARP) ma ps an IP address to a device’s MAC addre ss.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 79 Clear ip counters Set the IP counters to zero. Clear ip ssh counters Set the SSH counters to zero. Clear ip telnet counters Set the Telnet counters to zero. Clear rss Clears the RSS feed data.
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 inform ation on serial port configuration, see Interface 1 Level Menu on page 88 . Ip domain name <string> Set the default domain name on the XPort AR.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 81 IP http auth type <uri> ssl-basic Set the authentication type for an HTTP server authen tication directive to SSL-Basic. IP http auth type <uri> ssl-digest Set the authentication type for an HTTP server authen tication directive to SSL- Digest.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 82 IP icmp enable Allow the transmission and retrieval of In ternet Control Message Protocol (I CMP) packets. Ip name-server <ip address> Set the primary DNS server. Ip name-server <ip address> <ip address> Set the primary and secondary DNS servers.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 83 No clear ftp counters Revert the FTP counters to the last aggregate value. No clear ip ssh counters Revert the IP SSH counters to the last aggregate value. No clear ip telnet counters Reverts the IP Telnet counters to the last aggregate value.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 84 No ip http auth log Disables HTTP server loggi ng. No ip http auth log format Removes the log format string for the HTTP server. No ip http server Disables the HTTP server. No ip icmp enable Prevents the sending or retrieval of ICM P packets.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 85 No rss enable Disables the RSS feed. No rss persistent Disables RSS feed data persistence.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 86 Password Set the new password. Prompts for a pass word then requests password verification. Password <string> Enter the password on one line. Ppp 1 Display the PPP menu for serial port 1.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 87 Show ip Show IP statistics. Show rss Show the RSS feed settings. Show snmp-server Display SNMP server se ttings. Show ssh Display IP SSH configuration. Show telnet Display Telnet configuration.
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.
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.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 90 No ip default-gateway Remove the default gateway. Show Show interface settings. Show history Display previously-entered comma nd s. Show ip address filter Display the IP filter table.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 91 PPP Menu The following section describe s the configurab le parameters within the Point-to-Point Protocol (PPP) configuration menu. For more information on PPP, see Point-to-Point Protocol (PPP) on page 119 .
5: Configuration Using Telnet or Serial Port XPort AR User Guide 92 Ppp enable Enables PPP. Show Displays the curren t PPP configuration. Username <username> password <password> Sets the PPP authentication username a nd password. Write Store and apply current configuration into permane nt memory.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 93 Disable <group> Disable a group and make all CPs availa ble. Enable <group> Enable a disabled CP group. Exit Exit the CPM menu and return to the Enable menu (see Enable Menu on page 70 ).
5: Configuration Using Telnet or Serial Port XPort AR User Guide 94 Show history Show pre viously-entered co mmands. Write Write runtime configuration to permanent storag e. Device Menu The following section describe s the confi gurable parameters within the Device configuration menu.
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 a nd the Web Manager. The string is a maximum 8 characters. Show Displays system information. Show buffer pool Displays information on buffer pools.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 96 Dvt eeprom Configure non-destructive DVT of Electr ically-Erasabl e Programma ble Read-Only Memory (EEPROM). EEPROM is a non-vola tile storage chip used in computers and other devices.
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 param eter is the name for the copied file.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 98 Show Show filesystem stat istics. Show history Show previously entered commands. Show tree Show all filesystem files and directories. Tftp get ascii <source file> <destination file> <host> Obtain an ASCII file using TFTP.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 99 Tftp put binary <source file> <destination file> <host> Send a binary file using TFTP. Tftp put binary <source file> <destination file> <host> <port> Send a binary file using TFTP.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 100 Command mode serial string Set command mode to use serial settings. Command mode serial string <string> Set command mode serial string using ASCII characters. Command mode serial string binary <string> Set command mode serial string using binary value s.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 101 No clear line counters Reverts the serial counte rs to the last aggregate value. Line 2 Displays the Line 2 menu. Line 3 Displays the Line 3 menu No command mode Disables command mode.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 102 Parity odd Set the XPort AR’s parity to odd. Show Display the XPort AR’s settings. Show command mode Show Command Mode set t ings. Show line Show line settings. Show statistics Show line statistics.
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 describ e the configurable parameters within the SSH configuration menus.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 104 Client user <user> generate rsa 512 Generate RSA public and private key s. Client user <user> generate rsa 768 Generate RSA public and private key s. Clrscrn Clears the screen.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 105 Host generate rsa 768 Generate RSA public and private keys. Host user <user> <password> Sets the host username and password. Host user <user> <password> <key> Sets the host username, password and a publi c key.
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.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 107 Show history Displays previously-entered comm and s. Show ssl Displays the SSL certificate informatio n. Ssl Adds a SSL certificate and private key. Ssl <certificate> <private> Adds a SSL certificate and private key.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 108 Accept any character Enable accept mode upon the receptio n of a character. Accept block network Block the tunneling of network data. Accept block serial Block the tunneling of serial data.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 109 Accept protocol telnet Use Telnet (IAC) for accept mode. Accept start character Enable accept mode on recepti on of the start-chara cte r. Clear accept counters Set to zero the accept counters.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 110 Connect any character Enable connect mode on reception of a chara cter. Connect block network Block the tunneling of network data. Connect block serial Block the tunneling of serial data.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 111 Connect protocol ssh Use SSH for connect mode. Connect protocol tcp Use TCP fo r connect mode. Connect protocol tcp aes Use AES over TCP for connect mode. Connect protocol udp Use UDP for connect mode.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 112 Disconnect stop character Enable disconnect mode to disconne ct on reception of the stop character. Disconnect timeout Enable disconnect mode to disconne ct on a timeout. Disconnect timeout <number> Set disconnect mode time out in milliseconds.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 113 Modem echo pluses Echo +++ when entering m odem comma nd mode. Modem error unknown commands Returns an error upon unknown AT command s. Modem numeric response codes Use numeric response cod es.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 114 No accept keep alive Disable TCP keepalives. No accept port Use a random port number as the local port. No clear accept counters Unzeros accept counte rs. No clear aggregate counters Unzeros aggregate counte r s.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 115 No connect flush serial data Do not flush serial data buffer on connection. No connect keep alive Disable TCP keepalives. No connect port Use a random port number as the local port. No connect remote address Remove remote address to connect to.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 116 No modem echo pluses Do not echo +++ when entering modem comm and mode. No modem verbose Use decimal status codes. No packing mode Disable packing mode. No packing send character Remove the send charact er.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 117 Packing threshold <bytes> Set the threshold (byte count). Packing timeout <milliseconds> Set the timeout value in milliseconds. Packing trailing character <string> Set the trailing character.
5: Configuration Using Telnet or Serial Port XPort AR User Guide 118 Write Stores and apply current confi guration into permanent memory..
XPort AR User Guide 119 6: Point-to-Point Protocol (PPP) Point-to-Point Protocol (PPP) establishes a direct connec tion between two nodes. It defines a method for data link connectivity between devices u sing physical layers (such as serial lines). Some of t he PPP features include: error detection, compression, and authent ication.
XPort AR User Guide 120 7: T unneling Serial tunneling allows for devices to communicate ov er a netwo rk, without the realization of other devices conn ecting between them. Tunneling parameters are configured using the Web Manager’ s Tunnel 1 and Tunnel 2 Settings (on page 28 ) or Command Mode’s Tunn el Menu (on page 107 ).
7: Tunneling XPort AR User Guide 121 When setting AES encryption, both the encr ypt key and the decrypt key must be specified. The encrypt key is used for da ta sent out. The decrypt key is used for receiving data. Both of the keys may be set to the same value.
7: Tunneling XPort AR User Guide 122 Telnet/IAC mode (The XPort AR currently supports IA C codes. It drops the IAC codes when telnetting and does not forwa rd them to the serial port).
7: Tunneling XPort AR User Guide 123 Modem Emulation The XPort AR supports Modem Emulation mode fo r device s that send out modem signals. There are two different mo des supported: Command Mode: sends b a c k verbal respon s e codes. Data Mode: information transferred in is also transfe rred out.
7: Tunneling XPort AR User Guide 124 The XPort AR attempts to make a Command Mode conne ction as per the IP/DNS/port numbers defined in Conne ct Mode. It is possible to override the remote address, as well as the remote port number. Note: Configure either the IP address usi ng the address on its own (<xxx.
XPort AR User Guide 125 8: SSH and SSL Security The XPort AR supports Secure Shell (SSH) and Se cure Sockets Layer (SSL). These security protocols are confi gurable through the Web Manager (se e SSH Settings on page 42 and SSL Settings on page 46 ) and Command Mode (see SSH Menu on page 103 and SSL Menu on page 10 6 ).
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 Bi t Size from the Create Ne w Keys sect ion. Click Submit to create ne w private an d public host keys. Note: Generating new ke ys with a large bit size results in very long key generation time.
8: SSH and SSL Security XPort AR User Guide 127 Alternatively, it can be automat ically generated on the device; this certificate type is a self-signed certificate. Note: When uploading the certificate and t he private key, ensure the pri vate key is not compromised in transit.
XPort AR User Guide 128 9: Using Email The XPort AR has a Simple Mail Transfer Prot ocol (S MTP) client. SMTP is a TCP/IP protocol used in sending and re ceiving email. Its objective is to send email efficiently and reliably. There are three ways to send an email from the XPort AR: 1.
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; ce rtai n recipient systems have filters based on these priority levels.
9: Using Email XPort AR User Guide 130 Use the “Show Log” command to displa y 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 se rver to the XPort AR.
XPort AR User Guide 131 10: Configuration Pin Manager There are 11 configurable pins o n the XPort AR. All CPs (except for 5) are shared by some other function on the XPort AR.
10: Configuration Pin Manager XPort AR User Guide 132 State A value of 1 means asserted. 0 means de-a s serted. 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.
10: Configuration Pin Manager XPort AR User Guide 133 i. Enter a group name in the Crea te Gr oup 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.
XPort AR User Guide 134 11: XML The XPort AR supports conf iguration using Extensib le Markup Language (XML). XML’s main purpose is to assist the tran sm issio n of data across dif ferent systems. Two things are required for XML: It must be well-formed.
11: XML XPort AR User Guide 135 The XPort AR’s schema (or template ), is structured as follo w i ng: The ELEMENT tag The XML document element is known as a <configre cord>; this is the root element. Within each <configreco rd> are the conf iguration groups, containe d within the <configgroup> element.
11: XML XPort AR User Guide 136 Figure 11-2. XML Example W i th Mu ltiple Named Values <?xml version=”1.0” standalone=”yes”?> <configgroup name = "ssh server"> <config.
11: XML XPort AR User Guide 137 Configure an XPort AR with XML using the following step s: 1. Configure an XPort AR with the desired settings using the Web Manager (see Configuration Using We b Manager on page 17 ) or the Command Mode (see Configuration Using Telnet or Serial Port on page 66 ).
11: XML XPort AR User Guide 138 schema manually to ensure the XPort AR reboots aft er applying the XML configuration. These are labeled as Impo rt in the Import/Export column in the following table: Table 11-1.
11: XML XPort AR User Guide 139 Group Name Item Name Value Name Value Import/Export Additional Information 100 Import and Export Specify the speed on the Ethernet connection (10 or 100). Only valid if auto- negotiation is not enabled. half Import and Export Specify the duple x of the Ethernet connection.
11: XML XPort AR User Guide 140 Group Name Item Name Value Name Value Import/Export Additional Information enable Import and Export state disable Import and Export baud rate Import and Export Any value from 300 to 230400.
11: XML XPort AR User Guide 141 Group Name Item Name Value Name Value Import/Export Additional Information arp delete Import Remove an entry from the ARP table.
11: XML XPort AR User Guide 142 Group Name Item Name Value Name Value Import/Export Additional Information disable Import and Export max log entries Import and Export log format Import and Export disa.
11: XML XPort AR User Guide 143 Group Name Item Name Value Name Value Import/Export Additional Information remote address Import and Export remote port Import and Export tcp Import and Export udp Impo.
11: XML XPort AR User Guide 144 Group Name Item Name Value Name Value Import/Export Additional Information local port Import and Export tcp Import and Export tcp aes Import and Export ssh Import and E.
11: XML XPort AR User Guide 145 Group Name Item Name Value Name Value Import/Export Additional Information disable Import and Export disable Import and Export timeout Import and Export packing mode se.
11: XML XPort AR User Guide 146 Group Name Item Name Value Name Value Import/Export Additional Information private key Import and Export username Import and Export password Import and Export public rsa key Import and Export authorized users public dsa key Import and Export authorized users delete Import and Export Delete an SSH authorized user.
11: XML XPort AR User Guide 147 Group Name Item Name Value Name Value Import/Export Additional Information enable Import and Export persist disable Import and Export max entries Import and Export realm Import and Export Attribute of "instance" specifies the uri.
11: XML XPort AR User Guide 148 Group Name Item Name Value Name Value Import/Export Additional Information peer ip Import and Export network mask Import and Export authentication mode Import and Expor.
11: XML XPort AR User Guide 149 Group Name Item Name Value Name Value Import/Export Additional Information system Import This group specifies the passwords to use when importing an XCR using the CLI capture feature. The system value specifies the root password used if the root level is password protected.
XPort AR User Guide 150 12: Branding the XPort AR The XPort AR’s Web Manager and Co mmand Mode (CLI) are customizabl e. Web Manager Customization Customize the Web Manager’ s app earanc e by modifying the following files: Note: To view these files, open the http Æ config folder using the Filesystem Browser.
XPort AR User Guide 151 13: Updating Firmware Obtaining Firmware Obtain the most up-to-date firmware an d release notes for the unit from the Lantronix Web site (http: //www.lantronix .com/) or by using a nonymous FTP (ftp://ftp.lantronix.com/). Loading New Firmware Reload the firmware using the XPort AR’s Web Mana ger’s System window.
XPort AR User Guide 152 If you are experiencing an error that is not des cribed i n this user guide, or if you are unable to fix the error, you may: Check our online kn owledge base at http:// www.
XPort AR User Guide 153 B: Binary to Hexadecimal Conversions Many of the unit’s configurat ion procedures require you to assemble a series of options (represented as bits) into a comp lete comma nd (represent ed as a byte). The resulting binary value must be conv erted to a hexadecimal representation.
B: Binary to Hexadecimal Conversions XPort AR User Guide 154 1. On the Windows’ Start menu, click Programs Æ Accessor ies Æ Calculator . 1. On the View menu, select Scientific . The scientific calculator displ ays. 2. Click Bin (Binary), and type the number you wa nt to convert.
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 9261 8 USA Declares that .
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 shipm ent. During this period, if a customer is unable to resolv e a product problem with Lantronix Tech nical Support, a Return Material Authorization (R MA) will be issued.
An important point after buying a device Lantronix XPort AR (or even before the purchase) is to read its user manual. We should do this for several simple reasons:
If you have not bought Lantronix XPort AR yet, this is a good time to familiarize yourself with the basic data on the product. First of all view first pages of the manual, you can find above. You should find there the most important technical data Lantronix XPort AR - thus you can check whether the hardware meets your expectations. When delving into next pages of the user manual, Lantronix XPort AR you will learn all the available features of the product, as well as information on its operation. The information that you get Lantronix XPort AR will certainly help you make a decision on the purchase.
If you already are a holder of Lantronix XPort AR, but have not read the manual yet, you should do it for the reasons described above. You will learn then if you properly used the available features, and whether you have not made any mistakes, which can shorten the lifetime Lantronix XPort AR.
However, one of the most important roles played by the user manual is to help in solving problems with Lantronix XPort AR. Almost always you will find there Troubleshooting, which are the most frequently occurring failures and malfunctions of the device Lantronix XPort AR along with tips on how to solve them. Even if you fail to solve the problem, the manual will show you a further procedure – contact to the customer service center or the nearest service center
