ConnectPort® LTS Command Reference ConnectPort LTS 8, ConnectPort LTS 8 MEI, ConnectPort LTS 8 W, ConnectPort LTS 8 MEI W, ConnectPort LTS 16, ConnectPort LTS 16 MEI, ConnectPort LTS 16 W, ConnectPort LTS 16 MEI W, ConnectPort LTS 16 MEI 2AC, ConnectPort LTS 32, ConnectPort LTS 32 MEI, ConnectPort LTS 32 W, ConnectPort LTS 32 MEI W 90001099_C
© Digi International Inc.2012. All Rights Reserved. Digi, Digi International, the Digi logo, ConnectPort, XBee, and RealPort are trademarks or registered trademarks of Digi International, Inc. in the United States and other countries worldwide. All other trademarks are the property of their respective owners. Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International.
Contents 1. Introduction ........................................................................................................................................... 6 Products to which this book applies ...................................................................................................... 6 Quick reference for configuring features .............................................................................................. 7 Access the command line .........................................
revert ................................................................................................................................................... 45 rlogin ................................................................................................................................................... 50 set alarm .............................................................................................................................................. 51 set autoconnect ........................
set trace.............................................................................................................................................. 160 set udpserial ....................................................................................................................................... 164 set usb ................................................................................................................................................ 169 set user ....................................
1. 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. Basic information that applies to all commands, including navigation and editing keys, displaying online help, abbreviating commands, syntax conventions, and entering special characters in string values.
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. If you are viewing the PDF file of this document, click the commands in the “Commands” column to go to the command descriptions. Feature/Task Commands Alarms "set alarm". Autoconnection (automatically connect a user "set autoconnect". to a server or network device) "set serial". "set tcpserial".
Feature/Task Commands Python program storage and execution on To learn about the Python programming language and ConnectPort LTS products writing programs: see the Digi Python Programming Guide. To configure Python programs to execute when the Digi device boots: "set python" To manually execute a Python program from the command line: "python" RealPort (COM port redirection) "set realport" configuration See also the RealPort Installation Guide.
Feature/Task Commands Simple Mail Transfer Protocol (SMTP) To configure SMTP settings: "set smtp" settings Set system information: assign system- "set system".
Access the command line To configure devices using commands, you must first access the command line, and then log on as needed. This procedure assumes that you have already configured the ConnectPort LTS product with an IP address. 1.
Basic command information 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. Ctrl+h or Backspace Scroll back through commands. Ctrl+p or Upper arrow Scroll forward through commands. Ctrl+n or Lower arrow Execute the command.
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: \* Match any character. This escape sequence is only available on the “set alarm match=string” option. \a Alert character.
Verifying device support for commands To verify whether a ConnectPort LTS device supports a particular command or command options, and to get the allowed ranges and limits for command options, you can enter several commands. For example: “help” displays all supported commands for a device. “?” displays all supported commands for a device. “set ?” displays the syntax and options for the “set” command. You can use this to determine whether the device includes a particular “set” command variant.
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. Permissions for User 1 can be changed to be less than the default root permissions. Additional users may be defined as needed.
2. Command descriptions 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. See "set permissions" for details on setting user permissions for commands.
bash Purpose Initiates the BASH Linux shell. Required permissions Root privileges are required to initiate the BASH shell.
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. See "set permissions" for details on setting user permissions for commands.
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. #> boot action=reset Reboot using firmware from a boot host This example loads the firmware stored on the TFTP host into flash ROM.
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” command, you must first escape the active session. Do this by pressing the escape key defined for your session type. The following table lists default escape keys.
Options * Closes all active sessions. connection number Identifies the session to close by its session number. Examples Close a session identified by number #> close 1 Close the current session #> close Close all active sessions #> 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.
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 connect serial port Create multiple connections Issue multiple “connect” commands.
display Purpose Displays status information for the device. The “display” command’s focus is on real-time information. In contrast, the “info” command displays statistical information about a device over time, while the “status” command displays the status of outgoing connections (connections made by “connect,” “rlogin,” or “telnet” commands).
Syntax display {arp|buffers|device|dnsserver|memory| netdevice|proxyarp|serial|sockets|tcp|udp| uptime|versions|xbee {refresh|clear}} Options arp Displays ARP table entries. buffers Displays the contents of a port buffer. This option is covered in more detail in "display buffers". device Displays general product information including product name, MAC address, boot, and firmware versions, memory usage, CPU utilization, and uptime.
tcp Displays active TCP sessions and active TCP listeners. To display more TCP-related statistics, such as number of input and output bytes transmitted, issue an “info tcp” command (see "info"). udp Displays current UDP listeners. To display more UDP-related statistics, such as number of input and output bytes transmitted, issue an “info udp” command (see "info"). uptime Displays amount of time since the device was booted. versions Displays boot firmware version information.
Example Display device information #> display device device information: product : ConnectPort LTS 32 MEI W mac address #1 : 00:40:9D:CC:CC:C6 mac address #2 : 00:40:9D:56:47:39 firmware version : N/A bios version : N/A cpu utilization uptime See also : 1 % : 2 hours 51 seconds total memory : 255944 used memory : 40760 free memory : 215184 • "info" • "show" • "status" 25
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"). Contents are displayed in log form.
tftp=server:filename server The IP address or DNS name of a server running TFTP to which buffer information should be transferred. filename The name to use for the file that will be transferred to the TFTP server. If the “port” option specifies more than one port, one file will be transferred for each port. The filename for each port will be “filename_n,” where n is the port number.
exit Purpose Terminates the current session. Syntax exit Example #> exit See also "quit". The “quit” and “exit” commands perform the same operation.
help and ? Purpose Displays help about a specific command.
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).
Options For a description of the statistics displayed by all these options see the statistics tables in the “Output” section of this description. device Displays statistics from the device table. This information includes devicemodel information, MAC address, current Bios and firmware, memory usage, utilization, and uptime. The information displayed by this option is the same as that displayed by the “display device” command (see "display").
Output Following are descriptions of the statistics displayed for each “info” command option. The statistics displayed include data, event, and error counts. These statistics are useful in understanding how the device is operating and can be helpful in finding problems. In particular if an error counter is found to be increasing you may have a problem with the device. To reset the statistics, reboot the device. Device statistics Device Information Description Product The model of the device.
Ethernet statistics Statistic Description InBytes Number of bytes received. OutBytes Number of bytes sent. 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. OutErrors Number of outgoing packets that contained errors.
IP statistics Statistic Description InReceives Number of datagrams received. OutRequests Number of datagrams given to IP to transmit. InAddressErrors Number of received datagrams discarded because they were for another host and could not be forwarded. DatagramsForwarded Number of received datagrams forwarded to another host. InHeaderErrors Number of received datagrams discarded because of invalid header information.
Serial statistics Statistic Description rbytes Total data in: the number of bytes received. tbytes Total data out: the number of bytes transmitted. overrun errors The number of times FIFO has overrun. The next data character arrived before the hardware could move the previous character. frame errors The number of framing errors detected. The received data did not have a valid stop bit. parity errors The number of parity errors detected. The received data did not have the correct parity setting.
TCP statistics Statistic Description InSegments Number of segments received. OutSegments Number of segments sent. InErrors Number of segments received with errors. RetransmitSegments Number of segments retransmitted. Segments are retransmitted when the ConnectPort LTS product doesn't respond to a packet sent by the client. This is to handle packets that might get lost or discarded somewhere in the network. EstabResets Number of established connections that have been reset.
UDP statistics Statistic Description InDatagrams Number of datagrams received. OutDatagrams Number of datagrams sent. InErrors Number of bad datagrams that were received. This number does not include the value contained by "No Ports" NoPorts Number of received datagrams that were discarded because the specified port was invalid. ZigBee socket statistics Statistic Description Frames Sent Number of frame sent. Frames Received Number of frame received.
Example Display ICMP statistics #> info icmp ICMP statistics: InMessages : 3 OutMessages : 5 InDestUnreachables : 2 OutDestUnreachables InErrors : 0 : 2 ICMPv6 statistics: InMessages : 0 InDestUnreachables : 0 InErrors : 0 See also OutMessages OutDestUnreachables • "display" . • "show".
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” to use this command. See "set permissions" for details on setting user permissions for commands. Syntax kill [range] [connection id] Options range A range of connection IDs.
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. See "set permissions" for details on setting user permissions for commands. Syntax newpass [{id=number|name=string}] Options id=number Specifies the ID of the user to be acted on.
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" for details on setting user permissions for commands. Syntax ping ipaddress [options] Options ipaddress Identifies the target of the “ping” command by its IP address.
python Purpose Manually executes a Python program from the command line. The “python” command is similar to a command executed on a PC. However, other than a program name and arguments for the program, the command takes no arguments itself, and is currently unable to spawn an interactive session. Syntax python [tftp server ip address:]filename [program arguments...] Options [(tftp server ip address):]filename The main file to be executed.
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.
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” to use this command. See "set permissions" for details on setting user permissions for commands.
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” command. The “revert auth” command (revert authentication and authorization) reverts all users, all groups, and all permissions at the same time.
Syntax revert [all| alarm| auth [uid=range][gid=range]| autoconnect [port=range]| buffer [port=range]| host| lcd| modem [port=range]| network| nfs| pmodem [port=range]| portauth [port=range] portgroup| ppp| profile [port=range]| python| realport| rtstoggle [port=rtstoggle]| samba| sdmemory| serial [port=range]| serialport [port=range] service| smtp| snmp| socket_tunnel| switches [port=range]| sysauth| syslog| system| tcpserial [port=range]| udpserial [port=range]| usb| web| xbee] 46
Options all 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” command, the user settings configured by the “set user” command, and group settings, configured by the “set group” command.
ppp Reverts the Point-to-Point Protocol (PPP) settings, configured by the “set ppp” command. profile [port=range] Reverts the profile settings configured by the “set profile” command. python Reverts the Python program settings configured by the "set_python" command. realport Reverts the Realport settings configured by the “set realport” command.
socket_tunnel Reverts the socket tunnel settings configured by the “set socket_tunnel” command. switches [port=range] Reverts the switch settings configured by the “set switches” command. syslog Reverts the SYSLOG settings configured by the “set syslog” command. system Reverts the system settings configured by the “set system” command. tcpserial [port=range] Reverts the TCP serial settings configured by the “set tcpserial” command.
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. Syntax rlogin [esc=character] [{user=username}] [ip address] Options esc= character A different escape character than the ~ (tilde) character, which will be used for the current Rlogin session.
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” command, then enable alarms after they are fully configured by entering “set alarm state=on”.
Options General alarm options state= {on|off} Enables or disables all alarms. on Enables all alarms. off Disables all alarms. To avoid false errors, it is recommended that you configure alarms while alarms are disabled, and enable alarms after they are fully configured. The default is “off.” Options for setting multiple alarms with the “range” option range= {1-32} Specifies the alarm or range of alarms for which alarm options are set. active={on|off} Enables or disables an alarm. on Enables an alarm.
subject=string If “type=email,” this option specifies the text to be included in the “subject” field of an alarm-triggered email. If “type=snmptrap,” this option specifies the text to be included in the “Serial Alarm Subject” field of an alarmtriggered SNMP trap. to=string The text to be included in the “to” field of an alarm-triggered email. type={email|snmptrap|all} Used to determine what kind of an alarm is sent: an e-mail alarm, an SNMP trap or both.
Data pattern matching-based alarm options In data pattern match mode, an alarm will be triggered when a pattern is found in the stream of serial data. These options are used for setting alarms in data pattern match mode: port=1-16 The serial ports to which the data pattern match alarm applies. match=string A string that triggers an alarm if the data pattern is found in the incoming serial stream. The maximum length of this string is 32 characters, including escape sequences for special characters.
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.
Syntax Configure autoconnect set autoconnect [port={range|xbee|internalmodem}] [state={on|off}] [trigger={always|data|dcd|dsr|string}] [service={raw|rlogin|ssl|telnet|ssh}] [description=string] [ipaddress=ip address] [ipport=ip port] [connect on string=string] [flush_string={on|off}] [keepalive={on|off}] [nodelay=on|off] Display autoconnect settings set autoconnect [port={range|xbee|internalmodem}] Options port={range|xbee|internalmodem} Used to specify the serial port. Optional on a single-port device.
trigger={always|data|dcd|dsr|string} Indicates which events from the serial port will trigger a network connection to occur. always The serial port will continually attempt to keep a connection to a remote network destination active. data The serial port will attempt a network connection whenever data arrives on the serial port. dcd The serial port will attempt a network connection whenever the serial port’s DCD signal goes high.
ipaddress=ip address The IP address of the network destination to which a connection will be made. ipport=ip port The TCP port of the network destination to which a connection will be made. connect_on_string=string When the value of the “trigger” option is string, this option specifies the string that must be found in the serial data in order for a connection to occur. The maximum length of this string is 32 characters, including escape sequences for special characters.
keepalive={on|off} Indicates whether or not TCP keepalives are sent for the specified range of clients. If set to on, keepalives are sent, if it is off, keepalives are not sent. 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.
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.
Syntax Configure port buffering set buffer [clear] [clearbk] [port={range|xbee|internalmodem}] [size=number] [state={on|off|pause}] [autobk=(none|nfs|samba|sdmemory|usb)] [autobk_size=0-64] [syslog state={off|on}] Display port buffering settings set buffer [port=port] Options clear Clears the contents of the specified buffer. clearbk Clears the autobackup file port The port or ports to which the command applies. To configure settings for the XBee port, specify port=xbee.
autobk Automatic data backup option. The data will be buffered on following storage location. none Automatic data backup will not be enabled. nfs The data will be buffered on NFS server. samba The data will be buffered on Samba server. sdmemory The data will be buffered on SD memory. usb The data will be buffered on USB storage device. autobk_size The buffer size for automatic data backup option. syslog_state The data will be sent to SYSLOG server. To configure SYSLOG server, see “set syslog” command.
Examples Display port buffer configuration for all ports #> 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.
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. See "set permissions" for details on setting user permissions for commands.
speed={10|100|1000|auto 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: 10 The device operates at 10 megabits per second (Mbps) only. 100 The device operates at 100 Mbps only. 1000 The device operates at 1000 Mbps only. auto The device senses the Ethernet speed of the network and adjusts automatically. The default is “auto.
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. To apply a common set of user settings to more than one user, it may be desirable to create a group with the required settings and then associate that group with multiple users.
Options add Add a group. New groups are created with no permissions. A maximum of 32 groups can be defined. remove Remove groups. 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.
set host Purpose Configures a name for the device, also known as a host name, or displays the current host name for the device. Required permissions For products with two or more users, permissions must be set to “set permissions s-host=read” to display the current host name, and “set permissions s-host=rw” to display and set the host name. See "set permissions" for details on setting user permissions for commands.
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” to display ippool configuration settings, and “set permissions s-ppp=rw” to display and set ippool configuration settings. See "set permissions" on for details on setting user permissions for commands.
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] Change background image idle time-out set lcd wait_time=wait time Change default background image set lcd use_defaultimage=[on|off] Load background image from tftp
use_defaultimage={on|off} Specifies whether the default background image will be used on idle time out. on Use the default background image off 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.
set modem Purpose Used to configure options of modem profile for a serial port, or display current modem profile settings for a serial port.
connection_type={incoming|outgoing|network_bridge} Specifies the connection type of a modem profile. incoming Used for dial-in connections, such as inbound PPP connections or to manage a device through a telephone network. The ConnectPort LTS product server will receive connections from other hosts. outgoing The modem will dial-out to establish connections with external hosts or to connect to an external PPP 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. See "set permissions" for details on setting user permissions for commands.
[tcp keepalive options] are: [idle=10-86400] (seconds) [probe_count=5-30] [probe_interval=10-75] (seconds) [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.
ip_v4=device ipv4 address Sets the device IP v4 address when DHCP is off. This option is only applicable if the “mode_v4” option is set to “static” submask_v4= subnet mask for ipv4 address Sets the device submask address when DHCP is off. This option is only applicable if the “mode_v4” option is set to “static” gateway_v4= gateway ipv4 address Sets the network gateway IP address.
ip_6to4tunnel={off|on} Set this option on to supply 6to4 Tunneling which consists of encapsulating IPv6 packets within IPv4, in effect using IPv4 as a link layer for IPv6 so that ConnectPort LTS product can reach the remote IPv6 Internet through the existing IPv4 infrastructure. on Enable 6to4 Tunneling off Disable 6to4 Tunneling. ip_v4_6to4relay= ipv4 address of remote 6to4 relay Set the IPv4 address of the remote 6to4 relay device.
[tcp keepalive options] Are options that configure how TCP keep-alive probes are sent. The 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}”). idle=10-86400 The amount of time, in seconds, to wait while not receiving TCP packets before sending out a keep-alive probe.
Examples Manually set the device IP v4 address of Ethernet interface 1 #> set network index=1 mode_v4=static ip_v4=10.0.0.2 gateway_v4=10.0.0.1 submask_v4=255.255.255.
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.
Options state ={off|on} Specifies whether the NFS service will be enabled on Enable the NFS service. off Disable the NFS service. Default is off. server ={host name|ip address} Specifies the host name or the IP address of NFS server 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_type={email|snmptrap|all} Used to determine what kind of an alarm is sent: an e-mail alarm, an SNMP trap or both. For SNMP traps to be sent, the IP address of the system to which traps are sent must be configured, by issuing a “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. all Both an email alarm and SNMP trap are sent. The default is “email.
set permissions Purpose Used to set user permissions associated with various services and commandline interface (CLI) commands, or display current permission settings.
Syntax Set permissions set permissions [type={user|group}] {id=range|name=string} [backup={none|execute}] [boot={none|execute}] [buffers={none|r-self|read|rw-self| w-self-r|rw}] [connect={none|execute}] [display={none|execute}] [filesys=(none|read|rw)] [kill={none|execute}] [newpass={none|rw-self|rw}] [ping={none|execute}] [python={none|execute}] [reconnect={none|execute}] [revert-all={none|execute}] [rlogin={none|execute}] [status={none|execute}] [telnet={none|execute}] [who={none|execute}] [webui={none|e
[s-sysauth={none|read|rw}] [s-system={none|read|rw}] [s-tcpserial={none|r-self|read|rw-self| w-self-r|rw}] [s-trace={none|read|rw}] [s-udpserial={none|r-self|read|rw-self| w-self-r|rw}] [s-usb={none|read|rw}] [s-user={none|read|rw}] [s-webui={none|read|rw}] [s-xbee={none|read|rw}] Display current network configuration options set permissions Options Permission descriptions Here are the user permissions and their effects on commands. none The command cannot be executed.
id=range Specifies the ID or the range of IDs of the users or groups to be acted on. If omitted, the “name” option must be specified. name=string Specifies the name of the user or group to be acted on. If omitted, the “id” option must be specified. backup={none|execute} Permissions for the “backup” command. (See "backup".) boot={none|execute} Permissions for the “boot” command. (See "boot".) buffers={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “display buffers” and “set buffer” commands.
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. rw The user can set any user’s password. ping={none|execute} Permissions for the “ping” command. (See "ping") python={none|execute} Permissions for the “python” command. (See "python") reconnect={none|execute} Permissions for the “reconnect” command. (See "reconnect") revert-all={none|execute} Permissions for the “revert all” command.
s-alarm={none|read|rw} Permissions for the “set alarm” command. (See "set alarm") s-autoconnect={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “set autoconnect” command. (See "set autoconnect") s-group={none|read|rw} 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.
s-serial={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “set serial” and "set switches" commands. (See "set serial" and "set switches") s-service={none|read|rw} Permissions for the “set service” command. (See "set service") s-snmp={none|read|rw} Permissions for the “set snmp” command. (See "set snmp") s-socket-tunnel={none|read|rw} Permissions for the "set socket_tunnel" command. (See "set socket_tunnel") s-sysauth ={none|read|rw} Permissions for the “set sysauth” command.
Examples Set group permissions #> set permissions type=group name=gurus newpass=rw-self s-user=read Set user permissions #> set permissions id=1 newpass=rw s-user=rw s-group=rw See also • "set user" • "set group" • "show" • “User permissions in ConnectPort LTS products” on page 14 90
set pmodem Purpose Configures various options for modem emulation over TCP/IP, and display current modem-emulation settings.
Options port=range Used to specify the serial port. state={on|off} Used to enable or disable modem emulation on a given serial port. on Enables modem emulation. off Disables modem emulation. The default is “off”. telnet Enables or disables Telnet processing on incoming and outgoing modememulation connections. on Enables Telnet processing. off Disables Telnet processing. The default is “off”.
set portauth Purpose Configures or displays authentication settings of each serial port. Authentication options include None, Local. Radius, and LDAP.
Options port=(port|xbee|internalmodem) The serial port number or range of serial ports associated with the port authentication 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.
radius_down_local When selected, the user authentication performed through the Radius server first. If succeeded, user can access the serial port. But if the Radius server does not respond to the authentication request from the ConnectPort LTS, user authentication performed through local database of ConnectPort LTS again. But if the authentication through the Radius server is failed, authentication through local database of ConnectPort LTS is not performed and the user cannot access the serial port.
accountingsocket=0-65535 The TCP port to be used for authentication communication. The default port number for Radius authentication is 1813. The primary and the secondary servers are required to use the same TCP port. LDAP authentication method does not support accounting server and socket options. authsocket=0-65535 The TCP port to be used for authentication communication. The default port number for Radius authentication is 1812 and for LDAP authentication is 389.
timeout =0-300 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. Factory default value is 3. searchbase =string LDAP search base (the distinguished name of the search base object) defines the location in the directory from which the LDAP search begins.
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.
Options add Add a port group. A maximum of 16 port groups can be defined. remove Remove port groups index=1-16 Specifies the index number of port group or range of port group indexes to be acted on. name=group name 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.
set ppp Purpose Configures Point-to-Point Protocol (PPP) connections, or displays current PPP settings.
Options add Add a PPP setting. remove 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. The ConnectPort LTS product will dial-out to establish PPP connections with external hosts using this user information.
pppauth={none|chap|pap|both} Determines whether authentication is required for PPP connection and, if so, what kind. none The remote user does not require PPP authentication chap Challenge Handshake Authentication Protocol (CHAP) authentication is required. pap Password Authentication Protocol(PAP) authentication is required. both Both CHAP and PAP authentication are required. The default is “none” ipaddrmode={ippool|negotiated|static} The mode of IP address for the peer in an incoming PPP connection.
localipaddr_mode={none|unnumbered|static} The mode of IP address for local end in outgoing PPP connection. none No the mode of IP address is specified. Outgoing PPP connection is disabled. unnumbered Automatically obtain the IP address from remote peer. static Request specific IP address. localipaddr=ip address Specifies the IP address for local end to be requested if the “localipaddrmode=static.
Examples Set incoming PPP settings #> set ppp add index=2 newname=ibuser connection_type=incoming Set outgoing PPP settings #> set ppp add index=3 newname=obuser connection_type=outgoing Remove a PPP setting #>set pppremove index=2 Display current PPP settings #>set ppp index=1 Change PPP authentication protocol #>set ppp index=3 pppauth=pap See also "show ppp" 104
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. Port-profile configuration is most often performed through the Web user interface for a device.
Printer profile: This profile allows you to connect a printer to the serial port Modem profile: This profile allows you to connect a modem to the serial port in order to establish or receive connections from other systems and modems 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 profile settings for the line on which they are logged in: “set permissions s-profile=r-self” For a user to display the prof
Options port=port The serial port number or range of serial ports associated with the port profile. Required when configuring port profiles. profile=profile name The port profile to use for the serial port. Required when configuring port profiles. Choosing a particular port profile causes the serial port’s configuration to be reset to defaults, and then for the default settings for that port profile to take effect.
Example #> set profile port=1 profile=realport See also • "revert" • "show " 108
set python Purpose Configures Python programs to execute when the ConnectPort LTS product boots. Syntax set python [range=1–4] [state={on|off}] [command=filename] Options range=1 – 4 The index or indices to view or modify with the command. state={on|off} When the state is set to on, the command specified will be run when the device boots. command=filename The program filename to execute, including any arguments to pass with the program, similar to the arguments for the "python" command.
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 set realport Options keepalive={on|off} Enables or disables sending of RealPort keepalives.
exclusive={on|off} Enables or disables exclusive mode for RealPort connections. Exclusive mode allows the device to close an existing RealPort connection and establish a new one immediately upon a new connection request from the same IP address. This mode is useful when using RealPort over wide area networks, which can be unstable and where you are charged by the byte (such as cellular or satellite), and you do not wish to incur costs for keepalive traffic.
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.
Options port=range Used to specify the serial port. Optional on a single-port device. state={on|off} Used to enable or disable the RTS toggle feature. on Enables the RTS toggle feature. off 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.
set samba Purpose Configures and displays Samba service settings.
Options state={off|on} Specifies whether the Samba service will be enabled on Enable the Samba service. off Disable the Samba service. Default is off. server={hostname|ip address} 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.
alert_priority={normal|high} The priority of the alert when the alert type is email. normal The alert is sent with normal priority. high The alert is sent with high priority. The default is “normal.” alert_type={email|snmptrap|all} Used to determine what kind of an alarm is sent: an e-mail alarm, an SNMP trap or both. For SNMP traps to be sent, the IP address of the system to which traps are sent must be configured, by issuing a “set snmp” command with the “trapdestip” option. See "set snmp".
Examples Enable Samba service #>set samba state=on server=192.168.100.
set sdmemory Purpose Configures and displays SD memory device settings.
set serial Purpose Sets and displays general serial configuration options, such as baud rate, character size, parity, stop bits, and flow control.
Syntax Set general serial options set serial port={range|internalmodem|xbee} [altpin={on|off}] [baudrate=bps] [databits ={5|6|7|8}] [parity={none|even|odd|mark|space}] [stopbits ={1|2}] [flowcontrol={hardware|software|none|custom}] [sigsonopen=(none|rtsdtr)] [customflow={none|rtscts|dtrdsr|ixonixoff}] Display current serial options set serial [port=range] Options port={range|internalmodem}xbee} Used to specify the serial port. Optional on a single-port device.
flowcontrol={none|hardware|software|custom} Specifies which kind of flow control is used on the line. none No flow control. hardware Hardware flow control (RTS/CTS). software Software flow control (Xon/Xoff). custom Custom flow control, as specified by the “customflow” option. The default is “none.” parity={none|even|odd|mark|space} The parity used for the line. none No parity. even Even parity. odd Odd parity. mark Mark parity. space Space parity. The default is “none.
sigsonopen ={none|rtsdtr} Determines the signal behavior of the serial port when ports are opened and closed by client from the remote site. When set to none, the open/close of a port by remote client will not modify the signals state. When set to rtsdtr, the outgoing signals will be raised on open and dropped on close by remote client. The flow control configuration of an outgoing signal takes priority over any behavior specified by the sigsonopen parameter.
set service Purpose Enables and disable network , changes the network port on which a given service listens, and displays the entire service table, or an entry in the service table. 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.
Options range=range Used to specify the index of the network service to which the rest of the command’s options apply. For more information on using this option, see "Index numbers and changing default port numbers" state={on|off} Used to enable or disable a given network service. ipport=network port Used to change the network port on which a given network service listens. See "Supported network services and their default network port numbers" for more information on the network services available.
delayed_ack=0-1000 The time, in milliseconds, to delay sending ACK packets in response to received data for the specified range of network services. The default is 200 milliseconds. Setting this option to 0 (zero) sends an ACK packet back acknowledge the received data immediately. Setting it to any other value means that the ACK packet will be sent after the specified time. If the network services generate new data during that time, the ACK packet will be sent along with the data packet.
Supported network services and their default network port numbers The following table shows the network services controlled by the “set services” command, the services provided, and the default network port number for each service.
Default Service Services provided network port number Advanced Digi Discovery Discovery of Digi devices on a network. 2362 Secure Ethernet connections between COM or 1027 Protocol (ADDP), also known as Device Discovery Encrypted (Secure) RealPort TTY ports and device servers or terminal servers. Hypertext Transfer Protocol Access to web pages for configuration that (HTTP), also known as Web can be secured by requiring a user login.
Default Service Services provided network port number Secure Socket Service Authentication and encryption for 2601 ConnectPort LTS products. Simple Network Management Managing and monitoring the ConnectPort Protocol (SNMP) LTS product. If you want to run SNMP, but in 161 a more secure manner, note that SNMP allows for “sets” to be disabled. This securing is done in SNMP itself, not through this command.
Index numbers and changing default port numbers An index number is assigned to each of these services. The index numbers assigned can vary over time. If you want to change the network port number for a service, enter a “set service” or “show service” command to display the current index number assigned to all services. Locate the service for which you want to change the network port number, and note the index number for the service.
Examples Disable service #> set service range=1 state=off Change the network port (ipport) of a service #> set service range=1 ipport=500 Displaying the service table In this example, the “set service” command displays the entire service table. #> set service Displaying an entry in the service table In this example, the “set service” command displays a range of entries in the service table. #> set service range=2-4 Allow outgoing data that is unacknowledged or less than maximum segment size.
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. See "set permissions" for details on setting user permissions for commands.
user=username Specifies the user name for SMTP authentication password=password 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 "set alarm".
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. See "set permissions" for details on setting user permissions for commands.
[snmp trap options] are: [trap version={none|v1|v2c|v3}] [trap_community=string] [trapdestip={ip address|fqdn}] [trapsecdest={ip address|fqdn}] [authfailtrap={off|on}] [coldstarttrap={off|on}] [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
Options [snmpv1v2c options] snmpv1v2_enabled={off|on} Enables or disables the accessing of SNMP-managed objects through SNMP v1/v2c protocol. off Disables the accessing of SNMP-managed objects through SNMP v1/v2c protocol. on Enables the accessing of SNMP- managed objects through SNMP v1/v2c protocol. publiccommunity=string The password required to “get” SNMP-managed objects(v1/v2c). The default is “public”. privatecommunity=string The password required to “set” SNMP-managed objects(v1/v2c).
[snmpv3 options] snmpv3_enabled={off|on} Enables or disables use of SNMP version 3. off Disables the accessing of SNMP-managed objects through SNMP v3 protocol. on 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.
auth_pwd=password Set the password for authentication. priv_protocol={des|aes}] Specifies the privacy protocol algorithm. des Set DES algorithm as privacy protocol. aes Set AES algorithm as privacy protocol. 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. v1 Use SNMP v1 protocol for SNMP trap. v2c Use SNMP v2c protocol for SNMP trap.
authfailtrap={off|on} Enables or disables the sending of authentication failure traps. on Enables the sending of authentication failure traps. off Disables the sending of authentication failure traps. The default is “off”. coldstarttrap ={off|on} Enables or disables the sending of cold start traps. on Enables the sending of cold start traps. off Disables the sending of cold start traps. The default is “off”. linkuptrap={off|on} Enables or disables the sending of link up traps.
[snmpv3 trap options] trap_security_level={auth_nopriv|auth_priv|noauth_nopriv} Indicates the security level of the user with regard to authentication and privacy for SNMP v3 trap. auth_nopriv Set the security level to use authentication only. auth_priv Set the security level to use both authentication and privacy. noauth_nopriv Set the security level not to use both authentication and privacy. trap_auth_user=username The SNMPv3 trap user name that is authenticated to communicate with the SNMP engine.
Examples Enable authentication failure traps #> set snmp trapdestip=10.0.0.1 authfailtrap=on Specify a new private community string #> set snmp privatecommunity=”StLucia72!” See also • "revert". • To disable and enable SNMP, use the “set service” command. See "set service." • To disable and enable SNMP alarm traps, see "set alarm.
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. One of the endpoint devices is configured to initiate the socket tunnel.
Syntax Configure a socket tunnel set socket_tunnel [state={on|off}] [timeout={0|seconds}] {0 is no timeout} [from hostname={name|ip address} [from_port=port number] [from_protocol={tcp|ssl}] [to hostname={name|ip address}] [to_port=port number] [to_protocol={tcp|ssl}] Display current socket tunnel settings set socket_tunnel Options state={on|off} Enables or disables the configured socket tunnel.
to_port=port number The destination port: the port number that the ConnectPort LTS product uses to make a connection to the destination device. to_protocol={tcp|ssl} The destination protocol: the protocol used between ConnectPort LTS product and the destination device. Currently, TCP and SSL are the two supported protocols. This protocol does not need to be the same for both connections. See also • "revert" • "show" • The section on socket tunnel settings in the ConnectPort LTS User’s Guide.
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" command also apply to this command.
Options range=range The port or range of ports to which this command applies. mode={232|485} Selects the electrical interface of the serial port. The selected value determines whether the "wires" and "termination" options are meaningful. 232 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. 485 The serial port uses electrical interface EIA-485.
termination={on|off} Applies when the serial port is running in EIA-485 mode only. Determines whether termination and biasing resistors are used across the lines. on Termination and biasing resistors are enabled across the lines. Termination should be set to "on" if this node is an endpoint of the 485 network. Biasing should be used in at least one unit in a two-wire environment. off Termination and biasing resistors are disabled across the lines. The default is "off.
set sysauth Purpose Configures or displays authentication settings for the command-line interface or web server.
Options index=1-2 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.
radius_down_local User authentication is performed through the Radius server first. If authentication is successful, the user can access CLI or Web server. If the Radius server does not respond to the authentication request from the ConnectPort LTS, user authentication is performed through local database of ConnectPort LTS again.
accountingsocket=0-65535 The TCP port to be used for authentication communication. The default port number for Radius authentication is 1813. The primary and the secondary servers are required to use the same TCP port. LDAP authentication method does not support accounting server and socket options. authsocket=0-65535 The TCP port to be used for authentication communication. The default port number for Radius authentication is 1812 and for LDAP authentication is 389.
timeout=0-300 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 Specifies how many times the ConnectPort LTS will try to communicate with the Radius authentication server. Factory default value is 3. searchbase =string The name of the LDAP search base; that is, the distinguished name of the search base object.
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.
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” to display and change network service settings.
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.
Syntax Set behaviors of TCP serial connections set tcpserial port=range [hangupdcd={on|off}] [hangupdsr={on|off}] [idletime={0|n}] [sid={on|off}] [sidstring=socketid string] [buffered={on|off}] [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.
sid={on|off} Determines how the socket ID (SID) string in the “sidstring” option is handled. on The value for the “sidstring” option is sent to the network destination right before the first data bytes are sent to the network. off The value for the “sidstring” option is not sent to the network destination. The default is "off." sidstring=socketid string When the “sid” option is set to on, this string is sent to the network destination right before the first data bytes are sent to the network.
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. This option only is valid when the “buffered” option is “on.” A value of 0 (zero) disables this option. The default is 0. endpattern=string Indicates that data from the serial port should be sent out to the network after the given endpattern string has been found in the data from the serial port.
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. Out of the box, all ConnectPort LTS devices maintain time and date as the UNIX epoch (00:00:00, January 1, 1970) plus device up-time.
Options time={hh:mm:ss|hh:mm} hh Hour; ranges from 0 to23. mm Minute; ranges from 0 to 59. ss Second; ranges from 0 to 59. date=mm.dd.yy) mm Month; ranges from 1 to12. dd Day; ranges from 1 to 31. yy Year; ranges from 0 to 99. offset={hh:mm|hh} hh Hour offset; ranges from -12 to 14. mm Minute offset; allowed values are one of 00,15,30, or 45. Examples Set system time #>set time=09:30:00 date=03.15.
set trace Purpose information. Configures a ConnectPort LTS product for tracing and displays tracing Important: 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.
Options state={off|on|dump} Sets the state of the tracing function. off Turns the tracing function off. on Turns the tracing function on. dump Displays historical trace messages, when “mode” is set to “historical.” mode={historical|concurrent} Sets handling of trace messages. historical All trace messages stored in the buffer will be displayed by issuing the command: #> set trace state=dump concurrent All trace messages are printed to the administrative terminal.
mask=type:severity Identifies the type and nature of events that should be traced, and the severity level of the events. type The type of events that should be traced. Enter “set trace ?“ to view the list of types supported in the ConnectPort LTS product. Some commonly used trace types for diagnosing connection problems are “modem” and “ppp.” Contact Digi Technical Support for assistance in using the appropriate type keyword. severity={assert|critical|warning|info|debug} The severity level of events traced.
Examples Display current trace settings #> set trace trace is currently off, using historical mode syslog is currently off, loghost is "" logfile is "" system : ________ web confhdlr : ________ snmp : ________ addp : ________ : ________ connect : ________ fwupd : ________ xinetd ppp : ________ ssh pmodem : ________ syschkr : ________ : ________ : ________ confmenu ssl serialp : ________ : ________ : ________ Enable tracing and print all serial critical, info, and debug data to the
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.
Syntax Set general UDP serial forwarding characteristics for a serial port set udpserial port={range|xbee|internalmodem} [state={on|off}] [sendcount=bytes] [sendtime={0|time}] [endpattern=string] [strippattern={on|off}] [sid={on|off}] [sidstring=string} Set UDP destinations for a given serial port set udpserial port=range range=1-64 [active={on|off} [ipaddress=ip address} [ipport=ip port] Display current UDP serial settings set udpserial [port=range [range=range]] Options Options for setting general UDP
sendtime={0|time} The amount of idle time, in milliseconds, allowed before sending data to the network. If no data is received on the serial port for the time specified by this option, any buffered data will be sent on to the network destinations. A value of 0 (zero) disables this trigger. endpattern=string If this string is set, any pattern match of data received from the serial port will cause the data to be sent on to the network destinations.
sid={on|off} Determines how the socket ID (SID) string in the “sidstring” option is handled; that is, whether the string specified by the “sidstring” option is sent at the beginning of each UDP packet. on The value of “sidstring” is sent at the beginning of each UDP packet. off 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.
Options for setting UDP destinations for a given serial port The following options require a range to be specified by the “range” option. port=range Specifies the serial port. Optional on a single-port device. range={1-64} Specifies the UDP destination to be configured. active={on|off} Specifies whether data from the serial port is sent to this destination. on Data from the serial port is sent to this destination. off This destination is not sent any data. The default is “off.
set usb Purpose 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” Syntax Configure USB device settings set usb [id=device id number] [state={off|on} [format] [fstype={ext2|vfat}] Configure USB Modem options These options configure a USB dongle cellular modem.
Options id=usb port number Specifies the USB port number to be set. state={on|off} Specifies whether the USB device will be enabled. on Enable the USB device. off Disable the USB device. format Format the device, using a default file system type of ext2. To format with an alternate file system type, use the “fstype” option. fstype={ext2|vfat} The file system type. ext2 ext2 or second extended filesystem. vfat Virtual file allocation table filesystem.
USB Modem options Obtain the values for these options from your cellular service provider. apn=string The Access Point Name (APN). pin=string The pin for logging on the USB modem. number=string The dial-in number for logging onto the cellular network for the USB modem. auth={none|chap|pap|both} The authentication protocol for connections over the USB modem. none The remote user does not require authentication. chap Challenge Handshake Authentication Protocol (CHAP) authentication is required.
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. Remove users. Change user settings. Display user settings. Load an SSH public key.
Syntax Add a 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 set user disassociate {id=number|name=user name} {gid=number|gname=group name} Change
Options add Add a user. New users are created with the default permissions (see “Default permissions for a new user” earlier in this description). A maximum of 32 users can be defined. remove Remove users. associate 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.
groupaccess={on|off} Specifies whether the user is allowed to use the access rights for any associated groups. This allows a group to define the access rights for users. For instance, if the user has “commandline=off” and an associated group has “commandline=on,” then the user will have command line access if “groupaccess=on.” on The user can use group access rights. off The user cannot use group access rights.
public_key={tftphost:filename|clear} Loads or clears an SSH public key used for authentication of this user. The key must be an RSA or DSA public key, in either OpenSSH or the IETF draft format. tftphost:filename Loads an SSH2 public key for use with this user, where: tftphost The IP address or DNS name of a host from which the SSH public key will be downloaded to the ConnectPort LTS product using TFTP. filename The name of a file on the host that contains the SSH public key.
Examples Add a new user #> set user add newname=jsmith id=4 Remove user 7 #> set user remove id=7 Associate user “johndoe” with the root group #> set user associate name=johndoe gname=root Disassociate user 15 from group 2 #> set user disassociate id=15 gid=2 Set a new user name to be entered at login #> set user id=4 newname=jdoe Set a user to have default command line interface access #> set user id=4 defaultaccess=commandline See also • "newpass" • "revert" • "set group" • "set permissions" • "sh
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” Syntax Set time-out value for Web server set web [timeout=0-1140] Display Web server settings set web Options timeout=0-1140 Specifies the time-out value in minute for Web server login.
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.
Options state={on|off} on 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. off 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. However, the XBee RF module can be accessed via a network service such as Telnet. The default is “off.” load={host:filename} Loads firmware to the Xbee module.
Examples Set Xbee state ON (Exclusive mode is turned on) #>set xbee state=on Run the AT command “NI” #>set xbee NI Change the XBee ID using the AT command “ID” #> set xbee ID=0x001002F04 See also • "show xbee" • "set serial" • "set tcpserial" • "set udpserial" • "set portauth" • "set service" • "set autoconnect" 181
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” commands must have be set to either “read” or “r-self,” depending on the available permissions for the commands. See "set permissions" for details on setting user permissions for commands.
Option Displays settings configured by Works Works w/port w/range option option alarm set alarm No Yes autoconnect set autoconnect Yes No buffer set buffer Yes No ethernet set ethernet No No group set group No No host set host No No permissions set permissions No No pmodem set pmodem Yes No profile set profile Yes No python set python No Yes realport set realport No No rtstoggle set rtstoggle Yes No serial set serial Yes No service set service No
Option Displays settings configured by Works Works w/port w/range option option nfs set nfs No No portauth set portauth Yes No portgroup set portgroup No Yes ppp set ppp No Yes samba set samba No No sdmemory set sdmemory No No smtp set smtp No No switches set switches Yes No sysauth set sysauth No Yes syslog set syslog No Yes time set time No No trace set trace No No usb set usb No No web set web No No xbee set xbee No No port=range Identif
Examples Display network configuration settings #> show network Network configuration "eth0" interface configuration MAC address : IPv6 Link addr : IPv6 Site addr : 00:04:9F:EF:23:33 fe80::204:9fff:feef:2333/64 IPv6 Global addr : (Currently in use) Currently in use by the network stack Stored configuration ----------------------- ----------------------- IPv4 options mode_v4 : static static ip_v4 : 192.168.4.47 192.168.4.47 submask_v4 : 255.255.0.0 255.255.0.0 gateway_v4 : 192.
"eth1" interface configuration MAC address : IPv6 Link addr : IPv6 Site addr : 00:E0:0C:00:7E:21 IPv6 Global addr : (Currently in use) Currently in use by the network stack Stored configuration ----------------------- ----------------------- IPv4 options mode_v4 : ip_v4 : none none submask_v4 : gateway_v4 : IPv6 options mode_v6 : none ip_v6 : (Stored configuration) gateway_v6 : (Stored configuration) ip_6to4tunnel : off ip_v4_6to4relay
Display current alarm settings #> show alarm Display settings for a particular user #> show user range=3 See also • "revert" • The “set” commands (“set user,” “set network,” “set serial,” etc.). Entering a set command without any options displays the same information as that displayed by the “show” command.
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. Typically, the “status” command is used to determine which sessions to close.
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 ipaddress The IP address of the host to which you want make a Telnet connection. tcp port The TCP port assigned the Telnet application on the remote system.
wan 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.
who 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 who Options None at this time. Example Display a list of all current connections #> who ID User name From To Protocol -- --------------- --------------------------- ------------ ------------------1 root 10.8.16.