Lantronix EDS4100 Reference Manual
  1. Manuals
  2. Brands
  3. Lantronix Manuals
  4. Server
  5. EDS4100
  6. Reference manual

Lantronix EDS4100 Reference Manual

Eds device servers
Hide thumbs Also See for EDS4100:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual
EDS Device Servers
Command Reference
EDS4100
EDS8PR
EDS16PR
EDS32PR
Part Number 900-455
Revision B January 2007

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the EDS4100 and is the answer not in the manual?

Questions and answers

Related Manuals for Lantronix EDS4100

Summary of Contents for Lantronix EDS4100

  • Page 1 EDS Device Servers Command Reference EDS4100 EDS8PR EDS16PR EDS32PR Part Number 900-455 Revision B January 2007...
  • Page 2 Copyright & Trademark © 2006, 2007 Lantronix. 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. Printed in the United States of America.

  • Page 3: Table Of Contents

    Contents 1: Introduction 2: Configuration Using Telnet or Serial Port Using Telnet________________________________________________________ 5 Using a Serial Port ___________________________________________________ 5 Navigating the Command Line Interface __________________________________ 6 Guidelines _____________________________________________________________ 6 CLI Levels _____________________________________________________________ 7 3: Summary of CLI Commands Root Menu _________________________________________________________ 9 Enable Menu ______________________________________________________ 10 Chem Level Commands _____________________________________________ 14 Configure Menu ____________________________________________________ 16...

  • Page 4: 1: Introduction

    1: Introduction EDS device servers (EDS4100, EDS8PR, EDS16PR, and EDS32PR) contain all the components necessary to deliver full network connectivity to virtually any kind of serial device, a reliable TCP/IP protocol stack, and a variety of remote management capabilities. They boast an innovative design and run on Lantronix’s leading-edge Evolution OS™, which supports three convenient configuration methods (Web, command...

  • Page 5: 2: Configuration Using Telnet Or Serial Port

    2: Configuration Using Telnet or Serial Port As an alternative to using Web Manager, you can configure the EDS using a series of commands. You can access this command-line interface (CLI) with a Telnet session or through a serial port connection to the EDS. This command reference describes how to use the CLI and provides a detailed list of all the CLI commands supported.

  • Page 6: Navigating The Command Line Interface

    2: Configuration Using Telnet or Serial Port Navigating the Command Line Interface Guidelines Commands at the root level (top level) of the CLI do not affect current configuration settings. Commands within the Enable menu (and its sub-menus) modify the EDS’s configuration.

  • Page 7: Cli Levels

    2: Configuration Using Telnet or Serial Port To view the current configuration at any level: Type show. The configuration for that menu level displays. To view the list of commands available at the current menu level: At the command prompt, type ?. The list of current commands displays. To return to the next level up in the menu hierarchy: At the command prompt, type exit.

  • Page 8: 3: Summary Of Cli Commands

    3: Summary of CLI Commands The following sections describe the CLI commands. The commands are organized as follows: Root menu: page Enable menu: page Chem menu: page Configure menu: page Interface 1 Level Menu: page Device menu: page Filesystem menu: page Line menu: page SSH menu: page SSL menu: page...

  • Page 9: Root Menu

    <timeout> = number of seconds that must elapse without a response before the ping times out. show history Displays the set of commands inputted from the moment user was brought back up to this menu. show eds4100 Displays the current EDS settings. show eds8PR show eds16PR show eds32PR trace route <host>...

  • Page 10: Enable Menu

    3: Summary of CLI Commands Enable Menu The following configurable parameters reside in the Enable configuration menu Enable Menu Command Description auto show interfaces Displays interface statistics. auto show processes Continuously displays thread runtime information. auto show xsr Displays XML Status Record counters. chem <number>...
  • Page 11 (in seconds). reload Reboots the EDS and reloads the configuration from Flash memory. reload factory Resets the EDS configuration to the default settings. defaults show eds4100 Displays the EDS’s configuration. show eds8pr show eds16pr show eds32pr EDS Device Servers Command Reference...
  • Page 12 3: Summary of CLI Commands Enable Menu Command Description show history Displays previously entered commands. show hosts Displays the domain settings. Displays network-interface statistics. show interfaces show ip sockets Displays TCP and UDP state information and their associated ports. show processes Displays thread runtime information.
  • Page 13 3: Summary of CLI Commands Enable Menu Command Description xcr import <file> Imports a specific XML configuration to the EDS. <group list> <file> = name of the file to be imported. <group list> = name of the XML configuration to be imported.

  • Page 14: Chem Level Commands

    3: Summary of CLI Commands Chem Level Commands The following is a list of commands available in the chem (configurable host email) level. Chem Level Command Description Continuously displays email statistics auto show statistics <email addresses> = a semi-colon separated list of email addresses.
  • Page 15 3: Summary of CLI Commands Chem Level Command Description overriding domain Sets a domain name that will be used when connecting <domain> to an SMTP server to send an email alert instead of the device’s domain name in EHLO. <domain> = domain name to override the current domain name in EHLO.

  • Page 16: Configure Menu

    3: Summary of CLI Commands Configure Menu The following configurable parameters reside in the Configure menu. Configure Menu Description Command arp <ip address> <mac Maps an IP address to a device’s MAC address. address> <ip address> = IP address to be mapped. <MAC address>...
  • Page 17 3: Summary of CLI Commands Configure Menu Description Command clear udp counters Sets the UDP counters to zero. clock set <time Sets the system clock. (HH:MM:SS)> <day (1- <time (HH:MM:SS)> = time in hours, minutes, and 31)> <month text> seconds <year>...
  • Page 18 3: Summary of CLI Commands Configure Menu Description Command ip ftp username Sets the administrative username for the FTP server. <string> <string> = administrative username. ip http auth <uri> Creates a new HTTP server authentication directive. <realm> <uri> = URI of the server. <realm>...
  • Page 19 3: Summary of CLI Commands Configure Menu Description Command ip http max bytes Sets the maximum number of bytes the HTTP server <bytes> accepts when receiving a request. <bytes> = maximum number of bytes. ip http max timeout Sets the maximum timeout the HTTP server waits when <seconds>...
  • Page 20 3: Summary of CLI Commands Configure Menu Description Command no arp Clears the ARP table. no clear ftp counters Restores the FTP counters to the last aggregate value. no clear http counters Restores the HTTP counters to the last aggregate value. no clear icmp counters Restores the ICMP counters to the last aggregate value.
  • Page 21 3: Summary of CLI Commands Configure Menu Description Command no ip name-server Removes the name server. no ip ssh enable Disables and stops the SSH server. no ip tcp resets enable Prohibits TCP RSTs from sending on connect to unused ports.
  • Page 22 3: Summary of CLI Commands Configure Menu Description Command no snmp-server name Clears the SNMP server name. no syslog enable Disables syslog logging. no syslog host Removes the address of the syslog recipient. no syslog level Disables logging of all events. Sets the new password.
  • Page 23 3: Summary of CLI Commands Configure Menu Description Command show ssh Displays the IP SSH configuration. show syslog Displays syslog information. show tcp Displays TCP configuration information and statistics. show telnet Displays the Telnet configuration. Displays the TFTP settings and statistics. show tftp show udp Displays the UDP settings and statistics.

  • Page 24: Interface 1 Level Menu

    3: Summary of CLI Commands Configure Menu Description Command syslog host <ip Sets the address of the syslog recipient. address> syslog level <severity> Sets the minimum severity of events that will be logged. write Stores and applies the current configuration into permanent memory.
  • Page 25 3: Summary of CLI Commands Interface 1 Level Description Command ip address filter <ip Adds a filter to the IP filter table. address> <netmask> <ip address> = IP address. <netmask> = netmask in dotted notation. Sets the IP address for the default gateway. ip default-gateway <ip address>...

  • Page 26: Device Menu

    3: Summary of CLI Commands Interface 1 Level Description Command speed auto Sets the Ethernet link speed to auto-negotiation. write Stores and applies the current configuration into permanent memory. Device Menu The following configurable parameters reside in the Device configuration menu. Device Description Configuration...
  • Page 27 3: Summary of CLI Commands Device Description Configuration Command show ixp Shows various debug information about the IXP. show ixp db Shows information about the IXP Ethernet DB layer <port> show ixp Shows information about the IXP Ethernet Access layer ethernet <port>...

  • Page 28: Filesystem Menu

    3: Summary of CLI Commands Filesystem Menu The following commands are configurable parameters within the Filesystem menu. This level allows for the management of files in the EDS. Filesystem Menu Description Command Displays the contents of a specified file. cat <file> <file>...
  • Page 29 3: Summary of CLI Commands Filesystem Menu Description Command rmdir <directory> Removes a specified directory from the filesystem. <file> = name of the directory to be removed from the filesystem. show Displays filesystem statistics. show history Displays previously entered commands. show tree Displays all filesystem files and directories.
  • Page 30 3: Summary of CLI Commands Filesystem Menu Description Command tftp put ascii Sends an ASCII file using TFTP. <source file> <source file> = name of the file to be to a remote location. <destination file> <host> <port> <destination file> = name of the file when it is moved. <host>...

  • Page 31: Line Menu

    Sets the number of EDS data bits to 8. databits 8 enable rs485 full- Switches the serial port to RS485 interface in full duplex duplex mode EDS4100 only) enable rs485 half- Switches the serial port to RS485 interface in half duplex duplex mode EDS4100 only) exit Exits the Line menu and return to the Enable menu.
  • Page 32 3: Summary of CLI Commands Line Menu Command Description flowcontrol none Sets flow control to none. flowcontrol software Sets flow control to software. no clear line Restores the serial counters to the last aggregate value. counters line n Displays the Line n menu level, where n = 1, 2, 3, 4, and so forth (up to 32 for the EDS32PR).

  • Page 33: Ssh Menu

    3: Summary of CLI Commands Line Menu Command Description tunnel n Displays the Tunnel n menu level, where n = 1, 2, 3, 4, and so forth (up to 32 for the EDS32PR). write Stores and applies the current configuration into permanent memory.
  • Page 34 3: Summary of CLI Commands SSH Menu Command Description client user <user> Sets the client user, command, and RSA or DSA keys. <command> Sets the client user, password, command, and RSA or client user <user> <password> <command> DSA keys (optional). <user>...
  • Page 35 3: Summary of CLI Commands SSH Menu Command Description host <public> <private> Sets RSA or DSA public and private keys. <public> = public key to be set. <private> = private key to be set. Generates DSA public and private keys. host generate dsa 1024 host generate dsa 512 Generates DSA public and private keys.

  • Page 36: Ssl Menu

    3: Summary of CLI Commands SSH Menu Command Description no client user <user> Removes the client user DSA key. <user> = name of client user whose DSA key is to be removed. no client user <user> Removes the client user RSA key. <user>...

  • Page 37: Tunnel Menu

    3: Summary of CLI Commands SSL Menu Command Description Removes the SSL certificate. no ssl show history Displays previously-entered commands. show ssl Displays the SSL certificate information. Adds a SSL certificate and private key. ssl <certificate> Adds a SSL certificate and private key. <private>...
  • Page 38 3: Summary of CLI Commands Tunnel Menu Command Description Enables TCP keepalives and sets the timer in accept keep alive <milliseconds> milliseconds. <milliseconds> = timer value, in milliseconds. accept port <number> Sets a specific port to use as the local port. <port>...
  • Page 39 3: Summary of CLI Commands Tunnel Menu Command Description Enables TCP keepalives and the sets timer in connect keep alive <number> milliseconds. <number> = number of milliseconds to which the timer is set. Enable Connect mode when the modem control pin is set connect modem control active to asserted.
  • Page 40 3: Summary of CLI Commands Tunnel Menu Command Description Enables disconnect mode to disconnect when a stop disconnect stop character character is received. Enables disconnect mode to disconnect on a timeout. disconnect timeout disconnect timeout Sets disconnect mode timeout in milliseconds. <number>...
  • Page 41 3: Summary of CLI Commands Tunnel Menu Command Description Do not flush serial data buffer on connection. no accept flush serial data no accept keep alive Disables TCP keepalives. Uses a random port number as the local port. no accept port no clear accept counters Unzeros the accept counters.
  • Page 42 3: Summary of CLI Commands Tunnel Menu Command Description Do not echo the +++ characters when entering modem no modem echo pluses command mode. Uses decimal status codes. no modem verbose no packing mode Disables packing mode. no packing send character Removes the send character.
  • Page 43 3: Summary of CLI Commands Tunnel Menu Command Description Displays tunneling configuration. show show history Displays previously entered commands. show statistics Show connection statistics. start character <string> Sets the start character (string format: C, HEX: 0x##, Decimal: ###). stop character <string> Sets the stop- character (string format: C, HEX: 0x##, Decimal: ###).

  • Page 44: 4: Configuration Using Xml

    4: Configuration Using XML The EDS provides an Extensible Markup Language (XML) interface that can be used to configure EDS devices. Every configuration setting that can be issued from the EDS Web Manager or Command mode can also be specified using XML. Using the XML interface, you can import and export EDS configuration settings as XML configuration records (XCRs) using the CLI, filesystem, Web browser, or FTP.

  • Page 45: Quick Syntax Tour For Xcrs

    4: Configuration Using XML Each configuration group must have one or more <configitem> element. The configuration item is a specific group of configurable parameters relevant to the parent group. It accepts the “name” attribute. A <configitem> must have at least one <value>. This element specifies the actual value of the configuration parameter.

  • Page 46: Records, Groups, Items, And Values

    4: Configuration Using XML The element's content is everything that appears between the start tag and end tag, including text and other (child) elements. In addition to content, an element can contain attributes — name-value pairs included in the start tag after the element name. Attribute values must always be quoted, using single or double quotes.

  • Page 47: Importing And Exporting An Xml Configuration File

    System Status Page in the User Guide. FTP ⎯ to export a file, execute a get on the file eds4100.xml. To import a file, execute a put on the file eds4100.xml. When you execute a get or put with this XML file, the file is intercepted by the EDS and acted upon, without being placed on the filesystem.

  • Page 48: Best Practices

    These lines import all groups specified in the XML config record named in <file>. Any filename is valid, and the file name and extension are not important. However, the file name eds4100.xcr is not acceptable, since performing a get on that name produces the current configuration and does not get anything from the filesystem.

  • Page 49: Including Passwords In The Xml File

    4: Configuration Using XML The following example exports only the tunnel 1 settings to the file “tunnel_1.xcr” on the EDS filesystem: xcr export tunnel_1.xcr “tunnel:1” The following example exports only tunnel settings for all ports to the file “tunnel_all.xcr” on the EDS 4100 filesystem.: xcr export tunnel_all.xcr “tunnel”...

  • Page 50: Special Xcr Groups

    4: Configuration Using XML Special XCR Groups The following XCR groups are used to delete settings, control how the XML is processed, or control the device. They are not used for configuration purposes. For example, the Reboot group, which causes the EDS to reboot, is not a configurable setting that can be exported.

  • Page 51: Xml Groups

    4: Configuration Using XML XML Groups Table 4-1 lists the EDS XML import and export groups in alphabetical order. This table also indicates whether the group can be imported and/or exported. Table 4-1. EDS Import and Export Groups Group Item Value Value Import/Export...
  • Page 52 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information priority Very Low Import and Export Import and Export Normal Import and Export High Import and Export Urgent Import and Export overriding Import and domain Export ethernet auto enable...
  • Page 53 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information http server state enable Import and Export disable Import and Export port Import and Export secure port Import and Export max timeout Import and Export max bytes Import and Export logging...
  • Page 54 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information level passwords system Import This group passwords specifies the passwords to use when importing an XCR using the CLI capture feature. The system value specifies the root password used if the root level is password...
  • Page 55 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information xon char Import and Set the x-on Export character. Enter as a hexadecimal byte. xoff char Import and Set the x-off Export character. Enter as a hexadecimal byte.
  • Page 56 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information max entries Import and Export serial mode disable Import and command Export mode always Import and Export serial Import and string Export echo serial enable Import and string Export disable...
  • Page 57 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information known host Import and Specify the delete Export server host for deletion. client users Import and Specify the delete Export username for deletion. client rsa Import and Specify the key delete Export...
  • Page 58 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information disable Import and Export Import and character Export start Import and character Export modem Import and control Export asserted modem Import and Export local port Import and Export protocol Import and...
  • Page 59 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information remote Import and address Export remote port Import and Export protocol Import and Export Import and Export Import and Export tcp aes Import and Export udp aes Import and Export reconnect...
  • Page 60 4: Configuration Using XML Group Item Value Value Import/Export Additional Name Name Name Information disable Import and Export response text Import and type Export numeric Import and Export error enable Import and unknown Export commands disable Import and Export connect Import and string Export...

  • Page 61: Xsr Groups And Items

    free...
  • Page 62 4: Configuration Using XML Group Name Item Name Value Name Valid Values lock count share count banks bank a begin bank a end bank a erase cycles bank b begin bank b end bank b erase cycles status admin username connections rejected accepted...
  • Page 63 4: Configuration Using XML Group Name Item Name Value Name Valid Values address mask replies interface status ethernet ip address mac address auto negotiate speed duplex encapsulation type timeout transmits octets unicast non unicast discards errors broadcasts packets multicasts packets filtered packets deferred multiple retries...
  • Page 64 4: Configuration Using XML Group Name Item Name Value Name Valid Values failure success ip sockets ip socket protocol rx queue tx queue local address remote address local port remote port state ip socket protocol rx queue tx queue local address remote address local port remote port...
  • Page 65 4: Configuration Using XML Group Name Item Name Value Name Valid Values cluster pool cluster size total free used max used line statistics receive bytes breaks parity errors framing errors overrun errors number buffers allocated bytes transmit bytes breaks queued bytes flow control asserting asserted...
  • Page 66 4: Configuration Using XML Group Name Item Name Value Name Valid Values data entries bytes sessions line interface baud parity data bits stop bits flow control telnet local port remote ip address remote port duration state local port totals uptime bytes in bytes out send reset...
  • Page 67 4: Configuration Using XML Group Name Item Name Value Name Valid Values accept dns address invalids current connect local ip address connections local port remote ip address remote port uptime octets from serial octets from network connect dns address changes accept dns address invalids current accept...

  • Page 68: Index

    Index Best practices, XML, 48 system configuration record, 47 Filesystem menu, 28 Configure menu, 16 Groups, XML, 46 Device menu, 26 Import and export Enable menu, 10 XML groups, 51 Filesystem menu, 28 XSR groups, 61 Interface 1 Level menu, 24 Importing Line menu, 31 system configuration record, 47...

This manual is also suitable for:

? eds16pr? eds8pr? eds32pr

Table of Contents