Lantronix xport pro Command Reference Manual Download

Page: 1 / 100

Part Number 900-558

Revision A September 2009

XPort Pro™ Command Reference

Summary of Contents for xport pro

Page 1: ...Part Number 900 558 Revision A September 2009 XPort Pro Command Reference...

Page 2: ...trademarks of Microsoft Corp Netscape is a trademark of Netscape Communications Corporation Contacts Lantronix Corporate Headquarters 15353 Barranca Parkway Irvine CA 92618 USA Phone 949 453 3990 Fax...

Page 3: ..._______ 7 Navigating the Command Line Interface 8 Keyboard Shortcut Commands 12 3 Summary of CLI Commands 13 Command Hierarchy 13 Command Index 13 accept Level Commands 14 arp Level Commands 16 chem L...

Page 4: ...og Level Commands 57 tcp Level Commands 59 terminal Level Commands 59 tftp Level Commands 61 tunnel line Level Commands 62 udp Level Commands 63 vip Level Commands 63 4 Configuration Using XML 64 XML...

Page 5: ...Contents XPort Pro Command Reference 5 Index 99...

Page 6: ...ery similar to that used by data center equipment such as routers and hubs This Command Reference provides information about navigating the CLI interface and lists the CLI commands for configuring mon...

Page 7: ...net connection by clicking the Telnet Configuration tab in DeviceInstaller See the product User Guide for more information 1 From the Windows Start menu click Run The Run dialog box appears 2 In the R...

Page 8: ...wer off the device 2 Press and hold down the exclamation point key 3 Power on the device 4 When an exclamation point appears on the terminal or PC screen type xyz within 5 seconds to display the CLI p...

Page 9: ...2 Configuration Using Telnet or a Serial Port XPort Pro Command Reference 9 Figure 2 1 CLI Command Hierarchy...

Page 10: ...Command Mode is configured for always on operation a new session will immediately be restarted To view the current configuration at any level Type show To view the list of commands available at the cu...

Page 11: ...and their explanations for a partial command At the prompt type the partial command followed by and press Enter For example tunnel 1 echo displays a list of all echo commands and descriptions at the...

Page 12: ...dit any parameters The following key combinations are allowed when configuring the device server from the command line interface CLI Ctrl a place cursor at the beginning of line Ctrl b backspace one c...

Page 13: ...on a page number to see the details of a command Command Level Page accept 14 arp 16 chem 17 cli 19 configure 19 connect 21 cpm 23 cp output 23 device 25 disconnect 26 enable 27 ethernet link 42 files...

Page 14: ...ted by two adjacent hex digits Bytes may run together or be separated by optional punctuation 123ABC 12 3A BC 12 3A BC 12 3a bc 12 3a bc Note that quotes must enclose the value if it contains spaces a...

Page 15: ...e exit Returns to the tunnel level flush serial disable Characters already in the serial data buffer are retained upon establishing an accept mode tunneling connection flush serial enable Flushes the...

Page 16: ...er 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 99 A hex value character has the form 0xFF tcp keep alive...

Page 17: ...plays email statistics cc email addresses Sets Cc addresses for email alerts email addresses a semicolon separated list of email addresses within quotation marks For example name1 name2 chem number En...

Page 18: ...to 3 priority urgent Sets X Priority for email alerts to 1 priority very low Sets X Priority for email alerts to 5 replyto email address Sets Reply To address for email alerts email address email add...

Page 19: ...es Sets the inactivity timeout for all CLI sessions login password text Sets the CLI login password no enable level password Removes the enable level password no inactivity timeout No inactivity timeo...

Page 20: ...vel kill ssh session Kills SSH session with index from show sessions kill telnet session Kills Telnet session with index from show sessions lpd line Enters the configure lpd level line number of the l...

Page 21: ...sed for debugging clrscrn Clears the screen connect mode always Enables the tunneling server to always establish tunneling connections connect mode any character Enables the tunneling server to establ...

Page 22: ...e 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 instan...

Page 23: ...nnect cp output Level Prompt cp_output The following commands are available in the cp output level cp output level commands Description clrscrn Clears the screen connection value number Sets the value...

Page 24: ...ich 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...

Page 25: ...be specified as hex if prepended with 0x show group Displays group information for specified group group the name of the group show cp Displays configuration and group information for all CPs show gro...

