Digi Connect® Family Command Reference Revision history—90000566 Revision Date Description N September Updated several of the commands. 2013 P June 2015 Added product introduction for ConnectPort TS 16 MEI and added new and changed content to accommodate ConnectPort TS 16 MEI. R April 2017 Rebranded with minor updates. S December Updated password information. 2019 Added the mobile_fwupdate command. T June 2020 Added documentation for set radius command. Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners. © 2020 Digi International Inc. All rights reserved. Disclaimers Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose. Digi may make improvements and/or changes in this manual or in the product(s) and/or the program(s) described in this manual at any time. Warranty To view product warranty information, go to the following website: www.digi.com/howtobuy/terms Send comments Documentation feedback: To provide feedback on this document, send your comments to [email protected]. Customer support Digi Technical Support: Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and pricing, contact us at +1 952.912.3444 or visit us at www.digi.com/support. Digi Connect Family Command Reference 2 Contents Digi Connect Family Command Reference Access the Command Line 7 Configure an IP Address 8 Basic Command Information 8 Navigation and Editing Keys 8 Displaying Online Help 8 Abbreviating Commands 9 Syntax Conventions 9 Entering Special Characters in String Values 9 Escape Sequences for Special Characters 9 Length Limitations on String Values 10 Commands for managing connections and sessions 10 User Models and User Permissions in Digi devices 11 Identifying the User Model for Your Digi device 11 One-user Model 11 Two-user Model 11 More than Two-user model 11 Login Suppression Feature 12 Increasing Security for Digi Device Users 12 Entering commands from Remote Manager 12 Command Descriptions Verify device support for commands 17 backup 18 boot 19 certmgmt 21 close 28 connect 30 dhcpserver 32 display accesscontrol 36 display arp 37 display buffers 38 display carriers 40 display dcloud 42 display ddns 44 display device 45 display dnsserver 47 display failover 48 display gpio 51 Digi Connect Family Command Reference 3 display gps 52 display ikesa 53 display ikespd 54 display ipsecspd 55 display iridium 56 display logging 57 display memory 61 display mobile 62 display nat 64 display netdevice 66 display orbcomm 68 display passthrough 70 display pppstats 71 display provisioning 76 display proxyarp 78 display route 79 display sadb 81 display scancloak 82 display serial 83 display smscell 84 display sockets 87 display spd 88 display tcp 89 display techsupport 90 display udp 92 display uptime 93 display versions 94 display vpn 95 display vrrp 97 display wimax 98 display wlan 101 display Xbee 102 exit 105 findme 106 flashdrv 107 help and ? 108 info camera 109 info device 111 info ethernet 114 info ia 116 info icmp 118 info ip 120 info iridium 123 info orbcomm 125 info serial 127 info tcp 129 info time 131 info udp 133 info wlan 135 info xbee 138 iridium 142 kill 143 mobile_fwupdate 144 mobile_update 146 newpass 148 Digi Connect Family Command Reference 4 orbcomm 149 ping 151 provision 152 python 157 quit 159 reconnect 160 revert 162 rlogin 171 send 172 set accesscontrol 174 set alarm 176 set autoconnect 187 set buffer 191 set camera 193 set clocksource 196 set dcloud_msgservice 198 set ddns 200 set devicesecurity 204 set dhcpserver 206 set dialserv 213 set dirp 214 set dnsproxy 216 set ekahau 219 set ethernet 221 set failover 223 set forwarding 229 set geofence 233 set gpio 237 set group 239 set host 242 set hostlist 243 set ia 244 set login 255 set mgmtconnection 256 set mgmtglobal 260 set mgmtnetwork 263 set mobile 267 set mobileppp 274 set nat 279 set network 284 set orbcomm 291 set passthrough 293 set permissions 297 set pmodem 308 set position 311 set ppp 312 set profile 318 set putty 322 set python 329 set radius 331 set rciserial 333 set realport 335 set realportusb 336 set rtstoggle 338 set scancloak 340 Digi Connect Family Command Reference 5 set serial 344 set service 347 set sharing 353 set slideshow 358 set smscell 359 set snmp 370 set socket_tunnel 373 set surelink 375 set switches 380 set system 384 set tcpserial 386 set term 389 set time 391 set timemgmt 393 set trace 395 set udpserial 398 set user 402 set video 407 set vncclient 408 set vpn 410 set vrrp 433 set wimax 435 set wlan 438 set xbee 446 show 454 show smscell 461 show vpn 464 smscell 467 status 468 telnet 469 vpn 471 watchport 473 who 474 wimax 476 xbee 480 Modem Emulation Commands What Is Modem Emulation? 486 Modem Emulation Cable Signals 486 Modes of Operation 486 Common User Scenarios for Modem Emulation 486 Connection Scenarios for Modem Emulation 488 Outgoing Modem Emulation Connection 489 Incoming Modem Emulation Connection 489 Modem Emulation Pooling 489 Modem Emulation Bridge 489 About the Commands in this Chapter 489 Accepted But Ignored AT Commands 489 Modem Emulation AT Command Set 489 S-Register Definitions 493 Result Codes 495 Digi Connect Family Command Reference 6 Digi Connect Family Command Reference This book describes the commands in the command-line interface for the following product families: n Digi Connect Family Products n ConnectPort® TS Products n Digi Cellular Family Products: n Digi Connect WAN Family n ConnectPort WAN Family n ConnectPort X Family Products n ConnectPort X5 Family Products n ConnectPort Display n AnywhereUSB® This chapter provides the following information: n 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. n How to access the command line. n How to configure an IP address for a Digi device from the command line, if an address has not already been assigned. n Information about user models and user permissions in Digi devices, and how they affect the commands you can issue. Access the Command Line To configure devices using commands, you must first access the command line, and then log on with your user name and password. Note The default user name is root and the unique, default password is printed on the device label. If the password is not on the device label, the default password is dbps. If none of the defaults work, the user name and/or password may have been updated. Contact your system administrator. This procedure assumes that you have already configured the Digi device with an IP address. 1. To access the Command Line Interface for the Digi device, enter the following command from a command prompt on another networked device, such as a server: Digi Connect Family Command Reference 7 Digi Connect Family Command Reference Configure an IP Address #>telnet ip address where ip address is the Digi device’s IP address. For example: #> telnet 192.3.23.5 2. A login prompt appears. Enter the user name and password for the device. n User name: The default user name is root. n Password: The unique, default password is printed on the device label. If the password is not on the device label, the default password is dbps. If none of the defaults work, the user name and/or password may have been updated. Contact your system administrator. Configure an IP Address If the device you will be issuing commands has not already been assigned an IP address or the IP address needs to be modified from its initial configuration, see the Digi product’s User Guide for details on configuring an IP address. Basic Command Information Navigation and Editing Keys Navigation and Editing Keys Use the keys listed in the table to navigate the command line and edit commands: Action Keys Move the cursor back one space. Ctrl+b 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. Enter Displaying Online Help You can access help for all commands as described in the following table. For information on... Type All commands ? (with no additional options) Digi Connect Family Command Reference 8 Digi Connect Family Command Reference Basic Command Information For information on... Type A specific command help [command] OR [command] ? Example: help info Example: info ? Example: set alarm ? Abbreviating Commands You can abbreviate all commands by typing enough letters to uniquely identify the command. Syntax Conventions Presentation of command syntax in this manual follows these conventions: n Brackets [ ] surround optional material. n Braces { } surround entries that require you to chose one of several options, which are separated by the vertical bar, |. n Non-italicized text indicates literal values, that is, options or values that must be typed exactly as they appear. Yes and no options are examples of literals. n Italicized text indicates that a type of information is required in that option. For example, filename means that the name of a file is required in the option.