Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
Contents Introduction Products to which this book applies Quick reference for configuring features Access the command line Configure an IP address Basic command information Navigation and editing keys Displaying online help Abbreviating commands Syntax conventions Entering special characters in string values Verifying device support for commands User permissions in ConnectPort LTS products Multi-user model...
Page 4
rlogin set alarm set autoconnect set buffer set esc set ethernet set group set host set ippool set lcd set modem set network set nfs set permissions set pmodem set portauth set portgroup set ppp set profile set python set realport set rtstoggle set samba set sdmemory...
Introduction This book describes the commands in the command-line interface for several Digi product families, listed below. This chapter provides the following: A quick reference showing the commands used to configure features or perform configuration tasks from the command line.
Introduction Quick reference for configuring features ConnectPort LTS 32 ConnectPort LTS 32 MEI ConnectPort LTS 32 W ConnectPort LTS 32 MEI W Quick reference for configuring features The following table shows common features that can be configured from the command line, and the commands used to configure each feature.
Security, users, user access User permissions in ConnectPort LTS products for a discussion permissions, and of how users and access permissions are implemented in Digi user groups Connect products. To create users and change user names: set user To control access to inbound...
Introduction Access the command line Feature/Task Commands Status of your ConnectPort display status LTS product Telnet to network devices telnet set lcd set nfs Samba set samba SD memory set sdmemory Syslog set syslog Trace set trace set usb set web XBee set xbee Access the command line...
If the device to which you will be issuing commands has not already been assigned an IP address, or if the IP address needs to be modified from its initial configuration, see the Digi product’s User’s Guide for details on configuring an IP address.
Basic command information Navigation and editing keys Displaying online help Abbreviating commands Syntax conventions Entering special characters in string values Verifying device support for commands ConnectPort® LTS Command Reference...
Basic command information Navigation and editing keys Navigation and editing keys Use the keys listed in the table to navigate the command line and edit commands: Action Keys Move the cursor back one space. Ctrl+b or Left arrow Move the cursor forward one space. Ctrl+f or Right arrow Delete the character to the left of the cursor.
Basic command information Entering special characters in string values Entering special characters in string values Several commands have options that are string values, for example the “set alarm” command’s “match” option and the “set autoconnect” command’s “connect_on_string” option. Escape sequences for special characters Special characters can be entered in strings using the following escape sequences: Escape Sequence Processed as:...
Page 13
Some options may become available in new firmware revisions or before new documentation is released. Some commands relate only to particular features unique to specific Digi products. For example, the “set wlan” command applies only to wireless products. Other commands may have options that are specific to features that are not available on all devices.
User permissions in ConnectPort LTS products The user model in a ConnectPort LTS product influences the commands that users can issue. ConnectPort LTS supports multiple users. Multi-user model User 1 has a default name of “root.” This user is also known as the administrative user. User 1 has default permissions that enables the user to issue all commands.
Command descriptions backup bash boot close connect display display buffers exit help and ? info kill newpass ping python quit reconnect revert rlogin set alarm set autoconnect set buffer set esc set ethernet set group set host set ippool set lcd set modem set network set nfs...
Command descriptions set smtp set snmp set socket_tunnel set switches set sysauth set syslog set system set tcpserial set time set trace set udpserial set usb set user set web set xbee show status telnet ConnectPort® LTS Command Reference...
Command descriptions backup backup Purpose Saves the device configuration to a TFTP server located on the network or a storage device in the ConnectPort LTS device, or restores the configuration. Required permissions For products with two or more users, permissions must be set to “set permissions backup=execute” to use this command.
Command descriptions boot boot Purpose Reboots the ConnectPort LTS product, restores the device configuration to factory default settings, or loads new firmware files from a TFTP server. Required permissions For products with two or more users, permissions must be set to “set permissions boot=execute” to use this command.
Page 20
Command descriptions boot Examples Restore configuration defaults This example reloads the firmware stored in flash ROM and resets the configuration to factory defaults then reboots the device. #> boot action=factory Reboot using the current firmware and configuration This example reboots the device and uses the current firmware and configuration stored in flash ROM. #>...
Command descriptions close close Purpose Closes active connect, Rlogin, and Telnet sessions; that is, sessions opened by “connect,” “rlogin,” or “telnet” commands. The “close” command is associated with the sessions displayed by the“status” command. A “close” command issued without any options closes the current connection. To issue the “close”...
Page 22
Command descriptions close See also kill: The kill command has a broader effect than close, and lets you kill connections from the global list. That is, it is not limited to sessions associated with the current connection. status for information on displaying status information on active sessions. connect rlogin telnet...
Command descriptions connect connect Purpose Used to make a connection, or establish a session, with a serial port. Required permissions For products with two or more users, permissions must be set to “set permissions connect=execute” to use this command. See "set permissions" for details on setting user permissions for commands. Syntax There are several ways to create and manage connections: Create a single connection...
Current TCP and UDP session and listener information. Uptime information only. Version information for Boot, firmware, and Digi part numbers for those items. Required permissions For products with two or more users, permissions must be set to “set permissions display=execute”...
Page 25
Command descriptions display Displays DNS server information. memory Displays memory usage. netdevice Displays the active interfaces on the system, for example, PPP and Ethernet interfaces, and their status, such as “Closed” or “Connected.” proxyarp Displays Proxy ARP table entries. serial Displays serial modem signals (DTR, RTS, CTS, DSR, DCD).
Page 26
Command descriptions display total memory : 255944 used memory : 40760 free memory : 215184 See also info show status ConnectPort® LTS Command Reference...
Command descriptions display buffers display buffers Purpose Displays the contents of a port buffer, or transfers the contents of a port buffer to a server running Trivial File Transfer Protocol (TFTP). Port buffering is enabled by the “set buffer” command (see "set buffer").
Page 28
Command descriptions display buffers Examples Display port buffering information on the screen #> display buffers port=2 screen lines=32 tail=30 Output buffering information to a TFTP server #> display buffers port=2 tftp=192.168.1.1:port_ouput Output multi-port buffering information to a TFTP server #> display buffers port=2-3 tftp=192.168.1.1:port_ouput Note Port 2 buffering information goes to file port_output_2 and port 3 buffering information goes to file port_output_3.
Command descriptions exit exit Purpose Terminates the current session. Syntax exit Example #> exit See also quit: The “quit” and “exit” commands perform the same operation. ConnectPort® LTS Command Reference...
Command descriptions help and ? help and ? Purpose Displays help about a specific command. Syntax help [command] [command]? Examples #> help boot #> boot? #> help set serial #> set serial? See also Displaying online help ConnectPort® LTS Command Reference...
Command descriptions info info Purpose Displays statistical information about a device. The “info” command displays statistical information about a device over time. In contrast, the “display” command’s focus is on real-time information, while the “status” command displays the status of outgoing connections (connections made by “connect,” “rlogin,” or “telnet” commands). Command options allow display of the following categories of statistics: Device statistics Ethernet statistics...
Page 32
12 hexadecimal digits, usually starting with D. Firmware Version The current firmware version. This information may be used to help locate and download new firmware. Firmware updates may be downloaded from the Digi Support website. Bios Version The current bios version. CPU Utilization The amount of CPU resources being used by the device.
Page 33
Command descriptions info Statistic Description InUcastPkts Number of Unicast packets received. OutUcastPkts Number of Unicast packets sent. InNonUcastPkts Number of non-Unicast packets received. InDiscards Number of incoming packets that were discarded. OutDiscards Number of outgoing packets that were discarded. InErrors Number of incoming packets that contained errors.
Page 34
Command descriptions info Statistic Description InUnknownProtos Number of received datagrams discarded because the specified protocol is not available. OutDiscards Number of outgoing datagrams that were discarded for miscellaneous reasons. This statistic is not used and is always zero. InDiscards Number of received datagrams discarded for miscellaneous reasons. FragCreates Number of outgoing datagram fragments created.
Page 35
Command descriptions info Statistic Description EstabResets Number of established connections that have been reset. OutResets Number of outgoing connections that have been reset. PassiveOpens Number of passive opens. In a passive open, the ConnectPort LTS product is listening for a connection request from a client. ActiveOpens Number of active opens.
Page 36
Command descriptions info Example Display ICMP statistics #> info icmp ICMP statistics: InMessages OutMessages InDestUnreachables OutDestUnreachables InErrors ICMPv6 statistics: InMessages OutMessages : 11 InDestUnreachables OutDestUnreachables InErrors See also display show status ConnectPort® LTS Command Reference...
Command descriptions kill kill Purpose Kills or ends connections. The “kill” command is associated with the connections displayed by the “who” command. RealPort sessions cannot be killed by this command. Required permissions For products with two or more users, permissions must be set to “set permissions kill=execute”...
Command descriptions newpass newpass Purpose Creates or changes user passwords for the device. Required permissions For products with two or more users, permissions must be set to “set permissions newpass=rw-self” for a user to set their own password, and “set permissions newpass=rw” to set another user’s password.
Command descriptions ping ping Purpose Tests whether a host or other device is active and reachable. To interrupt the “ping” command, use Ctrl-C. Required permissions For products with two or more users, permissions must be set to “set permissions ping=execute” for a user to use this command. See "set permissions"...
Arguments to be supplied to the program. See also set python to manually execute a Python program. The Digi Python Programming Guide to learn more about the Python programming language as implemented in Digi products, and writing Python programs. ConnectPort® LTS Command Reference...
Command descriptions quit quit Purpose Use the quit command to log out of the device. Syntax quit Example #> quit See also exit: The “quit” and “exit” commands perform the same operation. ConnectPort® LTS Command Reference...
Command descriptions reconnect reconnect Purpose Reestablishes a previously established connection; that is, a connection opened by a “connect,” “rlogin,” or “telnet” command. The default operation of this command is to reconnect to the last active session. Required permissions For products with two or more users, permissions must be set to “set permissions reconnect=execute”...
Page 43
Command descriptions reconnect status for information on gathering status on current connections rlogin telnet ConnectPort® LTS Command Reference...
Command descriptions revert revert Purpose Reverts all or a subset of a devices’ configuration settings to their default values. If you enter “revert user,” “revert group,” or “revert permissions,” a message is displayed indicating that those settings cannot be reverted individually, and instead must be reverted all together at the same time via the “revert auth”...
Page 45
Command descriptions revert udpserial [port= range ]| usb| web| xbee] Options Reverts all settings except network settings, security settings (passwords and suppress login), and host key settings. alarm Reverts the alarm settings configured by the “set alarm” command. auth [uid=range] [gid=range] Reverts the permission settings configured by the “set permissions”...
Page 46
Command descriptions revert samba Reverts the service settings configured by the “set samba” command. sdmemory Reverts the SD memory settings configured by the “set sdmemory” command. serial [port=range] Reverts the serial settings configured by the “set serial” command. serialport [port=range] Reverts all serial settings configured by the “set serial”, “set tcpserial”, “set udpserial”, “set profile”, “set serial”, “set buffers”, “set pmode”, and “set modem”...
Page 47
Command descriptions revert See also boot The various “set” commands referenced in this description. show ConnectPort® LTS Command Reference...
Command descriptions rlogin rlogin Purpose Performs a login to a remote system, also referred to as an rlogin. Required permissions For products with two or more users, permissions must be set to “set permissions rlogin=execute” to use this command. See "set permissions" for details on setting user permissions for commands.
Page 49
Command descriptions set alarm set alarm Purpose Configures device alarms and display current alarm settings. Device alarms are used to send emails or SNMP traps when certain device events occur. These events include data patterns detected in the serial stream. To avoid false errors, configure alarms while alarms are disabled, by entering a “set alarm state=off”...
Page 50
“set snmp” command with the “trapdestip” option. See "set snmp." email An email alarm is sent. snmptrap An SNMP trap is sent. If snmptrap is specified, the “subject” text is sent with the alarm. The MIBs for these traps are DIGI-SERIAL-TRAPS.mib, and DIGI-BOBILETRAPS.mib. ConnectPort® LTS Command Reference...
Page 51
This command turns on alarm 11, and sends the alarm via email. The email is sent to fred@digi.com, with “Email alarm” on the subject line with a high priority. An alarm is sent if port 16 shows “kernel failure”...
Page 52
Command descriptions set autoconnect set autoconnect Purpose Used to establish an automatic connection (autoconnection) between the serial port and a remote network destination, and to display current autoconnect settings. Required permissions For products with two or more users, to use this command, permissions must be set to one of the following: For a user to display autoconnect settings for the line on which they are logged in: “set permissions s-autoconnect=r-self”...
Page 53
Command descriptions set autoconnect Used to specify the serial port. Optional on a single-port device. To configure settings for the XBee port, specify “port=xbee.”And to configure settings for an internal modem port, specify “port=internalmodem.” state={on|off} Enables or disables the autoconnect feature. Enables the autoconnect feature.
Page 54
Command descriptions set autoconnect A secure connection conforming to SSL (Secure Sockets Layer) Version 3 and Transport Layer Security (TLS) Version 1 will occur. telnet A connection with Telnet processing will occur. A SSH(Secure Shell) connection will occur. The default is “raw.” description=string A name for descriptive purposes only.
Page 55
Command descriptions set autoconnect Examples Set autoconnect on with trigger This example shows setting autoconnect to connect to the TCP port (2101) of the network IP destination when data arrives on the serial port. #> set autoconnect state=on trigger=data ipaddress=10.0.0.1 ipport=2101 Allow outgoing data that is either unacknowledged or less than maximum segment size #>...
Page 56
Command descriptions set buffer set buffer Purpose Configures buffering settings on a port, or displays the port buffer configuration settings on all ports. The port buffering feature allows you to monitor incoming ASCII serial data in log form. Required permissions For products with two or more users, to use this command, permissions must be set to one of the following: For a user to display the port buffering settings for the line on which they are logged in: “set...
Page 57
Command descriptions set buffer The port or ports to which the command applies. To configure settings for the XBee port, specify port=xbee. And to configure settings for an internal modem port, specify “port=internalmodem.” size The size in kilobytes to configure the buffer. Settings are configurable in 2-kilobyte increments. The maximum size is 64 kilobytes.
Page 58
Command descriptions set buffer #> set buffer Configure buffers In this example, the set buffer command sets the buffer state for port 1 to on mode and the buffer size to 64 kilobytes. #> set buffer port=1 state=on size=64 In this example, the set buffer command sets the buffer state for port 1 to on mode and the data will be buffered on NFS server with 16 kilobytes of buffer size.
Page 59
Command descriptions set esc set esc Purpose Sets escape characters. Required permissions Root privileges are required to initiate the set esc shell. Syntax Set escape character #> set esc Options connectesc=(string) telnetesc=(string) sshesc=(string) ConnectPort® LTS Command Reference...
Page 60
Command descriptions set ethernet set ethernet Purpose Configures, adjusts, and displays Ethernet communications options. Required permissions For products with two or more users, permissions must be set to “set permissions s-ethernet=read” to display Ethernet communications options, and “set permissions s-ethernet=rw” to display and configure Ethernet communications options.
Page 61
Command descriptions set ethernet Configures the Ethernet speed the ConnectPort LTS product will use on the Ethernet network. Specify an appropriate setting for your Ethernet network, which can be one of the following: The device operates at 10 megabits per second (Mbps) only. The device operates at 100 Mbps only.
Command descriptions set group set group Purpose Used to create and manage user groups. You can use “set group” to do the following: Add a group. A maximum of 32 groups can be defined. Remove groups. Change group configuration attributes. Display group configuration attributes.
Command descriptions set group id=range Specifies the ID or range of IDs of the groups to be acted on. name= string Specifies the name of the group to be acted on. newname=string Specifies a new group name. Default permissions When a new group is created, it has no permissions. Examples Add a new group #>...
Page 64
( _ ) and hyphen ( -) characters. To enter a multiple- word name with spaces, enclose the name in quotation marks, as shown in the example below. Examples #> set host name=CPLTS #> set host name=”CPLTS DIGI” See also show ConnectPort® LTS Command Reference...
Command descriptions set ippool set ippool Purpose Creates a pool of IP addresses for serial ports and internal modem, or displays the currently defined pool of IP addresses. This command can be used for configuring IP addresses for PPP connections. Required permissions Permissions must be set to “set permissions s-ppp=read”...
Page 66
Command descriptions set lcd set lcd Purpose Configure LCD device settings and displays current LCD settings Required permissions Permissions must be set to one of the following: For a user to display the LCD settings: “set permissions s-lcd=read” For a user to display and set the LCD settings: “set permissions s-lcd=rw” Syntax Enable/Disable LCD set lcd state=[on|off]...
Page 67
Command descriptions set lcd Specifies whether the default background image will be used on idle time out. Use the default background image Use the custom background image loaded by user. load_image=host:filename Specifies the tftp server and file name to be used to upload user custom LCD background image. host The IP address or DNS name of a host from which the custom LCD background image will be downloaded to the ConnectPort LTS device using TFTP.
Command descriptions set modem set modem Purpose Used to configure options of modem profile for a serial port, or display current modem profile settings for a serial port. Required permissions Permissions must be set to one of the following: For a user to display the modem settings: “set permissions s-modem=read” For a user to display and set the modem settings: “set permissions s-modem=rw”...
Page 69
Command descriptions set modem The modem will dial-out to establish connections with external hosts or to connect to an external PPP network. network_bridge The modem can be used both to establish connections to other hosts as well as receive connections from other hosts. ppp_connection={on|off} Specifies whether the modem will use the PPP connection.
Page 70
Command descriptions set network set network Purpose Sets and displays network configuration options. Required permissions For products with two or more users, permissions must be set to “set permissions s-network=read” to display network configuration attributes, and “set permissions s-network=rw” to display and set network configuration attributes.
Page 71
Command descriptions set network [ advanced ip options ] are: [reuse_old_op={off|on}] [autoip={off|on}] [sbr={off|on}] Display current network configuration options set network Options index=1-4 Select index for Ethernet interface to configure. "index=1” is for setting Ethernet interface 1(eth0) and "index=2” is for setting Ethernet interface 2(eth1). "index=3” and "index=4” are reserved for future use.
Page 72
Command descriptions set network Sets the mode of device IP v6 address none Disable IPv6 address. static When selected, the device uses the specified IP address and gateway address. dhcp When selected, the device attempts to use the DHCP v6 protocol to find an IP address and gateway address.
Page 73
Command descriptions set network Enable manual DNS. Disable manual DNS. dns1=primary dns server ip address dns2=secondary dns server ip address For DNS, these options specify the DNS nameservers to use. Name lookups will be performed using the nameserver specified on “dns1” first, and if fails, the nameserver specified on “dns2”...
Page 74
Command descriptions set network #> set network index=2 mode_v4=dhcp See also revert set autoconnect set service show ConnectPort® LTS Command Reference...
Page 75
Command descriptions set nfs set nfs Purpose Configures the Network File System (NFS) settings and displays the status of the NFS service. Network File System (NFS) is a network file system protocol that allows a user on a client computer to access files over a network in a manner similar to how local storage is accessed.
Page 76
Command descriptions set nfs path=pathname Specifies the full path of directory on NFS server. timeout=5-3600 Specifies a time out value for waiting response from NFS server. interval=5-3600 Specifies an interval to check the status of NFS server. alert_state={off|on} Specifies whether the alert for changing of the status of NFS service will be enabled. Enable the alert.
Page 77
Command descriptions set nfs If “alert_type=email,” this option specifies the text to be included in the “subject” field of an alarm- triggered email. If “alert_type=snmptrap,” this option specifies the text to be included in the “NFS Alarm Subject” field of an alarm- triggered SNMP trap. alert_to=email address The text to be included in the “to”...
Command descriptions set permissions set permissions Purpose Used to set user permissions associated with various services and command-line interface (CLI) commands, or display current permission settings. Commands without permissions There are no permissions associated with the following commands: close exit help info quit...
Page 80
Command descriptions set permissions r-self The user can execute the "display" portions for both commands if the user is logged in on the specified line. read The user can execute the "display" and "set" portions for both commands if the user is logged in on the specified line.
Page 81
Command descriptions set permissions Permissions for the “kill” command. (See "kill") newpass={none|rw-self|rw} Permissions for the “newpass” command. (See "newpass") none The command cannot be executed. rw-self The user can set their own password. The user can set any user’s password. ping={none|execute} Permissions for the “ping”...
Page 82
Command descriptions set permissions Permissions for the “set group” command. (See "set group") s-host={none|read|rw} Permissions for the “set host” command. (See "set host") s-internalmodem={none|read|rw} Permissions for the “set internalmodem” command. (See "set internalmodem") s-lcd ={none|read|rw} Permissions for the “set lcd” command. (See "set lcd" ) s-modem ={none|read|rw} Permissions for the “set modem”...
Page 83
Command descriptions set permissions Permissions for the “set trace” command. (See "set trace") s-udpserial={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “set udpserial” command. (See "set udpserial") s-usb ={none|read|rw} Permissions for the “set usb” command. (See "set usb") s-user={none|read|rw} Permissions for the “set user” command. (See "set user") s-xbee={none|read|rw} Permissions for the “set xbee”...
Command descriptions set pmodem set pmodem Purpose Configures various options for modem emulation over TCP/IP, and display current modem-emulation settings. Required permissions For products with two or more users, to use this command, permissions must be set to one of the following: For a user to display the modem emulation settings for the line on which they are logged in: “set permissions s-pmodem=r-self”...
Page 85
Command descriptions set pmodem Enables modem emulation. Disables modem emulation. The default is “off”. telnet Enables or disables Telnet processing on incoming and outgoing modem-emulation connections. Enables Telnet processing. Disables Telnet processing. The default is “off”. Example #> set pmodem port=1 state=on See also revert show...
Command descriptions set portauth set portauth Purpose Configures or displays authentication settings of each serial port. Authentication options include None, Local. Radius, and LDAP. Required permissions Permissions must be set to one of the following: For a user to display the authentication settings for serial ports: “set permissions s- portauth=read”...
Page 87
Command descriptions set portauth settings. Required when configuring port authentication settings. To configure authentication settings for an XBee port or internal modem, specify port=xbee or port=internalmodem. authmethod={none|local|radius_server|radius_local| local_radius|radius_down_local|ldap_server|ldap_local|local_ldap} The port authentication method to be used for the serial port. Required when configuring port authentication settings.
Page 88
Command descriptions set portauth local_ldap When selected, the user authentication performed through the local database of ConnectPort LTS first. If succeeded, user can access the serial port. If failed, user authentication performed through the LDAP server again. ldap_down_local When selected, the user authentication is performed through the LDAP server first. If it succeeds, the user can access the serial port.
Page 89
Command descriptions set portauth The timeout (specified in seconds) controls how long the ConnectPort LTS will wait for the response from Radius authentication server. Factory default value is 10. retries =1-50 The retries controls how many time the ConnectPort LTS will try to communicate with the Radius authentication server.
Command descriptions set portgroup set portgroup Purpose Configures or displays port group settings. Port group is a convenience feature which can be created to send data to multiple ports. Instead of sending data to individual serial ports, data can be sent to all ports in a group simultaneously through a port in a group.
Page 91
Command descriptions set portgroup Specifies the name of port group to be acted on. ports=0-32 Serial port or range of serial ports. If “port=0” is specified, all ports specified to this port group will be reset. showdata={on|off} When enabled, user can see the data from other ports in the same group from a terminal connected to the one of serial ports in the group.
Command descriptions set ppp set ppp Purpose Configures Point-to-Point Protocol (PPP) connections, or displays current PPP settings. Required permissions Permissions must be set to one of the following: For a user to display the PPP settings: “set permissions s-ppp=read” For a user to display and set the PPP settings: “set permissions s-ppp=rw” Syntax Add a new ppp setting set ppp add index=1-64...
Page 93
Command descriptions set ppp Remove a PPP setting. index=1-64 PPP user index. connection_type={none|incoming|outgoing} The connection type. none Disable PPP settings for the user. incoming Used for inbound PPP connections. The ConnectPort LTS product will receive connections from other hosts for this user. outgoing Used for outbound PPP connection.
Page 94
Command descriptions set ppp Allow remote peer to specify remote IP address. static The specified IP address for remote peer will be used. ipaddr=ip address The IP address of remote peer to be used if the ipaddrmode=static phonenumber1=phone number The primary phone number to dial to request PPP connection. phonenumber2= phone number The secondary phone number to dial to request PPP connection.
Command descriptions set profile set profile Purpose Associates a particular port with one of several port configuration profiles, or displays the current port-profile settings. Port profiles are a defined set of port configuration settings for a particular use. A port profile reconfigures serial-port settings to the necessary default values in order for the profile to operate correctly.
Page 97
Command descriptions set profile For a user to display the profile settings for any line, and set modem emulation settings for the line on which the user is logged in: “set permissions s-profile=w-self-r” For a user to display and set the profile settings on any line: “set permissions s-profile=rw” See "set permissions"...
Page 98
Command descriptions set profile Associates the UDP Sockets port profile with the port. custom Associates the Custom port profile with the port. printer Associates the Printer port profile with the port. modem Associates the Modem port profile with the port. local config Associates the Local Configuration port profile with the port.
"python" command. While this option allows for programs to be run from a TFTP server, this use is not recommended. If there are spaces to provide arguments, make sure to wrap the entire command in quotation marks. Example #> py dia.py See also python The Digi Python Programming Guide ConnectPort® LTS Command Reference...
Page 100
Command descriptions set realport set realport Purpose Configures and displays RealPort-related settings. Required permissions For products with root and non-root (normal) users, the root user can configure RealPort settings. The normal user can display RealPort settings. Syntax Configure RealPort settings set realport [keepalive={on|off}] [exclusive={on|off}] Display current RealPort settings...
Page 101
Command descriptions set realport See also network: The “set network” keepalive options (“idle,” “probe_count,” “probe_interval”) should be configured for various services that are configured by “set service keepalive= {on|off},” or clients such as autoconnect (“set autoconnect keepalive={on|off}”). set service set autoconnect ConnectPort®...
Page 102
Command descriptions set rtstoggle set rtstoggle Purpose RTS toggle is used to raise RTS when sending data. This command enables or disables RTS toggle on a given serial port, and displays current RTS toggle settings. Required permissions For products with two or more users, to use this command, permissions must be set to one of the following: For a user to display the RTS toggle settings for the line on which they are logged in: “set permissions s-rtstoggle=r-self”...
Page 103
Command descriptions set rtstoggle Enables the RTS toggle feature. Disables the RTS toggle feature. The default is “off”. predelay=delay Specifies the time in milliseconds to wait after the RTS signal is turned on before sending data. The range is 0 to 5000 milliseconds. The default is 0. postdelay=delay Specifies the time in milliseconds to wait after sending data before turning off the RTS signal.
Command descriptions set samba set samba Purpose Configures and displays Samba service settings. Required permissions Permissions must be set to one of the following: For a user to display the Samba settings: “set permissions s-service=read” For a user to display and set the Samba settings: “set permissions s-service=rw”...
Page 105
Command descriptions set samba Specifies the host name or the IP address of Samba server path=path Specifies the full path of directory on Samba server. timeout=5-3600 Specifies a time out value for waiting response from Samba server. interval=5-3600 Specifies an interval to check the status of Samba server. user=user name Specifies the name of user for Samba service.
Page 106
Command descriptions set samba The default is “email.” alert_subject=string If “alert_type=email,” this option specifies the text to be included in the “subject” field of an alarm- triggered email. If “alert_type=snmptrap,” this option specifies the text to be included in the “Samba Alarm Subject”...
Command descriptions set sdmemory set sdmemory Purpose Configurdes and displays SD memory device settings. Required permissions Permissions must be set to one of the following: For a user to display the SD memory settings: “set permissions s-sdmemory=read” For a user to display and set the SD memory settings: “set permissions s-sdmemory=rw”...
Page 108
Command descriptions set sdmemory ext2 ext2 or second extended filesystem. vfat Virtual file allocation table filesystem. Example Format the SD memory card #>set sdmemohry format ConnectPort® LTS Command Reference...
Command descriptions set serial set serial Purpose Sets and displays general serial configuration options, such as baud rate, character size, parity, stop bits, and flow control. Required permissions For products with two or more users, to use this command, permissions must be set to one of the following: For a user to display the serial settings for the line on which they are logged in: “set permissions s-serial=r-self”...
Page 110
Command descriptions set serial set serial [port= range ] Options port={range|internalmodem}xbee} Used to specify the serial port. Optional on a single-port device. To configure settings for an internal modem port, specify “port=internalmodem” To configure settings for an XBee port, specify “port=xbee.”...
Page 111
Command descriptions set serial Odd parity. mark Mark parity. space Space parity. The default is “none.” stopbits ={1|2} The number of stop bits per character to use on this line. The value used here must match the setting on the device connected to this port. Use 1 or 2 stop bits. The default is 1 stop bit.
Exercise caution in enabling and disabling network services, particularly disabling them. Changing certain settings can render your product inaccessible. For example, if you disable Advanced Digi Discovery Protocol (ADDP), the device will not be discovered on a network, even if it is actually connected.
Page 113
Command descriptions set service Configurable TCP keepalive parameters, for example, how many keepalives to send and when to send them are configured globally via the “set network” command (see "set network"). nodelay={on|off} Used to allow unacknowledged or smaller-than-maximum-segment-sized data to be sent for the specified range of network services.
Page 114
Default network port Service Services provided number Advanced Digi Discovery Discovery of Digi devices on a network. 2362 Protocol (ADDP), also known as Device Discovery Encrypted (Secure) RealPort Secure Ethernet connections between COM or TTY 1027 ports and device servers or terminal servers.
Page 115
Command descriptions set service Default network port Service Services provided number Telnet Passthrough Allows a Telnet connection directly to the serial port, 2001 often referred to as reverse Telnet. Transmission Control Allows a raw socket connection directly to the serial 2101 Protocol (TCP) Passthrough port, often referred to as reverse sockets.
Page 116
Command descriptions set service state port keepalive nodelay dlyd_ack Telnet Service none none HTTP Service none none HTTPS Service TCP Echo Service UDP Echo Service 50000 none none Modem Emulation(Pool) 2001 Telnet Server(Port 1) 2101 TCP Server(Port 1) 2101 UDP Server(Port 1) 2501 SSH Server(Port 1) 2601...
Page 117
Command descriptions set service See also revert set network show ConnectPort® LTS Command Reference...
Command descriptions set smtp set smtp Purpose Configures the Simple Mail Transfer Protocol(SMTP) server, or displays current SMTP settings. Required permissions For products with two or more users, permissions must be set to “set permissions s-service=read” to display the SMTP service settings, and “set permissions s-service=rw” to display and change the SMTP service settings.
Page 119
Specifies the password of the user for SMTP authentication. from=email address Specifies the sender’s e-mail address. Examples Enable SMTP service #>set smtp state=on mode=auth smtp_server=192.168.100.100 user=test password=test1234 from=lts@digi.com Display current SMTP settings #>set smtp See also revert To disable and enable SMTP alarm traps, see alarm.
Page 120
Command descriptions set snmp set snmp Purpose Configures the Simple Network Management Protocol (SNMP) agent, or displays current SNMP settings. Required permissions For products with two or more users, permissions must be set to “set permissions s-snmp=read” to display SNMP service settings, and “set permissions s-snmp=rw” to display and change SNMP service settings.
Page 121
Command descriptions set snmp [linkuptrap={off|on}] [logintrap={off|on}] [ snmpv3 trap options ] are: [trap security_level={auth nopriv|auth priv| noauth nopriv}] [trap_auth_user= username ] [trap_auth_protocol={md5|sha}] [trap_auth_pwd= password ] [trap_priv_protocol={des|aes}] [trap_priv_pwd= password ] [trap_engine_id= string ] Display SNMP settings set snmp Options [snmpv1v2c options] snmpv1v2_enabled={off|on} Enables or disables the accessing of SNMP-managed objects through SNMP v1/v2c protocol.
Page 122
Command descriptions set snmp Disables the accessing of SNMP-managed objects through SNMP v3 protocol. Enables the accessing of SNMP-managed objects through SNMP v3 protocol. security_level={auth_nopriv|auth_priv|noauth_nopriv} Indicates the security level of the user with regard to authentication and privacy auth_nopriv Set the security level to use authentication only. auth_priv Set the security level to use both authentication and privacy.
Page 123
Command descriptions set snmp priv_pwd=password Set the password for privacy. [snmp trap options] trap_version={none|v1|v2c|v3} Specify the version of SNMP protocol to use for SNMP trap configuration. none Disable SNMP trap. Use SNMP v1 protocol for SNMP trap. Use SNMP v2c protocol for SNMP trap. Use SNMP v3 protocol for SNMP trap.
Page 124
Command descriptions set snmp Enables the sending of link up traps. Disables the sending of link up traps. The default is “off”. logintrap={off|on} Enables or disables the sending of login traps. Enables the sending of login traps. Disables the sending of login traps. The default is “off”.
Page 125
Command descriptions set snmp Set DES algorithm as privacy protocol. Set AES algorithm as privacy protocol. trap_priv_pwd=password Specifies the SNMPv3 trap privacy password. trap_engine_id=string Specifies SNMPv3 trap engine ID. Examples Enable authentication failure traps #> set snmp trapdestip=10.0.0.1 authfailtrap=on Specify a new private community string #>...
Page 126
Command descriptions set socket_tunnel set socket_tunnel Purpose Configures a socket tunnel. A socket tunnel can be used to connect two network devices: one on the ConnectPort LTS product’s local network and the other on the remote network. This is especially useful for providing SSL data protection when the local devices do not support the SSL protocol.
Page 127
Command descriptions set socket_tunnel The timeout (specified in seconds) controls how long the tunnel will remain connected when there is no tunnel traffic. If the timeout value is zero, then no timeout is in effect and the socket tunnel will stay up until some other event causes it to close.
Command descriptions set switches set switches Purpose Configures Multiple Electrical Interface (MEI) settings on a per-port basis, and displays current MEI settings. MEI settings include the type of electrical interface (EIA-232 or EIA-485), the number of differential wires used for communication, and whether termination and biasing resistors are used. Required permissions The serial permissions associated with the "set serial"...
Page 129
Command descriptions set switches mode={232|485} Selects the electrical interface of the serial port. The selected value determines whether the "wires" and "termination" options are meaningful. The serial port uses electrical interface EIA-232. This interface uses independent wires to transmit and receive data, which allows data to be sent and received between devices simultaneously.
Page 130
Command descriptions set switches Configure a half-duplex EIA-485 endpoint #> set switches port=1 mode=485 wires=two termination=on Configure a full-duplex 422 interior node #> set switches port=1 mode=485 wires=four termination=off See also display: The “display switches” command displays the current switch settings. revert: The “revert switches”...
Command descriptions set sysauth set sysauth Purpose Configures or displays authentication settings for the command-line interface or web server. The following authentication options are provided: Local Radius LDAP Required permissions Permissions must be set to one of the following: For a user to display the authentication settings for CLI or Web server: “set permissions s-sysauth=read”...
Page 132
Command descriptions set sysauth The index number associated with the system authentication settings. Required when configuring system authentication settings. To configure authentication settings for Web server, specify “index=1.” To configure authentication settings for CLI access, specify “index=2.” authmethod= {local|radius_server|radius_local| local_radius|radius_down_local|ldap_server|ldap_local|local_ldap| ldap_down_local} The authentication method to be used for CLI or Web server.
Page 133
Command descriptions set sysauth ldap_down_local User authentication performed through the LDAP server first. If succeeded, user can access CLI or Web server. But if the LDAP server does not respond to the authentication request from the ConnectPort LTS, user authentication performed through local database of ConnectPort LTS again.
Page 134
Command descriptions set sysauth Security option for LDAP authentication. If start_tls is selected, the StartTLS extended operation is used to secure the communication between ConnectPort LTS and the LDAP Server. Example #> set sysauth index=1 authmethod=radius primary_authsvr=192.1681.1 secret=teststring See also revert show ConnectPort®...
Command descriptions set syslog set syslog Purpose Used for managing SYSLOG settings and showing the status of the SYSLOG service. The SYSLOG service sends serial port data to a SYSLOG server. Required permissions Permissions must be set to one of the following: For a user to display the Samba settings: “set permissions s-service=read”...
Command descriptions set system set system Purpose Configures and displays system-identifying information, such as a description of the device, its location, and a contact person. Required permissions For products with two or more users, permissions must be set to “set permissions s-service=read” to display network service settings, and “set permissions s-services=rw”...
Command descriptions set tcpserial set tcpserial Purpose Configures behaviors of TCP serial connections and displays current TCP serial settings. This command affects the following TCP serial connections: Connections made using the autoconnect feature. Incoming network connections made to the following: The TCP server (raw socket, IP port 2101~2132 by default) The Telnet server (telnet socket, IP port 2001~2032 by default) The SSH server (telnet socket, IP port 2501~2532 by default)
Page 139
Command descriptions set tcpserial [sendcount=1-65535] (bytes) [sendtime={0|1-65535}] (milliseconds) [endpattern= string ] [strippattern={on|off} Display TCP serial settings set tcpserial [port=range] Options port=range Used to specify the serial port. Optional on a single-port device. To configure settings for an XBee port, specify “port=xbee.” To configure settings for an internal modem port, specify “port=internalmodem.”...
Page 140
Command descriptions set tcpserial Indicates that data from the serial port should be sent out to the network after buffering the given number of bytes. This option only is valid when the “buffered” option is “on.” The default is 1024 bytes. sendtime={0|1-65535} (milliseconds) Indicates that data from the serial port should be sent out to the network after the given amount of time has passed where no new data has arrived from the serial port.
Command descriptions set time set time Purpose Set system time or display current system time. Sets the Coordinated Universal Time (UTC) and/or system time and date on the ConnectPort LTS device. If the “offset” option is set to anything other than “00”, this command assumes that if date and time are being set, they are system time.
Page 142
Command descriptions set time Month; ranges from 1 to12. Day; ranges from 1 to 31. Year; ranges from 0 to 99. offset={hh:mm|hh} Hour offset; ranges from -12 to 14. Minute offset; allowed values are one of 00,15,30, or 45. Examples Set system time #>set time time=09:30:00 date=03.15.10 Display current time...
Page 143
Configures a ConnectPort LTS product for tracing and displays tracing information. The “set trace” command should be used when working with Digi Technical Support. Enabling tracing can have an impact on system performance. Digi provides no guarantee that trace output is the same across firmware revisions.
Page 144
Support for assistance in using the appropriate type keyword. severity={assert|critical|warning|info|debug} The severity level of events traced. assert Tracing is done on assert lines only. This severity level is for Digi-internal use only. critical Tracing is done on only the most severe events. This is the default severity level.
Page 145
Enable tracing and send all ssh info and debug data to a syslog server. #> set trace state=on syslog=on loghost=SYSLOG_IP mask=ssh:+id Output Refer to Digi Technical Support for descriptions and interpretations of trace output. Digi provides no guarantee that trace output is the same across firmware revisions. See also info commands.
Command descriptions set udpserial set udpserial Purpose Configures and displays current settings for the UDP serial feature. This feature allows data to be sent between the serial port and one or more remote network destinations using the UDP protocol. When this feature is enabled for a given serial port, data sent to the serial port will be sent out to the configured destinations.
Page 147
Command descriptions set udpserial [ipaddress= ip address } [ipport= ip port ] Display current UDP serial settings set udpserial [port= range [range= range ]] Options Options for setting general UDP serial forwarding characteristics port=range Used to specify the serial port. Optional on a single-port device. To configure settings for an XBee port, specify “port=xbee”.
Page 148
Command descriptions set udpserial The value of “sidstring” is sent at the beginning of each UDP packet. The value of “sidstring” is not sent at the beginning of each UDP packet. The default is "off." sidstring=string The string sent at the beginning of each UDP packet if the “sid” option is set to on. The maximum length of this string is 32 characters, including escape sequences for special characters.
Page 149
Command descriptions set udpserial The following are all valid ways of using set udpserial to display current UDP serial settings: #> set udpserial See also revert show ConnectPort® LTS Command Reference...
Page 150
Command descriptions set usb set usb Purposhe Configure USB device settings and displays current USB settings. Required permissions Permissions must be set to one of the following: For a user to display the USB settings: “set permissions s-usb=read” For a user to display and set the SD memory settings: “set permissions s-usb=rw”...
Page 151
Password Authentication Protocol (PAP) authentication is required. both Both CHAP and PAP authentication are required. The default is “none.” CHAP authentication works between two Digi Connect products. CHAP will be negotiated to PAP for all other connections. user=string The user name for logging onto the cellular network via the USB modem.
Page 152
Command descriptions set usb Example Format the USB memory #>set usb format id=1 ConnectPort® LTS Command Reference...
Command descriptions set user set user Purpose Used to: Add users for access to a ConnectPort LTS product. Up to 32 users can be defined. Associate a user with up to two groups. A user can be associated with up to two groups. Disassociate a user from a group.
Page 154
Command descriptions set user set user add id= number name= user name [commandline={on|off}] [groupaccess={on|off}] [defaultaccess={commandline|group|none}] [defaultgroup={none|index| name of group for default access ) [public_key= tftphost:filename ] Remove a user set user remove {id=1-32|name= user name } Associate a user with a group set user associate {id=number|name= user name } {gid=group id|gname= string } Disassociate a user from a group...
Page 155
Command descriptions set user Associate a user with a group. A user can be associated with a maximum of two groups. disassociate Disassociate a user from a group. id=1-32 Specifies the ID or range of IDs of the users to be acted on. name=user name Specifies the name of the user to be acted on.
Page 156
Command descriptions set user climenu The user can display and access the command-line menu interface. shell The user will be displayed and given access to the Linux shell (Linux command line interface) assuming the user and/or associated groups have command line access rights enabled.
Page 157
Command descriptions set user #> set user id=4 defaultaccess=commandline See also newpass revert set group set permissions show User permissions in ConnectPort LTS products ConnectPort® LTS Command Reference...
Page 158
Command descriptions set web set web Purpose Configure the timeout value for the web interface. Required permissions Permissions must be set to one of the following: For a user to display the Web server settings: “set permissions s-service=read” For a user to display and set the Web server settings: “set permissions s-service=rw”...
Page 159
Command descriptions set xbee set xbee Purpose The “set xbee” command performs several functions: Displays current configuration settings for the XBee RF module Displays Xbee settings for a particular node Changes the state of the XBee RF module (enabled/disabled) Loads firmware to the XBee RF module Executes AT commands on the XBee RF module The XBee RF module is regarded as one of the serial ports on the ConnectPort LTS device.
Page 160
Command descriptions set xbee The XBee RF module can be managed from the command-line interface. That is, you can issue AT commands to the XBee RF module from the command-line interface. Release exclusive mode. The XBee RF module cannot be managed via the command-line interface. AT commands cannot be issued the XBee RF module via the CL.
Page 161
Command descriptions set xbee Change the XBee ID using the AT command “ID” #> set xbee ID=0x001002F04 See also set serial set tcpserial set udpserial set portauth set service set autoconnect ConnectPort® LTS Command Reference...
Page 162
Command descriptions show show Purpose Displays the current settings in a device, including current configuration settings, boot code loaded in the device, and the effects of commands issued to the device. Required permissions For products with two or more users, for this command to display current device settings, the various “set”...
Page 163
Command descriptions show Works Works w/port w/range Option Displays settings configured by option option rtstoggle set rtstoggle serial set serial service set service snmp set snmp socket_tunnel set socket_tunnel system set system tcpserial set tcpserial udpserial set udpserial (when specifying UDP serial destinations) user set user...
Page 164
Command descriptions show range=range A configuration table entry or range of entries. Examples Display network configuration settings #> show network Network configuration "eth0" interface configuration MAC address 00:04:9F:EF:23:33 IPv6 Link addr fe80::204:9fff:feef:2333/64 IPv6 Site addr IPv6 Global addr (Currently in use) Currently in use by the network stack Stored configuration...
Page 165
Command descriptions show ip_v6 <none> (Stored configuration) gateway_v6 <none> (Stored configuration) ip_6to4tunnel ip_v4_6to4relay 192.88.99.1 192.88.99.1 ip_v6_v4addr <none> <none> General options manual_dns dns1 206.13.28.12 0.0.0.0 dns2 0.0.0.0 0.0.0.0 idle 7200 7200 probe_count probe_interval reuse_old_ip autoip Display current alarm settings #> show alarm Display settings for a particular user #>...
Page 166
Command descriptions status status Purpose Displays the current list of sessions. The “status” command displays the status of outgoing connections (connections made by “connect,” “rlogin,” or “telnet” commands). In contrast, the “display” command displays real-time information about a device, while the “info” command displays statistical information about a device over time.
Page 167
Command descriptions telnet telnet Purpose Used to make an outgoing Telnet connection, also known as a session. Required permissions For products with two or more users, permissions must be set to “set permissions telnet=execute” to use this command. See "set permissions" for details on setting user permissions for commands. Syntax telnet ipaddress [ tcp port ] Options...
Page 168
Command descriptions Purpose Initiates and controls wide-area network (WAN) connections, or displays the status of current WAN connections. Required permissions Anyone can display the status of WAN connections. Root privileges are required to initiate or control WAN connections. Syntax Initiate and control WAN connections wan [close= username ] [start= username ] [range= range ]...
Page 169
Command descriptions Purpose Displays active connections to and from the device. Required permissions For products with two or more users, permissions must be set to “set permissions who=execute” to use this command. See "set permissions" for details on setting user permissions for commands. Syntax Options None at this time.
Need help?
Do you have a question about the ConnectPort LTS8 and is the answer not in the manual?
Questions and answers