Page 26: ...uring the current CLI session show linereference memory code filename Displays memory utilization by line reference for one code file show memory Displays current memory usage information show task me...

Page 27: ...input as text control decimal or hex A control character has the form control C A decimal value character has the form 99 A hex value character has the form 0xFF timeout milliseconds Disconnects when...

Page 28: ...ers no clear xsr counters Unzeros XML Status Record counters nslookup Lookup host information for the given host name nslookup host Return host information for the given host name ping host Ping desti...

Page 29: ...ion level telnet host Begin session on network host telnet host port Begin session on network host port trace route host Trace route to destination tunnel line Enters the tunnel level line number of t...

Page 30: ...e system and lose all data ls Show all files and directories in the current directory ls directory Show all files and directories in the specified directory mkdir directory Create a directory mv sourc...

Page 31: ...in password text Sets the administrative password for the FTP server text administrative password admin username text Sets the administrative username for the FTP server text administrative username I...

Page 32: ...e name of the host text name of the host no name Clears the name of the host no remote address Clears the remote address of the host no ssh username Clears the SSH username associated with the host pr...

Page 33: ...the server auth type uri none Sets the authentication type for an HTTP server authentication directive to none uri URI of the server auth type uri ssl Sets the authentication type for an HTTP server...

Page 34: ...Deletes an existing user for an HTTP Server authentication directive uri URI of the server user username exit Returns to the config level log disable Disables HTTP server logging log enable Enables H...

Page 35: ...tatistics Displays the HTTP statistics ssl port number Sets the port number the HTTP server will use over SSL number port number ssl3 disable Disables SSLv3 handling ssl3 enable Enables SSLv3 handling...

Page 36: ...configure if eth0 Level Prompt config if eth0 Where is the interface number 1 for eth0 The following commands are available in the if level if level commands Description bootp disable Disables BOOTP b...

Page 37: ...ult gateway no dhcp client id Clears the DHCP client ID no domain Clears the domain name no hostname Clears the host name no ip address Clears the IP address no primary dns Clears the name of the prim...

Page 38: ...et is allowed to live no clear counters Unzeros IP counters show Displays the current configuration show history Displays the last 20 commands entered during the current CLI session show stats Shows I...

Page 39: ...and mode command mode cp Sets the current line to enter command mode under control of a CP command mode cp cp group value Specifies the CP group and trigger value command mode echo serial string disab...

Page 40: ...Restores the default interface type to this line default parity Restores the default of no parity default protocol Restores the default protocol on the line default stop bits Restores the default of o...

Page 41: ...s a parity bit on the line for even parity parity none Does not use a parity bit on the line parity odd Uses a parity bit on the line for odd parity ppp line Enters the serial line PPP level protocol...

Page 42: ...control decimal or hex A control character has the form control C A decimal value character has the form 99 A hex value character has the form 0xFF xon char control Sets the xon character for use with...

Page 43: ...of the device server root level commands Description clrscrn Clears the screen enable Enters the enable level exit Exit from the system ping host Ping destination 5 times with 5 second timeout ping h...

Page 44: ...the last 20 commands entered during the current CLI session write Stores the current configuration in permanent memory lpd line Level Commands Command Path enable config lpd Level Prompt config lpd Wh...

Page 45: ...eoj text set text Sets the end of job text text ascii string that will be sent to the printer at the end of each print job exit Exits to the configuration level formfeed disable Disables the printer f...

Page 46: ...nary decimal up to 255 or hex up to 0xFF terminal line Enters the configure terminal level line number of the terminal line serial port to be configured terminal network Enters the configure terminal...

Page 47: ...ng connection automatic Automatically answer incoming network connections incoming connection disabled Disable incoming network connections incoming connection manual Wait for an ATA command before an...

Page 48: ...ling character Removes the trailing character for packing mode packing mode disable Disables packing Data is sent to the network when received packing mode send character Sets packing mode to accumula...

Page 49: ...s the form 0xFF write Stores the current configuration in permanent memory password Level Commands Command Path enable tunnel accept password Level Prompt tunnel accept password Where is the line numb...

Page 50: ...Commands XPort Pro Command Reference 50 password level commands Description show history Displays the last 20 commands entered during the current CLI session write Stores the current configuration in...

