Digi WMPX5F User Manual
ConnectPort™ X5 Family
User’s Guide
ConnectPort X5 R
ConnectPort X5 Fleet
ConnectPort X5 K
90001100_C
©Digi International Inc. 2010. All Rights Reserved.
The Digi logo, Digi Connect, iDigi, ConnectPort, Digi SureLink, Digi Dialserv are trademarks or
registered trademarks of Digi International, Inc.
All other trademarks mentioned in this document 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.
2
Contents
Contents........................................................................................................................................................................................3
About this guide...........................................................................................................................................................................7
Purpose................................................................................................................................................................................7
Audience..............................................................................................................................................................................7
Scope...................................................................................................................................................................................7
Where to find more information..........................................................................................................................................7
Digi contact information .....................................................................................................................................................8
Chapter 1: Introduction............................................................................................................................................................9
Important Safety Information................................................ .................................. ............................................................9
ConnectPort X5 Family products................................................................ ......................................................................10
Wireless carrier certifications............................................................................................................................................11
Features .............................................................................................................................................................................12
User interfaces.........................................................................................................................................................12
Quick reference for configuring features ................................................................................................................13
Hardware features ...................................................................................................................................................19
Network interface features ......................................................................................................................................19
Configurable network services................................................................................................................................19
IP protocol support..................................................................................................................................................20
Mobile/Cellular features and protocol support........................................................................................................24
RealPort software....................................................................................................................................................25
Alarms.....................................................................................................................................................................25
Modem emulation ...................................................................................................................................................25
Security features......................................................................................................................................................26
Configuration management............................................................... ......................................................................27
Customization capabilities ........................................................... ................................. ..........................................27
Supported connections and data paths in Digi devices .....................................................................................................28
Interfaces for configuring, monitoring, and administering Digi devices..........................................................................31
Configuration capabilities ................................................... ....................................................................................31
Configuration interfaces.......................................................................................................
Monitoring capabilities and interfaces....................................................................................................................38
Device administration ........................................ .................................. ...................................................................39
...................................31
3
Chapter 2: Hardware installation..........................................................................................................................................40
Cable harness guidelines...................................................................................................................................................41
ConnectPort X5 main connector .............................................................................................................................41
Available interfaces on the ConnectPort X5 main connector.................................................................................44
Mounting the ConnectPort X5 to a vehicle.......................................................................................................................46
ConnectPort X5 R .......................... .................................. .................................. .....................................................46
ConnectPort X5 Fleet............................................................................................... ...............................................47
Antennas............................................................................................................................................................................48
ConnectPort X5 R .......................... .................................. .................................. .....................................................48
ConnectPort X5 Fleet............................................................................................... ...............................................51
ConnectPort X5 K development kit ............................. .................................. ... ................................................................52
Chapter 3: Configure Digi devices.........................................................................................................................................53
Default IP address and methods for assigning an IP address............................................................................................54
Configure an IP address using DHCP.....................................................................................................................54
Configure an IP address using Auto-IP...................................................................................................................54
Test the IP address configuration.......................... .................................. ................................................................54
Configuration through the iDigi Platform.........................................................................................................................55
Create an Account on iDigi.com........................... .................................. .................................. .. ............................55
Add the Digi device to the idigi.com Device List...................................................................................................56
iDigi Platform views for configuring and managing Digi devices .........................................................................58
Configuration through the web interface...........................................................................................................................63
Open the web interface.............................................................. ..............................................................................63
Organization of the web interface...........................................................................................................................65
Change the IP address from the web interface, as needed ......................................................................................67
Network configuration settings ...............................................................................................................................68
Mobile (cellular) settings ......................................................................................................................................112
XBee network settings ..........................................................................................................................................135
Serial port settings.................................................................................................................................................145
Alarms...................................................................................................................................................................154
System settings......................................................................................................................................................158
Remote management settings................................................................................................................................164
Security settings ....................................................................................................................................................169
Position (GPS support).........................................................................................................
.................................172
Applications ..........................................................................................................................................................174
Configuration through the command line .......................................................................................................................178
Access the command line...................................................................................... ................................................178
Verify device support of commands .....................................................................................................................178
Configuration through Simple Network Management Protocol (SNMP).......................................................................181
Batch capabilities for configuring multiple devices........................................................................................................181
4
Chapter 4: Monitor and manage Digi devices....................................................................................................................182
Monitoring capabilities from the iDigi Platform.............................................................................................................183
Monitoring capabilities in the web interface...................................................................................................................184
Display system information ..................................................................................................................................184
Manage connections and services.........................................................................................................................201
Monitoring capabilities from the command line .............................................................................................................204
Commands for displaying device information and statistics ................................................................................204
Commands for managing connections and sessions .............................................................................................206
Commands for managing XBee networks and nodes ...........................................................................................207
Monitoring Capabilities from SNMP..............................................................................................................................208
Chapter 5: Digi device administration ................................................................................................................................209
Administration from the web interface ...........................................................................................................................209
File management...................................................................................................................................................210
X.509 Certificate/Key Management .....................................................................................................................211
Backup/restore device configurations...................................................................................................................214
Update firmware and Boot/POST Code................................................................................................................214
Restore a device configuration to factory defaults................................................................................................215
Display system information ..................................................................................................................................216
Reboot the Digi device..........................................................................................................................................216
Enable/disable access to network services............................................................................................................216
Administration from the command-line interface...........................................................................................................217
Chapter 6: Programming .....................................................................................................................................................218
Programming tools and resources .................................................................. .................................................................219
The Digi API for receiving and sending vehicle bus date.....................................................................................219
Vehicle bus protocol specifications.......................................................................................................................219
Digi Developer Community Wiki.........................................................................................................................220
Digi Python Custom Development Environment page.........................................................................................220
Digi Python Programming Guide..........................................................................................................................220
Python Support Forum on digi.com......................................................................................................................220
ConnectPort X5 programming examples and information ...................................................................................220
iDigi Dia................................................................................................................................................................221
iDigi Platform........................................................................................................................................................221
The Digi API for automotive/heavy industry protocols..................................................................................................222
Vehicle bus protocol specifications.......................................................................................................................222
Power consumption and management ............................................................................................................................236
External power control device...............................................................................................................................236
Sleep mode and waking.........................................................................................................................................236
5
Chapter 7: Specifications and certifications.......................................................................................................................237
Hardware specifications..................................................................................................................................................238
ConnectPort X5 R and ConnectPort X5 K specifications.................................. ...................................................238
ConnectPort X5 Fleet specifications.....................................................................................................................239
Wireless networking features....................................... ... .................................. ... ...........................................................240
Regulatory information and certifications.......................................................................................................................242
RF exposure statement ..........................................................................................................................................242
FCC certifications and regulatory information (USA only)..................................................................................242
Industry Canada (IC) certifications.......................................................................................................................243
Safety statements...................................................................................................................................................244
.International EMC (Electromagnetic Emissions/Immunity/Safety) standards ....................................................245
Environmental requirements for ConnectPort X5 Family products......................................................................246
Chapter 8: Troubleshooting.................................................................................................................................................247
Troubleshooting Resources.............................................................................................................................................247
System status LEDs.........................................................................................................................................................248
ConnectPort X5 R LEDs........................................................... .................................. ..........................................248
Glossary....................................................................................................................................................................................251
6
Purpose
Audience
Scope
About this guide
This guide describes and shows how to install, provision, configure, monitor, and administer Digi
devices.
This guide is intended for those responsible for setting up Digi devices. It assumes some
familiarity with networking concepts and protocols.
This guide focuses on configuration, monitoring, and administration of Digi devices. It does not
cover hardware details beyond a certain level, application development, or customization of Digi
devices.
Where to find more information
In addition to this guide, find additional product and feature information in the these documents:
Online help and tutorials in the web interface for the Digi device
Quick Start Guides
RealPort
Cellular 101 Tut orial
Digi Connect Family Customization and Integration Guide
iDigi tutorials and user’s guides
Release Notes
Cabling Guides
Product information available on the Digi website, www.digi.com, and Digi's support
site at www.digi.com/support, including, Support Forums, Knowledge Base, Data
sheets/product briefs, application/solution guid es, and carrie r-specific documents
®
Installation Guide
Python developer Wiki
7
Digi contact information
For more information about Digi products, or for customer service and technical support, contact
Digi International.
To Contact Digi International
Use:
by:
Mail Digi International
11001 Bren Road East
Minnetonka, MN 55343
U.S.A.
World Wide Web: http://www.digi.com/support/
email http://www.digi.com/contactus/email.jsp/
Telephone (U.S.) (952) 912-3444 or (877) 912-3444
Telephone (other locations) +1 (952) 912-3444 or (877) 912-3444
8
Introduction
CHAPTER 1
This chapter introduces Digi devices and their product families, types of connections and data
paths in which Digi devices can be used, and the interface options available for configuring,
monitoring, and administering Digi devices.
Important Safety Information
To avoid contact with electrical current:
Introduction
Never install electrical wiring during an electrical storm.
Never install an Ethernet connection in wet locations unless that connector is
specifically designed for wet locations.
Use caution when installing or modifying lines.
Use a screwdriver and other tools with insulated handles .
Wear safety glasses or goggles.
Do not place Ethernet wiring or connections in any conduit, outlet or junction box
containing electrical wiring.
Installation of inside wire may bring you close to electrical wire, conduit, terminals and
other electrical facilities. Extreme caution must be used to avoid electrical shock from
such facilities. Avoid contact with all such facilities.
Ethernet wiring must be at least 6 feet from bare power wiring or lightning rods and
associated wires, and at least 6 inches from other wire (antenna wires, doorbell wires,
wires from transformers to neon signs), steam or hot water pipes, and heating ducts.
Do not place an Ethernet connection where it would allow a person to use an Ethernet
device while in a bathtub, shower, swimming pool, or similar hazardous location.
Protectors and grounding wire placed by the service provider must not be connected to,
removed, or modified by the customer.
Do not touch uninsulated Ethernet wiring if lightning is likely!
External Wiring: Any external communications wiring installed needs to be constructed
to all relevant electrical codes. In the United States this is the National Electrical Code
Article 800. Contact a licensed electrician for details.
9
ConnectPort X5 Family products
The ConnectPort X5 Family offers compact, ruggedized telematics gateways for cost-effective
fleet management and asset tracking solutions. These gateways provide remote connectivity to
mobile assets to monitor operating health, performance, location and driver/operator behavior, as
well as to enable automated event reporting. They aggregate wireless vehicle Personal Area
Network (VP AN) traf fic, such as ZigBee and 80 2.15.4 point-to-multi point, for IP connectiv ity over
a secure cellular, Wi-Fi, or satellite connection in harsh environments.
Gateways in the ConnectPort X5 family include the ConnectPo rt X5 R and ConnectPort X5 K, and
ConnectPort X5 Fleet. The ConnectPort X5 K was designed as a development kit to be used for
testing and evaluation prior to de plo yme nt of the ConnectPort X5 R or ConnectPort X5 Fleet. The
ConnectPort X5 K comes with a development cable, antennas, and, for GSM versions, has an
opening in the enclosure to allow users to insert their own SIM card. As such, the
ConnectPort X5 K should be used for testing and evaluation only. Customers will be responsible
for procuring antennas and cabling for their specific ConnectPort X5 R and ConnectPort X5 Fleet
installations.These gateways support vehicle personal area networks with Digi’s industry-leading
XBee radio technology. Vehicle personal area networks (VPANs) allow users to deploy low-power
sensor networks within and around the vehicle or mobile asset to monitor additional asset points,
for example, tires, reefer units, door latch, temperature sensors, cargo sensors, RFID readers, etc.
Introduction
The ConnectPort X5 family provides flexible wide-area networking connectivity supporting
cellular, Wi-Fi, and satellite communications. Cellular connectivity provides instant, always-on
communications, while Wi-Fi provides a cost-effective way to transfer large files, firmware, or
logs across low-cost private Wi-Fi networks. The ConnectPort X5 Wi-Fi feature can also be used
to network in-vehicle or near-vehicle Wi-Fi-enabled devices, such as vehicle displays and
handheld mobile devices.
Features and benefits of the ConnectPort X5 gateway family include:
Factory-sealed IP67 enclosure, ensuring protectio n from dust and total wat er immersion
to 1 meter
Programmable for application developmen t through the Pyt hon programming la nguage,
iDigi device integration applications (Dia) and the iDigi services platform
J1708 protocol support, offering serial connectivity to a large installed base of heavy
duty vehicle fleets
Controller Area Network (CAN) interface support for connection to J1939 or
proprietary vehicle bus
Advanced power management, including sensitivity to ignition status
Location tracking and geofencing with on-board GPS
Global cellular coverage over GSM/GPRS or CDMA networks
Optional satellite on the ConnectPort X5 Fleet
Automated event reporting: the gateway can continuously transmit vehicle status at
user-defined intervals
iDigi Management Services for management and monitoring
10
Wireless carrier certifications
Digi devices are being certified around the world with major carriers supporting these
technologies. For a current list of carrier certifi cations for your Digi product, go to dig i.com and go
the product pages for your product. Click the Specs tab of the product pages. Carrier certifications
are listed under Mobile Certifications or Carrier Certifications.
Introduction
11
Features
User interfaces
Introduction
This is an overview of key features in Digi devices. Software features are covered in more detail in
the next three chapters. Hardware specifications and are covered in Chapter 7, "Specifications and
certifications"
There are several user interfaces for configuring and monitoring Digi devi ces, in clu di ng the
following.
The iDigi Platform
A web-based interface for configuring, monitoring, and administering Digi devices.
Plugging the ConnectPort X5 device into a switch or network to which a laptop
computer is connected allows direct access to the web interface for configuration.
A command-line interface available via local serial port, telnet or SSH.
Simple Network Management Protocol (SNMP).
12
Quick reference for configuring features
This guide primarily focuses on configuring, monitoring, and administ erin g D igi device s from the
web interface. This table provides a quick reference for configuring features and performing
device tasks, and where to find the features and settings in the web interface and this guide. Click
the page number in the Page column to jump to instructions on configuring or using the feature.
Some features are configurable from the command line interface only. In those cases, the
commands that configure the feature are noted. The command descriptions are in the Digi Conn ect
Family Command Reference.
Feature/task Path to feature in the web interface See page
Administration/Configuration management:
Introduction
File management: uploading and
downloading files, such as applet
files, and custom splash screens.
Python program file
management.
Backup/restore a configuration
from a TFTP server on the
network
Update firmware
Reset configuration to factory
defaults
System information, including
device identifiers and statistics
Reboot the Digi device
Certificate and key management,
including X.509, VPN, SSL,
SSH
Administration > File Management
210
See also the Digi Connect Family Customization and Integration Guide for
information on uploading and downloading files used to customized a Digi
device’s look-and-feel.
Applications > Python 174
Administration > Backup/Restore 214
Administration > Update Firmware 214
Administration > Factory Default Settings 215
Administration > System Information 216
Administration > Reboot 216
Administration > X.509 Certificate and Key Management 211
Alarms Configuration > Alarms 154
Autoconnection: automatically
connect a user to a server or network
Configuration > Serial Ports > port > Profile Settings > TCP Sockets >
Automatically establish TCP connections
147
device
13
Feature/task Path to feature in the web interface See page
Connection management:
Introduction
Manage serial port connections
Manage Virtual Private Network
Management > Serial Ports 201
Management > Connections > Virtual Private Network (VPN) Settings 201
(VPN) connections
Manage active system
Management > Connections > Active System Connections 201
connections
Manage network services
Management > Network Services
202
(Currently only DHCP server settings managed from here)
Domain Name System (DNS):
DNS Client
Dynamic DNS (DDNS) update
Dynamic Host Configuration Protocol
(DHCP) server
Configuration > Network > Advanced Network Settings 107
Configuration > Network > Dynamic DNS Update Settings 82
To configure a DHCP server:
75
Configuration > Network > DHCP Server Settings
To start and stop and show status of a DHCP server:
Management > Network Services > DHCP Server Management
Ethernet settings Configuration > Network > Advanced Network Settings 107
Event logging for the Digi device Management > Event Logging 201
Help on configuring features Help button on each page.
Host name for a device Configuration > Network > Advanced Network Settings > Host Name 107
IP address settings Configuration > Network > IP Settings
54, 70, 75, 107
Configuration > Network > Advanced Settings
IP filtering / access control Configuration > Network > IP Filtering Settings 85
IP forwarding: Network Address
Configuration > Network > IP Forwarding Settings 86
Translation (NAT) and port
forwarding configuration/static routes
IP pass-through Configuration > Network > IP Pa ss-through 94
14
Feature/task Path to feature in the web interface See page
Mobile (cellular) settings:
Introduction
Provisioning the cellular
modules
Configuration > Mobile
For Digi Cellular product that have a cellular module, provisioning must be
performed once.
To launch a wizard for provisioning the module, go to
Configuration > Mobile. Under Mobile Service Provider Settings, click
the Provision Device button.
Provisioning can also be performed from the command line:
To provision the CDMA module: provision
To display existing provisioning parameters: displayprovisioning
Mobile service provider and
connection settings
SureLink™ settings
Short Message Service (SMS)
Configuration > Mobile
Settings displayed vary by mobile service provider.
Configuration > Mobile > SureLink Settings.120
Configuration > Mobile > Short Message Service (S MS) Settings 125
settings
Modem emulation Configuration > Serial Ports > Port Profile Settings >
Modem Emulation
See the Connect Family Command Reference for modem emulation
commands.
114
113, 120
149
Port profiles: sets of preconfigured
Configuration > Serial Ports > Port Profile Settings 145
serial-port settings for a particular
connection and use scenario
Python support: loading and running
custom programs authored in the
Python programming language.
RealPort (COM port redirection)
configuration
Applications > Python
For more information on writing and running Python programs, see the
Digi Python Programming Guide.
Configuration > Serial Ports > port > Port Pr ofile Settings > RealPort
See also the RealPort Installation Guide.
174
146
Remote device management Configuration > Remote Management 164
Reverting configuration settings Administration > Factory Default Settings 215
15
Feature/task Path to feature in the web interface See page
Security/access control features:
Introduction
Control access to inbound ports
Secure Shell Server (SSH)
Establish/change user name for a
user
Issue a new/cha nged password to
a user
Serial port configuration:
Basic serial port settings
Advanced serial port settings
Port profiles: associate a serial
port with a set of preconfigured
port settings for a specific use
RCI over serial mode
Configuration > Serial Ports > port > Port Profile Settings >
145
TCP Sockets or UDP Sockets or Custom port profile
Network > Network Services > Enable Secure Shell Server (SSH) 80
Configuration > Security 169
Configuration > Security 169
Configuration > Serial Ports > Basic Serial Settings 150
Configuration > Serial Ports > Advanced Serial Settings 151
Configuration > Serial Ports > Port Profile Settings 145
Configuration > Serial Ports > Advanced Serial Settings 151
RTS Toggle
TCP serial connections
UDP serial characteristics
Configuration > Serial Ports > Advanced Serial Settings 151
Configuration > Serial Ports > port > Port Profile Settings >
147
TCP Sockets port profile
Configuration > Serial Ports > port > Port Profile Settings > UDP
148
Sockets port profile
16
Feature/task Path to feature in the web interface See page
Simple Network Management Protocol (SNMP):
Introduction
Configure SNMP through the
web interface
Enable/disable SNMP service
Enable/disable SNMP alarm
traps
Use SNMP as primary
configuration interface
Configuration > System > Simple Network Management Protocol
(SNMP) Settings
Configuration > Network > Network Services 79
Configuration > Alarms > alarm > Send SNMP trap to following
destination when alarm occurs
Basic network and serial settings configurable through standard and Digispecific Management Information Blocks (MIBs).
161
156, 157
37181
More advanced settings must be set through the web or command-line user
interfaces, and sending alarms as SNMP traps must be configured through
the web interface, on the pages listed above.
System information: assign system-
Configuration > System > Device Identity Settings 158
identifying information to a device
Socket Tunnel Settings Configuration > Network > Socket Tunnel Settings 93
Statistics for Digi devices Administration > System Information 184
Status of Digi devices Management > Serial Ports, Connections, Network Services 201
VPN (Virtual Private Network) To configure VPN:
94
Configuration > Network > Virtual Private Network (VPN) Settings
To manage VPN:
Management > Connections > Virtual Private Network (V PN)
Connections
Wi-Fi (wireless LAN) devices:
Wireless LAN Settings Configuration > Network > WiFi LAN Settings 71
Wireless Security Settings Configuration > Network > WiFi Security Settings 72
Wireless 802.1x Authentication
Configuration > Network > WiFi 802.1x Settings 74
Settings
17
Feature/task Path to feature in the web interface See page
XBee wireless network configuration and management:
Introduction
XBee network configuration
through web UI
XBee network configuration
through the iDigi Platform
XBee network monitoring/
management through web UI
XBee network monitoring/
management through command
line
Configuration >
XBee Network 135
In the iDigi Platform, the XBee Networks view 58
Administration > System Information > XBee Network
196
See also the iDigi Platform’s XBee Networks view and detailed view of
network nodes.
set xbee
184
display xbee
info zigbee_sockets
xbee
18
Hardware features
A summary of hardware features, including power-supply information, is in "Hardware
specifications" on page 238.
Network interface features
A detailed list of network interface features is in Chapter 7, "Specifications and certifications". Se e
also the data sheet for your Digi product.
Configurable network services
Access to network services can be enabled and disabled. This means that a device’s use of network
services can be restricted to those strictly needed by the device. To improve device security, nonsecure services, such as Telnet, can be disabled.
Network services that can be enabled or disabled include:
Advanced Digi Discovery Protocol (ADDP): can enable or disable ADDP, but cannot
change its network port number.
Introduction
RealPort
Encrypted RealPort
HTTP/HTTPS
Remote Login (rlogin)
Remote Shell (rsh)
Simple Network Management Protocol (SNMP)
Telnet
In the web interface, access to network services is enabled and disabled on the Network Services
page of Network Configuration. For more information, see "Network services settings" on page 79.
In the command-line interface, network services are enabled and disabled through the set service
command. See the Digi Connect Family Command Reference for the set service command
description.
19
IP protocol support
All Digi devices include a Robust on-board TCP/IP stack with a built-in web server. Supported
protocols include, unless otherwise noted:
Transmission Control Protocol (TCP)
User Datagram Protocol (UDP)
Dynamic Host Configuration Protocol (DHCP)
Simple Network Management Protocol (SNMP)
Secure Sockets Layer (SSL)/Transport Layer Security (TLS)
T e lnet Com Port Control Option (Telnet) including support of RFC 2217 (ability to
Remote Login (rlogin)
Line Printer Daemon (LPD)
HyperText Transfer Protocol (HTTP)/HyperText Transfer Protocol over Secure Socket
Introduction
control serial port through Telnet). See "Serial data communication over TCP and UDP"
on page 21 for additional information.
Layer (HTTPS)
Simple Mail Transfer Protocol (SMTP)
Internet Control Message Protocol (ICMP)
Internet Group Management Protocol (IGMP)
Address Resolution Protocol (ARP)
Advanced Digi Discovery Protocol (ADDP)
Point to Point Protocol (PPP)
Network Address Translation (NAT)/Port Forwarding
Secure Shell (SSHv2)
Generic Routing Encapsulation (GRE) Passthrough
IPSec Encapsulating Security Payload (ESP) on most models
ESP Passthrough
Following is an overview of some of the services provided by these protocols.
20
Introduction
Serial data communication over TCP and UDP
Digi devices support serial data communication over TCP and UDP. Key features include:
Serial data communication over TCP, also known as autoconnect and tcpserial can
automatically perform the following functions:
– Establish bidirectional TCP connections, known as autoconnections, between the serial
device and a server or other network device. Autoconnections can be made based on
data and or serial hardware signals.
– Control forwarding characteristics based on size, time, and pattern
– Allow incoming raw, Telnet, and SSL/TLS (secure-socket) connections
– Support RFC 2217, an extension of the Telnet protocol
Serial data communication over UDP, also known as udpserial, can automatically
perform the following functions:
– Digi Connect products can automatically send serial data to one or more devices or
systems on the network using UDP sockets. Options for sending data include whether
specific data is on the serial line, a specific time period ha s elapsed, or after the specified
number of bytes has been received on the serial port.
– Control forwarding characteristics based on size, time, and patterns.
– Support incoming datagrams from multiple destinations.
– Support outgoing datagrams sent to multiple destinations.
TCP/UDP forwarding characteristics.
Extended communication control on TCP/UDP data paths.
–Timeout
–Hangup
– User-configurable Socket ID string (text string identifier on autoconnect only)
Dynamic Host Configuration Protocol (DHCP)
Dynamic Host Configuration Protocol (DHCP) can be used to automatically assign IP addresses,
deliver TCP/IP stack configuration parameters such as the subnet mask and default router, and
provide other configuration information. For furt her details, see "Configure an IP address using
DHCP" on page 54.
Auto-IP
Auto-IP is a protocol that will automatical ly assign an IP address from a reserved pool of standard
Auto-IP addresses to the computer on which it is installed. For Di gi dev ice s ar e set to ob tai n it s IP
address automatically from a DHCP server and the DHCP server is unavailable or nonexistent,
Auto-IP will assign the device an I P address. For further details, see "Configure an IP address
using Auto-IP" on page 54.
21
Introduction
Simple Network Management Protocol (SNMP)
Simple Network Management Protocol (SNMP) is a protocol for managing and monitoring
network devices. SNMP architecture enables a network administrator to manage nodes--servers,
workstations, routers, switches, hubs, etc.--on an IP network; manage network performance, find
and solve network problems, and plan for network growth. Digi devices support SNMP Versions 1
and 2. For more information on SNMP as a device-management interface, see "Simple Network
Management Protocol (SNMP)" on page 37. For a list SNMP-related of supported Request for
Comments (RFCs) and Management Information Bases (MIBs), see page 161.
Secure Sockets Layer (SSL)/Transport Layer Security (TLS)
Secure Sockets Layer (SSL)/Transport Layer Security (TLS) are used to provide authentication
and encryption for Digi devices. For more information, see "Security features" on page 26.
Telnet
Digi devices support the following types of Telnet connections:
Telnet Client
Telnet Server
Reverse Telnet, often used for console management or device management
Telnet Autoconnect
RFC 2217, Telnet Com Port Control Option, an extension of the Telnet protocol
For more information on these connections, see "Supported connections and data paths in Digi
devices" on page 28. Access to Telnet network services can be enabled or disabled.
Remote Login (rlogin)
Users can perform logins to remote systems (rlogin). Access to rlogin service can be enabled or
disabled.
HyperText Transfer Protocol (HTTP) HyperText Transfer Protocol over Secure Socket Layer (HTTPS)
Digi devices provide web pages for configuration that can be secured by requ iring a user login.
Internet Control Message Protocol (ICMP)
ICMP statistics can be displayed, including the number of messages received, bad messages
received, and destination unreachable messages received.
22
Introduction
Point-to-Point Protocol (PPP)
The Point-to-Point Protocol (PPP) transports multi-prot ocol packet s over point-to -point links. PPP
encapsulates the data packet, allows the server to inform the dial-up client of its IP address (or
client to request the IP address), authenticates the exchange, negotiates multiple protocols, and
reassembles the data packet for network communication. ConnectPort X5 Family devices support
PPP as the connection protocol from the Digi device to the cellu lar IP network with NAT (Network
Address Technology).
Network Address Translation (NAT)/Port Forwarding
Network Address Translation (NAT) reduces the need for a large amount of publicly known IP
addresses by creating a separation between publicly known and privately known IP addresses.
Advanced Digi Discovery Protocol (ADDP)
The Advanced Digi Discovery Protocol (ADD P) runs o n an y o pe r ati ng sy ste m c ap abl e o f se nd ing
multicast IP packets on a network. ADDP allows the system to identify all ADDP-enabled Digi
devices attached to a network by sending out a multicast packet. The Digi devices respond to the
multicast packet and identify themselves to the client sending the multicast.
ADDP communicates with the TCP/IP stack using UDP. The TCP/IP stack should be able to
receive multicast packets and transmit datagrams on a network.
Not all Digi devices support ADDP. Access to ADDP service can be enabled or disabled, but the
network port number for ADDP cannot be changed from its default.
Generic Routing Encapsulation (GRE) Passthrough Encapsulating Security Payload (ESP) ESP Passthrough
Generic Routing Encapsulation (GRE) and Encapsulating Security Payload (ESP) are routing
protocols that are used to route (tunnel) various types of information between networks.
GRE applies to the encapsulation of IP datagrams tunnelled through the internet. The
encapsulation includes security , typically in the form o f IPSec (IP security), and i s most commonly
found in VPN (Virtual Private Network) implementation. RFC (Request For Comment) 1701 and
1702 define these standards.Similarly, ESP is used in conjunction with IPsec as a possible way of
carrying IP packets for a Virtual Private Network (VPN) setup. ESP is defined in RFC 2406.
In ESP Passthrough and GRE Passthrough, inbound IPsec ESP or GSP protocol traffic is
forwarded from to a VPN device connected to the Digi device’s Ethernet port.
Note: If an Auto-key Internet Key Exchange (IKE)-based VPN is used, UDP port 500 must also be
forwarded.
23
Mobile/Cellular features and protocol support
Key cellular features in cellular-enabled Digi devices include:
GSM: GPRS, EDGE, UMTS, HSPA, SMS
CDMA: 1xRTT, Ev-DO (Revs 0 and A)
IPSec ESP / IKE
IP Pass-through, also known as bridge mode
3-5 Volt SIM card
Signal-strength LEDs
Provisioning wizard
For Digi devices equipped with a Code-Division Multiple Access (CDMA)-based cellular modem,
the Mobile Device Provisioning Wizard is available in the web interface to properly co nfigure the
Digi device with the required configuration used to access the mobile network. The wizard allows
for both automatic and manual provisioning for a variety of mobile service providers.
Digi SureLink™
Introduction
Digi Connect Family, Digi Cellular Family, and ConnectPort X Family products support the Digi
SureLink™ feature. Digi SureLink provides an “always-on” mobile network connection to ensure
that a Digi device is in a state where it can connect to the network. It does this through hardware
reset thresholds and periodic tests of the connection.
Mobile/Cellular protocols
Mobile/cellular protocols supported in clu de, unless otherwise noted:
Global System for Mobile communication (GSM)
General Packet Radio Service (G PRS)
Enhanced Data Rates for GSM Evolution (EDGE)
Universal Mobile Telecommunications Service (UMTS)
High Speed Packet Access (HSPA)
Code-Division Multiple Access (CDMA)
Evolution-Data Optimized (EV-DO, EVDO, or 1xEV-DO)
Short Message Service (SMS), currently for GSM cellular products only. Digi cellular
gateways implement an SMS-based protocol that allows managing devices by sending
SMS commands from anywhere SMS messages can be sent. See "Short Message
Service (SMS) settings" on page 125.
24
RealPort software
Introduction
Digi devices use the patented RealPort COM/TTY port redirection for Microsoft Windows.
RealPort software provides a virtual connection to serial devices, no matter where they reside on
the network. The software is installed directly on the host PC and allows applications to talk to
devices across a network as though the devices were directly attached to the host. Actually, the
devices are connected to a Digi device somewhere on the network. RealPort is uniq ue among
COM port re-directors because it is the only implementation that allows multiple connections to
multiple ports over a single TCP/IP connection. Other implementations require a separate TCP/IP
connection for each serial port. Unique features also include full hardware and software flow
control, as well as tunable latency and throughput. Access to RealPort services can be enabled or
disabled.
Encrypted RealPort
Digi devices also support RealPort software with encryption. Encrypted RealPort offers a secure
Ethernet connection between the COM or TTY port and a device server or terminal server.
Encryption prevents internal and external snooping of data across the network by encapsulating the
TCP/IP packets in a Secure Sockets Layer (SSL) connection and encrypting the data using
Advanced Encryption Standard (AES), one of the latest, most effi cient security algo rithms. Access
to Encrypted RealPort services can be enabled or disabled. Digi’s RealPort with encryption driver
has earned Microsoft’s Windows Hardware Quality Lab (WHQL) certification. Drivers are
available for a wide range of operating systems, including Microsoft Windows Server 2003,
Windows XP, Windows 2000, Windows NT, Windows 98, Windows ME; SCO Open Server;
Linux; AIX; Sun Solaris SPARC; Intel; and HP-UX. It is ideal for financial, retail/point-of-sale,
government or any application requiring enhanced security to protect sensitive information.
Alarms
Modem emulation
Digi devices can be configured to issue alarms, in the form of email message or SNMP traps, when
certain device events occur. These events include changes in GPIO signals, certain data patterns
being detected in the data stream, and cellular alarms for signal strength and amount of cellular
traffic for a given period of time. Receiving alarms about these conditions provides the advantage
of notifications being issued when events occur, rather than having to monitor the device on an
ongoing basis to determine whether these events have occurred . Alarms can also be forwarded to
the iDigi platform for display and management in that platform. For more information on
configuring alarms, see "Alarms" on page 154.
Digi devices include a configuration profile that allows the device to emulate a modem. Modem
emulation sends and receives modem responses to a serial device over TCP/IP (including Ethernet
and Cellular) instead of Public Switched Telephone Network (PSTN). The modem emulation
profile allows maintaining a current software application but using it over the less expensive
Ethernet network. In addition, Telnet processing can be enabled or disabled on the incoming and
outgoing modem-emulation connections.The modem-emulation commands supported in Digi
devices are documented in the Digi Connect Family Command Refe rence.
25
Security features
Introduction
Security-related features in Digi devices include:
Secure access and authentication
One password, one permission level.
Passwords can be issued to device users.
Selective enabling/disabling network services such as ADDP, Rea lPort, Encrypted
RealPort, HTTP/HTTPS, LPD, Remote Login, Remote Shell, SNMP, and Telnet.
Can control access to inbound ports.
Secure sites for configuration: HTML pages for configuration have appropriate security.
Can control access to specific devices, IP addresses, or networks through IP filtering.
Encryption
Encrypted RealPort offers encryption for the Ethernet connection between the COM/
TTY port and the Digi device. Encryption prevents internal and external snooping of
data across the network by encapsul ati ng the TCP/IP pa cket s in a Secure Sockets Layer
(SSL) connection and encrypting the data using the Advanced Encryption Standard
(AES) security algorithm.
Strong Secure Sockets Layer (SSL) V3.0/ Transport Layer Security (TLS) V1.0-based
encryption: DES (64-bit), 3DES (192-bit), AES (128-/192-/256-bit), IPsec ESP: DES,
3DES, AES.
Wireless Digi Connect products provide Wi-Fi Protected Access (WPA/WPA2/802.1 1i)
and Wired Equivalent Privacy (WEP) encryption (64-/128-bit). Supported WPA/WPA2/
802.11i authentication methods are:
Supported WPA Authentication Methods
EAP-TLS PEAP EAP/TTLS
LEAP (WEP only) EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1) EAP-TTLS/EAP-MD5-Challenge
EAP-PEAP/TLS (both PEAPv0 and PEAPv1) EAP-TTLS/EAP-GTC
EAP-PEAP/GTC (both PEAPv0 and PEAPv1) EAP-TTLS/EAP-OTP
EAP-PEAP/OTP (both PEAPv0 and PEAPv1) EAP-TTLS/EAP-MSCHAPv2
EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1) EAP-TTLS/EAP-TLS
EAP-TTLS/MSCHAPv2
EAP-TTLS/MSCHAP
EAP-TTLS/PAP
EAP-TTLS/CHAP
SNMP security
SNMP “set” commands can be disabled to make use of SNMP read-only. Changing public and
private community names is recommended to prevent unauthorized access to the device.
26
Configuration management
Once a Digi device is configured and running, configur ation-management tasks need to be
periodically performed, such as:
Upgrading firmware
Copying configurations to and from a remote host
Software and factory resets
Rebooting the device
Memory management
File management
For more information on these configuration-management tasks, see Chapter 5, "Digi device
administration".
Customization capabilities
Several aspects of using Digi devices can be customized. For example:
Introduction
The look-and-feel of the device inte rface can be customized , to use a dif ferent company
logo or screen colors.
Custom applications written in Python can be executed.
Custom factory defaults to which devices can be reverted can be defined.
The Digi Connect Family Customization and Integration Guide (Part Number 90000734; available
with the Digi Connect Integration Kit) describes c ustomization and integration tools and processes.
Contact Digi International for more information on the Digi Connect Integration Kit cust omization
tools and resources and for assistance with customization efforts.
27
Supported connections and data paths in Digi devices
Digi devices allow for several kinds of connections and pat hs for data flow between the Digi
device and other entities. These connections can be grouped into two main categories:
Network services, in which a remote entity initiates a connection to a Digi device.
Network/serial clients, in which a Digi device initiates a network connection or op ens a
serial port for communication.
This discussion of connections and data paths may be helpful in understanding the effects of
enabling certain features and choosing certain settings when configuring Digi products.
Network services
A network service connection is one in which a remote entity initiates a connection to a Digi
device. There are several categories of network services:
Network services associated with specific serial ports
Network services associated with serial ports in general
Network services associated with the command-line interface (CLI)
Introduction
Network services associated with specific serial ports
Reverse Telnet: A telnet connection is made to a Digi device, in which data is passed
transparently between the telnet connection and a named serial port.
Reverse raw socket: A raw TCP socket connection is made to a Digi device, in which
data is passed transparently between the socket and a named serial port.
Reverse TLS socket: An encrypted raw TCP socket is made to a Digi device, in which
data is passed transparently to and from a named serial port.
Modem emulation, also known as Pseudo-modem (pmodem): A TCP connection is
made to a named serial port, and the connection will be “interpreted” as an incoming
call to the pseudo-modem.
28
Introduction
Network services associated with serial ports in general
RealPort: A single TCP connection manages (potentially) multiple serial ports.
Modem emulation, also known as pseudo-modem (pool): A TCP connection to the
“pool” port is interpreted as an incoming call to an available pseudo-modem in the
“pool” of available port numbers.
rsh: Digi devices support a limited implementation of the Remote shell (rsh) protocol, in
that a single service listens to connections and allows a command to be executed. Only
one class of commands is allowed: a single integer that specifies which serial port to
connect to. Otherwise, the resulting connection is somewhat similar to a reverse telnet
or reverse socket connection.
DialServ: Connecting a DialServ device to the serial port. DialServ simulates a public
switched telephone network (PSTN) to a modem and forwards the data to th e serial port.
The Digi device sends and receives the data over an IP network.
Network services associated with the command-line interface
Telnet: A user can Telnet directly to a Digi device’s command-line interface.
rlogin: A user can perform a remote login (rlogin) to a Digi device’s command-line
interface.
Network/serial clients
A network/serial client connection is one in which a Digi device initiates a network connection or
opens a serial port for communication. There are several categories of network/serial client
connections:
Autoconnect behavior client connections
Command-line interface (CLI)-based clients
Modem emulation (pseudo-modem) client connections
Autoconnect behavior client connections
In client connections that involve autoconnect behaviors, a Digi device initiates a network
connection based on timing, serial activity, or serial modem signals. Autoconnect-related client
connections include:
Raw TCP connection: The Digi device initiates a raw TCP socket connection to a
remote entity.
T eln et connec tion: The Digi dev ice initi ates a TCP co nnectio n using th e Telnet protocol
to a remote entity.
Raw TLS encrypted connection: Th e Di gi devi ce init iates an encrypted raw TCP socket
connection to a remote entity.
Rlogin connection: The Digi device initiates a TCP connection using the rlogin protocol
to a remote entity.
29
Introduction
Command-line interface (CLI)-based client connections
Command-line interface based client connections are available for use once a user has established
a session with the Digi device’s CLI. CLI-based client connections include:
telnet: A connection is made to a remote entity using the Telnet protocol.
rlogin: A connection is made to a remote entity using the Rlogin protocol .
connect: Begin communicating with a local serial port.
Modem emulation (pseudo-modem) client connections
When a port is in the modem-emulation or pseudo-modem mode, it can initiate network
connections based on AT command strings received on the serial port.The AT commands for
modem emulation are documented in the Digi Connect Family Command Reference.
30
Loading...