Home

Lantronix LX6 User's Manual

1. Stores the current configuration in permanent memory Clears the screen connection value number Sets the value to output to the CP Group upon connect mode connection number binary to output typically 1 or 0 default connection value Restores the default value for connect mode connection default disconnection value Restores the default value for connect mode disconnec tion disconnection value number Sets the value to output to the CP Group upon connect mode disconnection number binary to output typically 1 or 0 group text Configures the CP Group to set upon making or breaking a connect mode connection XPort amp Pro Lx6 Embedded Device Server Command Reference 45 5 Commands and Levels show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory cirscrn Clears the screen connection value number Sets the value to output to the CP Group upon accept mode connection number binary to output typically 1 or 0 default connection value Restores the default value for accept mode connection default disconnection value Restores the default value for accept mode disconnection disconnection value number Sets the value to output to the CP Group upon accept mode disconnection number binary to output typically 1 or 0 group text Configures the CP Group to set upon making or breaking an a
2. aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics show connection statistics clrsern Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout exit Exits to the next higher level no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout port lt number gt Sets the remote port to use for connect mode tunneling lt number gt number of the port to use XPort amp Pro Lx6 Embedded Device Server Command Reference 58 5 Commands and Levels protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protoc
3. cp group Attribute of an instance is Line1 RS485 TxE nable cp group Attribute of an instance is Line RTS CTS device diagnostics discovery dns email Attribute of instance is a number ethernet Attribute of an instance is ethO ftp server cp Attribute of an instance is 2 state cp Attribute of an instance is 1 cp Attribute of an instance is 3 state firmware version long name serial number short name log state ipv6 precedence login password cc cp from local port message file overriding domain priority reply to server port subject to duplex speed state assert low bit type assert low bit type assert low bit type output max length group trigger value 4 Configuration Using XML enable disable enable disable enable disable enable disable amp 60 None amp 62 normal 25 enable disable XPort Pro Lx6 Embedded Device Server Command Reference Default disable Default disable 7 5 0 0R20 Lantronix XPort Pro Lx6 07110977T800R2 XPort Pro Lx6 Default enable 21 http authentication uri http server icmp interface Attribute of an instance is ethO realm type user delete user Attribute of an instance is admin authentication timeout log format logging state max bytes max log entries max timeout port state state s
4. and Levels flush serial disable Does not flush serial data upon closing a tunneling con nection flush serial enable Flushes serial data buffer when a tunneling connection is closed flush stop character disable Forwards the stop character from the Line to the network flush stop character enable Prevents the stop character from the Line from being for warded to the network modem control disable Does not watch the modem control pin to disconnect modem control enable Watches the modem control pin and disconnects if it is not i NAME no no stop character character Removes the Removes the stop character character no timeout Disables disconnect after timeout feature for tunneling sessions show history Displays the last 20 commands entered during the current CLI session stop character lt control gt Sets the stop character The character may be input as text control decimal or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF timeout lt milliseconds gt Disconnects when no data has been received on the line serial port for the specified length of time lt milliseconds gt timeout in milliseconds Stores the current configuration in permanent memory show history Displays the last 20 commands entered during the current CLI session show statistics Displays statistics and information about the discovery
5. byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics show connection statistics clrscrn Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout exit Exits to the next higher level no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections XPort amp Pro Lx6 Embedded Device Server Command Reference 72 5 Commands and Levels no tcp keep alive Disables the connect mode TCP keep alive timeout port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet i Telnet protocol with IAC for connect mode t
6. decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number 30 4 Configuration Using XML snmp Forwarding decimal number DefaultTTL decimal number InReceives decimal number InHdrErrors decimal number InAddrErrors decimal number ForwDatagrams decimal number InUnknownProtos decimal number InDiscards decimal number InDelivers decimal number OutRequests decimal number OutDiscards decimal number OutNoRoutes decimal number ReasmTimeout decimal number ReasmReqds decimal number ReasmOKs decimal number ReasmFails decimal number FragOKs decimal number FragFails decimal number FragCreates decimal number netstat InTruncatedPkts decimal number InMcastPkts decimal number OutMcastPkts decimal number InBcastPkts decimal number OutBcastPkts decimal number InNoRoutes decimal number ip sockets ip socket protocol tcp or udp rx queue decimal number tx queue decimal number local address local port remote address remote port state ip address in format nnn nnn nnn nnn decimal number ip address in format nnn nnn nnn nnn decimal number or LISTEN SYN RECVD SYN SENT ESTABLISHED CLOSE WAIT LAST ACK FIN WAIT 1 FIN WAIT 2 CLOSING or TIME WAIT XPort amp Pro Lx6 Embedded Device Server Command Reference 31 4 Configuration Using XML line Attribute of instance receiver bytes is lt decimal gt parity errors framin
7. document XPort Pro Lx6 Embedded Device Server Command Reference 2 Table of Contents Copyright and Trademark 2 Contacts 2 Disclaimer 2 Revision History 2 List of Figures 4 List of Tables 5 About This Guide 6 Chapter Summaries 6 Conventions 6 Additional Documentation 7 Overview XML Architecture and Device Control 8 Command Line Interface 8 Command Line Interface 9 Configuration Using Telnet 9 Configuration Using the Serial Port 9 Navigating the CLI Hierarchy 10 Using Keyboard Shortcuts and CLI 11 Understanding the CLI Level Hierarchy 11 Configuration Using XML 14 XML Configuration Record Document Type Definition 14 Quick Tour of XML Syntax 15 Declaration 15 Element Start and End Tags 15 Element Attributes 15 Record Group Item and Value Tags 16 Importing and Exporting an XML Configuration File 18 Best Practices 18 Importing 19 Exporting 19 XML Configuration Groups 20 XML Status Record Groups and Items 28 5 Commands and Levels 38 XPort Pro Lx6 Embedded Device Server Command Reference 3 List of Figures Figure 3 2 CLI Level Hierarchy Figure 3 3 Login Level Commands Figure 3 4 Enable Level Commands Figure 4 1 DTD for XCRs Figure 4 2 XML Example Figure 4 3 XML Example Figure 4 4 XML Example of Multiple Named Values Figure 4 5 XML Example of Multiple Items Figure 4 6 XML Example with Multi
8. email alert upon establishing a connect mode tunnel number the number of the email profile to use email disconnect number Sets an email profile to use to send an email alert upon closing a connect mode tunnel number the number of the email profile to use flush serial disable Characters already in the serial data buffer are retained upon establishing a connect mode tunneling connection flush serial enable Flushes the serial data buffer upon establishing a connect mode tunneling connection flush start character disable Enables forwarding of the connect start character into the network flush start character enable Disables forwarding of the connect start character into the network host instance Enters the next lower level Specify the instance for the next lower level host mode sequential Connects to the first host in the list that accepts the con nection host mode simultaneous Selects simultaneous connections to all hosts on the host list kill connection Disconnects the active connect mode tunneling connec tion or connections XPort amp Pro Lx6 Embedded Device Server Command Reference 43 5 Commands and Levels local port number Sets a specific port for use as the local port number the number of the port to use no email connect Discontinues sending email alerts upon establishing a connect mode tunnel no email disconnect Discontinues sending email alerts upon closing a connect
9. encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes encrypt key text text Sets the accept tunnel AES encrypt key with up to 16 bytes XPort amp Pro Lx6 Embedded Device Server Command Reference 39 5 Commands and Levels Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces block network disable Forwards tunnels network data in accept mode tunnel ing block network enable Discards all data coming in from the accept mode tunnel before forwarding it to the serial interface generally used for debugging block serial disable Restores the default priority for the interface block serial enable Sets the priority for interface number priority number cp output Enters the next lower level default accept mode Restores the default accept mode as always default local port Uses the default port number as the local port for accept mode tunneling The default port is 10000 where is the line number for this tunnel default protocol Restores the default protocol as TCP default start character Defaults the accept mode start character default tcp keep alive Restores the default 45 second accept mode TCP keep alive timeout email connect n
10. in the history Ctrl p Displays the previous line in the history Ctrl u Deletes entire line and places cursor at start of prompt Ctrl w Deletes one word back Ctrl z Exits the current CLI level Esc b Moves cursor back one word Esc f Moves cursor forward one word Understanding the CLI Level Hierarchy The CLI hierarchy is a series of levels Arranging commands in a hierarchy of levels provides a way to organize and group similar commands provide different levels of security and reduce the complexity and number commands and options presented to a user at one time When you start a command line session you begin at the login level This level can be password protected and provides access to high level status a few diagnostic commands and the enable level Further device information and configuration are accessed via the enable level The enable level can also be password protected and is the gateway to full configuration and management of the device server There are commands for gathering and effecting all elements of device status and configuration as well as commands that take you to additional levels For instance tunnel specific status and configuration is found under the tunnel level and network specific status and configuration commands are found under the configuration level XPort amp Pro Lx6 Embedded Device Server Command Reference 11 3 Command Line Interface An overview of the levels in the XPort Pro Lx6 e
11. is a number xml import control echo pluses echo commands verbose response response type error unknown commands incoming connection connect string display remote ip packing mode timeout threshold send character trailing character dtr restore factory configuration cpm group delete delete cpm groups delete http authentication uris http authentication uri delete reboot name 4 Configuration Using XML enable disable enable disable enable disable text numeric enable disable disabled automatic manual enable disable disable timeout send character asserted while connected continuously asserted unasserted truport enable disable enable disable enable disable enable disable XPort amp Pro Lx6 Embedded Device Server Command Reference Default disable Default enable Default enable Default text Default disable Default disabled Default disable Default disable Default 1000 milliseconds Default 512 bytes Accepts a control character for example amp 60 control amp 62 A represents control A Default lt control gt M Accepts a control character for example amp 60 control amp 62 A represents control A Default asserted while connected Deletes existing HTTP authentication URIs before importing new ones Deletes the specified HTTP authentication URI Reboots after importing 27 XML Status Record G
12. key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces show connection statistics Clears the screen Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunnel con nections Disables the connect mode TCP keep alive timeout Sets the remote port to use for connect mode tunneling number number of the
13. mode tunnel promote host number Promotes the identified host exchanging it place with the host above it to adjust the order of the defined hosts reconnect time lt milliseconds gt Sets the reconnect time value for tunneling connections established by the device in milliseconds lt milliseconds gt timeout in milliseconds show history Displays the last 20 commands entered during the current CLI session start character lt control gt Sets the connect mode start character The character may be input as text control decimal or hex A control character has the form lt control gt C A decimal value character has the form 99 A hex value character has the form OxFF Stores the current configuration in permanent memory cirscrn Clears the screen group text Specify a CP group that shall trigger an email text configurable pin group Disables the trigger to send an email no trigger value Clears the value that shall trigger an email show history Displays the last 20 commands entered during the current CLI session trigger value number Specify a value of the CP group that shall trigger an email number numeric value to watch for from the CP group Can be specified as hex if prepended with Ox Stores the current configuration in permanent memory group text Specify a CP group that shall trigger an email text configurable pin group no trigger value Clears the value that shall
14. port to use Uses TCP protocol for connect mode tunneling Uses TCP protocol with AES encryption for connect mode tunneling Uses Telnet protocol with IAC for connect mode tunnel ing Uses UDP protocol for connect mode tunneling Uses UDP protocol with AES encryption for connect mode tunneling XPort amp Pro Lx6 Embedded Device Server Command Reference 57 5 Commands and Levels show history D the last 20 commands entered during the current T X a session showstalisics statistics showconnection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces
15. signon message wait time relay address relay port state host remote port severity log level state port max sessions authentication 4 Configuration Using XML always serial string disable enable disable enable disable none emergency alert critical error warning notice information debug enable disable enable disable XPort amp Pro Lx6 Embedded Device Server Command Reference Default disable Default enable Sets a string that can be entered at boot time to enter command mode This text may specify binary characters Within use binary decimal up to 255 or hex up to OxFF Within specify decimal milliseconds time delay Sets a sign on message that is sent from the serial port when the device boots and when the line is in command mode This text may specify binary characters Within use binary decimal up to 255 or hex up to OxFF Default 5000 milliseconds Default disable Default 514 Default none Default enable Default 23 Default 3 Default disable 24 terminal Attribute of instance is a number or network tunnel accept Attribute of instance is a number terminal type login connect menu exit connect menu send break break duration echo accept mode start character flush start character local port protocol tcp keep alive aes encrypt key aes decrypt key flush serial block serial bloc
16. to exit to the CLI exit connect menu enable On the login connect menu inserts the menu item allow ing the user to exit to the CLI line line Enters the line level lt line gt number of the line serial port to be configured login connect menu disable Disables the login connect menu so a user will get the CLI immediately after logging in login connect menu enable Enables the login connect menu so a user will get the menu rather than the CLI immediately after logging in Shows the layout of the connect menu with current set tings send break control Sets the optional send break character text the character The character may be input as text control decimal or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF show history Displays the last 20 commands entered during the current CLI session terminal line Enters the configure terminal level XPort amp Pro Lx6 Embedded Device Server Command Reference 84 5 Commands and Levels line number of the terminal line serial port to be configured terminal network Enters the configure terminal level for the network terminal type text Sets the terminal type tunnel line Enters the tunnel level line number of the tunnel line serial port to be con figured Stores the current configuration in permanent memory break duration l
17. 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces XPort amp Pro Lx6 Embedded Device Server Command Reference 73 5 Commands and Levels qe 00 no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet no Telnet protocol with IAC for connect mode tunnel protocol udp Uses UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode oot show history e the last 20 commands entered during the current oC E session Show statistics statistics show connection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connec
18. BC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains 68 5 Commands and Levels aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port show connection statistics Clears the screen Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep ali
19. LANT ONIX Xprort Pro Lx Embedded Device Server Command Reference Part Number 900 689 R Revision A December 2013 Copyright and Trademark 2013 Lantronix Inc All rights reserved No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix Lantronix and XPort are registered trademarks of Lantronix Inc in the United States and other countries Devicelnstaller is a trademark of Lantronix Inc U S Patents 6 881 096 7 018 242 Additional patents pending Windows and Internet Explorer are a registered trademarks of Microsoft Corporation Mozilla and Firefox are registered trademarks of the Mozilla Foundation Chrome is a trademark of Google Inc Opera is a trademark of Opera Software ASA Corporation Norway All other trademarks and trade names are the property of their respective holders Contacts Lantronix Inc Corporate Headquarters 167 Technology Drive Irvine CA 92618 USA Toll Free 800 526 8766 Phone 949 453 3990 Fax 949 453 3995 Technical Support Online www lantronix com support Sales Offices For a current list of our domestic and international sales offices go to the Lantronix web site at www lantronix com about contact Disclaimer The information in this guide may change without notice The manufacturer assumes no responsibility for any errors that may appear in this guide Revision History December 2013 A Initial
20. Server Integration Guide Pro Lx6 into your product Devicelnstaller Online Help Instructions for using the Lantronix Windows based utility to locate the XPort Pro Lx6 and to view its current settings XPort amp Pro Lx6 Embedded Device Server Command Reference 2 Overview XPort Pro Lx6 embedded device server supports three convenient configuration methods Web Manager Command Line Interface CLI and Extensible Markup Language XML For more information about the Web Manager see the XPort Pro Lx6 Embedded Device Server User Guide on the Lantronix website XML Architecture and Device Control XML is a fundamental building block for the future growth of Machine to Machine M2M networks XPort Pro Lx6 embedded device server supports XML configuration records that make configuring the device server easy for users and administrators XML configuration records are easy to edit with a standard text editor or an XML editor For a brief overview of XML see Chapter 4 Configuration Using XML It provides rules on basic XML syntax a guide to the specific XML tags used and a guide to using XML configuration records Command Line Interface Making the edge to enterprise vision a reality the XPort Pro Lx6 embedded device server uses industry standard tools for configuration communication and control For example the XPort Pro Lx6 uses a command line interface CLI whose syntax is very similar to that used by data center equipment such as rout
21. a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics show connection statistics clrsern Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout exit Exits to the next higher level no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout port lt number gt Sets the remote port to use for connect mode tunneling lt number gt number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encry
22. ace in the Reply To field of the email alert Sends an email using the current settings se ort number Sets the port used by the SMTP server number port used for SMTP on the server side tistics show history Displays the last 20 commands entered during the current CLI session rver p subject text Sets the Subject for email alerts text text to placed as the subject to text Sets To addresses for email alerts text a quoted semicolon separated list of email ad dresses Stores the current configuration in permanent memory auto show statistics Continuously displays email statistics cc text Sets Cc addresses for email alerts text a quoted semicolon separated list of email ad dresses clear mail counters Sets the email counters to zero cirscrn Clears the screen XPort amp Pro Lx6 Embedded Device Server Command Reference 52 5 Commands and Levels default local port Sets the local port used to send email alerts to random default priority Sets X Priority for email alerts to 3 normal default server port Restores the factory default port for SMTP on the server side from text Sets the From address for email alerts text email address to place in the From field of the email alert local port number Sets the local port used to send email alerts number local port to use for email alerts message file text Specifies a text file the contents of which w
23. aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet Tm Telnet protocol with IAC for connect mode tunnel protocol udp Tem UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode we show history D the last 20 commands entered during the current TIC o A A session showstalisics statistics showconnection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional p
24. ains spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces auto show statistics show connection statistics clrsern Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout exit Exits to the next higher level no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con eee no tcp no tep keep alive alive Disables the connect mode TCP Disables the connect mode TCP keep alive timeout alive timeout port lt number gt Sets the remot
25. al or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF show history Displays the last 20 commands entered during the current CLI session threshold bytes Sets the threshold byte count If the queued data reach es this threshold then the data will be sent bytes number of bytes in the threshold timeout lt milliseconds gt Sets the timeout value for packing mode in milliseconds milliseconds timeout value in milliseconds trailing character control Sets the trailing character for packing mode The character may be input as text control decimal or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF Stores the current configuration in permanent memory Removes the password so connections will be accepted XPort amp Pro Lx6 Embedded Device Server Command Reference 81 5 Commands and Levels b nehallenged password text Sets the password required on the network side of the tunnel to begin a connection prompt disable Inhibits any prompting for password on the network side of the tunnel prompt enable Sets up so a user on the network side of the tunnel will be prompted for a password show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent me
26. alive timeout exit Exits to the next higher level no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout XPort amp Pro Lx6 Embedded Device Server Command Reference 65 5 Commands and Levels port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet n Telnet protocol with IAC for connect mode tunnel protocol udp Uses UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling show history Displays the last 20 commands entered during the current CLI session show statistics show connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer milliseconds timer value in milliseconds Stores the current configuration in permanent memory address text Sets the remote host to establish tunneling connections with text IP address or host name of the remote host aes de
27. and Reference ip address in format nnn nnn nnn nnn decimal number decimal number decimal number decimal number decimal number decimal number 33 4 Configuration Using XML netstat RtoAlgorithm RtoMin RtoMax MaxConn ActiveOpens PassiveOpens AttemptFails EstabResets CurrEstab InSegs OutSegs RetransSegs InErrs OutRsts SyncookiesSent SyncookiesRecv SyncookiesFailed EmbryonicRsts PruneCalled RevPruned OfoPruned OutOfWindowlcmps LockDroppedicmps ArpFilter TW TWRecycled TWkilled PAWSPassive PAWSActive PAWSEstab DelayedACKs DelayedACKLocked DelayedACKLost ListenOverflows ListenDrops TCPPrequeued TCPDirectCopyFromBacklo g TCPDirectCopyFromPreque ue TCPPrequeueDropped TCPHPHits XPort amp Pro Lx6 Embedded Device Server Command Reference decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number 34 tcp
28. ards all data coming in from the serial interface before forwarding it to the connect mode tunnel generally used for debug ging XPort amp Pro Lx6 Embedded Device Server Command Reference 42 5 Commands and Levels cirscrn Clears the screen connect mode always Enables the tunneling server to always establish tunneling connections connect mode any character Enables the tunneling server to establish a tunneling con nection when a character is received on the corresponding line serial port connect mode disable Disables connect mode tunneling connect mode modem control asserted Enables the tunneling server to make tunneling connec tions when the modem control pin is asserted connect mode modem emulation Enables modem emulation for connect mode tunneling connect mode start character Enables connect mode tunneling when the configured start character is received on the line cp output Enters the next lower level default connect mode Restores the default connect mode as disable default host mode Connects to the first host in the list that accepts the con nection default local port Uses a random port number as the local port for establish ing tunneling connections to other devices default reconnect time Restores the default reconnect time value for connect mode tunneling default start character Defaults the connect mode start character email connect number Sets an email profile to use to send an
29. ars the screen Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunnel con nections Disables the connect mode TCP keep alive timeout Sets the remote port to use for connect mode tunneling number number of the port to use Uses TCP protocol for connect mode tunneling Uses TCP protocol with AES encryption for connect mode tunneling Uses Telnet protocol with IAC for connect mode tunnel ing Uses UDP protocol for connect mode tunneling Uses UDP protocol with AES encryption for connect mode tunneling Shows the current configuration Displays the last 20 commands entered during the current CLI session show connection statistics Enables TCP keep alive for connect mode tunneling and sets the timer milliseconds timer value in milliseconds Stores the current configuration in permanent memory Sets the remote host to establish tunneling connections with text IP address or host name of the remote host Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123A
30. ask Sets the IPv6 address and network prefix length Formats accepted 3456 abcd 456 de10 64 address and prefix length Enables support for stateless autoconfiguration of IPv6 addresses Sets the Maximum Transmission Unit MTU size XPort Pro Lx6 Embedded Device Server Command Reference 76 5 Commands and Levels show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory default ip time to live Restores the default IP time to live default multicast time to live Restores the default IP multicast time to live which is one hop ip time to live lt hops gt Sets the IP time to live known by SNMP as ipDefaultTTL lt hops gt number of hops that a typical IP packet is al lowed to live multicast time to live lt hops gt Sets the IP multicast time to live lt hops gt number of hops that a multicast IP packet is allowed to live show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory auto show statistics Continuously displays line statistics baud rate lt bits per second gt Sets the line speed lt bits per second gt the speed Standard speeds include 1200 2400 4800 9600 19200 and so on clear line counters Sets the serial counters to zero clrsern Clears the screen command mode always Sets the current line to always be in command m
31. atistics Clears the screen efault protocol Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunnel con nections Disables the connect mode TCP keep alive timeout 3rTs 5 olol loi o olo o v Sle h oO g I olo o o Q c 3lo alan amp 3 2 sie g 8 E alo iz o lt x o D gjg 2 x x o a v S xq 31 oO Sets the remote port to use for connect mode tunneling lt number gt number of the port to use Uses TCP protocol for connect mode tunneling Uses TCP protocol with AES encryption for connect mode tunneling Uses Telnet protocol with IAC for connect mode tunnel ing Uses UDP protocol for connect mode tunneling Uses UDP protocol with AES encryption for connect mode tunneling show history Displays the last 20 commands entered during the current CLI session show statistics show connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Wite 00 Stores the current configuration in permanent memory address text Sets the remote host to establish tunneling connec
32. be started by pasting a valid XCR directly into the CLI prompt The XPort Pro Lx6 embedded device server immediately processes the configuration record changing any settings specified This can be done on any level including the root Special tags in the XML allow for providing root and enable level passwords so that this can also be done at the password prompt Web browser Web Manager can be used to import and export an XCR to the device server file System It can also be used to import an XCR from an external source such as your local hard drive FTP The device server FTP server can export and import XCRs when an FTP get or put command for the filename xport pro Ix6 xcr for export xport pro Ix6 import xcr for import both are under the pwxcr directory is requested On export FTP get of xport pro Ix6 xcr the FTP server obtains the current XCR from the XPort Pro Lx6 and sends it as a file On import FTP put of xport pro Ix6 import xcr the FTP server processes the file by sending it directly to the XML engine In both cases the device server filesystem is not accessed The files xport pro Ix6 xcr and xport pro Ix6 import xcr are not read from or written to the file system See FTP in the XPort Pro Lx6 Embedded Device Server User Guide Best Practices You can import or export an entire XCR or just a portion of it by specifying the group name and or group instances In the examples below import and export operations are performed
33. ccept mode connection text CP Group show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory add cp to group Adds the specified CP to the specified group cp configurable pin group the name of the group to which you want to add the CP add cp to group bit Adds a specified CP to a specified group at a specified bit position cp configurable pin group the name of the group to which you want to add the CP bit bit position cirscrn Clears the screen create group Creates a configurable pin CP group group the name for the new group delete cp from group Removes a CP from a specified group and sets the CP to its default configuration of input cp configurable pin group the name of the group delete group Removes a group and resets all CPs in that group to the default configuration of input group the name of the group disable group Disables the specified group group the name of the group XPort amp Pro Lx6 Embedded Device Server Command Reference 46 enable group exit get group Set cp as input Set cp as input assert low set cp as output set cp as output assert low set group value show group show cp show groups show history write auto show tlog clrscrn exit show sh
34. continued 4 Configuration Using XML netstat continued TCPHPHitsToUser TCPPureAcks TCPHPAcks TCPRenoRecovery TCPSackRecovery TCPSACKReneging TCPFACKReorder TCPSACKReorder TCPRenoReorder TCPTSReorder TCPFullUndo TCPPartialUndo TCPDSACKUndo TCPLossUndo TCPLoss TCPLostRetransmit TCPRenoFailures TCPSackFailures TCPLossFailures TCPFastRetrans TCPForwardRetrans TCPSlowStartRetrans TCPTimeouts TCPRenoRecoveryFail TCPSackRecoveryFail TCPSchedulerFailed TCPRcvCollapsed TCPDSACKOldSent TCPDSACKOfoSent TCPDSACKRecv TCPDSACKOfoRecv TCPAbortOnSyn TCPAbortOnData TCPAbortOnClose TCPAbortOnMemory TCPAbortOnTimeout TCPAbortOnLinger TCPAbortFailed TCPMemoryPressures TCPSACKDiscard TCPDSACKIgnoredOld decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number TCPDSACKIgnoredNoUndo decimal number XPort amp Pro Lx6 Embedded Device Server Command Refe
35. crypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics show connection statistics clrscrn Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout XPort amp Pro Lx6 Embedded Device Server Command Reference 66 5 Commands and Levels no address Removes the remote host address used to establish tun neling connections no
36. cter control Sets the accept mode start character The character may be input as text control decimal or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF tcp keep alive lt milliseconds gt Enables TCP keep alive for accept mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory add lt P address gt MAC address gt Adds an entry to the ARP table mapping an IP address to a MAC address lt ip address gt IP address to be mapped lt mac address gt MAC address in colon separated form cirscrn Clears the screen remove ip P address Removes an entry from the ARP cache ip address address of the entry being removed show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory default inactivity timeout The default inactivity timeout will apply to CLI sessions default login password Restores the default CLI login password Restores the default string to quit the connect line telnet and ssh commands XPort amp Pro Lx6 Embedded Device Server Command Reference 41 5 Commands and Levels quit connect line control Sets the string used to quit the connect line telnet and ssh commands The characters may be input as text or control A cont
37. dded Device Server Command Reference 75 show history state disable state enable write cirscrn exit show history show neighbors write bootp disable bootp enable clrscrn default gateway lt P address gt default mtu dhcp client id lt text gt dhcp disable dhcp enable dhcpv6 disable dhcpv6 enable domain lt text gt exit hostname lt text gt ip address lt ip address cidr gt ipv6 address ip address prefix_length gt ipv6 autoconf enable ipv6 default gateway IP address link mtu bytes no default gateway no dhcp client id no domain no hostname 5 Commands and Levels Displays the last 20 commands entered during the current CLI session Prevents ICMP packets from being sent or received Allows ICMP packets to be sent and received Stores the current configuration in permanent memory Clears the screen Exits to the configuration level Displays the last 20 commands entered during the current CLI session Displays IPv6 neighbor cache Stores the current configuration in permanent memory Disables BOOTP Enables BOOTP Clears the screen Sets the configurable gateway IP address to the default value Restores the default Maximum Transmission Unit MTU size text name of the domain text name of the host Sets the IP address and network mask Formats accepted 192 168 1 1 default mask 192 168 1 1 24 CIDR 192 168 1 1 255 255 255 0 explicit m
38. decimal number String 28 InErrors InDestUnreachs InTimeExcds InParmProbs InSrcQuenchs InRedirects InEchos InEchoReps InTimestamps InTimestampReps InAddrMasks InAddrMaskReps OutMsgs OutErrors OutDestUnreachs OutTimeExcds OutParmProbs OutSrcQuenchs OutRedirects OutEchos OutEchoReps OutTimestamps OutTimestampReps OutAddrMasks OutAddrMaskReps XPort amp Pro Lx6 Embedded Device Server Command Reference 4 Configuration Using XML decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number 29 4 Configuration Using XML interface Attribute of instance is ethO XPort amp Pro Lx6 Embedded Device Server Command Reference default gateway ip address ipv6 addresses ipv6 default gateway generic network mask receive transmit ip source ip source status bytes packets errs drop fifo frame compressed multicast bytes packets errs drop fifo colls carrier compressed dotted notation dotted notation linkup dotted notation decimal number decimal number decimal number decimal number decimal number decimal number decimal number
39. e current configuration in permanent memory Ws EmesteDNSiwl iperf lt params gt Run iperf with command line parameters passed in quot ed string kill telnet lt session gt Kills Telnet session with index from show sessions lt line gt number of the line serial port to be configured show history Displays the last 20 commands entered during the current CLI session trace route lt host gt lt protocol gt tunnel line Enters the tunnel level line number of the tunnel line serial port to be con figured XPort amp Pro Lx6 Embedded Device Server Command Reference 54 5 Commands and Levels Stores the current configuration in permanent memory Show al fs and directories inthe curent drecioy show history Displays the last 20 commands entered during the current CLI session show history Displays the last 20 commands entered during the current CLI session address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc XPort amp Pro Lx6 Embedded Device Server Command Reference 55 5 Commands and Levels Note that quotes must enclose the value if it cont
40. e last character Kills command mode session on the Line lt line gt number of the line serial port to be configured no command mode signon message Clears the signon message displayed at boot time and when entering command mode no gap timer Removes the gap timer so forwarding depends on the line speed Uses no protocol on the line XPort Pro Lx6 Embedded Device Server Command Reference 78 5 Commands and Levels show history Displays the last 20 commands entered during the current CLI session terminal line Enters the configure terminal level line number of the terminal line serial port to be configured terminal network Enters the configure terminal level for the network termination disable Refrains from terminating the line termination enable Enables 120 ohm line termination in RS485 half duplex mode threshold bytes Sets the threshold in bytes After this many bytes are re ceived they are forwarded without delay tunnel line Enters the tunnel level line number of the tunnel line serial port to be con figured Stores the current configuration in permanent memory xoff char control Sets the xoff character for use with software flow control on this line The character may be input as text control decimal or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF xon char cont
41. e name of a local file Removes the Cc addresses for email alerts no clear mail counters Restores the email counters to the aggregate values empty no reply to Removes the Reply To address for email alerts Removes subject used for email alerts XPort amp Pro Lx6 Embedded Device Server Command Reference 50 5 Commands and Levels Removes the To addresses for email alerts overriding domain text Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the device s domain name in EHLO text domain name to override the current domain name in EHLO priority high Sets X Priority for email alerts to 2 high priority low Sets X Priority for email alerts to 4 low priority normal Sets X Priority for email alerts to 3 normal priority urgent Sets X Priority for email alerts to 1 urgent priority very low Sets X Priority for email alerts to 5 very low reply to text Sets the Reply To address for email alerts text email address to place in the Reply To field of the email alert server port number Sets the port used by the SMTP server number port used for SMTP on the server side show history Displays the last 20 commands entered during the current CLI session show statistics Displays email statistics subject text Sets the Subject for email alerts text text to placed as the subject to text Sets To addresses for emai
42. e port to use for connect mode tunneling lt number gt number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet o Telnet protocol with IAC for connect mode tunnel protocol udp Uses UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling show history Displays the last 20 commands entered during the current CLI session show statistics show connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer milliseconds timer value in milliseconds Stores the current configuration in permanent memory XPort amp Pro Lx6 Embedded Device Server Command Reference 56 address text aes decrypt key lt hexadecimal gt aes decrypt key text text aes encrypt key lt hexadecimal gt aes encrypt key text text auto show statistics cirscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no tcp keep alive port number protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes 5 Commands and Levels Sets the remote host to establish tunneling connections with text IP address or host name of the remote host Sets the connect tunnel AES decrypt
43. echo commands and descriptions at the tunnel level To view the last 20 commands entered at the CLI Type show history XPort amp Pro Lx6 Embedded Device Server Command Reference 10 3 Command Line Interface Using Keyboard Shortcuts and CLI One useful shortcut built into XPort Pro Lx6 embedded device server is that the complete text of a command does not have to be entered to issue a command Typing just enough characters to uniquely identify a command then hitting enter can be used as a short cut for a command For example at the enable level sh can be used for the show command Tab Completion is also available using the Tab and Enter keys on the keyboard Typing the first few characters of a command then hitting the Tab key displays the first command that begins with those characters Hitting the Tab key again displays the next command that begins with the original characters typed You can press Enter to execute the command or you can backspace to edit any parameters The following key combinations are allowed when configuring the device server using the CLI Table 3 1 Keyboard Shortcuts Ctrl a Places cursor at the beginning of a line Ctrl b Backspaces one character Ctrl d Deletes one character Ctrl e Places cursor at the end of the line Ctrl f Moves cursor forward one character Ctrl k Deletes from the current position to the end of the line Ctrl I Redraws the command line Ctrl n Displays the next line
44. em takes the name attribute and must contain one or more value elements For example the line group might have parameters such as baud rate data bits and parity A value may specify the value of a configuration parameter It may contain the name attribute In this example a value of 9600 might be specified for baud rate 7 may be specified for data bits and even may be specified for parity A name attribute identifies the group item or value It is always quoted as are all XML attributes For example a group that contains serial port parameters has the name line An instance attribute identifies which of several instances is being addressed It is always quoted For example the serial port name in the line configgroup has the instance 1 to indicate serial port 1 or 2 to specify serial port 2 The following figures show examples of XML configuration records and the use of the lt configrecord gt configgroup lt configitem gt and value XML elements Figure 4 3 XML Example configgroup name arp gt configitem name arp delete value name ip address gt lt configitem gt Figure 4 4 XML Example of Multiple Named Values configgroup name cp group instance Linel Modem Ctl In gt configitem name cp instance 3 gt lt value name bit gt 0 lt value gt lt value name type gt input lt value gt lt value name assert low gt enable lt value gt lt configitem gt configitem name sta
45. ents and can have a version attribute A lt configgroup gt must have one or more lt configitem gt elements and can have name and instance attributes A lt configitem gt element must have one or more value elements and can have a name attribute A lt value gt element can have only data and can have a name attribute The name attribute identifies a group item or value It is always a quoted string The instance attribute identifies the specific option like the serial port number The instance attribute is always a quoted string XPort amp Pro Lx6 Embedded Device Server Command Reference 14 4 Configuration Using XML Note The name for each configgroup specified with the name attribute is the group name listed in the Web Manager XCR groups or with the xcr list CLI command See the XPort Pro Lx6 Embedded Device Server User Guide for more information about the XCR groups An empty or missing value element in each present lt configgroup gt clears the setting to its default Quick Tour of XML Syntax Declaration The first line lt xml version 1 0 standalone yes gt is called the XML declaration It is required and indicates the XML version in use normally version 1 0 The remainder of the file consists of nested XML elements some of which have attributes and content Element Start and End Tags An element typically consists of two tags a start tag and an end tag that surrou
46. er Command Reference 19 4 Configuration Using XML XML Configuration Groups Table 4 7 lists the XPort Pro Lx6 embedded device server XCR groups in alphabetical order This table indicates the various group items as well as some possible value names and options Note Any instance of amp 60 in the table may be read as less than and any instance of amp 62 may be read as greater than cli cp group Attribute of an instance is Line1 Modem Ctl In cp group Attribute of an instance is Out cp group Attribute of an instance is Line RS485 HDp x cp group Attribute of an instance is Line1 RS485 Sele ct arp delete arp entry inactivity timeout line authentication quit connect line cp Attribute of an instance is 3 state cp Attribute of an instance is 2 state state state Table 4 7 XCR Groups ip address ip address mac address assert low bit type assert low bit type enable disable enable disable enable disable enable disable enable disable XPort amp Pro Lx6 Embedded Device Server Command Reference Remove an entry from the ARP table Specify the entry by its IP address Default 15 minutes Default disable Accepts text containing control characters for example amp 60 control amp 62 A represents control A Default lt control gt L Default disable Default disable Default disable Default disable 20
47. ers and hubs For details of the CLI see Chapter 5 Commands and Levels It provides an index of the CLI Command Hierarchy with links to the corresponding command details The CLI provides commands for configuring monitoring and controlling the device server XPort amp Pro Lx6 Embedded Device Server Command Reference 8 3 Command Line Interface This chapter describes accessing the XPort Pro Lx6 embedded device server by using Telnet or serial ports to configure the device navigating the Command Line Interface CLI typing keyboard shortcuts and moving between the levels It contains the following sections e Configuration Using Telnet Configuration Using the Serial Port e Navigating the CLI Hierarchy Using Keyboard Shortcuts and CLI e Understanding the CLI Level Hierarchy Refer to Chapter 5 Commands and Levels for a complete list of levels commands and descriptions Configuration Using Telnet To access and configure the device server by using a Telnet session over the network you must first establish a Telnet connection You can also establish a Telnet connection by clicking the Telnet Configuration tab in the Devicelnstaller utility See the Devicelnstaller Online Help for more information available on our website www lantronix com support downloads To access the XPort Pro Lx6 embedded device server by using Telnet perform the following steps 1 Click Start Run The Run dialog box displays 2 Type c
48. es the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics show connection statistics clrscrn Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep
49. evels Provides an index of the CLI Command Hierarchy with hyperlinks to the corresponding command details Conventions The table below lists and describes the conventions used in this book Bold text Default parameters Italic text Required values for parameters Brackets Optional parameters Angle Brackets lt gt Possible values for parameters Pipe Choice of parameters Warning Warning Means that you are in a situation that could cause equipment damage or bodily injury Before you work on any equipment you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents Note Note Means take notice Notes contain helpful suggestions information or references to material not covered in the publication Caution Caution Means you might do something that could result in faulty equipment operation or loss of data Screen Font CLI terminal sessions and examples of CLI input Courier New XPort Pro Lx6 Embedded Device Server Command Reference 6 1 About This Guide Additional Documentation Visit the Lantronix website at www lantronix com support documentation for the latest documentation and the following additional documentation XPort Pro Lx6 Embedded Device Describes how to configure and use the XPort Pro Lx6 embedded Server User Guide device server XPort Pro Embedded Device Contains information about the hardware and integrating the XPort
50. from the CLI on the local filesystem and require a XCR on the local filesystem The Web Manager provides the same functionality Caution Using Microsoft Word to edit and save an XCR will change the format of the file and make it incompatible with XPort Pro Lx6 embedded device server This is true even if the file is saved as Plain Text txt or an XML Document xml Notepad a third party text editor or a specialized XML editor should be used instead XPort amp Pro Lx6 Embedded Device Server Command Reference 18 4 Configuration Using XML Importing The following syntax can be used to import configurations from a file xcr import lt file gt xcr import file groups and or group instances The first line imports all groups specified in the XML config record named in file Any filename is valid and the file name and extension are not important In the second line Instance follows group with a colon see the third example on the next page Multiple groups are separated with a comma Any white space requires the list of groups to be quoted Only the named groups get imported even if the XCR contains additional XCR groups The following syntax can be used to export configurations to a file on the device server s file system xcr export lt file gt xcr export file groups and or group instances gt The same guidelines above regarding importing configurations also apply to exporting configura
51. g errors overrun errors no receive buffer errors queued bytes flow control transmitter bytes breaks queued bytes flow control line levels cts rts dsr dtr line group nested within state line above protocol baud rate parity data bits stop bits flow control xon char xoff char memory main heap total memory available memory processes process Attribute of stack used instance is lt decimal gt sinc size cpu 96 thread name XPort amp Pro Lx6 Embedded Device Server Command Reference decimal number decimal number decimal number decimal number decimal number decimal number decimal number go stop or n a decimal number decimal number decimal number go stop or n a asserted or not asserted asserted or not asserted asserted or not asserted asserted or not asserted enable or disable Tunnel or None decimal bits per second None Odd or Even 7 0r8 10r2 None Hardware or Software of form amp amp 60 control amp amp 62 Q of form amp amp 60 control amp amp 62 S decimal number of bytes decimal number of bytes decimal number decimal number decimal number String 32 4 Configuration Using XML query port last connection ip address port in discoveries unknown queries erroneous packets out discovery replies errors status sessions line Attribute of an instance baud is a number data bits flow control parity stop bits XPort amp Pro Lx6 Embedded Device Server Comm
52. guration settings as an XML document known as an XML Configuration Record XCR An XCR can be imported or exported via the CLI a Web browser FTP or the device server filesystem An XCR can contain many configuration settings or just a few For example it might change all of the configurable parameters for a device server or it may only change the baud rate for a single serial line Using XCRs is a straightforward and flexible way to manage the configuration of multiple device server devices XML Configuration Record Document Type Definition An XML document type definition DTD is a description of the structure and content of an XML document It verifies that a document is valid XCRs are exported using the DTD as shown in Figure 4 1 DTD for XCRs Figure 4 1 DTD for XCRs lt DOCTYPE configrecord lt ELEMENT configrecord configgroup gt lt ELEMENT configgroup configitem configgroup gt lt ELEMENT configitem value gt lt ELEMENT value PCDATA gt lt ATTLIST configrecord version CDATA IMPLIED gt lt ATTLIST configgroup name CDATA IMPLIED gt lt ATTLIST configgroup instance CDATA IMPLIED gt lt ATTLIST configitem name CDATA IMPLIED gt lt ATTLIST value name CDATA IMPLIED gt The device server DTD rules state the following The XML document element is a lt configrecord gt element This is the root element A lt configrecord gt must have one or more lt configgroup gt elem
53. he current CLI session terminal lt ine gt Enters the configure terminal level lt line gt number of the terminal line serial port to be configured terminal network Enters the configure terminal level for the network XPort Pro Lx6 Embedded Device Server Command Reference 85 5 Commands and Levels terminal type text Sets the terminal type tunnel line Enters the tunnel level line number of the tunnel line serial port to be con figured Stores the current configuration in permanent memory line number of the line serial port to be configured show history Displays the last 20 commands entered during the current CLI session show statistics show connection statistics terminal line Enters the configure terminal level line number of the terminal line serial port to be configured terminal network Enters the configure terminal level for the network tunnel line Enters the tunnel level line number of the tunnel line serial port to be con figured Stores the current configuration in permanent memory cirscrn Clears the screen secret xcr dump Dump XML configuration containing secrets to the con sole secret xcr dump group list Dump specified XML configuration containing secrets to the console secret xcr export file Save XML configuration containing secrets to a file secret xcr export file group list Save specified XML configuration c
54. ill be the mes sage body of an email alert text the name of a local file Removes the Cc addresses for email alerts no clear mail counters Restores the email counters to the aggregate values Removes the file name so the message body will be empty no reply to Removes the Reply To address for email alerts Removes subject used for email alerts Removes the To addresses for email alerts overriding domain lt text gt Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the device s domain name in EHLO lt text gt domain name to override the current domain name in EHLO Sets X Priority for email alerts to 1 urgent reply to lt text gt Sets the Reply To address for email alerts lt text gt email address to place in the Reply To field of the email alert send Sendsanemailusing the current settings server port number Sets the port used by the SMTP server number port used for SMTP on the server side show history Displays the last 20 commands entered during the current CLI session show statistics Displays email statistics subject text Sets the Subject for email alerts text text to placed as the subject XPort amp Pro Lx6 Embedded Device Server Command Reference 53 5 Commands and Levels to text Sets To addresses for email alerts text a quoted semicolon separated list of email ad dresses Stores th
55. k network password email connect email disconnect password prompt 4 Configuration Using XML enable disable enable disable enable disable disable always enable disable tcp telnet tcp aes amp 60 None amp 62 enable disable enable disable enable disable enable disable amp 60 None amp 62 amp 60 None amp 62 XPort Pro Lx6 Embedded Device Server Command Reference Default UNKNOWN Default disable Default disable Accepts a control character for example amp 60 control amp 62 A represents control A Default 500 milliseconds Default enable Default always Accepts a control character for example amp 60 control amp 62 A represents control A Default lt control gt B Default enable Default 0 Default tcp Default 45000 milliseconds Value is SECRET hidden from user view Value is SECRET hidden from user view Default disable Default disable Default disable Value is SECRET hidden from user view Default disable Default lt None gt Default lt None gt 25 tunnel connect Attribute of instance is a number tunnel disconnect Attribute of instance is a number connect mode start character flush start character local port host Attribute of an instance is a number host mode reconnect time flush serial block serial block network email connect email disconnect st
56. l alerts text a quoted semicolon separated list of email ad dresses Stores the current configuration in permanent memory auto show statistics Continuously displays email statistics cc text Sets Cc addresses for email alerts text a quoted semicolon separated list of email ad dresses m mestenekwriw default local port Sets the local port used to send email alerts to random default priority Sets X Priority for email alerts to 3 normal default server port Restores the factory default port for SMTP on the server side from text Sets the From address for email alerts text email address to place in the From field of the email alert local port number Sets the local port used to send email alerts number local port to use for email alerts XPort amp Pro Lx6 Embedded Device Server Command Reference 51 5 Commands and Levels message file text Specifies a text file the contents of which will be the mes sage body of an email alert text the name of a local file empty Removes the To addresses for email alerts overriding domain text Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the device s domain name in EHLO text domain name to override the current domain name in EHLO Sets X Priority for email alerts to 2 high Sets the Reply To address for email alerts text email address to pl
57. l con nections Disables the connect mode TCP keep alive timeout Sets the remote port to use for connect mode tunneling number number of the port to use Uses TCP protocol for connect mode tunneling Uses TCP protocol with AES encryption for connect mode tunneling Uses Telnet protocol with IAC for connect mode tunnel ing Uses UDP protocol for connect mode tunneling Uses UDP protocol with AES encryption for connect mode tunneling Shows the current configuration Displays the last 20 commands entered during the current CLI session show connection statistics Enables TCP keep alive for connect mode tunneling and XPort amp Pro Lx6 Embedded Device Server Command Reference 70 5 Commands and Levels sets the timer lt milliseconds gt timer value in milliseconds write 00 Stores the current configuration in permanent memory address text Sets the remote host to establish tunneling connections with text IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by
58. l tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics tcp keep alive lt milliseconds gt 5 Commands and Levels Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces show connection statistics Clears the screen Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunne
59. mbedded device server is presented in Figure 3 2 CLI Level Hierarchy below login enable Figure 3 2 CLI Level Hierarchy configure cpm device dns email number JM e filesystem line line tunnel line accept cp output password connect disconnect modem packing serial xml cp output host number arp cli telnet diagnostics log discovery ftp http icmp icmpv6 ethernet link smtp syslog terminal line terminal network Commands at the login level see Figure 3 3 Login Level Commands below do not affect current configuration settings and are not displayed initially If you type you will see the login sub commands These commands provide diagnostic and status information only gt 22 clrscrn iperf lt params gt Figure 3 3 Login Level Commands ping host count ping6 lt host gt ping6 host count timeout show history trace route host protocol Note To configure the XPort Pro Lx6 embedded device server you must be in the exit ping host ping host count timeout ping6 host count show trace ro
60. md in the dialog box and press OK 3 Enter telnet command according to the type of device you are utilizing a Typetelnet x x x x x x x xis the IP address in a Windows Linux command prompt a Tologin through telnet using IPv6 address please use the below commands Typetelnet x x x x ethO0 x x x x is the IPv6 address in Linux machines Type telnet x x x x x x x xis the IPv6 address in Windows command prompt 4 The XPort Pro Lx6 embedded device server is online when the command prompt gt displays You are at the root level of the CLI Note Depending on the level of security a password may be required Configuration Using the Serial Port Serial Recovery Serial Recovery mode will temporarily override the line and tunnel settings for the serial line to allow configuration changes to be made The line and tunnel settings will be restored once the user exits the Serial Recovery mode CLI XPort amp Pro Lx6 Embedded Device Server Command Reference 9 3 Command Line Interface To configure the Lantronix device server locally using a serial port 1 Connect a terminal or a PC running a terminal emulation program to one of the device server s serial ports Configure the terminal to the following settings 9600 baud 8 bit No parity 1 stop bit 9 9 9 o No flow control Power off the device Press and hold down the exclamation point key Power on the device After about 15 seconds the exclamatio
61. mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes XPort amp Pro Lx6 Embedded Device Server Command Reference 61 5 Commands and Levels Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces show connection st
62. mory iperf lt params gt Run iperf with command line parameters passed in quot ed string show history Displays the last 20 commands entered during the current CLI session trace route lt host gt Trace route to destination trace route lt host gt lt protocol gt Trace route to destination using TCP ICMP or UDP default dtr Restores default DTR control asserted while connected dtr asserted while connected Asserts DTR whenever a connect or accept mode tunnel connection is active dtr continuously asserted Asserts DTR regardless of any connections dtr truport Asserts DTR to match remote DSR when connected via Telnet dtr unasserted Does not assert DTR show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory default relay port Restores the SMTP relay port to its default XPort Pro Lx6 Embedded Device Server Command Reference 82 5 Commands and Levels no relay address Removes the SMTP relay address relay address lt text gt Sets an SMTP relay address to direct all outbound email messages through a mail server relay port lt number gt Sets the SMTP relay port show history Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory Sets the address of the syslog recipient lt text gt IP address or name of the host remote port lt number gt Sets
63. n point will display on the terminal or PC screen Type xyz within 5 seconds to display the CLI prompt Navigating the CLI Hierarchy The CLI is organized into a hierarchy of levels Each level has a group of commands for a specific purpose For example to configure a setting for the FTP server one would navigate to the FTP level which is under the configuration level To move to a different level Enter the name of the level from within its parent level For example to enter the tunnel level type tunnel number at the enable prompt This displays enable tunnel lt number gt To exit and return to one level higher Type exit and press the Enter key Typing exit at the login level or the enable level will close the CLI session To view the current configuration at any level Type show To view the list of commands available at the current level Type the question mark Items within lt gt e g lt string gt are required parameters To view the available commands and explanations Type the asterisk To view the list of commands available for a partial command Type the partial command followed by the question mark For example lt tunnel 1 gt show displays a list of all echo commands at the tunnel level To view available commands and their explanations for a partial command Type the partial command followed by the asterisk For example lt tunnel 1 gt show displays a list of all
64. nds text and other elements element content The start tag consists of a name surrounded by angle brackets for example configrecord The end tag consists of the same name surrounded by angle brackets but with a forward slash preceding the name for example configrecord The element content can also contain other child elements Element Attributes The XML element attributes that are name value pairs included in the start tag after the element name The values must always be quoted using single or double quotes Each attribute name should appear only once in an element Figure 4 2 shows an XML example which consists of a declaration first line nested elements with attributes and content Figure 4 2 XML Example statusgroup name arp gt lt statusitem name arp entry lt value name ip address gt 172 19 39 17 lt value gt lt value name mac address gt 00 30 48 5B 6A A6 lt value gt lt value name type gt dynamic lt value gt value name interface gt eth0 lt value gt lt statusitem gt XPort Pro Lx6 Embedded Device Server Command Reference 15 4 Configuration Using XML Record Group Item and Value Tags A lt configgroup gt is a logical grouping of configuration parameters and must contain one or more configitem elements It must have a name attribute and may have an instance attribute A lt configitems is a specific grouping of configuration parameters relevant to its parent group An it
65. nect host 1 15 e host 16 tunnel connect host 1 16 disconnect tunnel disconnect 1 modem tunnel modem 1 packing tunnel packing 1 serial tunnel serial 1 e xml xml Table 5 1 Commands and Levels accept mode always Enables the tunneling server to always accept tunneling connections accept mode any character Enables the tunneling server to accept tunneling connec tions only when a character is received through the corresponding line seri al port accept mode disable Disables accept mode tunneling accept mode modem control asserted Enables the tunneling server to accept tunneling connec tions when the modem control pin is asserted accept mode modem emulation Enables modem emulation for accept mode tunneling accept mode start character Enables accept mode tunneling when the configured start character is received on the line aes decrypt key lt hexadecimal gt Sets the accept tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes decrypt key text text Sets the accept tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the accept tunnel AES
66. nt hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces auto show statistics show connection statistics clrscrn Clears the screen default protocol Restores the default protocol as TCP default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout exit Exits to the next higher level no address Removes the remote host address used to establish tun XPort amp Pro Lx6 Embedded Device Server Command Reference 59 5 Commands and Levels eo jP ingcomecions no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet a Telnet protocol with IAC for connect mode tunnel protocol udp Tem UDP p
67. o Lx6 Embedded Device Server Command Reference 63 address text aes decrypt key lt hexadecimal gt aes decrypt key text text aes encrypt key lt hexadecimal gt aes encrypt key text text auto show statistics clrsern default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no tcp keep alive port lt number gt protocol tcp protocol tcp aes protocol telnet protocol udp XPort Pro Lx6 Embedded Device Server Command Reference 5 Commands and Levels Stores the current configuration in permanent memory Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the val
68. ode command mode echo serial string disable Disables user defined serial boot string to be echoed in the CLI command mode echo serial string enable Enables user defined serial boot string to be echoed in the CLI command mode serial string Enables user to enter a custom string at boot time to enter command mode command mode serial string lt string gt Sets a string that can be entered at boot time to enter command mode lt string gt text with possible binary characters Within use binary decimal up to 255 or hex up to OxFF Within specify decimal milliseconds time delay XPort Pro Lx6 Embedded Device Server Command Reference 77 5 Commands and Levels command mode signon message lt string gt Sets a sign on message that is sent from the serial port when the device boots and when the line is in command mode lt string gt text with possible binary characters Within use binary decimal up to 255 or hex up to OxFF command mode wait time lt milliseconds gt Sets boot up wait time for command mode serial string lt milliseconds gt wait time configure cu ttings Configures line with the current value of settings e rrent se i i i ings Does not provide flow control on the line flow control software Uses software xon xoff characters flow control on the line gap timer lt milliseconds gt Sets the gap timer in milliseconds If some data has been received it will be forwarded after this time since th
69. ol with AES encryption for connect mode tunneling protocol telnet n Telnet protocol with IAC for connect mode tunnel protocol udp fee UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode we show history D the last 20 commands entered during the current icones session showstaisics statistics show connection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjace
70. ontaining secrets to a local file show history Displays the last 20 commands entered during the current CLI session XPort amp Pro Lx6 Embedded Device Server Command Reference 86 5 Commands and Levels XPort amp Pro Lx6 Embedded Device Server Command Reference 87
71. op character flush stop character modem control timeout flush serial address port protocol tcp keep alive aes encrypt key aes decrypt key 4 Configuration Using XML disable always any character start character modem control asserted modem emulation enable disable amp 60 Random amp 62 amp 60 None amp 62 tcp udp telnet tcp aes udp aes amp 60 None amp 62 sequential simultaneous enable disable enable disable enable disable amp 60 None amp 62 amp 60 None amp 62 enable disable enable disable enable disable XPort Pro Lx6 Embedded Device Server Command Reference Default disable Accepts a control character for example amp 60 control amp 62 A represents control A Default lt control gt B Default enable Default lt Random gt Default lt None gt Default tcp Default 45000 milliseconds Value is SECRET hidden from user view Value is SECRET hidden from user view Default sequential Default 15000 milliseconds Default disable Default disable Default disable Default lt None gt Default lt None gt Accepts a control character for example amp 60 control amp 62 A represents control A Default enable Default disable Default 0 milliseconds Default disable 26 tunnel modem Attribute of instance is a number tunnel packing tunnel serial Attribute of instance
72. ow hardware information show history show memory show task state show tlog write cirscrn exit show show history write cirscrn exit 5 Commands and Levels Enables a disabled group group the name of the group Exits to the enable level Displays the value of the specified group group the name of the group Configures a CP as an asserted high input cp configurable pin Configures a CP as an asserted low input cp configurable pin Configures a CP as an asserted high output cp configurable pin Configures a CP as an asserted low output cp configurable pin Assigns a value to the specified group group the name of the group value numeric value to assign to the CP group Can be specified as hex if prepended with Ox Displays group information for specified group group the name of the group Displays configuration and group information for all CPs Displays all groups defined and their state Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory Displays the last 20 commands entered during the current CLI session Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory Clears the screen Returns to the tunnel level XPort amp Pro Lx6 Embedded Device Server Command Reference 47 5 Commands
73. ple Groups XPort amp Pro Lx6 Embedded Device Server Command Reference 12 12 13 14 15 16 16 17 17 List of Tables Table 3 1 Keyboard Shortcuts Table 4 7 XCR Groups Table 4 8 XSR Group and Items Table 5 1 Commands and Levels XPort amp Pro Lx6 Embedded Device Server Command Reference 11 20 28 39 v About This Guide This guide describes how to configure the XPort amp Pro Lx6 embedded device server using the Command Line Interface CLI and or Extensible Markup Language XML CLI provides an interactive mode for accessing the device configuration and management interface It is most suited for system and network administrators comfortable with using similar interfaces on Enterprise IT and Networking products It is also helpful as a quick tool for access via the product s serial ports or console management ports XML provides an extensible mode for software developers interfacing with the device and system integrators performing batch provisioning updates Chapter Summaries This table lists and summarizes content of each chapter Chapter 2 Overview Gives an overview of CLI and XML Chapter 3 Command Line Interface Lists commands and describes how to use CLI to configure the XPort Pro Lx6 embedded device server Chapter 4 Configuration Using XML Lists XCR groups and items and describes how to use XCRs to configure the XPort amp Pro Lx6 embedded device server Chapter 5 Commands and L
74. ption for connect mode tunneling protocol telnet Uses Telnet protocol with IAC for connect mode tunnel ing XPort Pro Lx6 Embedded Device Server Command Reference 71 5 Commands and Levels protocol udp Uses UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling show history Displays the last 20 commands entered during the current CLI session show statistics show connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer milliseconds timer value in milliseconds Stores the current configuration in permanent memory address text Sets the remote host to establish tunneling connections with text IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes decrypt key text lt text gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each
75. rence 35 tcp continued tunnel Attribute of an instance is a number 4 Configuration Using XML netstat continued aggregate TCPSpuriousRTOs TCPMD5NotFound TCPMD5Unexpected TCPSackShifted TCPSackMerged TCPSackShiftFallback TCPBacklogDrop TCPMinTTLDrop TCPDeferAcceptDrop IPReversePathFilter TCPTimeWaitOverflow completed connects completed accepts disconnects dropped connects dropped accepts octets from octets from network connect 0 connection time connect 1 connection time connect 2 connection time connect 3 connection time connect 4 connection time connect 5 connection time connect 6 connection time connect 7 connection time connect 8 connection time connect 9 connection time connect 10 connection time connect 11 connection time connect 12 connection time XPort amp Pro Lx6 Embedded Device Server Command Reference decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d da
76. ride the current domain name in EHLO priority urgent Sets X Priority for email alerts to 1 urgent XPort Pro Lx6 Embedded Device Server Command Reference 49 5 Commands and Levels text email address to place in the Reply To field of the email alert Sends an email using the current settings server port number Sets the port used by the SMTP server number port used for SMTP on the server side show history Displays the last 20 commands entered during the current CLI session show statistics Displays email statistics subject text Sets the Subject for email alerts text text to placed as the subject to text Sets To addresses for email alerts text a quoted semicolon separated list of email ad dresses Stores the current configuration in permanent memory auto show statistics Continuously displays email statistics cc text Sets Cc addresses for email alerts text a quoted semicolon separated list of email ad dresses default server port Restores the factory default port for SMTP on the server side from text Sets the From address for email alerts text email address to place in the From field of the email alert local port number Sets the local port used to send email alerts number local port to use for email alerts message file text Specifies a text file the contents of which will be the mes sage body of an email alert text th
77. rol Sets the xon character for use with software flow control on this line The character may be input as text control decimal or hex A control character has the form control C A decimal value character has the form X99 A hex value character has the form OxFF clrscrn Clears the screen default duplex Restores the default duplex setting which is auto default speed Restores the default speed setting which is auto negotiate XPort amp Pro Lx6 Embedded Device Server Command Reference 79 show history speed 10 speed 100 speed auto write clrscrn default max length default output exit max length Kbytes output disable output filesystem output line number show show history write clrscrn connect string text default incoming connection default response type display remote ip disable display remote ip enable echo commands disable echo commands enable echo pluses disable echo pluses enable error unknown commands disable error unknown commands enable exit incoming connection automatic incoming connection disabled incoming connection manual no connect string reassert response type numeric 5 Commands and Levels Displays the last 20 commands entered during the current CLI session Displays the last 20 commands entered during the current CLI session Stores the current configuration in permanent memory Clears the screen Sets the CONNECT string used in modem emula
78. rol character has the form control C show history Displays the last 20 commands entered during the current CLI session Change to menu level for Telnet configuration and status Stores the current configuration in permanent memory arp Changes to the command level for ARP configuration and status li tp Change to menu level for CLI configuration and status Enters the ftp level http Enters the http level icmp Changes to the command level for ICMP configuration and status icmpv6 Changes to the command level for ICMPv6 configuration and status Changes to the command level for IP configuration and status kill telnet session Kills Telnet session with index from show sessions show history Displays the last 20 commands entered during the current CLI session smtp Changes to the command level for SMTP configuration and status terminal line Enters the configure terminal level line number of the terminal line serial port to be configured terminal network Enters the configure terminal level for the network Stores the current configuration in permanent memory block network disable Forwards tunnels network data in connect mode tunnel ing block network enable Discards all data coming in from the connect mode tunnel before forwarding it to the serial interface generally used for debugging block serial disable Forwards tunnels serial data in connect mode tunneling block serial enable Disc
79. rotocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling show history Displays the last 20 commands entered during the current CLI session show statistics show connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer milliseconds timer value in milliseconds Stores the current configuration in permanent memory address text Sets the remote host to establish tunneling connections with text IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encr
80. roups and Items 4 Configuration Using XML Table 4 8 lists the supported XML Status Record XSR groups and items These groups and items show the status of the device in XML form and can only be exported The XSR schema differs slightly from the XCR groups and items in that the XSR allows groups within groups Note The Valid Values column of Table 4 8 indicates the default value Table 4 8 XSR Group and Items device email Attribute of instance is lt decimal gt email log Attribute of instance is lt decimal gt hardware http http log arp entry product info success failed queued entry cpu memory state totals entry Attribute of instance is lt decimal gt ip address mac address type interface product type serial number firmware version uptime permanent config sent sent with retries time log speed type flash size ram size entries bytes XPort amp Pro Lx6 Embedded Device Server Command Reference ip address in format nnn nnn nnn nnn mac address in format XX XX XX XX XX XX dynamic or static ethO Lantronix XPort Pro Lx6 14 characters alpha numeric value string in version format like 7 3 0 1R7 elapsed time in format d days hh mm ss saved or unsaved decimal number decimal number decimal number decimal number timestamp in format d days hh mm ss string string string decimal number decimal number decimal number
81. s lt configgroup name cp group instance Linel Modem Ctl Out gt configitem name cp instance 2 gt value name bit gt 0 lt value gt value name type gt output lt value gt value name assert low enablec value lt configitem gt configitem name SsState gt lt value gt disable lt value gt lt configitem gt lt configgroup gt configgroup name cp group instance Linel RS485 Select gt configitem name state lt value gt disable lt value gt lt configitem gt lt configgroup gt XPort Pro Lx6 Embedded Device Server Command Reference 17 4 Configuration Using XML configgroup name cp group instance Linel Modem Ctl In gt configitem name cp instance 3 gt lt value name bit gt 0 lt value gt lt value name type gt input lt value gt lt value name assert low gt enable lt value gt lt configitem gt configitem name state lt value gt disable lt value gt lt configitem gt lt configgroup gt Importing and Exporting an XML Configuration File An XCR can be imported or exported using the following methods Filesystem XCRs can be saved to the device server file system and imported or accessed as needed See Best Practices on page 18 or the Filesystem Browser section in the XPort Pro Lx6 Embedded Device Server User Guide CLI XCRs can be imported captured or exported dumped directly to a Telnet or serial line CLI session Capturing an XCR can
82. sent excluding headers 0 h remote host same as a h i header contents from request h header string m request method p ephemeral local port value used for request q query string prepend with or empty t timestamp HH MM SS same as Apache H M S t u remote user could be bogus for 401 status U URL path info 9er first line of request same as m U q lt version gt s return status logging state disable Disables HTTP server logging logging state enable Enables HTTP server logging max bytes lt number gt Sets the maximum number of bytes the HTTP server ac cepts when receiving a request max log entries lt number gt Sets the maximum number of HTTP server log entries lt number gt maximum number of HTTP server log en tries max timeout lt seconds gt Sets the maximum time the HTTP server waits when re ceiving a request lt seconds gt maximum timeout value no clear counters Restores the HTTP counters to the aggregate values no port Disables the HTTP Server port port lt number gt Sets the port number the HTTP server will use lt number gt port number show Displays the current configuration show auth Displays the HTTP server authentication settings show history Displays the last 20 commands entered during the current CLI session clrscrn Clears the screen exit Exits to the configuration level show Displays the current configuration XPort Pro Lx6 Embe
83. services state disable Disables the Query Port server state enable Enables the Query Port server Stores the current configuration in permanent memory XPort Pro Lx6 Embedded Device Server Command Reference 48 5 Commands and Levels o o o Oeon Show DNS status Stores the current configuration in permanent memory auto show statistics Continuously displays email statistics cc lt text gt Sets Cc addresses for email alerts lt text gt a quoted semicolon separated list of email ad dresses m o Emeshenewriwd default local port Sets the local port used to send email alerts to random default priority Sets X Priority for email alerts to 3 normal default server port Restores the factory default port for SMTP on the server side from text Sets the From address for email alerts text email address to place in the From field of the email alert local port number Sets the local port used to send email alerts number local port to use for email alerts message file text Specifies a text file the contents of which will be the mes sage body of an email alert text the name of a local file no clear mail counters Restores the email counters to the aggregate values empty overriding domain lt text gt Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the device s domain name in EHLO lt text gt domain name to over
84. t e enable enable e configure config e arp config arp e cli config cli e telnet config cli telnet e diagnostics config diagnostics e log config diagnostics lo discovery config discover ftp config ft http config htt icmp config icmp icmpv6 config icmpv6 if 1 config if ethO e link config ethernet ethO ip config ip smtp config smt syslog config syslog terminal 1 config terminal 1 terminal network config terminal network cpm cpm device device dns dns email 1 email 1 e cp email cp 1 e email 2 email 2 e email 3 email 3 e cp email cp 3 e email 4 email 4 e cp email cp 4 e filesystem filesystem e line 1 line 1 e tunnel 1 tunnel 1 e accept tunnel accept 1 e cp output tunnel accept cp output 1 e password tunnel accept password 1 e connect tunnel connect 1 e cp output tunnel connect cp output 1 host 1 tunnel connect host 1 1 host 2 tunnel connect host 1 2 host 3 tunnel connect host 1 3 host 4 tunnel connect host 1 4 host 5 tunnel connect host 1 5 host 6 tunnel connect host 1 6 host 7 tunnel connect host 1 7 host 8 tunnel connect host 1 8 host 9 tunnel connect host 1 9 XPort amp Pro Lx6 Embedded Device Server Command Reference 5 Commands and Levels host 10 tunnel connect host 1 10 host 11 tunnel connect host 1 11 host 12 tunnel connect host 1 12 host 13 tunnel connect host 1 13 host 14 tunnel connect host 1 14 host 15 tunnel con
85. t milliseconds gt Sets how long a break should last when it is being sent to the line lt milliseconds gt number of milliseconds default break duration Restores the break duration to the default value 500 ms default terminal type Sets the default terminal type UNKNOWN echo disable Disables echoing of characters received on the line back to the line echo enable Enables echoing of characters received on the line back to the line exit connect menu disable On the login connect menu removes the menu item al lowing the user to exit to the CLI exit connect menu enable On the login connect menu inserts the menu item allow ing the user to exit to the CLI line line Enters the line level lt line gt number of the line serial port to be configured login connect menu disable Disables the login connect menu so a user will get the CLI immediately after logging in login connect menu enable Enables the login connect menu so a user will get the menu rather than the CLI immediately after logging in Shows the layout of the connect menu with current set tings send break lt control gt Sets the optional send break character lt text gt the character The character may be input as text control decimal or hex A control character has the form lt control gt C A decimal value character has the form 99 A hex value character has the form OxFF show history Displays the last 20 commands entered during t
86. t mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds write Stores the current configuration in permanent memory auth lt uri gt Creates a new HTTP server authentication directive lt uri gt URI of the server auth type lt uri gt digest Sets an HTTP server authentication directive to the Digest Access Authentication scheme lt uri gt URI of the server auth type lt uri gt none Sets the authentication type for an HTTP server authenti cation directive to none lt uri gt URI of the server authentication timeout lt minutes gt For any Digest AuthType sets the timeout for authentica tion lt minutes gt authentication timeout value default log format Restores the HTTP Server log format string to its default value default max bytes Resets the maximum bytes to its default value default max log entries Restores the default maximum number of HTTP Server XPort Pro Lx6 Embedded Device Server Command Reference 74 5 Commands and Levels a T 000000 default max timeout Resets the timeout to its default value default port Resets the HTTP Server port to its default value delete auth lt uri gt Deletes an existing HTTP Server authentication directive lt uri gt URI of the server log format lt text gt Sets the log format string for the HTTP server using the following directives a remote ip address could be a proxy b bytes sent excluding headers B bytes
87. tate bootp default gateway dhcp client id dhcp dhcpv6 domain hostname ip address ipv6 address ipv6 autoconf ipv6 default gateway mtu primary dns secondary dns ip time to live multicast time to live name password disable enable XPort amp Pro Lx6 Embedded Device Server Command Reference 4 Configuration Using XML Default enable 22 line name Attribute of interface instance is a number termination state protocol baud rate parity data bits stop bits flow control xon char xoff char gap timer threshold 4 Configuration Using XML rs232 rs485 half duplex rs485 full duplex usb cdc acm enable disable enable disable none tunnel even none odd 7 8 1 2 none hardware software amp 60 None amp 62 XPort amp Pro Lx6 Embedded Device Server Command Reference Default Default disable Default depends on instance Default Default 9600 bits per second Default none Default 8 Default 1 Default none Accepts a control character for example amp 60 control amp 62 A represents control A Default lt control gt Q Accepts a control character for example amp 60 control amp 62 A represents control A Default lt control gt S Default lt None gt Default 56 bytes 23 serial command mode Attribute of instance is a number smtp Syslog telnet mode echo serial string serial string
88. te lt value gt disable lt value gt lt configitem gt lt configgroup gt configrecord version 0 1 0 0T0O gt lt configgroup name host instance 3 gt lt configitem name name gt lt value gt lt configitem gt configitem name protocol gt lt value gt Telnet lt value gt lt configitem gt lt configitem name ssh username gt XPort Pro Lx6 Embedded Device Server Command Reference 16 4 Configuration Using XML lt value gt lt configitem gt lt configitem name remote address gt lt value gt lt configitem gt lt configitem name remote port gt lt value gt 0 lt value gt lt configitem gt lt configgroup gt Figure 4 5 XML Example of Multiple Items lt configgroup name xml import control gt lt configitem name restore factory configuration gt lt value gt disable lt value gt lt configitem gt lt configitem name delete cpm groups gt lt value gt enable lt value gt lt configitem gt configitem name cpm group delete gt lt value name name gt lt configitem gt lt configitem name delete http authentication uris gt lt value gt disable lt value gt lt configitem gt lt configitem name http authentication uri delete gt lt value name name gt lt configitem gt lt configitem name reboot gt lt value gt disable lt value gt lt configitem gt lt configgroup gt Figure 4 6 XML Example with Multiple Group
89. ted by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces show connection statistics Clears the screen Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunnel con nections Disables the connect mode TCP keep alive timeout Sets the remote port to use for connect mode tunneling number number of the port to use Uses TCP protocol for connect mode tunneling Uses TCP protocol with AES encryption for connect mode tunneling Uses Telnet protocol with IAC for connect mode tunnel ing Uses UDP protocol for connect mode tunneling Uses UDP protocol with AES encryption for connect mode tunneling Shows the current configuration Displays the last 20 commands entered during the current CLI session show connection statistics Enables TCP keep alive for connect mode tunneling and sets the timer milliseconds timer value in milliseconds XPort amp Pr
90. the syslog remote port lt number gt number of the remote port used when mak ing a syslog connection show history Displays the last 20 commands entered during the current CLI session authentication disable No password required for Telnet users authentication enable Challenges the Telnet user with a password default max sessions Restores the default maximum allowed concurrent incom ing Telnet sessions default port Restores the default local port to the Telnet server Sets the maximum allowed concurrent incoming Telnet XPort Pro Lx6 Embedded Device Server Command Reference 83 5 Commands and Levels sessions number number of sessions port number Sets the local port that the Telnet server uses number local port number show Displays the current configuration show history Displays the last 20 commands entered during the current CLI session break duration lt milliseconds gt Sets how long a break should last when it is being sent to the line lt milliseconds gt number of milliseconds default break duration Restores the break duration to the default value 500 ms default terminal type Sets the default terminal type UNKNOWN echo disable Disables echoing of characters received on the line back to the line echo enable Enables echoing of characters received on the line back to the line exit connect menu disable On the login connect menu removes the menu item al lowing the user
91. tion lt string gt connect string Default disables incoming network connections Default uses text type responses The incoming RING has nothing following it The incoming RING is followed by the IP address of the caller Does not echo modem commands Echoes modem commands Does not echo the characters when entering modem command mode Echoes the characters when entering modem com mand mode Wait for an ATA command before answering an incoming network connection Removes optional CONNECT string information for mo dem emulation Asserts tunnel modem status with current configured val ues Uses numeric type responses XPort amp Pro Lx6 Embedded Device Server Command Reference 80 5 Commands and Levels response type text Uses text type responses show history Displays the last 20 commands entered during the current CLI session cirscrn Clears the screen default packing mode Sets to default packing mode which is Disable packing mode disable Disables packing Data is sent to the network when re ceived packing mode send character Sets packing mode to accumulate data and transmit it upon receiving the configured send character on the line serial port packing mode timeout Sets packing mode to accumulate data and transmit it after a specified amount of time timeout send character control Sets the send character for packing mode The character may be input as text control decim
92. tions If no groups are specified then the export command will export all configuration settings to the file If instances are specified after the groups only those group instances are written If no instance is specified all instances of that group are written Exporting The following example exports only the accept mode tunneling settings for 1 to the file tunnel 1 xcr on the device server filesystem xcr export tunnel 1 xcr tunnel accept 1 The following example exports only the mode tunneling settings for all to the file tunnel all xcr on the device server filesystem xcr export tunnel all xcr tunnel The following example imports only the settings for 2 from an XCR named factory config xcr on the device server filesystem If factory config xcr has other configuration settings they are ignored xcr import factory config xcr 2 The following example imports only settings for all from a configuration record on the device server filesystem named foobar xcr xcr import foobar xcr To import only mode tunnel settings for 1 and all settings for 2 from an XML configuration record named production xcr that contains these settings and possibly more issue the following command xcr import production xcr tunnel 1 The following example exports mode tunneling for all to the file tunnel config xcr on the device server filesystem xcr export tunnel config xcr tunnel XPort amp Pro Lx6 Embedded Device Serv
93. tions with text IP address or host name of the remote host olo o olo ols ba ay ay OIO olo o ojo oa Aa 2 olo o ojo Q olo la olo o ojo o ojo x oO cle a Els S 3 o o o0 co T o 3 o M o g Sio 9 gt D VIE o vw E aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation XPort Pro Lx6 Embedded Device Server Command Reference 62 aes decrypt key text text aes encrypt key lt hexadecimal gt aes encrypt key text lt text gt auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no tcp keep alive port lt number gt protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics tcp keep alive lt milliseconds gt 5 Commands and Levels 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separa
94. trigger an email show history Displays the last 20 commands entered during the current CLI session trigger value number Specify a value of the CP group that shall trigger an email XPort amp Pro Lx6 Embedded Device Server Command Reference 44 5 Commands and Levels number numeric value to watch for from the CP group Can be specified as hex if prepended with Ox Stores the current configuration in permanent memory group text Specify a CP group that shall trigger an email text configurable pin group Disables the trigger to send an email no trigger value Clears the value that shall trigger an email show history Displays the last 20 commands entered during the current CLI session trigger value number Specify a value of the CP group that shall trigger an email number numeric value to watch for from the CP group Can be specified as hex if prepended with Ox Stores the current configuration in permanent memory group text Specify a CP group that shall trigger an email text configurable pin group Disables the trigger to send an email no trigger value Clears the value that shall trigger an email show history Displays the last 20 commands entered during the current CLI session trigger value number Specify a value of the CP group that shall trigger an email number numeric value to watch for from the CP group Can be specified as hex if prepended with Ox
95. ue if it contains spaces Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains spaces show connection statistics Clears the screen Restores the default protocol as TCP Restores the default 45 second connect mode TCP keep alive timeout Exits to the next higher level Removes the remote host address used to establish tun neling connections Removes the connect tunnel AES decrypt key Removes the connect tunnel AES encrypt key Removes the remote port used to establish tunnel con nections Disables the connect mode TCP keep alive timeout Sets the remote port to use for connect mode tunneling lt number gt number of the port to use Uses TCP protocol for connect mode tunneling Uses TCP protocol with AES encryption for connect mode tunneling Uses Telnet protocol with IAC for connect mode tunnel ing Uses UDP protocol for connect mode tunneling 64 5 Commands and Levels protocol udp aes Uses UDP protocol with AES encryption for connect mode anas show history D the last 20 commands entered during the current To aeaee session Show statistics statistics show connection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stor
96. umber Sets an email profile to use to send an email alert upon establishing an accept mode tunnel number the number of the email profile to use email disconnect number Sets an email profile to use to send an email alert upon closing an accept mode tunnel number the number of the email profile to use flush serial disable Characters already in the serial data buffer are retained upon establishing an accept mode tunneling connection flush serial enable Flushes the serial data buffer upon establishing an accept mode tunneling connection flush start character disable Enables forwarding of the accept start character into the network flush start character enable Disables forwarding of the accept start character into the network number number of the port to use no email connect Discontinues sending email alerts upon establishing an accept mode tunnel no email disconnect Discontinues sending email alerts upon closing an accept mode tunnel no tcp keep alive Disables the accept mode TCP keep alive timeout XPort amp Pro Lx6 Embedded Device Server Command Reference 40 5 Commands and Levels protocol tcp Uses TCP protocol for accept mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for accept mode tunneling protocol telnet n Telnet protocol with IAC for accept mode tunnel show history Displays the last 20 commands entered during the current CLI session start chara
97. unc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes encrypt key text text Sets the connect tunnel AES encrypt key with up to 16 XPort amp Pro Lx6 Embedded Device Server Command Reference 67 auto show statistics clrscrn efault protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no tcp keep alive port number protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show history show statistics tcp keep alive lt milliseconds gt address text aes decrypt key lt hexadecimal gt aes decrypt key text text XPort amp Pro Lx6 Embedded Device Server Command Reference 5 Commands and Levels bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces show connection statistics Cle
98. unnel Ing protocol udp Uses UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode oe show history D the last 20 commands entered during the current ETT lt session Show statistics statistics show connection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains Spaces aes decrypt key text text Sets the connect tunnel AES decrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains Spaces aes encrypt key lt hexadecimal gt Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by two adjacent hex digits Bytes may run together or be separated by optional punc tuation 123ABC 12 3A BC
99. ute host enable enable level and any of its sub levels Figure 3 4 below shows the enable level commands XPort amp Pro Lx6 Embedded Device Server Command Reference 12 3 Command Line Interface Figure 3 4 Enable Level Commands gt gt enable enable auto show interfaces clrscrn connect cpm disable email number filesystem kill telnet session ping lt host gt ping host count timeout ping6 host count reload show show interfaces show processes telnet host trace route host tunnel line xml enable auto show processes configure connect line lt line gt device dns exit iperf lt params gt line lt line gt ping lt host gt lt count gt ping6 host ping6 host count timeout reload factory defaults show history show ip sockets show sessions telnet host port trace route host protocol write See the Chapter 5 Commands and Levels at the end of this document for a complete list of levels commands and descriptions XPort amp Pro Lx6 Embedded Device Server Command Reference 13 4 Configuration Using XML The device server provides an Extensible Markup Language XML interface that you can use to configure device server devices Every configuration setting that can be issued from the device server Web Manager and CLI can be specified using XML The device server can import and export confi
100. ve timeout port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet Telnet protocol with IAC for connect mode tunnel protocol udp Uses UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode ees show history D the last 20 commands entered during the current lt ae session showstalisics statistics show connection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect mode tunneling and sets the timer lt milliseconds gt timer value in milliseconds Stores the current configuration in permanent memory address lt text gt Sets the remote host to establish tunneling connections with lt text gt IP address or host name of the remote host aes decrypt key lt hexadecimal gt Sets the connect tunnel AES decrypt key with up to 16 bytes XPort Pro Lx6 Embedded Device Server Command Reference 69 aes decrypt key text text aes encrypt key lt hexadecimal gt aes encrypt key text text auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no tcp keep alive port lt number gt protoco
101. ypt key text text Sets the connect tunnel AES encrypt key with up to 16 bytes Each byte is represented by a single character Note that quotes must enclose the value if it contains XPort amp Pro Lx6 Embedded Device Server Command Reference 60 5 Commands and Levels EE UNE default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout no address Removes the remote host address used to establish tun neling connections no aes decrypt key Removes the connect tunnel AES decrypt key no aes encrypt key Removes the connect tunnel AES encrypt key no port Removes the remote port used to establish tunnel con nections no tcp keep alive Disables the connect mode TCP keep alive timeout port number Sets the remote port to use for connect mode tunneling number number of the port to use protocol tcp Uses TCP protocol for connect mode tunneling protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling protocol telnet Td Telnet protocol with IAC for connect mode tunnel protocol udp Tm UDP protocol for connect mode tunneling protocol udp aes Uses UDP protocol with AES encryption for connect mode wd show history A the last 20 commands entered during the current eo C e session Show statistics statistics show connection statistics connection statistics tcp keep alive lt milliseconds gt Enables TCP keep alive for connect
102. ys hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss 36 4 Configuration Using XML tunnel Attribute of an instance is a number continued tunnel modem udp XSr aggregate continued echo commands verbose response response type error unknown commands incoming connection echo commands verbose response response type error unknown commands incoming connection snmp out errors connect 13 connection time connect 14 connection time connect 15 connection time accept connection time connect dns address changes connect dns address invalids InDatagrams NoPorts InErrors OutDatagrams RovbufErrors SndbufErrors bytes lines elements XPort amp Pro Lx6 Embedded Device Server Command Reference elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss elapsed time in format d days hh mm ss decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number decimal number 37 5 Commands and Levels Click the level in the tree structure and it will take you to the command list for that level roo

Lantronix LX6 User's Manual

Contents

Download Pdf Manuals

Related Search

Related Contents