Command Reference Digi Connect® Family Digi Connect SP, Digi Connect Wi-SP, Digi Connect ME, Digi Connect Wi-ME, Digi Connect EM, Digi Connect Wi-EM, Digi Connect WAN, Digi Connect RG, Digi Connect ES Family www.digi.
Digi International Inc. 2003, 2004, 2005. All Rights Reserved. Digi, Digi International, the Digi logo, the Digi Connectware logo, the Making Device Networking Easy logo, Digi Connect Family, Digi Connect SP, Digi Connect Wi-SP, Digi Connect ME, Digi Connect Wi-ME, Digi Connect EM, Digi Connect Wi-EM, Digi Connect WAN, Digi Connect RG, and Digi Connect ES are trademarks or registered trademarks of Digi International, Inc. in the United States and other countries worldwide.
Chapter 1 Introduction Quick Reference for Configuring Features ............................................ 6 Basic Command Information ................................................................. 9 Access the Command Line.................................................................. 11 Configure an IP Address ..................................................................... 11 Chapter 2 Command Descriptions Verifying Device Support for Commands ............................................
set permissions.................................................................................... 86 set pmodem....................................................................................... 102 set pppoutbound................................................................................104 set profile ........................................................................................... 110 set rciserial ......................................................................................
Introduction Chapter 1 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. • How to access the command line.
Quick Reference for Configuring Features 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.
Quick Reference for Configuring Features Feature/Task Commands Modem emulation "set pmodem" on page 102 "set serial" on page 116 Chapter 3, "Modem Emulation Commands" on page 151 Network access control "set accesscontrol" on page 44 Network configuration "set network" on page 84 Network services, enabling and disabling "set service" on page 118 Ping a host or device "ping" on page 36 Point to Point Protocol (PPP) "set pppoutbound" on page 104 Port buffering "display buffers" on page 21 "set b
Quick Reference for Configuring Features Feature/Task Security and access permissions Commands • • • • Simple Network Management Protocol (SNMP) • • • 8 To change user name for a user: "set user" on page 131 To issue new password to user: "newpass" on page 35 To set permissions associated with various services and commands: "set permissions" on page 86 To add or remove user groups, change group configuration attributes, or display group configuration attributes: "set group" on page 65 To configure SNM
Basic Command Information 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 Move the cursor forward one space. Ctrl+f Delete the character to the left of the cursor. Back space or Ctrl+h Delete the character under the cursor. Delete Scroll back through commands. Ctrl+p Scroll forward through commands. Ctrl+n Execute the command.
Basic Command Information 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.
Access the Command Line Access the Command Line To configure devices using commands, you must first access the command line from a Telnet session, and then log on as needed. This procedure assumes that you have configured the Digi device with an IP address already. 1. To Telnet to the device server, enter the following command from a command prompt on another networked device, such as a server: telnet ip-address where ip-address is the device server’s IP address. For example: telnet 192.3.23.5 2.
Configure an IP Address 12 Chapter 1 Introduction
Verifying Device Support for Commands Command Descriptions Chapter 2 This chapter provides a description of each command in the Digi Connect Command-Line Interface. Verifying Device Support for Commands For verification that a device supports a particular command, 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.
backup backup Devices supported This command is supported in all Digi Connect Family devices. Purpose Use the backup command to save or restore the device configuration from a TFTP server located on the network. Required permissions Permissions must be set to “set permissions backup=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands.
boot boot Devices supported This command is supported in all Digi Connect Family devices. Purpose The boot command is used to reboot the device server, restore the device configuration to factory default settings, and load new firmware (both EOS and POST images) from a TFTP server. Required permissions Permissions must be set to “set permissions boot=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands.
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. boot action=reset Reboot using firmware from a boot host This example loads the firmware stored on the TFTP host into flash ROM.
close close Devices supported This command is supported in all Digi Connect Family devices. 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 escape the active session.
connect connect Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to make a connection, or establish a session, with a serial port. There are several ways of using the connect command: • To make multiple connections, issue multiple connect commands. • To temporarily suspend a connection, escape the active session by pressing Ctrl [. • To temporarily suspend a connection and return to the command line, press the escape character and then the Enter key.
display display Devices supported This command is supported in all Digi Connect Family devices. Purpose Use the display command to status information for a device. Command options allow for displaying a variety of status information, including: • General product information, including the product name, MAC address, boot, post, and firmware versions, memory usage, utilization, and uptime, or the amount of time since the device was last booted. • Access control status information • GPIO signals.
display nat Displays Network Address Table (NAT) status information. pppstats Displays Point-to-Point Protocol (PPP) status information. serial Displays serial modem signals (DTR, RTS, CTS, DSR, DCD). uptime Displays amount of time since the device was booted. version Displays boot, POST and EOS firmware version information and Digi part numbers for those items. wlan Displays typical wireless LAN (WLAN) parameters for wireless devices.
display buffers display buffers Devices supported This command is supported in all Digi Connect devices except the Digi Connect WAN. Purpose The display buffers command is used to display the contents of a port buffer, or Transfer 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" on page 55). Contents are displayed in log form.
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 that port 2 buffering information goes to file port_output_2 and port 3 buffering information goes to file port_output_3.
exit exit Devices supported This command is supported in all Digi Connect Family devices. Purpose Use the exit command to terminate your current session. Syntax exit Example exit See also "quit" on page 37. The quit and exit commands perform the same operation.
help help Devices supported This command is supported in all Digi Connect Family devices. Purpose Displays help about a specific command. Syntax help [command] OR [command]? Examples help boot boot? help set serial set serial? See also 24 "Displaying Online Help" on page 9.
info info Devices supported This command is supported in all Digi Connect Family devices. Purpose This command prints out statistical information about a device. Command options allow display of the following categories of statistics: • Device statistics • Ethernet statistics • ICMP statistics • IP statistics • Serial statistics • TCP statistics • UDP statistics • WLAN statistics (For wireless devices only) The statistics in these tables are those gathered since the tables were last cleared.
info Results 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.
info 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. OutNonUcastPkts Number of non-Unicast packets sent. InDiscards Number of incoming packets that were discarded. OutDiscards Number of outgoing packets that were discarded. InErrors Number of incoming packets that contained errors.
info IP statistics Statistic 28 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.
info Serial statistics Statistic Chapter 2 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. overflow errors The number of times the Received buffer has overrun. The receive buffer was full when additional data was received. frame errors The number of framing errors detected.
info 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 server 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.
info Wireless (WLAN) statistics The WLAN statistics may aid in troubleshooting network communication problems with your wireless network. Statistic Chapter 2 Description TxFrames Number of frames transmitted. TxBroadcastFrames Number of broadcast frames transmitted. TxRtsFrames Number of Request-to-Send (RTS) frames transmitted. TxRetries Number of times an outgoing frame is retransmitted because the acknowledgement for the frame was not received.
info Examples Display ICMP statistics #> info icmp ICMP statistics: See also 32 InMessages : 14 OutMessages : 0 InDestUnreachables : 5 OutDestUnreachables : 0 InErrors : 0 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).
kill kill Devices supported This command is supported in all Digi Connect Family devices. Purpose Use the kill command to kill connections. The kill command is associated with the connections displayed by the who command. Required permissions Permissions must be set to “set permissions kill=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands. Syntax kill [ran ge] [co nne cti on_i d] Options range A range of connection IDs.
mode mode Devices supported This command is supported in all Digi Connect Family devices. Purpose Changes or displays the operating options for a current Telnet session. Required permissions Permissions must be set to “set permissions telnet=execute” to display or set Telnet operating options. See "set permissions" on page 86 for details on setting user permissions for commands. Required privileges Anyone can use this command.
newpass newpass Devices supported This command is supported in all Digi Connect Family devices. Purpose Use the newpass command to create or change user passwords for the device. Required permissions 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" on page 86 for details on setting user permissions for commands.
ping ping Devices supported This command is supported in all Digi Connect devices. Purpose Tests whether a host or other device is active and reachable. To interrupt the “ping” command, use Ctrl-C. Required permissions Permissions must be set to “set permissions ping=execute” for a user to use this command. See "set permissions" on page 86 for details on setting user permissions for commands.
quit quit Devices supported This command is supported in all Digi Connect Family devices. Purpose Use the quit command to log out of the device. Syntax quit Example quit See also "exit" on page 23. The “quit” and “exit” commands perform the same operation.
reconnect reconnect Devices supported This command is supported in all Digi Connect Family devices. 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 Permissions must be set to “set permissions reconnect=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands.
revert revert Devices supported This command is supported in all Digi Connect Family devices. Purpose Sets a particular group of a devices’ settings to its 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.
revert devicesecurity Reverts the Connectware Device Protocol device security settings configured by the “set devicesecurity” command. forwarding Reverts the port-forwarding settings configured by the “set forwarding” command. gpio Reverts the GPIO settings configured by the “set gpio” command. host Reverts the host name set by the “set host” command. menu Reverts the custom menu settings configured by the “set menu” command.
revert 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. term [port=range] Reverts the terminal connection settings configured by the “set term” command. udpserial [port=range] Reverts the UDP serial settings configured by the “set udpserial” command. user Reverts the user settings configured by the “set user” command.
rlogin rlogin Devices supported This command is supported in all Digi Connect devices. Purpose Performs a login to a remote system, also referred to as an rlogin. Required permissions Permissions must be set to “set permissions rlogin=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands.
send send Devices supported This command is supported in all Digi Connect Family devices. Purpose Sends a Telnet control command to the last active Telnet session. Required permissions Permissions must be set to “set permissions telnet=execute” to display or set Telnet operating options. See "set permissions" on page 86 for details on setting user permissions for commands. Required privileges Anyone can use this command.
set accesscontrol set accesscontrol Devices supported This command is supported in Digi Connect WAN and Digi Connect RG devices. Purpose Used to specify information that limits network access to this device, or display current access-control settings. For the Digi Connect WAN, the access-control settings also limit routing of packets through the device.
set accesscontrol subnip[1-32]=ipaddress Used to specify up to 32 subnet IP addresses. Any IP address in these subnets will be allowed to access this device server. subnmask[1-32]=mask Used to specify a subnet mask associated with one of the 32 subnet IP addresses. Examples Set access control settings set accesscontrol enabled=on addrip1=143.191.1.228 Set access control for a specific subnet This command will allow any IP address in the 143.191.2.0 subnet (netmask 255.255.255.
set alarm set alarm Devices supported Digi Connect EM, Digi Connect Wi-EM, Digi Connect ME, Digi Connect WiME, Digi Connect WAN, and Digi Connect RG. Setting alarms in GPIO mode is not supported in the Digi Connect SP device. Purpose Use this command to configure device alarms or display current alarm settings. Device alarms are used to send emails or SNMP traps when certain device events occur. These events include changes in GPIO signals and data patterns in the serial stream.
set alarm Options Options for setting alarms with general options from=string The text to be included in the “from” field of an alarm-triggered email. mailserverip=ipaddress Used to configure IP address of the mail server to which alarm-triggered emails are sent. state= {on|off} Enables or disables all alarms. on Enables all alarms. off Disables all alarms. The default is “off.
set alarm priority={normal|high} The priority of the triggered email. normal The email is sent with normal priority. high The email is sent with high priority. The default is normal. The default is off. 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.
set alarm Options for setting alarms in GPIO mode In GPIO mode, alarms are triggered when there are transitions between states for GPIO pins. The following options allow you set which GPIO pins’ transitions will trigger alarms. pins=list_of_pins A list of GPIO pins that trigger alarms. highpins=list_of_highpins A list of GPIO pins that trigger alarms when a pin’s signal is high. lowpins=list_of_lowpins A list of GPIO pins that trigger alarms when a pin’s signal is low.
set alarm Options for setting alarms in match mode In match mode, an alarm will be triggered when a pattern is found in the stream of serial data. The following options are used for setting alarms in match mode: mode=match Sets the alarm to match mode. 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 40 characters, including escape sequences for special characters.
set autoconnect set autoconnect Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to establish an automatic connection (autoconnection) between the serial port and a remote network destination, and to display current autoconnect settings.
set autoconnect Options port=range Used to specify the serial port. Optional on a single-port device. state={on|off} Enables or disables the autoconnect feature. on Enables the autoconnect feature. off Disables the autoconnect feature. The default is off. If you are using the serial port for another purpose, it is recommended this value be set to “off.” trigger={always|data|dcd|dsr|string} Indicates which events from the serial port will trigger a network connection to occur.
set autoconnect description=string A name for descriptive purposes only. ipaddress=ipaddress The IP address of the network destination to which a connection will be made. ipport=ipport 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.
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 is less than maximum segment size set autoconnect port=1 nodelay=on See also 54 • • • "revert" on page 39. "set network" on page 84. "set serial" on page 116.
set buffer set buffer Devices supported This command is supported in all Digi Connect Family devices. 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.
set buffer state The buffering state, which can be any of the following: on The data will be buffered. off The data will not be buffered and all data will be cleared from the buffer. pause The data will not be buffered, but data in the buffer will not be cleared. 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 devicesecurity set devicesecurity Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to set or display the Connectware Device Protocol device security settings.
set devicesecurity discoverycodingscheme={nonenone|aesmd5|nonemd5} Used to specify the method of encryption used during the discovery phase of the connection. The first option specifies the encryption mode, the second option specifies the authentication mode. nonenone No encryption and no authentication. aesmd5 AES encryption and MD5 authentication. nonemd5 No encryption and MD5 authentication. Only the “nonenone” value is allowed if the “identityverificationform” option is set to “simple.
set devicesecurity keyencryptingkey=hexstring This key is a shared secret between the device server and Connectware Manager. The value must be generated by Connectware Manager. It is used when the “identityverificationform” option is set to “crypto.
set ethernet set ethernet Devices supported This command is supported in Digi Connect SP, Digi Connect EM, and Connect ME devices. Purpose Configures, adjusts, and displays Ethernet communications parameters. Required permissions Permissions must be set to “set permissions s-ethernet=read” to display Ethernet communications parameters, and “set permissions s-ethernet=rw” to display and configure Ethernet communications parameters.
set ethernet speed Configures the Ethernet speed the Digi device 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. auto The device senses the Ethernet speed of the network and adjusts automatically. The default is “auto.
set forwarding set forwarding Devices supported This command is supported in Digi Connect WAN devices only. Purpose Enables or disables IP routing, or forwarding of IP datagrams, between network interfaces. IP forwarding must be enabled to allow the Network Address Table and port forwarding features to work properly.
set gpio set gpio Devices supported This command is supported Digi Connect EM, Digi Connect Wi-EM, Digi Connect ME, Digi Connect Wi-ME, Digi Connect WAN, and Digi Connect RG devices. Purpose Used to: • Configure General Purpose I/O (GPIO) pins. In normal operation, the GPIO pins are used for the serial CTS, DCD, DSR, DTR, and RTS pins. The set gpio command allows these GPIO pins to be used for different purposes. • Display current GPIO pin settings.
set gpio Default serial signal settings for GPIO pins The default serial signal settings for the GPIO pins on a Digi Connect device are as follows. Depending on the device, there are five or nine GPIO pins.
set group set group Devices supported This command is supported in Digi Connect WAN and Digi Connect RG devices only. 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.
set group name= string Specifies the name of the group to be acted on. newname=string Specifies a new group name. commandline={on|off} Specifies whether the users in the group are allowed to access the command line of the device. on Users can access the command line interface. off Users can not access the command line interface. The default is “on.
set group Default permissions When a new group is created, it has no permissions.
set host set host Device support This command is supported in all Digi Connect Family devices. Purpose Configures a name for the device, also known as a host name, or displays the current host name for the device. Required permissions 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" on page 86 for details on setting user permissions for commands.
set menu set menu Devices supported This command is currently not supported in any Digi Connect Family devices. Purpose The “set menu” command is used to create and modify custom menus. There are several modes of using the “set menu” command: • To update global settings for custom menus. • To add or update custom menus. • To add or update individual items in a custom menu.
set menu previous_key=key The key and text displayed on the custom menu next to the “previous_label” that allows a user to return to the previous menu when they have previously selected a submenu. This option is only shown and only valid when the displayed menu is an active submenu such that pressing this key will return the user to the original menu. The default is “R.“ The key is case insensitive; therefore, the keys “A” and “a“ will act the same.
set menu title=string subtitle=string The title and optional subtitle for a particular menu. The title is displayed above the custom menu and the subtitle, if specified, is displayed immediately below it. These strings are shown to the user accessing the custom menu as a means to identify, explain, or describe a custom menu. Note that when creating a new custom menu, the “title” option is required. If the string contains spaces, enclose it in double quotes.
set menu Options for Adding/Updating Custom Menu Items range=1-32 The index of the custom menu to add menu items to. Either the “range” or “name” option can be specified to add or update menu items for a particular menu. name=string The name of the custom menu to add or update menu items for. This option can be used rather than “range.” If the string contains spaces, enclose it in double quotes. item=1-32 The index of the menu item to add or update.
set menu Examples Updating Global Settings set menu quit_key=Q quit_label=”Quit” previous_key=R previous_label=”Return to Previous Menu” presskey_label=”Press any key to continue...
set mgmtconnection set mgmtconnection Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to set or display the Connectware Device Protocol connection settings.
set mgmtconnection timedperiod=period For a timed connection, this option is used to specify the time interval in minutes between the device server's attempts to connect to the Connectware Manager server. If a device server is already in a connection to a Connectware Manager when the time interval expires, it will not start a new connection at that time.
set mgmtconnection Examples Set values for the client connection set mgmtconnection connenabled=on conntype=client clntreconnecttimeout=50 Display current connection settings set mgmtconnection See also 76 "set devicesecurity" on page 57 "revert" on page 39 Chapter 2 Command Descriptions
set mgmtglobal set mgmtglobal Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to set or display the Connectware Device Protocol global settings, or revert the device ID to factory settings.
set mgmtnetwork set mgmtnetwork Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to set or display the Connectware Device Protocol network settings.
set mgmtnetwork connectionmethod={auto|none|mt|mdh|proxy} Used to specify the Connectware Device Protocol firewall traversal method. auto Automatically detect the connection method. none No firewall; connect using TCP. mt Connect using TCP. mdh Connect using HTTP. proxy Connect using HTTP over proxy. proxyaddress=string Used to specify the proxy host address when connection method is proxy proxyport=port Used to specify the proxy host port when connection method is proxy.
set mgmtnetwork mtwaitcount=count Used to specify the wait count when connection method is MT. mdhrxkeepalive=time Used to specify the transmit keep alive time when connection method is MDH. mdhtxkeepalive=time Used to specify the receive keep alive time when connection method is MDH. mdhwaitcount=count Used to specify the wait count when connection method is MDH.
set nat set nat Devices supported This command is supported in Digi Connect WAN devices only. Purpose Used to set or display Network Address Translation (NAT) and port/ protocol forwarding settings. Note that at this time, the only IP protocol for which protocol forwarding is supported is Generic Routing Encapsulation (GRE). Port forwarding is supported for the TCP and UDP protocols.
set nat prnumber[1-4]=gre Used to specify the IP protocol whose packets will be forwarded for this entry. The keyword “gre” indicates that the Generic Routing Encapsulation (GRE) protocol will be forwarded. At this time, GRE is the only protocol supported by the protocol-forwarding feature. prtype[1-4]=type Used to specify the GRE payload type to forward for this entry. A value of 0 (zero) means all payload types will be forwarded (this is recommended).
set nat Examples Enable NAT and specify settings for port forwarding entry 1 This example command will enable the forwarding of TCP packets received at port 4009 of the public (PPP) interface of the device server, to TCP port 7008 of the host whose IP address is 143.191.1.228 on the Ethernet side of the device server. set nat enabled=on poenabled1=on poproto1=tcp poexternal=4009 pointernal=7008 poip=143.191.1.
set network set network Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to set general network configuration options and display current network configuration options. Required permissions 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.
set network IP address, gateway address, and submask. The default is on. autoip={on|off} When enabled, the device attempts to use the Auto IP protocol to find an IP address, gateway address, and submask. The default is on. idle=10-86400 The amount of time, in seconds, to wait while not receiving TCP packets before sending out a keepalive probe. probe_count=5-30 The number of TCP keepalive probes (specially formatted TCP frames) to send out before closing the TCP connection.
set permissions set permissions Devices supported This command is supported in all Digi Connect Family devices. However, not all options are supported by Digi Connect devices. For example, s-ethernet is only supported in the wired devices. Purpose Used to set permissions associated with various services and commandline interface (CLI) commands, or display current permission settings.
set permissions Syntax Set permissions set permissions [type={user|group}] {id=range|name=string} [backup={none|execute}] [boot={none|execute}] [connect={none|execute}] [display={none|execute}] [buffers={none|r-self|read|rw-self|w-self-r|rw}] [kill={none|execute}] [newpass={none|rw-self|rw}] [ping={none|execute}] [reconnect={none|execute}] [revert-all={none|execute}] [rlogin={none|execute}] [s-accesscontrol={none|read|rw}] [s-alarm={none|read|rw}] [s-autoconnect={none|r-self|read|rw-self|w-self-r|rw}] [s-d
set permissions Options type={user|group} Specifies whether the command applies to users or groups. This option defaults to “user.” 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} Specifies permissions for the “backup” command. none The command cannot be executed.
set permissions connect={none|execute} Specifies permissions for the “connect” command. none The command cannot be executed. execute The command can be executed. display={none|execute} Specifies permissions for the “display” command. none The command cannot be executed. execute The command can be executed. kill={none|execute} Specifies permissions for the “kill” command. none The command cannot be executed. execute The command can be executed.
set permissions revert-all={none|execute} Specifies permissions for the “revert all” command. Individual “revert” commands are governed by the permissions for that particular command, but “revert all” uses a different mechanism that bypasses the individual commands. none The user cannot execute the command. execute The user can execute the command. rlogin={none|execute} Specifies permissions for the “rlogin” command. none The command cannot be executed. execute The command can be executed.
set permissions s-autoconnect={none|r-self|read|rw-self|w-self-r|rw} Specifies permissions for the “set autoconnect” command. none The command cannot be executed. r-self The user can execute the "display" portion of the command if the user is logged in on the specified line. read The user can execute the "display" portion of the command for any line. rw-self The user can execute the "display" and "set" portions of the command if the user is logged in on the specified line.
set permissions s-gpio={none|read|rw} Specifies permissions for the “set gpio” command. none The command cannot be executed. read The user can execute the "display" portion of the command. rw The user can execute the "display" and "set" portions of the command. s-group={none|read|rw} Specifies permissions for the “set group” command. none The command cannot be executed. read The user can execute the "display" portion of the command. rw The user can execute the "display" and "set" portions of the command.
set permissions s-mgmtglobal={none|read|rw} Specifies permissions for the “set mgmtglobal” command. none The command cannot be executed. read The user can execute the "display" portion of the command. rw The user can execute the "display" and "set" portions of the command. s-mgmtnetwork={none|read|rw} Specifies permissions for the “set mgmtnetwork” command. none The command cannot be executed. read The user can execute the "display" portion of the command.
set permissions s-pmodem={none|r-self|read|rw-self|w-self-r|rw} Specifies permissions for the “set pmodem” command. none The command cannot be executed. r-self The user can execute the "display" portion of the command if the user is logged in on the specified line. read The user can execute the "display" portion of the command for any line. rw-self The user can execute the "display" and "set" portions of the command if the user is logged in on the specified line.
set permissions s-profile={none|r-self|read|rw-self|w-self-r|rw} Specifies permissions for the “set profile” command. none The command cannot be executed. r-self The user can execute the "display" portion of the command if the user is logged in on the specified line. read The user can execute the "display" portion of the command for any line. rw-self The user can execute the "display" and "set" portions of the command if the user is logged in on the specified line.
set permissions s-rtstoggle={none|r-self|read|rw-self|w-self-r|rw} Specifies permissions for the “set rtstoggle” command. none The command cannot be executed. r-self The user can execute the "display" portion of the command if the user is logged in on the specified line. read The user can execute the "display" portion of the command for any line. rw-self The user can execute the "display" and "set" portions of the command if the user is logged in on the specified line.
set permissions s-service={none|read|rw} Specifies permissions for the “set service” command. none The command cannot be executed. read The user can execute the "display" portion of the command. rw The user can execute the "display" and "set" portions of the command. s-snmp={none|read|rw} Specifies permissions for the “set snmp” command. none The command cannot be executed. read The user can execute the "display" portion of the command.
set permissions s-tcpserial={none|r-self|read|rw-self|w-self-r|rw} Specifies permissions for the “set tcpserial” command. none The command cannot be executed. r-self The user can execute the "display" portion of the command if the user is logged in on the specified line. read The user can execute the "display" portion of the command for any line. rw-self The user can execute the "display" and "set" portions of the command if the user is logged in on the specified line.
set permissions s-udpserial={none|r-self|read|rw-self|w-self-r|rw} Specifies permissions for the “set udpserial” command. none The command cannot be executed. r-self The user can execute the "display" portion of the command if the user is logged in on the specified line. read The user can execute the "display" portion of the command for any line. rw-self The user can execute the "display" and "set" portions of the command if the user is logged in on the specified line.
set permissions status={none|read|rw} Specifies permissions for the “status” command. none The command cannot be executed. read The user can execute the "display" portion of the command. rw The user can execute the "display" and "set" portions of the command. telnet={none|execute} Specifies permissions for the “telnet,” “mode,” and “send” commands. none The commands cannot be executed. execute The commands can be executed. who={none|execute} Specifies permissions for the “who” command.
set permissions 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" on page 131 "set group" on page 65 Chapter 2 Command Descriptions 101
set pmodem set pmodem Devices supported This command is not supported in Digi Connect WAN devices. Purpose Used to: • Configure various options for modem emulation over TCP/IP. • Display current modem-emulation settings.
set pmodem telnet Used to enable or disable Telnet processing on the incoming and outgoing modem-emulation connections. on Enables Telnet processing. off Disables Telnet processing. The default is “off.” Example set pmodem port=1 state=on See also • • Chapter 2 Command Descriptions "revert" on page 39 Chapter 3, "Modem Emulation Commands" for descriptions of Digispecific commands for modem-emulation configurations.
set pppoutbound set pppoutbound Devices supported This command is supported in Digi Connect WAN and Digi Connect RG devices only. Purpose Configures Point-to-Point Protocol (PPP) outbound connections, or displays current PPP outbound settings.
set pppoutbound Options port=range The physical interface to which the PPP outbound configuration applies. Required. state={enabled|disabled} The state of the interface. The default is “disabled.” auth_method={none|PAP|CHAP|both} Determines whether authentication is required for outbound PPP connections and, if so, what kind. none The remote user does not require PPP authentication. pap Password Authentication Protocol (PAP) authentication is required.
set pppoutbound address_mask=ip_address_mask The IP mask to apply to the address specified on the “remote address” and “local address” options. When you specify a specific IP address on the “remote address” and “local address” options, this option modifies the meaning of the IP address for routing purposes. The default is 255.255.255.255. default_gateway={yes|no} Selects whether to use the PPP interface as the default route. The default is “no.
set pppoutbound lcp_keepalive={on|off} Specifies whether the device server sends Link Control Protocol (LCP) echo requests after a “quiet” interval, in order to test the PPP link and/or keep it alive. “Quiet” means not having received any bytes over the PPP link for a specified time interval, which is set by the “lcp_ka_quiet_time” option. In PPP networks that support LCP echoes, an LCP echo reply is returned by the remote end of the PPP connection.
set pppoutbound chap_id=chap_id A character string that identifies the outbound PPP user using CHAP authentication. This is equivalent to a user or login name. The string must be 32 or fewer characters and must be recognized by the peer. chap_key=chap_key A character string that authenticates the outbound PPP user using CHAP authentication. This is equivalent to a password. The string must be 16 or fewer characters and must be recognized by the peer.
set pppoutbound dial_script=chat_script A dialing script, used any time a number is dialed for the interface. For example: dial_script="'' ATDT\T CONNECT \c" login_script=chat_script A login script, used to log in to the remote system on the other end of the outbound PPP connection.
set profile set profile Devices supported This command is supported in all Digi Connect Family devices. However, some port profiles are not supported in particular devices, as noted in the “profile” option’s description. 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.
set profile Required permissions 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-pmodem=r-self” • For a user to display the profile settings for any line: “set permissions spmodem=read” • For a user to display and set the profile settings for the line on which they are logged in: “set permissions s-pmodem=rw-self” • For a user to display the profile settings for any line, and set
set profile tunneling Associates the Serial Bridge port profile with the port. udp_sockets Associates the UDP Sockets port profile with the port. Not supported in Digi Connect WAN. custom Associates the Custom port profile with the port. See also 112 • • "revert" on page 39. For more information on port profiles, see the topic in the Digi Connect Family User’s Guide titled “Using Port Profiles to Configure Devices.
set rciserial set rciserial Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to: • Turn on/off RCI serial mode on the first serial port. The RCI serial mode is a mode that allows a configuration file to be loaded over a serial port when the DSR input signal is high. • Display current RCI serial-mode settings.
set rtstoggle set rtstoggle Devices supported This command is not supported in Digi Connect WAN devices. Purpose Used to: • Enable or disable RTS toggle on a given serial port. RTS toggle is used to raise RTS when sending data. • Display current RTS toggle settings.
set rtstoggle 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. The range is 0 to 5000 milliseconds. The default is 0.
set serial set serial Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to: • Set general serial configuration options, such as baud rate, character size, parity, stop bits, and flow control. • Display current serial configuration options.
set serial csize={5|6|7|8} The character size, which can be 5, 6, 7, or 8 bits. The default is 8. flowcontrol={hardware|software|none} Specifies which kind of flow control is used on the line. hardware Hardware flow control (RTS/CTS). software Software flow control (Xon/Xoff). none No flow control. The default is “software.” 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.
set service set service Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to: • Enable and disable network services. • Change the network port on which a given service listens. • Display the entire service table, or an entry in the service table. Required permissions 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 service nodelay={on|off} Used to allow unacknowledged or smaller than maximum segment sized data to be sent. Note: The “nodelay” option disables Nagle’s algorithm, which is on by default, for some TCP services. The purpose of Nagle's algorithm is to reduce the number of small packets sent. Briefly Nagle's algorithm says to hold on to outgoing data when there is either unacknowledged sent data or there is less than maximum segment size (typically around 1500 bytes for Ethernet) worth of data to be sent.
set snmp set snmp Devices supported This command is supported in all Digi Connect Family devices. Purpose Configures the Simple Network Management Protocol (SNMP) agent, or displays current SNMP settings. Required permissions Permissions must be set to “set permissions s-snmp=read” to display network service settings, and “set permissions s-snmp=rw” to display and change network service settings.
set snmp authfailtrap={on|off} 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={on|off} 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={on|off} Enables or disables the sending of link up traps.
set system set system Devices supported This command is supported in all Digi Connect Family devices. Purpose Configures and displays system-identifying information, such as a description of the device, its location, and a contact person. Required permissions 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 set tcpserial Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to set behaviors of TCP serial connections, or display current TCP serial settings. This command affects the following TCP serial connections: • Connections made using the autoconnect feature.
set tcpserial Options port=range Used to specify the serial port. Optional on a single-port device. hangupdcd={on|off} Indicates whether an established network connection should be terminated when the serial port’s DCD signal drops. The default is “off.” hangupdsr={on|off|} Indicates whether an established network connection should be terminated when the serial port’s DSR signal drops. The default is “off.
set tcpserial 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. This option only is valid when the “buffered” option is “on.” An empty string disables this option. The maximum length of this string is 16 characters, including escape sequences for special characters. For more details on the escape sequences, see "Entering Special Characters in String Values" on page 10.
set term set term Devices supported This command is supported in Digi Connect WAN and Digi Connect RG devices only. Purpose Allows for connecting a terminal to a device’s serial port and accessing the command line of the device. In the cases where the default access to the terminal and the command line is “on,” this command is important if users want to use the serial port for purposes other than having a command line.
set udpserial set udpserial Devices supported This command is not supported in Digi Connect WAN devices. Purpose Use this command to set up the UDP serial feature, or display current UDP serial settings. The UDP serial 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.
set udpserial Options Options for setting general UDP serial forwarding characteristics port=range Used to specify the serial port. Optional on a single-port device. state={on|off} Used to enable or disable sending data from the serial port to remote network destinations. The default is “off.” sendcount=bytes The number of bytes received from the serial port that will cause the data to be sent on to the network destinations. This trigger cannot be disabled. The default is 1024 bytes.
set udpserial 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 256 characters, including escape sequences for special characters. For more details on the escape sequences, see "Entering Special Characters in String Values" on page 10. The maximum parsed length of this string is 256 characters. That is, this string must reduce down to a 256-character string when the escape sequences are processed.
set udpserial Examples Set general UDP serial forwarding based on bytes received In this example, the amount of bytes received from the serial port will cause the data to be sent on to the network destination. set udpserial port=1 state=on sendcount=2 Set UDP destinations for a given serial port In this example, data will be sent to the destination identified. set udpserial port=1 range=1 ipaddress=10.0.0.
set user set user Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to: • Add users for access to this Digi device. Up to 32 users can be defined. • Associate a user with a group. A user can be associated with up to two groups. • Disassociate a user from a group. • Remove users. • Change user configuration attributes. • Display user configuration attributes.
set user Syntax Add a user set user add id=number newname=string Remove a user set user remove {id=range|name=string} Associate a user with a group set user associate {id=number|name=string} {gid=number|gname=string} Disassociate a user from a group set user disassociate {id=number|name=string} {gid=number|gname=string} Change user configuration attributes set user [id=range|name=string] [newname=string] [commandline={on|off}] [groupaccess={on|off}] [menu={none|index|name}] [defaultaccess={none|command
set user gid=number Specifies the identifier for the group being associated with a user. If omitted, the “gname” option must be specified. gname=string Specifies the name of the group being associated with a user. If omitted, the “gid” option must be specified. commandline={on|off} Specifies whether the user is allowed to access the command line of the device. on User can access the command line interface. off User can not access the command line interface. The default is “on.
set user defaultaccess={none|commandline|menu|group} Specifies the default access method and interface that a user will be given upon logging into the device. Note that the specified interface must be enabled for the user and have a valid menu and/or group if specified. none The user has no default access to the device and must explicitly specify the access type.
set user 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 commandline=on defaultaccess=commandline Set a user to use group access rights set user name=johndoe groupa
set wlan set wlan Devices supported This command is supported in Digi Connect Wi-ME, Digi Connect Wi-EM, and Digi Connect Wi-SP devices. Purpose Configures wireless devices, or displays the status of wireless devices. Configuring Wireless Settings Following is information on how configuration choices for wireless devices, such as the authentication method, affect other configuration choices, such as encryption types and other options on the “set wlan” command.
set wlan Authentication methods and associated data fields The following table shows the authentication methods available for wireless devices, and the associated data fields, or command options, that apply to each method. All data fields with that have an X in a particular authentication method’s column are required, except for trusted certificates, which is optional. Data Fields: Authentication Method: Open WEP keys X If WEP encryption is selected.
set wlan Inner and outer protocols The following table shows relationships between outer protocols and inner protocols specified on the “set wlan” command. Outer protocols are the types of Extensible Authentication Protocols (EAP) that are allowed to establish the initial connection with an authentication server or access point. The outer protocols are specified by the “outer_eap” option. Inner protocols are the types of protocols that are allowed to authenticate the device.
set wlan Syntax Configure wireless settings set wlan [protmode={bss|ibss_create|ibss_join|any}] [channel={0|1-14}] [ssid=str ing ] [authentication={[open],[sharedkey],[wep_auth],[wpa_psk], [wpa_auth],[leap],[any]} [encryption={[open],[wep],[tkip],[ccmp],[any]}] [outer_eap={[peap],[tls],[ttls],[any]}] [inner_eap={[gtc],[md5],[mschapv2],[otp],[chap],[mschap], [ttls_mschapv2],[pap],[any]}] [options={[diversity],[short_preamble],[verify_cert]}] [username=stri ng ] [password=stri ng ] [psk=str ing ] [wepmode={6
set wlan ssid=string Used to specify the identifier of the wireless network that the device should be joined to. The default is an empty string, which indicates that the first wireless network that the device finds will be joined to. authentication= {[open],[sharekey],[wep_auth],[wpa_psk],[wpa_auth],[leap],[any]} The types of authentication that are allowed to establish a connection with the access point. open IEEE 802.11 open system authentication is used to establish a connection with the access point.
set wlan encryption={[open],[wep],[tkip],[ccmp],[any]} The types of encryption that are allowed to encrypt data transferred over the wireless link. open No encryption is used over the wireless link. Can be used with open and sharedkey authentication. wep Wired Equivalent Privacy (WEP) encryption is used over the wireless link. Can be used with open, sharedkey, wep_auth, wpa_psk, wpa_auth, and leap authentication. tkip Temporal Key Integrity Protocol (TKIP) encryption is used over the wireless link.
set wlan inner_eap={[gtc],[md5],[mschapv2],[otp],[chap],[mschap], [ttls_mschapv2],[pap,[any]]} The types of protocols that are allowed to authenticate the device. These are used within the encrypted connection established by PEAP or TTLS. The following are Extensible Access Protocols (EAP) that can be used with PEAP or TTLS: gtc Generic token card. md5 Message Digest Algorithm (MD5). mschapv2 Microsoft Challenge response Protocol version 2. otp One Time Password.
set wlan psk=string Used when the “security” option is set to “wpa_psk.” This option specifies a string that is converted into a pre-shared key (PSK) that is used for encryption. wepmode={64bit|128bit} Specifies the key size used when WEP encryption is enabled. The default is 64bit. wepindex=1-4 Specifies which of the 4 possible keys will be used. The default is 1. wepkeyN=hex_string A hexadecimal string that serves as the key if WEP encryption is enabled.
show show Devices supported This command is supported in all Digi Connect Family devices. 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 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.
show Works w/ range option Displays settings configured by Works w/ port option nat set nat N N network set network N N permissions set permissions N N pmodem set pmodem Y N pppoutbound set pppoutbound Y N profile set profile Y N rciserial set rciserial N N route The IP routing table. This command is not associated with a “set” command.
show Display current alarm settings show alarm Display settings for a particular user show user range=3 See also 146 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 status Devices supported This command is supported in all Digi Connect Family devices. Purpose Displays the current list of sessions. This includes any session that was created by a connect, rlogin, or telnet command. Typically, the status command is used to determine which sessions to close. Required permissions Permissions must be set to “set permissions status=read” or “set permissions status=rw” to use this command.
telnet telnet Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to make an outgoing Telnet connection, also known as a session Required permissions Permissions must be set to “set permissions telnet=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands.
who who Devices supported This command is supported in all Digi Connect Family devices. Purpose Displays active connections to and from the device. Required permissions Permissions must be set to “set permissions who=execute” to use this command. See "set permissions" on page 86 for details on setting user permissions for commands. Syntax who Options None at this time. Examples Display a list of all current connections who See also Chapter 2 "kill" on page 33.
who 150 Chapter 2 Command Descriptions
What Is Modem Emulation? Modem Emulation Commands Chapter 3 This chapter describes the commands that can be issued when Digi devices are configured in modem emulation mode. What Is Modem Emulation? Modem emulation enables a system administrator to configure a networked Digi device to act as a modem. The Digi device emulates modem responses to a serial device and seamlessly sends and receives data over an Ethernet network instead of a PSTN (Public Switched Telephone Network).
Common User Scenarios for Modem Emulation Common User Scenarios for Modem Emulation The Digi device in modem emulation mode allows for the easy replacement of modems in almost any environment where there is a LAN or WAN. User Scenario - Diagram A Workstation Serial cable DIG IO NE Digi device Ethernet Server 192.168.25.5 In Diagram A, the Digi Connect device replaces a modem connected to a workstation running an application.
Common User Scenarios for Modem Emulation User Scenario - Diagram B Workstation Serial cable DIG IO NE Ethernet Workstation Digi device Serial cable DIG IO NE Digi device In Diagram B, two Digi devices will replace modems on both sides of the connection. The initiation of the connection occurs with either of the Digi devices. If both ends are Digi devices, the TCP listening port number is 50001 for port 1. An example of the connection command is ATDT 192.168.25.30:50001.
Connection Scenarios for Modem Emulation Connection Scenarios for Modem Emulation Modem emulation can involve the following types of connection scenarios: Outgoing Modem Emulation Connection In an outgoing modem emulation connection, a serial device sends an ATDx.x.x.x:y command, which triggers the Digi device to establish a connection to destination IP=x.x.x.x, port=y.
About the Commands in this Chapter About the Commands in this Chapter This chapter describes the Digi-specific modem emulation commands that have been implemented for Digi Connect devices. It is divided into several sections: • The AT command set. These are commands to perform actions in a modem-emulation connection. • Modem S-Register definitions. • A description of the result codes for the commands.
Modem Emulation AT Command Set Modem Emulation AT Command Set The following commands can be issued to perform actions in a modememulation configuration scenario. AT Command Result Code Function n+++n When in data mode, this command causes the modem to switch to command mode. The value of n corresponds to the required delay before and after the escape sequence is entered. The delay can be changed by modifying S-register 12. The escape character can be changed by modifying S-register 2.
Modem Emulation AT Command Set AT Command ATO ATQn Function Result Code Return to on-line data mode. If the modem is in the on-line command mode, the modem enters the on-line data mode. If the modem is in the off-line command mode (no connection), ERROR is reported. • O0, O1: If there is an active connection, switches the modem to data mode. OKn = 0 or 1 and a connection exists. ERROR Otherwise or if not connected. Quiet results codes control command.
Modem Emulation AT Command Set AT Command AT&V Displays current values and settings. • AT&V0- AT&V5: Displays S-Register/command values for the current and stored configuration. • AT&Wn 158 Result Code Function AT&V6: Displays current network settings. Store configuration. Stores the specified S-registers in flash memory.
S-Register Definitions S-Register Definitions Following is a description of the S-registers that can be set. Register Function Range Units Default S0 Rings to Auto-Answer. Sets the number of rings required before the Digi device automatically answers a call. Setting this register to Zero disables auto-answer mode. 0-255 Rings 0 S1 Ring Counter. Specifies the current number of rings. S1 is incremented each time the modem detects a ring signal on the telephone line.
S-Register Definitions Register Function Range Units Default General Options Status. Indicates the status of command options. • Default: 52 (34h) (00110100b) • Bits 0 - 2: Ignored. • Bits 3-4: DTE’s DTR behavior (&Dn): 0 = DTR drop is ignored (&D0). 1 = DTR drop causes a transition from data to command mode without hanging up an existing connection (&D1). S21 2 = DTR drop hangs up the existing connection (&D2) (Default.) • - - 52 (34h) 0-255 s or 0.
Result Codes Result Codes Following is a description of the return codes returned by modem emulation commands.
Result Codes 162 Chapter 3 Modem Emulation Commands
Index A abbreviating commands 9 abort output signal 43 access control 44 newpass command 35 set user 131 status information 19 add line feed characters 34 alarms 46 configuring 46 reverting to default settings 39 alert character 10 altpin option 116 are you there signal 43 arp table 144 AT commands 155, 156 authentication 105 newpass command 35 set user command 131 authentication failure traps 121 Auto IP protocol 85 autoconnect 51 configuring 51 for TCP serial connections 123 reverting to default settings
display buffers command description 21 setting permissions for 88 display command description 19 setting permissions for 89 display current settings in a device See also the display variations of all set commands show command 144 display operating options 34 display statistics 25 displaying active connections to the device 149 DSR altpin field (swapping DCD with DSR) 116 GPIO pin for 63 hangupdsr field 124 DTR pin GPIO pin for 63 E EOS 15 EOS firmware version 19 erase character 43 erase line signal 43 esca
NAT See Network Address Translation navigation and editing keys 9 Network Address Translation (NAT) configuring 81 status information 19 network configuration options 84 reverting to default settings 40 network configuration options 84 network port 118 network services enabling and disabling 118 new-line character 10 newpass command description 35 setting permissions for 89 no option signal 43 O octal bytes in strings 10 odd parity 117 online help 9, 24 operating system updates 15 overflow errors 29 overru
service table 118 services, enabling and disabling 118 sessions closing 17 exiting 23 killing 33 reconnecting to 38 status of 147 Telnet 148 set accesscontrol command description 44 displaying current settings 44, 144 reverting settings 39 setting permissions for 90 set alarm command description 46 displaying current settings 46, 144 reverting settings 39 setting permissions for 90 set autoconnect command description 51 displaying current settings 51, 144 reverting settings 39 setting permissions for 91 set
displaying current settings 123, 145 reverting settings 41 setting permissions for 98 set term command description 126 displaying current settings 126, 145 reverting settings 41 set udpserial command description 127 displaying current settings 127, 145 reverting settings 41 setting permissions for 99 set user command description 131 displaying current settings 132, 145 reverting settings 39, 41 setting permissions for 99 set wlan command description 136 displaying current settings 139, 145 reverting setting
status information for 19 wireless Ethernet (wlan) table 25 X Xon/Xoff 117 168 Index