Page 51: ...screen default authentication mode Removes PPP authentication exit Exits to the configuration level line line Enters the line level line number of the line serial port to be configured local ip ip add...

Page 52: ...e serial port to be configured username text Sets the user name for PPP authentication write Stores the current configuration in permanent memory query port Level Commands Command Path enable config q...

Page 53: ...a persistence persist enable Enables RSS feed data persistence show Displays the current configuration show history Displays the last 20 commands entered during the current CLI session show status Dis...

Page 54: ...p level snmp level commands Description clrscrn Clears the screen community ro string Sets the SNMP read only community string string name of the read only community string to be set community rw stri...

Page 55: ...CLI session traps disable Disables the sending of SNMP trap messages traps enable Enables the sending of SNMP trap messages write Stores the current configuration in permanent memory ssh Level Comman...

Page 56: ...password Sets Host username and password host user user password public Sets Host username password and either a RSA or DSA public key Place the entire contents of the file generated by ssh keygen wit...

Page 57: ...ble level generate dsa Generates a new Self Signed DSA Certificate generate rsa Generates a new Self Signed RSA Certificate no dsa Removes DSA Certificate and Private Key no intermediate authority cer...

Page 58: ...er of the remote port used when making a syslog connection severity log level alert Log only Alert and more severe events severity log level critical Log only Critical and more severe events severity...

Page 59: ...dards exit Exits to the configuration level no clear counters Unzeros TCP counters resets disable Does not send TCP RSTs upon connection to unused ports resets enable Sends TCP RSTs upon connection to...

Page 60: ...o the CLI line line Enters the line level line 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 l...

Page 61: ...ile creation disable Prohibits the TFTP server from creating files on the file system allow file creation enable Enables the TFTP server to create files on the file system allow firmware update disabl...

Page 62: ...igured lpd line Enters the configure lpd level line number of the line lpd serial port to be configured modem Enters the modem level for this tunnel no clear counters Unzeros all tunnel counters packi...

Page 63: ...n in permanent memory vip Level Commands Command Path enable config vip Level Prompt config vip The following is a list of commands available in the vip level vip level commands Description auto show...

Page 64: ...straightforward and flexible way to manage the configuration of multiple device server devices XML Configuration Record Document Type Definition DTD An XML DTD is a description of the structure and co...

Page 65: ...e the instance attribute to identify the specific option like the serial port number the instance attribute is always a quoted string Quick Syntax Tour for XCRs Figure 4 2 shows a simple XML example F...

Page 66: ...grouping of configuration parameters relevant to its parent group An item takes the name attribute and must contain one or more value elements For example the line group might have parameters such as...

Page 67: ...configgroup name email instance 1 configitem name to value john doe somewhere com value configitem configitem name from value evolution xportar com value configitem configgroup Figure 4 6 XML Example...

Page 68: ...our local hard drive FTP The device server s FTP server will export and import XCRs when a get or a put on the file xport_pro xcr is requested On export FTP get of xport_pro xcr the FTP server obtains...

Page 69: ...en 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...

Page 70: ...to one or more device server devices that are password protected you can include the appropriate passwords in the XML configuration record and forego the usual login steps The xml paste passwords con...

Page 71: ...laceholder If configured and not exporting secrets exports only a placeholder login password import export Placeholder Same as above quit connect line import export Normally this will be a control key...

Page 72: ...subject import export message file import export local port import export Either a specific number or Random server port import export Very Low Low Normal High priority Urgent import export overridin...

Page 73: ...ser realm import export type import export user Attribute of instance is the user name password import export Placeholder If configured and not exporting secrets exports only a placeholder http authen...

Page 74: ...ddress and mask Use CIDR form 192 168 0 1 1 6 or explicit mask 192 168 0 1 255 255 0 0 default gateway import export primary dns import export interface Attribute of instance is eth0 secondary dns imp...

Page 75: ...0x 0x11 or decimal with 17 xoff char rs232 import export Set the x off character Prefix hex with 0x 0x11 or decimal with 17 rs485 half duplex rs485 full duplex interface import export name lpd import...

Page 76: ...device dna dsc t unnel ip addr device dna dsc t unnel ssh public encrypted dsm credentials device dnaid device dna syst em change num ber device config na me managelinx common device dna syst em chang...

Page 77: ...rss max entries import export cp cp and serial string disable serial string mode enable import export disable echo serial string import export serial string import export signon message import export...

