Digi 90000566-H User Manual
Command Reference
Digi Connect® Family
Digi Connect Family:
Digi Connect SP, Digi Connect Wi-SP, Digi Connect ME, Connect ME4,
Digi Connect Wi-ME, Digi Connect EM, Digi Connect Wi-EM,
Digi Connect ES Family (Digi Connect ES 4/8/16 devices)
ConnectPort
ConnectPort TS 8, ConnectPort TS 8 MEI
Digi Cellular Family:
Digi Connect WAN, Digi Connect WAN VPN,
Digi Connect WAN Sync, Digi Connect WAN IA, ConnectPort
Connect WAN Family:
Digi Connect
Digi Connect WAN IA, Digi Connect WAN Sync
•
WAN, Digi Connect WAN VPN,
ConnectPort
ConnectPort WAN VPN
ConnectPort
•
TS Products:
•
Family:
•
X Family:
ConnectPort X8
TM
WAN VPN
www.digi.com
ConnectPort Display
90000566_H
© Digi International Inc.2007. All Rights Reserved.
Digi, Digi International, the Digi logo, Digi Connect Family, Digi Connect SP,
Digi Connect Wi-SP, Digi Connect ME, Digi Connect ME4, Digi Connect Wi-ME,
Digi Connect EM, Digi Connect Wi-EM, Digi Connect ES, ConnectPort TS 8,
ConnectPort TS 8 MEI, Digi Connect WAN, Digi Connect WAN VPN, ConnectPort WAN
VPN, Digi Connect WAN IA, Digi Connect WAN Sync, ConnectPort Display, RealPort,
and Digi SureLink 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.
Digi provides this document “as is,” without warranty of any kind, either 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.
This product could include technical inaccuracies or typographical errors. Changes are
periodically made to the information herein; these changes may be incorporated in new
editions of the publication.
Contents
Chapter 1 Introduction
Digi Connect Products and Families to Which This Book Applies.........7
Quick Reference for Configuring Features............................................8
Access the Command Line..................................................................11
Configure an IP Address .....................................................................11
Basic Command Information...............................................................12
User Models and User Permissions in Digi Connect Products............14
Chapter 2 Command Descriptions
Verifying Device Support for Commands ............................................17
backup.................................................................................................18
boot......................................................................................................19
close....................................................................................................21
connect................................................................................................22
dhcpserver...........................................................................................23
display .................................................................................................27
display buffers .....................................................................................37
exit.......................................................................................................39
help and ?............................................................................................40
info.......................................................................................................41
kill ........................................................................................................49
mode....................................................................................................50
newpass ..............................................................................................51
ping......................................................................................................52
provision..............................................................................................53
python..................................................................................................58
quit.......................................................................................................59
reconnect.............................................................................................60
revert ...................................................................................................61
rlogin....................................................................................................66
send.....................................................................................................67
set accesscontrol.................................................................................68
set alarm..............................................................................................70
set autoconnect...................................................................................81
set bsc.................................................................................................85
set buffer..............................................................................................90
set ddns...............................................................................................92
set dhcpserver.....................................................................................96
set ekahau.........................................................................................104
Contents 3
set ethernet........................................................................................107
set forwarding....................................................................................109
set gpio..............................................................................................113
set group............................................................................................115
set host..............................................................................................118
set ia..................................................................................................119
set login.............................................................................................131
set menu............................................................................................132
set mgmtconnection ..........................................................................137
set mgmtglobal..................................................................................140
set mgmtnetwork...............................................................................143
set nat................................................................................................146
set network........................................................................................149
set passthrough.................................................................................153
set permissions..................................................................................157
set pmodem.......................................................................................164
set pppoutbound................................................................................166
set profile...........................................................................................172
set putty.............................................................................................175
set python..........................................................................................183
set rciserial ........................................................................................184
set realport.........................................................................................185
set rtstoggle.......................................................................................187
set serial............................................................................................189
set service .........................................................................................191
set snmp............................................................................................198
set socket_tunnel...............................................................................200
set surelink ........................................................................................202
set switches.......................................................................................208
set system .........................................................................................211
set tcpserial .......................................................................................212
set term..............................................................................................215
set udpserial......................................................................................216
set user..............................................................................................220
set video............................................................................................225
set vncclient.......................................................................................226
set vpn...............................................................................................228
set wlan .............................................................................................241
show..................................................................................................249
status.................................................................................................254
telnet..................................................................................................255
vpn.....................................................................................................256
4 Contents
who....................................................................................................258
Chapter 3 Modem Emulation Commands
What Is Modem Emulation? ..............................................................259
Modem Emulation Cable Signals ......................................................259
Modes of Operation...........................................................................259
Common User Scenarios for Modem Emulation...............................260
Connection Scenarios for Modem Emulation....................................262
About the Commands in this Chapter................................................263
Accepted But Ignored AT Commands...............................................263
Modem Emulation AT Command Set................................................264
S-Register Definitions........................................................................267
Result Codes.....................................................................................269
Index.......................................................................................................271
Contents 5
6 Contents
Digi Connect Products and Families to Which This Book Applies
Chapter 1
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.
• How to access the command line.
• How to configure an IP address for a Digi device from the command
line, if an address has not already been assigned.
• Information about user models and user permissions in Digi Connect
products, and how they affect the commands you can issue.
Introduction
Digi Connect Products and Families to Which This Book Applies
This manual documents the command-line interface for the following Digi
products:
• The Digi Connect Family, which includes these products:
• Digi Connect SP
• Digi Connect Wi-SP
• Digi Connect ME
• Digi Connect Wi-ME
• Digi Connect EM
• Digi Connect Wi-EM
• Digi Connect ES Family (Digi Connect ES 4/8/16 devices)
• Connectport TS 8
• ConnectPort TS 8 MEI
• The Digi Cellular Family, which includes these products:
• Digi Connect WAN
• Digi Connect WAN VPN
• ConnectPort WAN VPN
• Digi Connect WAN IA
• Digi Connect WAN Sync
• The ConnectPort X Family, which includes these products:
• ConnectPort X8
• ConnectPort Display
Chapter 1 Introduction 7
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. 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" on page 70.
Autoconnection (automatically connect a user to
a server or network device)
Bisynchronous communications "set bsc" on page 85
Configuration management/administration Backup/restore a configuration from a TFTP server on the
Connectware Manager/Remote Management:
Connectware Device Protocol configuration
settings
Custom menus "set menu" on page 132.
DHCP (Dynamic Host Configuration Protocol) To configure a DHCP server: "set dhcpserver" on page 96.
Display current configuration settings in a device "show" on page 249.
Dynamic DNS (DDNS) "set ddns" on page 92.
"set autoconnect" on page 81.
"set serial" on page 189.
"set tcpserial" on page 212.
network: "backup" on page 18.
Update firmware: "boot" on page 19.
Reset configuration to factory defaults: "revert" on page
61; or boot action=factory (see "boot" on page 19).
Reboot the device: "boot" on page 19.
"set mgmtconnection" on page 137.
"set mgmtglobal" on page 140.
"set mgmtnetwork" on page 143.
To manage and show status of a DHCP server:
"dhcpserver" on page 23.
Ekahau Client™ device-location software "set ekahau" on page 104
Ethernet settings for wired devices "set ethernet" on page 107.
General Purpose Input/Output (GPIO) pins "set gpio" on page 113.
"set alarm" on page 70.
Help on device commands "help and ?" on page 40.
Host name for a device (Specify a name for the
device)
Industrial Automation (IA) • “set profile profile=ia” See "set profile" on page 172.
IP address settings "set network" on page 149.
8 Chapter 1 Introduction
"set host" on page 118.
• "set ia" on page 119.
• For additional information on configuring Industrial
Automation, see this web site:
http://www.digi.com/support/ia
Quick Reference for Configuring Features
Feature/Task Commands
IP Forwarding and Network Address T ran slation
(NAT)
IP pass-through "set passthrough" on page 153
Mobile (Cellular) features:
• Provisioning CDMA cellular modules To display existing provisioning parameters:
• Mobile service provider and connection
settings
• SureLink™ Settings "set surelink" on page 202.
Multiple Electrical Interface (MEI) "set switches" on page 208
Point to Point Protocol (PPP) "set pppoutbound" on page 166.
Port buffering "display buffers" on page 37.
"set forwarding" on page 109.
"set nat" on page 146.
“display provisioning” -- see "display" on page 27
To provision the CDMA module: "provision" on page 53
The only mobile connection setting that can be set from
the command line is the inactivity timeout,
(“set pppoutbound (rx_idle_timeout=timeout.)
The Inactivity timeout specifies the time, in seconds, after
which if no data has received over the link, the mobile
connection will be disconnected and re-established.
"set pppoutbound" on page 166.
"set buffer" on page 90.
Port profiles: sets of preconfigured serial-port
settings for a particular use
Python
devices
RCI over Serial "set rciserial" on page 184.
RealPort (COM port redirection) configuration "set realport" on page 185.
Remote access through VNC (Virtual Network
Computing) protocol
Remote login (rlogin) "rlogin" on page 66.
Reverting configuration settings "revert" on page 61.
RTS Toggle "set rtstoggle" on page 187.
®
program storage and execution on Digi
"set profile" on page 172.
To learn about the Python programming language and
writing programs: see the Digi Python Programming
Guide.
To configure Python programs to execute when the Digi
device boots: "set python" on page 183.
To manually execute a Python program from the command
line: "python" on page 58.
See also the RealPort Installation Guide.
"set vncclient" on page 226.
Chapter 1 Introduction 9
Quick Reference for Configuring Features
Feature/Task Commands
Serial port configuration Serial port communication options: "set serial" on page
Security, users, user access permissions, and
user groups
189.
Port profiles: "set profile" on page 172.
RCI serial mode: "set rciserial" on page 184.
RTS Toggle: "set rtstoggle" on page 187.
TCP serial connections: "set tcpserial" on page 212.
UDP serial characteristics: "set udpserial" on page 216.
See "User Models and User Permissions in Digi Connect
Products" on page 14 for a discussion of how users and
access permissions are implemented in Digi Connect
products.To create users and change user names: "set
user" on page 220.
To control access to inbound ports:"set service" on page
191.
Enable/disable command-line access: "set term" on page
215.
To issue new password to user: "newpass" on page 51.
To set permissions associated with various services and
commands: "set permissions" on page 157.
T o add or remove user grou ps, change group configuration
attributes, or display group configuration attributes: "set
group" on page 115.
To suppress user login: "set login" on page 131.
Simple Network Management Protocol (SNMP) To configure SNMP: "set snmp" on page 198.
To enable/disable SNMP service: "set service" on page
191.
To enable/disable SNMP alarm traps: "send" on page 67.
Set system information: assign systemidentifying information to a device
Socket tunnel settings "set socket_tunnel" on page 200.
Statistics for your Digi device "info" on page 41.
Status of your Digi device "display" on page 27.
Digi SureLink™ "set surelink" on page 202.
Telnet to network devices "telnet" on page 255.
Terminal Em ula tio n fo r Con nect Po rt Disp lay "set putty" on page 175.
Video settings for ConnectPort Display "set video" on page 225.
VPN (Virtual Private Network) To configure VPN: Using the Web user interface is
"set system" on page 211.
"status" on page 254.
"who" on page 258.
"mode" on page 50.
"send" on page 67.
recommended. See "set vpn" on page 228.
To manage VPN: "vpn" on page 256.
10 Chapter 1 Introduction
Feature/Task Commands
Wireless devices "set wlan" on page 241.
"set ekahau" on page 104.
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 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:
#> telnet ip address
where ip address is the Digi device’s IP address. For example:
#> telnet 192.3.23.5
2. If user authentication has been set up for the device, (that is, a username and password have been set up for the device), a login prompt is
displayed. If you do not know the user name and password for the
device, contact the system administrator who configured the device.
The default username is “root” and the default password is “dbps.”
Access the Command Line
Configure an IP Address
If the device to which you will be issuing commands has not already been
assigned an IP address, or if the IP address needs to be modified from its
initial configuration, see the Digi product’s User’s Guide for details on
configuring an IP address.
Chapter 1 Introduction 11
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:
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
Help is available for all commands. The table describes how to access it.
Action Keys
For information on... Type
All commands ? (with no additional options)
A specific command help [command]
Abbreviating Commands
All commands can be abbreviated. Simply supply enough letters to
uniquely identify the command.
Syntax Conventions
Presentation of command syntax in this manual follows these conventions:
• Brackets [ ] surround optional material.
• Braces { } surround entries that require you to chose one of several
options, which are separated by the vertical bar, |.
• 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.
OR
[command] ?
Example: help info
Example: info ?
Example: set alarm ?
• 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.
12 Chapter 1 Introduction
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:
Basic Command Information
Escape
Sequence
\* Match any character. This escape sequence is only available on the
“set alarm match=string” option.
\a Alert character.
\b Backspace character.
\f Form-feed character.
\n New-line character.
\r Carriage-return character.
\s Acts as a separator between characters. This sequence allows you to
enter a string such as “\xB8\s4” where you want the B8 translated as
a hexadecimal character separate from the numeric ch ar ac te r 4.
\t Horizontal tab character.
\v Vertical tab character.
\\ Backslash character ( \ ).
\xN A hexadecimal number, where N is up to 20 hexadecimal digits. For
example: \x10\x2
Processed as:
\N An octal byte, where N is up to 3 octal digits. For example: \2 or
\208
Length Limitations on String Values
String values for certain command options have specific limitations on the
maximum total string value including special characters, and the maximum
parsed value (that is, the character-string length when any escape
sequences in the string are processed). The option descriptions note these
maximum lengths.
Chapter 1 Introduction 13
User Models and User Permissions in Digi Connect Products
User Models and User Permissions in Digi Connect Products
The user model in a Digi Connect product influences the commands that
users can issue. There are three user models implemented in the various
Digi Connect and ConnectPort devices: one-user model, two-user model,
and more than two-user model.
Identifying the User Model for Your Digi Connect Product
To determine which user model is implemented in your Digi Connect
product, issue a “show user” or “set user” command (see "show" on page
249 and "set user" on page 220). In the command output, note how many
user IDs are defined: one, two, or more than two. You can also issue a
“set user ?” command and note the range for the “id=” option. If the “id=”
option is not listed, there is one user. Otherwise, the range for user IDs is
displayed.
One-user Model
In the one-user model, by default there is no login prompt, and the default
name for user 1 is “root.”
To enable the login prompt, you must issue a “newpass” command with a
password length of one or more characters (see "newpass" on page 51).
Once a password is enabled, issuing a “newpass” command with a zerolength password will disable it.
• User 1 has a default name of “root.”
• User 1 has permissions that enables it to do all commands.
Permissions cannot be altered.
Two-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 it to issue all commands.
• Permissions for User 1 can be changed to be less than the default root
permissions.
• User 2 is undefined. That is, it does not exist by default, but it can be
defined.
• When defined, User 2 has a limited set of permissions, defined by the
“set permissions” command (see "set permissions" on page 157).
• Permissions for User 2 can be changed to be either greater than or less
than its default.
More than Two-user model
User definitions are exactly the same as the two-user model, with the
addition of user groups and more users. The “set group” command defines
user groups (see "set group" on page 115).
14 Chapter 1 Introduction
User Models and User Permissions in Digi Connect Products
Login Suppression Feature
The login prompt can be disabled by issuing the “set login” command. See
"set login" on page 131.
Increasing Security for Digi Device Users
As needed, you can enforce additional security for device users. For
example, you can use the autoconnect feature, where a user is
automatically connected to another system without accessing the Digi
device’s command line. See "set autoconnect" on page 81.
Chapter 1 Introduction 15
User Models and User Permissions in Digi Connect Products
16 Chapter 1 Introduction
Verifying Device Support for Commands
Chapter 2
This chapter provides a description of each command in the Digi Connect
Family Command-Line Interface.
Verifying Device Support for Commands
To verify whether a Digi Connect 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.
• “help set” displays syntax and options for the “set” command.
• “set serial ?” displays the syntax and options for the “set serial”
command.
• “help set serial” displays the syntax and options for the “set serial”
command.
Command Descriptions
Some options may become available in new firmware revisions or before
new documentation is released.
Some commands relate only to particular features unique to specific Digi
products. For example, the “set wlan” command applies only to wireless
products. Other commands may have options that are specific to features
that are not available on all devices. For example, the “display” command’s
“mobile” option applies only to Digi Cellular Family products.
Chapter 2 Command Descriptions 17
backup
backup
Devices
This command is supported in all Digi Connect products.
supported
Purpose Save the device configuration to a TFTP server located on the network, or
restores the configuration from a saved copy on the TFTP server.
Required
permissions
For Digi Connect products with two or more users, permissions must be set
to “set permissions backup=execute” to use this command. See
"set permissions" on page 157 for details on setting user permissions for
commands.
Syntax backup [to=serv eripaddress[:filename]|
from=serv eripaddress[:filename]|print]
Options to=serveripaddress[:filename]
The IP address of the TFTP server to which the configuration will be
saved, and the filename that the configuration will be saved as. If a
filename is not specified, the default filename of config.rci is used.
from=serveripaddress[:filename]
The IP address of the TFTP server and the filename from which the
configuration will be restored. If a filename is not specified, the default
filename of config.rci is assumed.
print
Prints out the current device configuration.
Example
#> backup from=10.0.0.1:config.rci
See also "set rciserial" on page 184. The “set rciserial” command allows a
configuration file to be loaded over a serial port when the DSR input signal
is high.
18 Chapter 2 Command Descriptions
boot
boot
Devices
This command is supported in all Digi Connect products.
supported
Purpose Reboots the device server, restores the device configuration to factory
default settings, or loads new firmware files (both EOS and POST images)
from a TFTP server.
Required
permissions
For Digi Connect products with two or more users, permissions must be set
to “set permissions boot=execute” to use this command. See
"set permissions" on page 157 for details on setting user permissions for
commands.
Syntax Reboot the device server
boot action=reset
Restore configuration defaults
boot action=factory
Load new firmware or POST file into flash ROM from a TFTP host
boot load=host ip address:load file
Options action
The action to be performed.
factory
Resets the entire configuration to factory defaults, then reboots the
device.
reset
Reboots the device.
load
The firmware to be loaded.
host ip address
The IP address of a host with new firmware or POST file, which is then
burned into flash ROM. The host must be running a TFTP server.
load file
The name of a firmware file or POST file. The software automatically
detects the type of file and performs the appropriate load operation.
Chapter 2 Command Descriptions 19
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.
A reboot is required to use the new firmware.
#> boot load=10.0.0.1:firmware.bin
See also "revert" on page 61.
20 Chapter 2 Command Descriptions
close
close
Devices
This command is supported in all Digi Connect products.
supported
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. Do this
by pressing the escape key defined for your session type. The following
table lists default escape keys.
Session Type Default Escape Keys
Connect Ctrl+[+Enter
Rlogin ~+Enter
Telnet Ctrl+]+Enter
Syntax close [{*|connection number}]
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" on page 49. The kill command has a broader effect than close, and
lets you kill connections from the global list. That is, it is not limited to
sessions associated with the current connection.
• "status" on page 254 for information on displaying status information on
active sessions.
• "connect" on page 22
• "rlogin" on page 66
• "telnet" on page 255
Chapter 2 Command Descriptions 21
connect
connect
Devices
This command is supported in all Digi Connect products.
supported
Purpose Used to make a connection, or establish a session, with a serial port.
Required
permissions
For Digi Connect products with two or more users, permissions must be set
to “set permissions connect=execute” to use this command. See
"set permissions" on page 157 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.
Temporarily suspend a connection
Escape the active session by pressing Ctrl [.
Temporarily suspend a connection and return to the command line
Press the escape character and then the Enter key.
Switch between active sessions (without first escaping to the command
line)
Press the escape character and then the number of the session you wish
to enter, for example, Esc+1.
Pressing the connect escape character twice causes the next session to
appear, enabling you to easily page through sessions.
Options serial port
The number of the port on which to establish a connection.
Example
Create a connection to port 1
#> connect 1
See also • "close" on page 21 for information on ending a session.
• "reconnect" on page 60 for information on reestablishing a port
connection.
22 Chapter 2 Command Descriptions
dhcpserver
dhcpserver
Devices
This command is supported in Digi Cellular Family products only.
supported
Purpose Used for managing and showing the status of a DHCP server, including
managing the leases for IP addresses, restarting, running, and shutting
down the DHCP server, and displaying DHCP server status information.
Required
permissions
For Digi Connect products with two or more users, permissions must be set
to “set permissions connect=execute” to use this command. See
"set permissions" on page 157 for details on setting user permissions for
commands.
Syntax dhcpserver [deletelease={ip address|all}]
restart
run
shutdown
status
Options deletelease={ip address|all}
Specifies how to handle IP address leases. You may remove leases from
the DHCP Server while it is running.
ip address
Removes a specific lease from the DHCP server.
all
Removes all IP address leases from the DHCP server.
Removing a lease will cause the associated IP address to be returned
immediately to the available address pool. Any IP address in this
available address pool may be served in a new lease to a DHCP client.
If you stop or restart the DHCP server, or if you reboot the Digi Connect
product, all knowledge of the IP address leases will be lost. All leased
addresses, except for reservations, will be returned to the available
address pool and may be served in a new lease to a DHCP client.
Static lease reservations will always be displayed in the lease list. These
reservation leases may be removed, but a new lease will be created
immediately. To disable or permanently remove a reservation, use the
“set dhcpserver” command. See the examples for "set dhcpserver" on
page 96.
restart
Restarts the DHCP server.
run
Runs (starts) the DHCP server if it not already started.
shutdown
Shuts down the DHCP server.
status
Displays DHCP server status information.
Chapter 2 Command Descriptions 23
dhcpserver
Example Display DHCP server status
#> dhcpserver status
Device Networking Status:
IP address : 10.30.1.188
Subnet mask : 255.255.255.0
Default gateway : 10.6.6.6
Static IP configured : yes
Uptime : 0 days + 21:00:44
DHCP server status: running
Uptime : 0 days + 21:00:36
Scopes configured in server:
Scope 1:
Name : eth0
IP address : 10.30.1.188
Subnet mask : 255.255.255.0
Starting IP address : 10.30.1.190
Ending IP address : 10.30.1.198
Routers : 10.30.1.188
DNS servers : 209.183.48.10 209.183.48.11
Lease duration : 3600 (seconds)
Offer delay : 500 (milliseconds)
Addr conflict detect : disabled
Address reservations:
Reservation 1:
IP address : 10.30.1.135
Client ID : 00:40:9D:24:73:F8
Lease duration : 3600 (seconds)
Reservation 2:
IP address : 10.30.1.192
Client ID : 02:40:9D:24:73:F8
Lease duration : using scope lease duration
Reservation 3:
IP address : 10.30.1.195
Client ID : 00:09:26:19:51:05
Lease duration : using scope lease duration
Reservation 4:
IP address : 10.30.1.196
Client ID : 00:09:26:19:51:06
Lease duration : using scope lease duration
Reservation 5:
24 Chapter 2 Command Descriptions
dhcpserver
IP address : 10.30.1.197
Client ID : 00:09:26:19:51:07
Lease duration : using scope lease duration
Address exclusions:
none configured
Lease Records:
Client ID Lease Time in Seconds
IP Address (MAC Address) Duration Remaining Lease Record Status
--------------- ----------------- ---------- ---------- ------------------
10.30.1.135 00:40:9D:24:73:F8 3600 1834 Reserved (active)
10.30.1.192 02:40:9D:24:73:F8 3600 N/A Reserved (inactive)
10.30.1.195 00:09:26:19:51:05 3600 N/A Reserved (inactive)
10.30.1.196 00:09:26:19:51:06 3600 N/A Reserved (inactive)
10.30.1.197 00:09:26:19:51:07 3600 N/A Reserved (inactive)
Delete a lease
dhcpserver deletelease=10.30.1.135
Delete all leases
dhcpserver deletelease=all
Lease status values
Following are descriptions of the lease status values. The amount of time
that a lease table entry will remain in each state also is stated. Note that
after a lease is deleted, the associated IP address is returned to the
available address pool.
Assigned (active)
A lease is currently assigned and active for the given client. The client
may renew the lease, in which case the lease remains in this state.
Assigned (expired)
A lease has expired and is no longer active for the given client. A lease
in this state will remain for 4 hours, after which it is deleted. If the same
client requests an IP address before the lease is deleted, it will be given
the same IP address previously served to it.
Reserved (active)
A lease for an address reservation is currently active for the given client.
A reservation lease will remain indefinitely, although the status may
alternate between active and inactive.
Reserved (inactive)
A lease for an address reservation is currently inactive for the given
client. A reservation lease will remain indefinitely, although the status
may alternate between active and inactive.
Reserved (unavail)
A lease for an address reservation was offered to a client, but that client
actively declined to use the IP address. Typically this is because the
client determined that another host on the same subnetwork is already
using that IP address. Upon receiving the client's decline message, the
Chapter 2 Command Descriptions 25
dhcpserver
DHCP server will mark the address as unavailable. The lease will remain
in this state for 4 hours, after which it is reverts to the Reserved (inactive)
status.
Offered (pre-lease)
A lease has been offered to the given client, but that client has not yet
requested that the lease be acknowledged. It may be that the client also
received an offer from another DHCP server, in which case this offer will
expire in approximately 2 minutes. If the client requests this lease before
that 2 minute interval elapses, this lease will change status to Assigned.
Released
A lease was previously assigned to the given client, but that client has
proactively released it. A lease in this state will remain for 1 hour, after
which it is deleted. If the same client requests an IP address before the
lease is deleted, it will be given the same IP address previously served to
it.
Unavailable Address
A lease was offered to a client, but that client actively declined to use the
IP address. Typically this is because the client determined that another
host on the same subnetwork is already using that IP address. Upon
receiving the client's decline message, the DHCP server will mark the
address as unavailable. The lease will remain in this state for 4 hours,
after which it is deleted.
This status may also occur if the DHCP Server determines that the IP
address is in use before it offers the address to a client. See the
"set dhcpserver" command option "conflictdetect" option.
See also • "set dhcpserver" on page 96.
• The Web user interface’s help text for Network Settings, which includes
information on configuring DHCP server settings and managing DHCP
servers.
26 Chapter 2 Command Descriptions
display
display
Devices
This command is supported in all Digi Connect products.
supported
Purpose Displays status information for a Digi Connect 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).
Status information that can be displayed includes:
• General product information, including the product name, MAC
address, boot, post, and firmware versions, memory usage, CPU
utilization, and uptime, or the amount of time since the device was last
booted.
• Access control status information.
• ARP table information.
• Contents of a port buffer (see also "display buffers" on page 37).
• Dynamic DNS (DDNS) service status information.
• GPIO signals.
• Memory usage information only.
• Mobile (cellular modem) status information.
• Network Address Table (NAT) status information.
• Active network device interfaces and their status.
• IP pass through status.
• Point-to-Point Protocol (PPP) status information, including SureLink
statistics.
• Provisioning parameters in a Digi Cellular Family device’s CDMA
cellular module.
• Route Table entries.
• Security Association (SA) database entries (can also be displayed with
other Virtual Private Network (VPN) information).
• Security Policy Database (SPD) entries (can also be displayed with
other Virtual Private Network (VPN) information)
• Serial modem signals (DTR, RTS, CTS, DSR, DCD).
• Socket status information.
• Multiple Electrical Interface (MEI) switch settings currently defined for
ports, on devices supporting MEI.
• Current TCP and UDP session and listener information.
• Uptime information only.
• Version information for Boot, POST and EOS firmware, and Digi part
numbers for those items.
Chapter 2 Command Descriptions 27
display
• Virtual Private Network (VPN) information, including Security
Association (SA) database entries and Security Policy Database (SPD)
entries.
• Typical wireless LAN (WLAN) parameters for wireless devices.
100% CPU Utilization may indicate encryption key generation is in-progress
There may be instances when a “display device” command returns a CPU
utilization of 100%. A CPU usage this high may indicate that encryption key
generation is in-progress. On initial boot, the Digi device generates some
encryption key material: an RSA key for SSL/TLS operations, and a DSA
key for SSH operations. This key-generation process can take as long as
40 minutes to complete. Until the corresponding key is generated, the Digi
device will be unable to initiate or accept that type of encrypted connection.
It will also report itself as 100% busy but, since key generation takes place
at a low priority, the device will still function normally. On subsequent
reboots, the Digi device will use its existing keys and will not need to
generate another unless a reset to factory defaults is done, which will
cause a new key to be generated on the next reboot.
Required
permissions
For Digi Connect products with two or more users, permissions must be set
to “set permissions display=execute” to use this command. See
"set permissions" on page 157 for details on setting user permissions for
commands.
Syntax
display {accesscontrol|arp|buffers|ddns|device|gpio|memory|mobile|
nat|netdevice|passthrough|pppstats|provisioning|route|sadb|
serial|sockets|spd|switches|tcp|udp|uptime|version|vpn|wlan}
Options accesscontrol
Displays access control status information.
arp
Displays ARP table entries.
buffers
Displays the contents of a port buffer. This option is covered in more
detail in "display buffers" on page 37.
28 Chapter 2 Command Descriptions
display
device
Displays general product information including product name, MAC
address, boot, post, and firmware versions, memory usage, CPU
utilization, and uptime. The information displayed by this option is the
same as that displayed by the “info device” command (see "info" on page
41).
ddns
Displays status information for the Dynamic DNS (DDNS) service. See
"set ddns" on page 92 for information on the DDNS service.
gpio
Displays GPIO signals.
memory
Displays general memory, network memory, and streams memory
usage.
mobile
Displays mobile (cellular modem) status information. Applies to Digi
Cellular Family products only. To display statistics associated with the
SureLink feature, use the “pppstats” option.
nat
Displays Network Address Table (NAT) status information.
netdevice
Displays the active interfaces on the system, for example, PPP and
Ethernet interfaces, and their status, such as “Closed” or “Connected.”
passthrough
Displays status of the IP pass-through mode, enabled by the “set
passthrough” command. See "set passthrough" on page 153.
pppstats
Displays status and activity information for a Point-to-Point Protocol
(PPP) link, including SureLink statistics. See "Information returned by
“display pppstats”" on page 32 for descriptions.
provisioning
Displays the current provisioning information in the Digi device’s CDMA
cellular module.
Before using the “provision” command to provision the CDMA module, It
is recommended that you use this option to determine which parameters
are already set in the module. See "provision" on page 53.
Important Use of the “provision” and “display provisioning” commands
requires that any existing PPP sessions be closed.
route
Displays Route Table entries.
sadb
Displays the contents of the Security Association (SA) database. The SA
database lists the connections to VPN servers. Each entry identifies the
subnets traffic is being routed between, and the security protocols
chosen for the VPN tunnel. Applies to Digi Cellular Family products only.
Chapter 2 Command Descriptions 29
display
serial
Displays serial modem signals (DTR, RTS, CTS, DSR, DCD).
sockets
Displays information about how socket resources are being used by the
system.
spd
Displays Security Policy Database (SPD) entries defined for Virtual
Private Network (VPN) tunnels.
switches
Displays Multiple Electrical Interface (MEI) switch settings currently
currently defined for ports, on devices supporting MEI. (See
"set switches" on page 208.)
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" on page 41).
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" on
page 41).
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.
vpn
Displays all VPN-related status information, including Security
Association (SA) database entries and Security Policy Database (SPD)
entries. Applies to Digi Cellular Family products only.
wlan
Displays typical wireless LAN (WLAN) parameters for Digi Connect
wireless devices.
30 Chapter 2 Command Descriptions
Loading...