Page 78: ...a key import export Placeholder If configured and not exporting secrets exports only a placeholder public rsa key import export password import export Placeholder If configured and not exporting secre...

Page 79: ...key import export host dsa keys private key import export Placeholder If configured and not exporting secrets exports only a placeholder password import export Placeholder If configured and not export...

Page 80: ...Placeholder Enter the text of the private key If configured and not exporting secrets exports only a placeholder disable delete all cas import If enabled deletes any existing trusted cas before addin...

Page 81: ...al Attribute of instance is either network or the number 1 terminal type enable import export disable state enable import export disable tftp server allow file creation always import export allow firm...

Page 82: ...xport Milliseconds email connect import export email disconnect import export group import export CP group name connection value import export cp output disconnection value enable import export disabl...

Page 83: ...a placeholder local port import export Either a specific number or Random vip disable vip name address port protocol tcp ssh username tcp keep alive 45000 milliseconds aes encrypt key host aes decrypt...

Page 84: ...disconnect Attribute of instance is the number 1 timeout enable import export Milliseconds A value of 0 disables the timeout disable echo pluses enable import export disable echo commands enable impo...

Page 85: ...ate enable import export enable disable restore factory configuration enable import export disable delete cpm groups import export Deletes existing groups before importing new ones cpm group delete na...

Page 86: ...uffer pool group which has the following groups as sub groups Protocol stack Ethernet driver Line The tunnel group which has the following group as sub group Tunnel Modem The CLI command usage is iden...

Page 87: ...ted logic not inverted active group cps cp Attribute of instance is a number from 1 to 3 group product type serial number firmware version uptime saved device product info permanent config unsaved sen...

Page 88: ...available dirty used total used data filesystem busy file count directory count system count open count lock count entries share count current firmware begin firmware end firmware erase cycles firmwa...

Page 89: ...tions accepted ip address ftp last client port type cpu speed flash size hardware memory ram size enabled state disabled http port ports https port max bytes max timeout enabled state disabled max ent...

Page 90: ...ssages parameter problems source quench requests redirects ping requests ping replies timestamp requests timestamp replies address mask requests address mask replies messages messages discarded errors...

Page 91: ...ests address mask replies no link link up disabled status unknown generic errors speed ethernet Present only for eth0 duplex encapsulation type arp timeout default gateway network mask domain mac addr...

Page 92: ...s broadcast packets multicast packets filtered packets deferred multiple retries one retry underflows late collisions retry errors carrier lost errors octets unicast non unicast discards errors broadc...

Page 93: ...isabled default ttl forwarded route discards receives header errors address errors unknown protocols discarded in delivered requests discards out discards no route timeout needed success reassembly fa...

Page 94: ...rors no receive buffer errors queued bytes receiver flow control bytes breaks queued bytes transmitter flow control cts rts dsr line Attribute of instance is the number 1 line levels dtr enabled state...

Page 95: ...ed line number within group buffer pool cluster pool max used jobs printed bytes printed current client ip address current client port last client ip address lpd Attribute of instance is the number 1...

Page 96: ...discovery replies query port out errors url entries rss data bytes baud parity data bits stop bits line Attribute of instance is the number 1 flow control local port remote ip address remote port ssh...

Page 97: ...ctive open passive failed resets connections established errors in in resets out in out tcp segments retransmitted enabled state disabled uptime bytes in telnet totals bytes out enabled disabled statu...

Page 98: ...ction time connect dns address changes connect dns address invalids echo commands enable verbose response enable response type text error unknown commands disable tunnel modem within group tunnel inco...

Page 99: ...t configuration 7 XML configuration 64 disconnect Level Commands 26 DTD 64 E enable Level Commands 27 Enable menu 27 ethernet link Level Commands 42 Exporting system configuration record 68 F filesyst...

Page 100: ...mands 57 Summary of CLI commands 13 syslog Level Commands 57 System configuration record exporting 68 importing 68 T tcp Level Commands 59 Telnet configuration 7 terminal Level Commands 59 Terminal me...

Search results

Summary of Contents for xport pro

Reviews:

Related manuals for xport pro

Brands by name

Popular brands

Lantronix xport pro, Command Reference Manual

Search results

Summary of Contents for xport pro

Reviews:

Related manuals for xport pro

Brands by name

Popular brands