Command Reference Digi One® and PortServer® TS Family Digi One Family Products: Digi One SP, Digi One SP IA, Digi One IA, Digi One IAP PortServer TS Family Products: PortServer TS Family (RS-232 only) Products: PortServer TS 1/2/4 Family: PortServer TS 1, PortServer TS 2, PortServer TS 4, PortServer TS 8/16 Family Products: PortServer TS 8, PortServer TS 8 DC, PortServer TS 16, Port Server TS 16 Rack, PortServer TS 16 Rack DC, PortServer TS 16 Enterprise PortServer TS MEI Products: PortServer TS 1 MEI, Por
© 2006 Digi International Inc. All Rights Reserved. Digi, Digi International, the Digi logo, the Digi Connectware logo, the Making Device Networking Easy log, Digi One, PortServer, and RealPort are trademarks or registered trademarks of Digi International, Inc. in the United States and other countries worldwide. All other trademarks are the property of their respective owners.
Contents Chapter 1 Command Line Configuration Tasks Devices in the Digi One and PortServer TS Family...............................7 Quick Reference for Configuring Features ............................................9 Access the Command Line.................................................................. 14 Users and User Permissions ............................................................... 15 Configure RealPort ..............................................................................
quit....................................................................................................... 75 reconnect............................................................................................. 76 remove.................................................................................................77 revert ................................................................................................... 79 rlogin.........................................................................
set service ......................................................................................... 196 set sharing ......................................................................................... 198 set snmp ............................................................................................ 201 set snmpauth ..................................................................................... 204 set sntp ..................................................................................
Contents
Devices in the Digi One and PortServer TS Family C o m m a n d L i n e C o n f i g u r a t i o n Ta s k s Chapter 1 This chapter shows how to perform common device configuration tasks from the command line. Devices in the Digi One and PortServer TS Family This manual uses “the Digi One and PortServer TS Family” to refer to all devices in the family, and family names to refer to a group of devices.
Devices in the Digi One and PortServer TS Family PortServer TS MEI devices The term “PortServer TS MEI devices” refers to the following device families: PortServer TS MEI Family: • • PortServer TS 1 MEI, formerly known as Digi One TS PortServer TS 2 MEI • PortServer TS 4 MEI PortServer TS H MEI Hardened Family: • • • PortServer TS 1 H MEI PortServer TS 2 H MEI PortServer TS 4 H MEI • PortServer TS 1 Hcc MEI • PortServer TS 2 Hcc MEI • PortServer TS 4 Hcc MEI PortServer TS M MEI Modem Family:
Quick Reference for Configuring Features Quick Reference for Configuring Features The following table shows common features that can be configured, the Digi devices in which the features are supported, the commands used to configure each feature, and where to find more information in this chapter.
Quick Reference for Configuring Features Feature/Task Digi Devices supported in Commands, discussion, examples Industrial Automation (IA): • Protocol conversion between Modbus, AllenBradley, and ASCII device Digi One IAP • Allen-Bradley Ethernet-toSerial Bridging Digi One IAP • Omron Hostlink Multi-Master Digi One IAP • Modbus Ethernet-to-Serial Bridging Digi One IA Digi One IAP PortServer TS Family • Custom (user-defined) Multi-Master Protocol Digi One IAP PortServer TS Family IP routing All
Quick Reference for Configuring Features Feature/Task Digi Devices supported in Commands, discussion, examples All; console menu feature available on PortServer TS Family devices only.
Quick Reference for Configuring Features Feature/Task Digi Devices supported in Commands, discussion, examples Security, users, and access control features: • Control user access to configuration settings All • "Control Access to the Configuration" on page 35 • "set user" on page 230 • Control user access to inbound and outbound ports All • "Control Access to Inbound Ports" on page 36 • "Control Access to Outbound Ports" on page 37 • "set ports" on page 169 - "dev" option • "set logins" on page 152
Quick Reference for Configuring Features Feature/Task Digi Devices supported in Commands, discussion, examples Security, users, and access control features (continued): • Configure SSH Version 2 for secure communication Digi One IAP PortServer TS Family • "Configure SSH Version 2 Encryption for Secure Communication" on page 41 • To configure password protection: "set user" on page 230 - "name" and "password" options, and "newpass" on page 69 • To use a public key: "set user" on page 230 - "name" and "l
Access the Command Line Access the Command Line To configure devices using commands, you must first access the command line, either from a locally connected terminal or a Telnet session, and then log on as root from the command line. From a Locally-Connected Terminal To access the command line and the configuration from a terminal connected to one of the device server’s serial ports, follow these steps. 1. Connect a terminal or PC to a serial port on the device server.
Users and User Permissions Users and User Permissions Digi One and PortServer TS products have two types of users, with different user permissions that influence the commands that the users can issue. The “root” User A “root” user exists in all products. This root user has permissions to execute all commands, except “admin,” which is used to give a normal user temporary administrative privileges. The root user can configure settings as well as display current settings.
Configure RealPort Configure RealPort RealPort is a feature that allows network-based host systems to use the ports of the device server as though they were the host system’s own ports, appearing and behaving as local ports to the network-based host. The “set rpauth” sets authentication options for RealPort. RealPort has a challenge-authentication protocol that, if enabled, allows only hosts that authenticate to use ports on the Digi device.
Configure Serial Port Settings Configure Serial Port Settings Configuring serial port settings involves setting the following options for a port: • Point-to-Point (PPP) connections • Industrial automation (IA) • Modem emulation • TCP socket communication • UDP Multicast communication • Autoconnection • Port sharing Configure PPP Connections Configuring Point-to-Point Protocol (PPP) connections includes: • Configuring inbound PPP connections • Configuring outbound PPP connections • Using filters on the PPP
Configure Serial Port Settings 3. To configure the baud rate for this connection, enter: #> set line range=range baud=bps where range is the port or ports to configure and bps is the line speed in bits-per-second. Typically, you can set this to 115000 bps for modem connections. For example: #> set line range=3 baud=115000 4. To create an inbound PPP user, enter: #> set user name=name protocol=ppp netservice=on defaultaccess=netservice where name is a name to assign to the PPP user.
Configure Serial Port Settings See also For more information, see these command descriptions: • "set ports" on page 169 • "set flow" on page 116 • "set line" on page 149 • "set user" on page 230 Configure Outbound PPP Connections with Filters To configure outbound-only PPP connections with filters, or the outbound portion of bidirectional connections with filters, follow the steps below.
Configure Serial Port Settings 6. To set up routing for the PPP connection, enter: #> set forwarding state=active splithorizon=off poisonreverse=off #> set route net=ip address mask=subnetmask metric=1 wanname=”username” The value of the “wanname” option must match the value of the “username” option in step 2. 7.
Configure Serial Port Settings Filters for PPP Connections Filters are used to manage and control Point-to-Point Protocol (PPP) connections. You can design a filter to do any of the following: • Bring up a connection. • Allow certain types of packets to use the connection and keep certain types of packets from using it. • • Keep up a connection. Send a message to the log file when a specified event occurs on the connection.
Configure Serial Port Settings Configure Industrial Automation (IA) To configure how devices in an industrial automation (IA) environment communicate, use the “set ia” command. See "set ia" on page 125 for command syntax, option descriptions, and examples. The syntax for “set ia” varies according to the IA device being configured: serial port-connected devices, network-based masters, network-based slaves, and destination tables for forwarding messages.
Configure Serial Port Settings Configure Autoconnection The autoconnection feature allows you to configure a user to access the device server and then be automatically connected to a host on the LAN. You can implement autoconnection in the following ways: • By port, where all port users are automatically connected to the same host. The device server is completely transparent to them. • By user, where a user is required to log on and may be required to supply a password.
Configure Serial Port Settings Configure Port Sharing A Digi device enabled for port sharing allows more than one client to open a port through RealPort, reverse Telnet, reverse SSH, or connect. All clients that share a port will read the same data from the serial port; the data is duplicated and sent to each client. All clients that share a port will have the data they write merged and sent out the serial port.
Configure Serial Port Settings When changes to port-sharing settings take effect Some changes will not take effect until all clients have closed a port. If this is the case, the “set sharing” command will print a warning message saying: “Warning: Some port sharing parameter changes will not take effect until all clients have closed the port.
Configure Serial Port Settings • • • • • When multiple clients share control of the serial port options, and a new client opens a port, that new client might momentarily set the options to default values before the application can set the options correctly. This might momentarily disrupt communication with the other clients. Depending on the operating system used by the client, it is possible to set the default serial port options to match the options required by the application.
Configure Port Logging Configure Port Logging The port logging feature passively logs data going into or out of a serial port. This means that you can be using a standard reverse or RealPort session on a port, and all the data from that session can be sent to a configurable server. To configure port logging, use “set logport” command. See "set logport" on page 155. To revert the port-logging settings to defaults or to the latest configuration stored in NVRAM, use the “revert logport” command.
Configure Network Settings Configure Network Settings Configuring network settings involves setting network parameters, configuring IP routing, setting up a Domain Name Server (DNS). and setting up Simple Network Management Protocol (SNMP). Configure Network Parameters The "set config" command configures network parameter, and includes several options for optimizing your network for better Ethernet/IP performance. See "set config" on page 97. The "set ethernet" command sets Ethernet options.
Configure Network Settings Example: Route Using the Ethernet Interface In this example, a route to a subnet is created over the Ethernet interface. Key features include the following: • The address on the “net” option is a subnetwork address, not the IP address of a specific device. • The “wanname=ether” option, indicating that this route is over the Ethernet interface. • The “metric” option indicates that packets to this subnet will pass through two routers.
Configure Network Settings Configure Dynamic Routes Using RIP To configure the device server for dynamic routing using the Routing Information Protocol (RIP), use the “set forwarding” command. See "set forwarding" on page 120. You should be signed on as “root” and have configured or will configure modems, modem scripts, devices, and filters for routes that use serial lines. 1. Configure the links over which routed packets and RIP updates will be sent.
Configure Network Settings Configure Proxy ARP To configure the device server for Proxy ARP, use the “set forwarding” command. See "set forwarding" on page 120. This procedure assumes that you have signed on as “root” and have configured or will configure modems, modem scripts, devices, and filters for routes that use serial lines. 1. Configure the links over which packets will be routed using a “set user” command.
Configure Network Settings Configure Domain Name System (DNS) The domain name system (DNS) maps domain names to information associated with these names, such as IP addresses. Configuring the DNS involves the following tasks: • Configure a DNS server • Configure the host table DNS components include: • A distributed database consisting of domain names and associated information.
Configure Network Settings Configure the Host Table To configure the host table, which maps IP addresses to host names, enter: #> set host name=name ip=ip address where: • name is the name the host • ip address is the IP address of the host For example, the following commands configure three IP address-to-name mappings: #> set host name=poe ip=204.221.110.200 #> set host name=gary ip=204.221.110.202 #> set host name=toni ip=204.221.110.203 For more information, see "set host" on page 124.
Configure Network Settings The SNMP management agent supports the following MIBs: • Read-write for MIB II (RFC 1213), which is an Internet-standard MIB, consisting of managed objects from the systems, interfaces, IP, ICMP, TCP, UDP, transmission, and SNMP group • Read-write for the character-stream devices using SMIv2 MIB (RFC 1658) • • Read-write for the RS-232-like hardware devices MIB (RFC 1659) Read-write for the device server IP Network Control Protocol of the Point-to-Point Protocol MIB (RFC 1473) Th
Configure Security Features Configure Security Features From the command line, you can configure several security-related features to do the following: • Control access to the configuration. • Control access to inbound ports. • Control access to outbound ports. • Restrict access to outbound ports. • Use CHAP authentication for PPP users. • Control user access to the command line. • Use RADIUS to authenticate users. • Issue user passwords. • Configure SSH Version 2 for secure communication.
Configure Security Features Control Access to Inbound Ports An inbound port is one defined on the “dev” option of the command for one of the following device types: • “term” for terminal connections. • “min” for incoming modem connections. • “mio” for bi-directional modem connections. • “hdial” or “hio” for computer connections. The default configuration for inbound ports is that a login and password are required to access them.
Configure Security Features Control Access to Outbound Ports An outbound port is one defined on the “set ports” “dev” option, where “dev” is set to one of the following device types: • “prn” for printer connections. • “mout” for outbound modem connections. • “mio” for bi-directional modem connections. • “host” for host connections. • “ia” for industrial automation devices. The default for outbound ports is unlimited access.
Configure Security Features Use RADIUS to Authenticate Users The RADIUS feature is available on all PortServer TS Family products only. It is not supported on Digi One Family devices. RADIUS (remote authentication dial-in user service) is a method of maintaining a database of profiles of dial-in users. These profiles can include login and password information, as well as other user attributes. The device server can be configured to use RADIUS.
Configure Security Features RADIUS Table Key The numbers in the following tables have the following meaning: # Meaning 0 This attribute must not be present. 0+ Zero or more instances of this attribute may be present. 0-1 Zero or one instance of this attribute may be present. 1 Exactly one instance of this attribute must be present. RADIUS Attributes (RFC 2138) Supported The following attributes are supported in the Digi device server RADIUS client implementation.
Configure Security Features RADIUS Accounting Attributes (RFC 2139) The following RADIUS accounting attributes are supported in the Digi device server.
Configure Security Features Configure SSH Version 2 Encryption for Secure Communication Users can be configured to use SSH version 2 encryption for secure communication. SSH keys need to be generated from your SSH client. SSH is supported in Digi One IAP and all PortServer TS Family products. To configure simple password authentication for an SSH user, no SSHspecific configuration is required. Configure a user by entering: #> set user name=name password=on #> newpass name=name where name is a user name.
Configure Security Features Control Access to Services You can disable services, such as Telnet and Rlogin, for inbound users, which means that users cannot access the Digi device using those services. This feature allows you to turn off individual services or to specify a security level, which means that all services not included in that level are turned off. To control access to services for inbound users, see "set secureaccess" on page 194.
Configure Power Over Serial Ports Configure Power Over Serial Ports Power over serial ports is only available for the PortServer TS P MEI Family. Power over serial ports is a hardware feature. Enabling this feature involves changing a jumper inside the device. See the Digi One and PortServer TS Family User Guide’s chapter on power over ports for more details. Reset the Circuit Breaker From the command line, the only power-related task you can perform is to reset the circuit breaker. 1.
Configure Embedded Modem Common Configurable User Features Here are common user-related features configurable by “set user” command options. For a complete list of features, see "set user" on page 230. Feature Description “set user” Option accesstime Determines the times and days the user can access the device server. accesstime autoconnect Automatically connects the user to the host specified on the “autohost” option using the service (TCP port) defined on the “autoport” or “autoservice” options.
Configuration Management Configuration Management Configuration management tasks performed from the command line include: • Upgrading firmware • Copying the configuration to and from a remote host • Resetting the configuration to defaults Upgrade Firmware To upgrade firmware, use the “boot” command. See "boot" on page 51. Copy the Configuration to and from a Remote Host (Backup/Restore) To use the command line to copy the configuration to and from a remote host, use the “cpconf” command.
Configuration Management 46 Chapter 1 Command Line Configuration Tasks
Command Descriptions Chapter 2 This chapter provides the following: • Basic information that applies to all commands, including navigation and editing keys, displaying online help, abbreviating commands, and syntax conventions. • A description of each command.
Basic Command Information Verifying Device Support for Commands For verification that a device supports a particular command, you can enter several commands. For example: • “help” displays all supported commands for a device. • “?” displays all supported commands for a device. • “set ?” displays the syntax and options for the “set” command. 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.
Basic Command Information Entering Special Characters in String Values Several commands have options that are string values. String values may involve special characters or be subject to length limitations. Escape Sequences for Special Characters Special characters can be entered in strings using the following escape sequences: Escape Sequence Processed as: \* Match any character. \a Alert character. \b Backspace character. \f Form-feed character. \n New-line character.
admin admin Device support This command is supported in all devices. Purpose Used to temporarily access commands reserved for administrators (root) when logged in as a normal (non-root) user. After issuing the "admin" command, the following occurs: 1. A prompt requesting the root password appears. 2. You enter the root password. 3. If the password is accepted, the device displays the root prompt, indicating that you can issue commands reserved for administrators.
boot boot Device support This command is supported in all devices. Users of PortServer TS Family and Digi One IAP devices must be very careful with the load option. If this operation fails and then you reboot the device, the unit may not work. To ensure success, do the following: 1. Attempt to boot from a remote firmware image before issuing the “boot load” command. See "set config" on page 97 for more information. 2.
boot Options action={eewrite|factory|reset} The action to be performed. eewrite Resets all but the network-related parts of the configuration to defaults. Ports, users, passwords, and most other features are reset. This option does not apply to the PortServer TS 8/16. factory Resets the entire configuration to defaults. For PortServer TS 8/16, this option also reverts to the factory EOS. reset Reboots the device. load={host ip address|host name}:[load file] The firmware to be loaded.
boot Examples Reload firmware and reset configuration to defaults #> boot action=factory Reset all-but the network-related parts of the configuration to defaults This example does not apply to PortServer TS 8/16. #> boot action=eewrite Reboot device and use current firmware and configuration #> boot action=reset Load firmware using a boot host The command loads the firmware stored on the host into flash ROM. A reboot is required to use the new firmware. #> boot load=198.150.150.
close close Device support This command is supported in all devices. Purpose Closes active connect, Rlogin, and Telnet sessions; that is, sessions opened by "connect," "rlogin," or "telnet" commands. The "close" command is associated with the sessions displayed by the "status" command. That is, you can only close sessions that are displayed by the "status" command by issuing a "close" command, and not by the "kill" command. A "close" command issued without options closes the current connection.
close • • Chapter 2 • • • "send" on page 85. "set user" on page 230 for information on defining escape keys for Telnet, Rlogin, and connect sessions. "status" on page 254 to display status information on active sessions. "rlogin" on page 83. "telnet" on page 255. • "who" on page 261.
connect connect Device support This command is supported in all devices. Purpose Initiates a local connection on a port. There are several ways of using the "connect "command: • To make multiple connections, issue multiple "connect" commands. • • • To temporarily suspend a connection, escape the active session by pressing the escape character defined on the “set user” command. The default escape character is Ctrl [ (Control key and left bracket).
connect • • • • • Chapter 2 "set user" on page 230 for information on defining an escape character. "set ports" on page 169 for information on defining a hunt group. "status" on page 254 to display status information on active sessions. "telnet" on page 255. "who" on page 261.
cpconf cpconf Device support This command is supported in all devices. Purpose Used to: • Copy a configuration to and from a remote host (backup/restore) • Display the configuration on a terminal. Required permissions Root privileges are required to use this command. Syntax cpconf {fromhost=h os t[:f i le ]|tohost={h o st [:fi l e]|term}} Options fromhost=host[:file] Copies the configuration from the host and file specified. Be sure to: • Identify the host by either its IP address or DNS name.
display display Device support This command is supported in all devices. Purpose Used to: • Display the status of the EIA-232 signals on serial ports. • Display a list of errors. • Clear the errors list. • Display information on Digi devices that use dip-switch settings to enable multiple electrical interface (MEI) on serial ports. • Display power information for the Digi devices that support the Power Over Ethernet feature. • Display the contents of a port buffer.
display Examples Display configuration information on a port #> display port range=1 Display configuration information on a range of ports #> display port range=1-2 Display a list of errors #> display error Display information on dip switch settings #> display switches Display power information #> display power Clear errors #> display error clear See also 60 • "display buffers" on page 61 to display the contents of a port buffer. The "display" command’s focus is on real-time information.
display buffers display buffers Device support This command is supported in PortServer TS Family devices. Purpose Used to: • Display the contents of a port buffer. • Transfer the contents to a server running TFTP. • Configure the screen parameters. Required permissions Root privileges are required to use this command.
exit exit Device support This command is supported in all devices. Purpose Used to terminate either of the following sessions: • Your current session. • A temporary root session. If you are in a root session, the "exit" command returns you to a regular session. Required permissions Anyone can use this command. Syntax exit Example #> exit See also • • • • • • • • • • • • 62 "admin" on page 50 for information on starting a temporary root session. "close" on page 54. "connect" on page 56.
help help Device support This command is supported in all devices. Purpose Displays information on commands. Required permissions Anyone can use this command. Syntax help Example #> help See also "Displaying Online Help" on page 47.
info info Device support This command is supported in all devices. Purpose Displays or clears statistics, including protocol, interface, IA, serial, and UDP over serial. The statistics displayed are those gathered since the statistics tables were last cleared. Required permissions Normal users can view statistics tables. Root privileges are required to clear them.
info About the port statistics displayed by "info serial" The statistics displayed by "info serial" include data, event, and error counts, described below. These statistics are useful in understanding how the device is operating and can be helpful in finding problems. In particular, if an error counter is found to be increasing, there may be a problem in the device.
kill kill Purpose Clears or resets sessions on ports. The "kill" command is associated with the connections displayed by the "who" command. That is, you can only close connections that are displayed by the "who" command by issuing a "kill" command, and not by the "close" command. Device support This command is supported in all devices. Required permissions Root privileges are required to use this command.
mode mode Device support This command is supported in all devices. Purpose Changes or displays the operating options for a current Telnet session. Required permissions Anyone can use this command. Syntax Change Telnet options mode [bin={on|off}] [crmod={on|off}] [crlf={on|off}] Display Telnet options mode Options bin={on|off} Specifies whether binary mode is enabled.
mode Examples Turn on binary mode #> mode binary=on Add line feed characters #> mode crmod=on crlf=on Display operating options #> mode See also 68 • • • • • • • • • • • "close" on page 54. "connect" on page 56. "exit" on page 62. "kill" on page 66. "quit" on page 75. "reconnect" on page 76. "rlogin" on page 83. "send" on page 85. "status" on page 254 "telnet" on page 255. "who" on page 261.
newpass newpass Device support This command is supported in all devices. Purpose Used to create or change your own password, if you are logged in under your own name, the root password, or another user’s password, if you are logged in as root. When you enter the "newpass" command, a series of prompts guide you through the process of changing a password. Required permissions Any user can change their own password. Root privileges are required to change someone else’s password or the root password.
ping ping Device support This command is supported in all devices. Purpose Tests whether a host or other device is active and reachable. Required permissions Anyone can use this command. Syntax ping [continuous] [fill=ch ar ] {ho s tn a me |i p ad d r} [intv=ms ec ] [loose_sroute=ip a d dr ,i p a dd r ...] [npkts=nu m] [pksiz=by te s ] [record_route] [strict_sroute=i p a dd r, i p ad d r...] [verbose] Options continuous Specifies that "ping" commands be sent continuously until stopped.
ping record_route Specifies that routers handling the "ping" command include their IP addresses in the echo reply. strict_sroute=ip addr,ip addr... Specifies that the "ping" command should pass through the routers indicated—and only those indicated—on its way to the target host. Routers are identified by their IP addresses. verbose Specifies that echo replies include statistics associated with the "ping" command, such as round-trip time and number of packets transmitted and received.
power power Device support This command is supported in PortServer TS Family devices only. Purpose The "power" command is used to manage power controllers attached to the PortServer TS device. It can control the power state of specific ports on PortServer TS devices or devices connected to the ports, display the power state of specific ports on the PortServer TS devices, and display the status of a power unit. This command is context-sensitive.
power group=group# Performs the specified action on an outlet with the specified group number. Examples Display outlet status This command displays the status of the outlets, including whether they are on or off, their IDs, and the group number. #> power action=show range=2 outlets=3 Or: #> power range=2 outlet=3 Display power unit status This example displays the status a power controller that is connected to a Digi PortServer TS device but not fully configured yet.
power Control a device with a device range This example turns on the power to the device on the unit 2 connected to the outlet 3. #> power action=on range=2 outlet=3 Control a device with an ID In this example, the power to all outlets affiliated with a device named “Router” will be rebooted. This command will only work if the outlets are all currently on. #> power action=reboot id=Router See also 74 • • "set powerunit" on page 175.
quit quit Device support This command is supported in all devices. Purpose Ends the following types of sessions: • The current session. If you are in a regular or root session, "quit" closes the session. • A temporary root session. If you are in a root session started with the "admin" command, "quit" returns you to a regular session. Required permissions Anyone can use this command.
reconnect reconnect Device support This command is supported in all devices. Purpose Reestablishes a previously established connection. This command applies only to sessions that have been backed-out of, but not closed. Required permissions Anyone can use this command. Syntax reconnect [{s er i al po rt |p=se r ia l p or t |s=s e ss i on}] Options serial port The serial port to which this command applies. p=serial port | s=session The serial port or session to which this command applies.
remove remove Device support This command is supported in all devices. Purpose Removes entries from configuration tables. Required permissions Root privileges are required to use this command.
remove Examples Remove an entry from user table by name #> remove user name=martymertz Remove an entry from altip table by IP address #> remove altip ip=192.168.2.120 Remove an entry from altip table by index number #> remove altip range=3 See also 78 The "set" commands used to add or display values in the configuration tables.
revert revert Device support This command is supported in all devices. Purpose Restores the configuration to defaults or to the latest configuration stored in NVRAM. The revert command does not restore network-related parts of the configuration to defaults. Required permissions Root privileges are required to use this command.
revert option 80 Reverts this part of the configuration: keys "set keys" configuration. line "set line" configuration. login "set login" configuration. logport "set logport" configuration. menu "set menu" configuration. modem "set modem" configuration. netlogin "set netlogins" configuration. netport "set netport" configuration. network altip, arp, host, route, snmp, tcpip, and telnetip configuration. Not related to network connectivity. pmodem "set pmodem" configuration.
revert option Reverts this part of the configuration: telnetip "set telnetip" configuration. terms "set terms" configuration. timezone “set timezone” configuration. trace Trace settings configured by "set trace." udpdest "set udpdest" command. udpserial "set udpserial" command. users "set user" configuration. wan The configuration settings set by "set chat," "set device," "set ippool," "set modem," "set script," "set filter." wlan "set wlan" command. webui "set web" command.
revert Examples Reset the port configuration to defaults #> revert port=factory range=1 Reset network-related settings The configuration is reset to the latest user configuration saved in NVRAM. 1. First, turn off saving configuration changes to NVRAM: #> set config save=off 2. Change the baud rate of port 8 to 115200: #> set line baud=115200 ra=8 3. Run a test of serial port 8 at 115200 baud. 4. Once testing is complete, return port 8 to normal: #> revert line=nvram 5.
rlogin rlogin Device support This command is supported in all devices. Purpose Performs a login to a remote system, also referred to as an rlogin. Required permissions Anyone can use this command. Syntax rlogin [esc=c ha r ] {ho s tn a me |h o st i p a d dr } [{user=us er na me |-l us e r n am e}] Options esc=char A different escape character than the ~ (tilde) character, which will be used for the current rlogin session.
rlogin • • 84 "set user" on page 230 for information on configuring a user-specific Rlogin escape character. "who" on page 261.
send send Device support This command is supported in all devices. Purpose Sends a control command to a the current escaped Telnet session. Required permissions Anyone can use this command. Syntax send {ao|ayt|brk|ec|el|escape|ga|ip|nop|synch} Options ao Sends the “abort output” signal to discard output buffered on the peer. ayt Sends the “are you there” signal to test whether a host is still active. brk Sends the “break” signal to interrupt the executing application.
send • • • • • 86 "mode" on page 67. "reconnect" on page 76. "status" on page 254 "telnet" on page 255. "who" on page 261.
set altip set altip Device support This command is supported in all devices. Purpose Configures a serial port or group of serial ports with an alternate IP address, or displays current entries in the alternate IP address (altip) table. Alternate IP addresses enable routing of traffic from the LAN to serial ports or group of ports using IP addresses.
set altip See also • • • 88 "remove" on page 77 to remove values from the altip table. "revert" on page 79. The “revert altip” option reverts the “set altip” configuration. "set config" on page 97. The “sockets” option configures the base TCP socket service.
set arp set arp Device support This command is supported in all devices. Purpose Manually configures an entry in the Address Resolution Protocol (ARP) table, or displays the contents of the ARP table. The ARP table contains the Ethernet-to-IP address mappings of other devices on the LAN, which is required to communicate with these devices. The ARP protocol updates this table automatically, so manual modification is seldom required. Required permissions The root user can configure ARP table entries.
set auth set auth Device support This command is supported in PortServer TS Family devices only. Purpose Configures or displays access permissions to serial ports for LAN users. The "set auth" command is a very powerful tool for limiting LAN users’ access to ports. To produce the intended configuration results, follow these principles: • The default access permission for a port is unrestricted access.
set auth Syntax Configure access permissions set auth ip=ip ad d re s s [login={r a ng e|none}] [mask=ma sk ] [realport={r a ng e|none}] [unrestricted={r an g e|none}] Display access permissions set auth [r a ng e=range] Options ip=ipaddress The IP address of the device to which this "set auth" command applies. login={range|none} Requires that users of the IP address specified log in. A value of none indicates that users of the IP address specified have login access to none of the ports.
set auth Examples Display entire auth table #> set auth Display a range of entries in auth table #> set auth range=1-2 Configure no access for an IP address #> set auth ip=199.150.10.12 mask=255.255.255.255 login=none realport=none unrestricted=none Configure mixed access In this example, an 8-port device server is configured for mixed access. #> set auth ip=199.150.10.12 mask=255.255.255.
set buffer set buffer Device support This command is supported in PortServer TS Family devices only. Purpose Configures buffering parameters on a port, or displays the port-buffer configuration on all ports. Required permissions The root user can configure port buffering. Normal users can display current settings.
set buffer See also • • • 94 "display buffers" on page 61. "revert" on page 79. The “revert buffers” option reverts the “set buffer” configuration. "set wlan" on page 244.
set chat set chat Device support This command is supported in PortServer TS Family devices only. Purpose Used to configure, display, remove, or rename entries in the chat table. Chat table entries provide telephone number string translation and can be accessed by any configured script. The chat table holds a maximum of 12 entries. The “set chat” command is not related to the chat protocol supported under the “set ia” command. See "set ia" on page 125 for details on configuring the chat protocol.
set chat retry=number The number of times to retry a call. The range is 0 to 99 times. star=string A string of characters that will replace the "*" character in the chat script. pound=string A string of characters that will replace the "#" character in the chat script. wait=string A string of up to 24 characters to substitute into telephone numbers in place of the wait character. rmchat=on range=range|rmchat=chatname Removes the chat table entry specified on the "range" or "name" option.
set config set config Device support This command is supported in all devices. Purpose Configures or displays network settings. These settings are stored in the network parameters configuration table. The “optimize={latency|throughput}” option can be used to optimize your network for better Ethernet/IP performance. Required permissions The root user can configure network parameters. Normal users can display network parameters.
set config Options bootfile=file The name of a boot file on a TFTP host. Specify the full path to the file if this is required to satisfy the host’s TFTP implementation. This option does not apply to PortServer TS 8/16. boothost=host ipaddr The IP address of a host from which the device server can boot using TFTP. This option does not apply to PortServer TS 8/16 devices. circuitbreaker=reset Resets the circuit breaker. dhcp={on|off} Enables or disables DHCP (Dynamic Host Configuration Protocol).
set config optimize={latency|throughput} Configures how the Digi device handles network latency. latency Choose latency if the Digi device will handle delay-sensitive data. throughput Choose throughput if overall network throughput is more important than latency. For Digi One IAP, the default is "latency." For all other models, the default is "throughput." ping-arp={on|off} Enables or disables the ping-arp protocol to set the IP address.
set config securerealport=tcp port The TCP port number used for secure RealPort connections. The default is 1027. sockets=socket num Sets the base TCP socket service. TCP socket communication enables serial devices to communicate with each other over an Ethernet network as though they were connected by a serial cable.
set config tbreak={std|any|none} Sets the Telnet break keystroke (tbreak). Once a Telnet connection is initiated, but before the connection is established, the connection can be broken by entering a designated keystroke. This keystroke is determined by these settings. std Configures tbreak so only the ^] (control right bracket) keystroke will break a Telnet connection. any Configures tbreak so any keystroke will break a Telnet connection.
set consmenu set consmenu Device support This command is supported PortServer TS Family devices only. Purpose Configures or displays console menu options. The Digi PortServer TS device supports multiple connections to a port simultaneously. The “set consmenu” command may be used with the port sharing feature (see "Configure Port Sharing" on page 24 and "set sharing" on page 198). When port sharing is enabled, it can be useful to see who else is connected to a port before making a connection.
set consmenu Examples Following is a sample of a menu displayed upon connecting to a port using reverse telnet, reverse SSH: [Port 1 Console Menu] - to connect Port 1 connected sessions: TTY user connected from 9 root 10.49.1.1 10 10.49.1.12 (current connection) console 1> At this stage, you can execute console commands.
set device set device Device support This command is supported in PortServer TS Family devices only. Purpose Configures devices used for outbound connections to use dialer scripts and chat table entries; configures a different baud rate (line speed) for modems and other devices used for outgoing connections than the rate defined on the “set line” command; or displays the contents of the device table. Required permissions The root user can configure devices.
set device dialer={no|index num|script name} Specifies whether a dialer script is associated with this device. no A dialer script is not associated with this device. index num A script table entry (index number) associated with this device. script name The name of a script. The default is “no.” name=name A user-defined name for the device. ports=range The port or range of ports available to this device. newname=newname A new name for a previously defined device.
set dhcp set dhcp Device support This command is supported in all devices. Purpose Used to: • Enable/disable DHCP (Dynamic Host Configuration Protocol). Enabling DHCP causes the device server to obtain an IP address from the host server. If DHCP is disabled, a static IP address must be defined for the device server. • Renew the IP address of the device server. This causes the device server to discard its current IP address and obtain a new one from the host server.
set dhcp client_id_type=type A number between 0 and 255 that can be used to define the type of information in the client_identifier string. For example, all routers could be assigned 11 as the client_id_type. keepalive={accept|ignore} Determines which TCP keep-alive attributes are used, those set by the DHCP server or those specified on the "set tcpip" command. accept The DHCP server settings are used, and the "set tcpip" settings are not used.
set embmodem set embmodem Device support This command is supported in PortServer TS M MEI devices only. Purpose Configures the embedded modem on PortServer TS M MEI devices, or displays current embedded-modem settings. Required permissions The root user can configure the embedded modem. Normal users can display embedded modem settings.
set ethernet set ethernet Device support This command is supported in all devices. Purpose Configures and adjusts Ethernet communications options, and displays current Ethernet options. Required permissions The root user can configure Ethernet options. Normal users can display Ethernet options.
set ethernet Examples Configure 100 Mbps throughput #> set ethernet speed=100 Configure full-duplex mode #> set ethernet duplex=full See also • • 110 "revert" on page 79. The “revert ethernet” option reverts the “set ethernet” configuration. "set config" on page 97.
set filter set filter Device support This command is supported in PortServer TS Family products. Not supported in Digi One Family products. Purpose Manages filters. Filters can be used with PPP and RADIUS. • For PPP, filters can control and record traffic over PPP connections. • When using RADIUS, the RADIUS server can send to the RADIUS client (that is, a Digi product) a filter ID attribute, meaning a filter name that is used in authenticating the connection.
set filter Rules for creating filters When creating filters, follow these rules: • The action a filter takes depends on the contents of the filter and on the type of filter it is defined as on the "set user" command. If the filter is referenced on the: • "passpacket" option, it will allow packets that meet filter criteria to pass through a serial port and block all others. • "bringup" option, it will bring up a connection when the port handles a packet that meets filter criteria.
set filter Required permissions The root user can configure filters. Normal users can display filter settings. Syntax Create filters, add stanzas, or rename filters set filter name=n am e [newname=n a me ] [s#=to k en \to k en \t o ke n...] Display filter table entries set filter [range=r an ge ] Display filter stanzas set filter name=n am e show={on|off} Options name=name A name for the filter. newname=name A new name for a previously defined filter. s#=token/token/token...
set filter Token Value Filter Criteria src Source IP packet options, such as IP addresses, ports, or host names. syn Start filtering when the start of a TCP data stream is encountered. This option is always used with the "fin" option and is used to trigger logging ("logpacket" option on the "set user" command). fin Stop filtering when the end of a TCP data stream is encountered. This value is always used with the "syn" option and ends logging ("logpacket" option on the "set user" command.).
set filter Examples Display the filter table #> set filter Display filter stanzas #> set filter name=filter1 show=on Remove a filter from the filter table #> set filter rmfilter=filter1 Create a filter on a Source IP Address #> set filter name=filter1 s1=src/199.86.8.3 Create a filter on an ICMP packet type In this example the “set filter” command creates a filter that uses an ICMP type 13 packet (destination unreachable) as filter criterion.
set flow set flow Device support This command is supported in all devices. Purpose Configures or displays flow control options for the device server’s EIA-232 serial ports. Several options related to the RTS toggle feature are hidden by default, and can be displayed by using the “show=rtstoggle” option. Required permissions The root user can configure flow control options. Normal users can display flow control options.
set flow altpin={on|off} Determines whether the altpin option, which swaps DCD with DSR so that eight-wire RJ-45 cables can be used with modems, is used: on The altpin option is used. off The altpin option is not used. The default is "off." cts={on|off} Determines whether CTS (clear to send) is used for output flow control: on CTS is used for output flow control. off CTS is not used for output flow control. The default is "off.
set flow forcedcd={on|off} Determines whether the port acts as though DCD were always high. The primary implications is that autoconnections are launched as soon as the Digi device completes booting when this option is on and an appropriate incoming device type (see the "set ports" "dev" option) is defined for the port. The default is "off." itoss={on|off} Used only with software flow control (XON\XOFF) and only if "ixany=on:" on The character that resumes output is discarded.
set flow post-delay=milliseconds Specifies the time in milliseconds to wait after sending data before turning off the RTS signal. The range is 0 to 5000 milliseconds, and the default is 0. This option does not apply to PortServer TS 8/16 devices. range=range A port or range of ports to which this "set flow" command applies. ri={on|off|power} Determines whether RI (ring indicator) is used for output flow control: on Use RI for output flow control. off Do not use RI for output flow control.
set forwarding set forwarding Device support This command is supported in PortServer TS Family devices only. Purpose Configures or displays IP routing, or forwarding, options. The “set forwarding” command can be used to configure a Digi device in the following ways: • To function as an IP router using Routing Information Protocol (RIP) to dynamically maintain routes. • To perform Proxy ARP services. • To handle various ICMP-related functions.
set forwarding icmpdiscovery={on|off} on Send and answer ICMP Router Discovery packets. off Do not send and answer ICMP Router Discovery packets. The default is "off.
set forwarding proxyarp={on|off} Specifies whether proxy ARP services are enabled. Proxy ARP is a technique in which a router answers ARP requests intended for another system. By pretending to be the other system, the router accepts responsibility for forwarding packets to that system. Use proxy ARP to route packets to and from serial routes on the same IP subnetwork as the device server’s Ethernet interface. on Provide proxy ARP services. off Do not provide proxy ARP services. The default is "off.
set forwarding timeout=time The time in which an entry in the routing table must be updated. If an entry exceeds the value specified here, it will be discarded. This value must be at least six times the advertise value. The range is 60 to 1080 seconds. The default is 180 seconds.
set host set host Device support This command is supported in all devices. Purpose Configures or displays the host table, containing host name-to-IP address mappings. The Digi device’s IP component can use the host table and a DNS server to map host names to IP addresses. These mappings allow users to identify hosts by user-friendly names, instead of IP addresses. Using the host table is a convenience only. If you do not configure the host table or DNS, users identify hosts by IP addresses.
set ia set ia Device support “set ia” is supported in the following Digi products. The extent of Industrial Automation (IA) protocol support varies among products; for more details, see "Communication protocols supported in devices" on page 126.
set ia Communication protocols supported in devices IA devices can use various communication protocols, which vary by device. See "Configure protocol-specific options" on page 128 and "Options for configuring protocols" on page 136 for more information.
set ia Syntax Configure serial port-connected devices set ia serial range={port#|port#-port#} [chartimeout=(3-65535ms)] [messagetimeout=(10-65535ms)] [slavetimeout=(10-65535ms)] [lineturndelay=(0-65535ms)] [table=(1..32)] [type={master|slave}] [protocol=p r ot oc o l] For “protocol,” See "Configure protocol-specific options" on page 128. See “Options for configuring serial port-connected devices” on page 130. To set the baud rates for the port, see "set line" on page 149.
set ia Configure route entries within destination tables set ia table=(1..32) route=(1..
set ia Option Applies to these protocols acktimeout=10-65535 df1fullduplex, df1halfduplex, hostlink acklimit=0-255 df1fullduplex, df1halfduplex, hostlink addextfunc=N,M,… modbusrtu, modbusascii, modbustcp ansiescape={on|off} custom broadcast={on|off|replace} modbusrtu, modbusascii, modbustcp buffer custom checksum={bcc|crc} df1fullduplex, df1halfduplex class={ucmm|cm3} ethernetip connpath=”pa th ” ethernetip dontecho={on|off} chat duplex={half|rcv_only|xmt_only} custom, ascii_import
set ia Display current IA settings To display current IA settings, the "show" command is recommended instead of a "set ia" command with no options: show ia all Options for configuring serial port-connected devices The following command options apply to configuring serial port-connected devices. chartimeout=3-65535 milliseconds (applies to master or slave) After a first byte is received, this is the time to wait for additional bytes to either consider the message complete or to be aborted.
set ia table (applies to master only) Defines which table is used to route messages to their destination. This applies only to master-attached devices. type={master|slave} Defines whether the serial device configured with this command is a master or a slave device. For peer support, such as DF1 Full Duplex, set this option to "master." Options for configuring network masters – incoming message sources The following command options apply to network listeners.
set ia permit={all|readonly|rdwrdata} (Modbus only) Allows the Digi device to block or allow specific Modbus commands. Since more than one Modbus master can be defined, you can use standard network firewalls to enable “safe” incoming Modbus/TCP paths that cannot modify device memory. all Allows all commands through the Digi device. Nothing is blocked. readonly Only commands that read normal operational data are allowed through the Digi device. All writes or special commands are blocked.
set ia type={tcp|udp} Defines whether the incoming connection is TCP (connected) or UDP (unconnected). The default is "tcp." Options for configuring destination tables The following command options are used to configure destination tables: addroute=N Creates a new route in this entry in the table. command={destroy} Destroys, or deletes, this master entry. This stops the network listener and the protocol connection will no longer be accepted. moveroute=N,M Move the destination route from slot N to slot M.
set ia ipport=0-65535 The UDP or TCP port on which to listen for protocol messages. Modbus/TCP defaults to TCP port 502. AB/Ethernet defaults to TCP port 2222. Ethernet/IP defaults to TCP port 44818. mapto=N Used for destination entries of type "mapto." This option defines the protocol address for which to reevaluate this message. messagetimeout=10-65535 milliseconds When messages are received from remote clients, this is the time to wait to allow the message to be answered.
set ia splitip={on|off} splitdivisor=(1-255) splitbase=(0|1) These settings enable a message forwarding scheme similar to the Modicon BM-85. splitip={on|off} Enables or disables this message forwarding mode. splitdivisor=(1-255) Defines how the protocol address is split. splitbase=(0|1) Defines whether or not the result is incremented by 1. For example, suppose a destination route entry exists for protocol addresses 100 to 255, with a split divisor of 10, a split base of 0, and a remote IP address of 192.
set ia Options for configuring protocols These options apply to specific protocols and are not available on all products. The protocols are noted in parentheses after the option name. protocol=protocol Specifies which protocol is being used. One of the following protocol names or short names may be specified: protocol value Short Name abethernet abcsp Allen-Bradley (AB)/Client-Server Protocol; older port 2222 protocol. Digi One IAP ascii_import ascii ASCII devices.
set ia Protocol-specific options acktimeout (df1fullduplex, df1halfduplex, hostlink) The period to wait for an acknowledgment from the connected device after sending a message. When this period is exceeded, the Digi device re-sends the message. The range is 0 to 65535 milliseconds. The default is 250 milliseconds. acklimit (df1fullduplex, df1halfduplex, hostlink) The number of times that the "acktimeout" timer can expire before the Digi device discards a message as undeliverable. The range is 0 to 255.
set ia checksum={bcc|crc} (df1fullduplex, df1halfduplex) Selects the checksum or error-detection method used by the attached device. DF1 supports both a 16-bit CRC (“crc”) and an 8-bit Block Check Code (“bcc”). Rockwell ‘C*Logix’ processors default to “bcc,” while MicroLogix and other PLC families tend to default to “crc.” The Digi device default is “crc.
set ia end="pattern" (custom, ascii_import, chat) The Digi device uses this character pattern to detect an end of a message. The default is "" or no pattern. Rules and guidelines for specifying this character pattern string are: • The string can be between 1 and 4 characters long. • The string can be made up of printable or unprintable characters. • To use an unprintable character, enter the character in hexadecimal format, that is, \xhh, where hh is replaced with a hexadecimal number.
set ia errorresponse={on|off} (modbusrtu, modbusascii, modbustcp, df1fullduplex, df1halfduplex, abcsp) Controls behavior for common run-time errors such as no response from the slave device. By default, “errorresponse=on,” which means return an error response – except for Modbus/RTU and ASCII protocols, where by default, “errorresponse” should be “off.” This option exists because different clients handle error response and no response differently.
set ia packing={ch_pad|direct|swap|pad_ch} (ascii_import) Defines how ASCII characters are packed into word registers. ch_pad One character is placed into the low-byte of each register, with a pad byte placed in the high-byte. How this appears within the protocol is protocol-specific. Use "pad_ch" if this sequence is wrong. direct Characters are packed directly into the registers exactly as received. How this appears within the protocol is protocol-specific. Use "swap" if this sequence is wrong.
set ia rbx={off|half} (modbusrtu--(slave only)) Enables the serial slave driver to handle Report-By-Exception (XMIT) writes between polls. A pilot Report-By-Exception (or XMIT) handler has been added to the Modbus/RTU serial slave driver. The Digi device pauses between slave polls to receive potential “Master Requests” initiated by the slave. Just as with a serial Master-attached configuration, the Modbus/RTU “slave address” is used with the IA route table to determine the remote destination.
set ia target={…} (df1fullduplex, df1halfduplex, abethernet, ethernetip) Used in protocol conversion to select the format of protocol commands to accommodate different processors. To understand and use protocol conversion, refer to the IA support documentation at the following URL: http://www.digi.com/support/ia. cif Uses PLC2/Common Interface File style Unprotected Read/Write PCCC/DF1 commands 1 and 8 (see Rockwell Publication 1770-6.5.16 pages 7-31 & 7-32).
set ia Setting up a Modbus/TCP to RTU bridge with slave(s) attached Because of the increased flexibility of IA configuration in this firmware release, creating a simple Modbus bridge by command line requires more steps than previous firmware. This example defines the message source (the ia master), a message destination (the ia serial), and how messages are forwarded. In this example, all incoming messages are forwarded to serial port 1.
set ia Setting up a AB/DF1 PLC with Pass-Thru for local HMI display Suppose a simple AB PLC has a single serial port already attached to a local Human Machine Interface (HMI). Using the DigiOne IAP Pass-Thru port, we can network enable the PLC and still have our local HMI. This configuration defines two message sources (the AB/Ethernet or CSP protocol and the second serial port), one message destination (serial port 1), and the destination table that forwards all messages to serial port 1.
set ippool set ippool Device support This command is supported in PortServer TS Family devices only. Purpose Creates a pool of IP addresses for serial ports, or displays the currently defined pool of IP addresses. This command can be used for configuring IP addresses for PPP connections. Required permissions The root user can configure a pool of IP addresses. Normal users can display the currently defined pool of IP addresses.
set keys set keys Device support This command is supported in all devices. Purpose Changes the key or key sequences used to generate certain characters and command functions, or displays current key mappings for these characters and functions. Use the carat character (^) to indicate that the Ctrl key should be held while pressing another key. Required permissions The root user can configure key sequences. Normal users can display key mappings.
set keys xoff The XOFF character. The default is ^s. xona The auxiliary XON character. The default is ^q. xoffa The auxiliary XOFF character. The default is ^s. range=range A range of ports. If you issue the command from a Telnet session, you must specify the "range" option. If you issue the command from an attached terminal, the command will work for the port to which the terminal is attached, unless you use the "range" option to specify a different port.
set line set line Device support This command is supported in all devices. Purpose Configures or displays options associated with a serial line. Required permissions The root user can configure line options. Normal users can display line options.
set line error={ignore|null|parmrk|dos} Determines how the device server handles parity errors on the line. ignore The device server ignores errors. null The device server changes the error character to a null character. parmrk The device server “marks” the error with FF (16450 error byte). dos The device server marks the error with an error character. The default is "ignore." inpck={on|off} Specifies whether input parity checking is on or off. on Input parity checking is turned on.
set line otab={on|off} Specifies handling of output tabs. on means that output tabs are converted to eight spaces. off Output tabs are not converted. The default is "off." parity={o|e|n|m|s} The parity used for the line. o Odd parity. e Even parity. n No parity. m Mark parity. s Space parity. The default is "n" (no parity). range=range The port or range of ports to which this command applies. stopb={1|2} The number of stop bits per character to use on this line.
set logins set logins Device support This command is supported in all devices. Purpose Use the "set logins" command to: • Configure the sequence of events that occurs when a user logs into a port. This includes information the user supplies and prompts and responses. • Display current login settings. Required permissions The root user can configure login sequences. Normal users can display login settings.
set logins passwd={on|off} Specifies whether users are required to supply a password to access the ports specified by the "range" option. on Users are required to supply a password to access the ports specified by the "range" option. off Users do not supply a password. The default is “on.” This option is disabled when the port is configured as an auto port (see "set ports" on page 169). passprompt=string The password prompt displayed. The maximum length is 10 characters.
set logins write={on|off} Specifies whether configuration changes made by regular users can be saved and used for subsequent sessions by that user. on Configuration changes made by regular users can be saved. off Configuration changes made by regular users are not saved.
set logport set logport Device support This command is supported by all devices except Digi One IA and Digi One SP. Purpose Configures or displays the port-logging feature, also known as logport. The port-logging feature passively logs data going into, out of, or both on a serial port. This means that you can be using a standard reverse or RealPort session on a port, and all the data from that session can be sent to a configurable server. Required permissions The root user can configure port logging.
set logport mode={raw|syslog} Specifies whether the data is sent as raw data or in syslog format. raw Sends data to the server as it is seen on the port. syslog The serial data is encapsulated in syslog format. The default is "syslog." pri=0-65535 The syslog priority, which instructs the syslog server how to prioritize this packet. This option applies only if "mode=syslog." ipaddress=ipaddress The IP address to which packets are sent. udpport=1-65535 The UDP port to which packets are sent.
set logport delimiter=string The string in the serial data that tells the Digi device that the message is complete and should be forwarded to the destination. If you do not specify a delimiter, the Digi device will forward a message based on the number of bytes accumulated in the buffer (specified by the "rmax" option) and on the period to wait for the buffer to fill (specified by the "rtime" option).
set mei set mei Device support This command is supported in PortServer TS 8/16 MEI Family devices only. Purpose Controls global Multiple Electrical Interface (MEI) configuration settings. The system configuration MEI settings for baud rate range are only valid for EIA-422/485 ports when automatic transmitter control is active. Required permissions The root user can configure MEI settings. Normal users can display MEI settings.
set menu set menu Device support This command is supported in PortServer TS Family devices only. Purpose The "set menu" command is used to create and modify custom menus. Use the "set menu" command to: • Create menus for users. • Display menu table entries. • Display lines of a menu. • Remove a line from a menu. Required permissions The root user can configure menus. Normal users can display menu settings.
set menu m#=string A text or informational line for the menu, where: m Specifies that this is a text or informational line. # A line number for the menu. Lines appear in numeric order on the menu. string A text string. Enclose strings with spaces in quotation marks. range=range A port or range of ports. t#=string A title line for the menu, where: t Means that this is a title line. # A line number for the menu. Each menu can have two title lines (t1 and t2). string A text string.
set menu Examples Create a menu In this example, "set menu" commands create a menu with active fields that enable users to start connections to hosts named "server1" and "server2.
set modem set modem Device support This command is supported in PortServer TS Family devices only. Purpose Use the "set modem" command to: • Configure an association between a port and modem test and initialization scripts. • • Display the modem table. Clear the association between ports and modem test and initialization scripts. Required permissions The root user can configure modem settings. Normal users can display modem settings.
set modem Examples Display the current port’s scripts In this example, the "set modem" command displays the script table for the current port.
set netlogins set netlogins Device support This command is supported on the PortServer TS 8/16 Family devices only. Purpose Use the "set netlogins" command to: • Configure the sequence of events that occur when a user logs into a server over the network (netlogin). • Display current netlogin settings. Required permissions The root user can configure netlogins. Normal users can display netlogin settings.
set netlogins passprompt=string The password prompt displayed. The maximum length is 10 characters. Enclose this string in quotation marks if it includes spaces. The default is password: passwd={on|off} Specifies whether users are required to supply a password to access the ports specified by the "range" option. on Users are required to supply a password. off Users do not supply a password. The default is “on.
set netlogins Examples Display network login information on all ports #> set netlogins Display network login information on a range of ports #> set netlogins range=1-2 Configure a port for user configuration In this example, the "set netlogins" command configures a port so that users can save their login-related configuration changes and use them in future sessions: #> set netlogins write=on range=1 Configure the command prompt In this example, the "set netlogins" command configures the command prompt
set netport set netport Device support This command is supported by all devices. Purpose Changes the netport, or port number used for the webserver (HTTP) service to a different port than the default, which is 80. The new port must not already be in use by another service. Required permissions The root user can configure the netport for the webserver service. Normal users can display the current netport number.
set pmodem set pmodem Device support This command is supported in the following devices: • Digi One SP • Digi One IA • All PortServer TS Family products Purpose Used to configure options for modem emulation over TCP/IP, or display current modem-emulation settings. Required permissions The root user can configure modem emulation settings. Normal users can display modem emulation settings.
set ports set ports Device support This command is supported in all devices. Purpose Configures or displays a port’s operating parameters. Required permissions The root user can configure port parameters. Normal users can display port parameters.
set ports autoservice={default|raw|rlogin|telnet} Specifies the autoconnection service for this port, which is only used if "auto=on." Choose one of the following: default Normally means the Digi device uses the Telnet service. The exception is if the "dport" option is 0 or 513. In that case, "rlogin" is used. raw Data is passed between the serial port and the TCP stream without modification. rlogin The Digi device uses the remote login (rlogin) service. telnet The Digi device uses the Telnet service.
set ports If the device you are configuring does not fit into the device types listed in the previous table, or requires unusual flow control attributes, use the information in the following table to define a device type. Note that for “mio,” “mout,” “min,” “host,” and “hdial” device types, the device lowers DTR at disconnect and holds it low for two seconds to ensure a clean disconnection.
set ports Device Type Use for Devices with These Attributes pm • • • • The device never generates a login. This device’s characteristics are specific to modem emulation settings for a given port. DTR and RTS are low when the connection is idle. Use dev=pm when initiating communication with the device. power (PortServer TS 8/16 only) • • • • • The device never generates a login. This device’s characteristics are specific to power management settings for a given port.
set ports flushstchar={default|on|off} Determines whether the first character of an autoconnection is discarded. If you specify "flushstchar=default," the first character will be discarded for Telnet and Rlogin connections and will not be discarded for raw connections. group={none|group} Assigns a group number to this port, which means that this port is part of a hunt group. Outgoing calls specifying this hunt group can then use any available port in the group.
set ports p[1-9]=script param Letters and numbers that can be used in the variable fields of login or dialer scripts. This option is used only when the port-based autoconnect feature is on. (See the "dest" option.) range=range The port or range of ports to which this command applies. scriptname=name The name of a script (defined with the "set script" command) to use with auto connections to automatically log on to a host or run a script on a host.
set powerunit set powerunit Device support This command is supported PortServer TS Family devices only. Purpose Configures or displays power management options. This command is used to configure Digi RPM power controllers for use with a PortServer TS device to manage power for other connected devices. Required permissions The root user can configure power-management options. Normal users can display power-management options.
set powerunit range=port Identifies the port or ports to which the specified power control unit is connected. You can specify ports using an individual port number, a list of ports separated by commas, or a range of ports using a dash. See the examples that follow. For: range value An individual port range=2 A list of ports range=1,3,5 A range of ports range=1-5 size=number_of_outlets The number of outlets on the power control unit. tempthreshold1=threshold, ...
set powerunit Configure a current threshold This example configures the current threshold for 15 Amps. #> set powerunit range=8 alarm1=15 Configure a temperature threshold This example configures the temperature threshold for 32 degrees C. #> set powerunit range=8 temp1threshold=32 Configure an ID In this example, all the devices connected to outlets 1-4 are assigned an ID, allowing them to be managed as a single unit.
set profiles set profiles Device support This command is supported in all devices that support the default Web user interface. Purpose Sets the particular port configuration profile for a serial port. The “set profiles” command may be used for two purposes: • Used with the default Web interface to set the particular profile for a serial port. • Used to set the default parameters for a specific profile.
set profiles • • Internal Modem (or Embedded Modem) profile: Configures the internal modem of this device. The Internal Modem Profile is used for serial ports that contain an internal modem to configure both the serial port and the modem. Chat profile: Allows multiple clients to simultaneously connect and manage a server connected to a serial port. Use this profile if multiple clients need to share a single server/slave resource.
set profiles power Associates the Power port profile with the port. printer Associates the Printer port profile with the port. realport Associates the RealPort port profile with the port. tcpsockets Associates the TCP Sockets port profile with the port. terminal Associates the Terminal port profile with the port. tunneling Associates the Tunneling (Serial Bridge) port profile with the port. udpsockets Associates the UDP Sockets port profile with the port.
set radius set radius Device support This command is supported in PortServer TS Family products only. Not supported in Digi One Family devices. Purpose Use the "set radius" command to: • Configure a Digi device to use one or more RADIUS (Remote Authentication Dial-In User Service) servers to authenticate and maintain user profiles on dial-in users. • Display current RADIUS configuration options.
set radius ignorefilterid={on|off} Specifies handling of unknown Filter ID attributes. Setting this field to “on” can pose security issues on the Digi device. on Ignore Filter ID attributes that are not found in the list of filters on the Digi device. If a Filter ID attribute matches a filter on the Digi device, it is processed normally. off Filter ID attributes which do not find a matching filter on the Digi device cause an authentication failure. primary=ip adr The IP address of the primary RADIUS server.
set radius Examples Display status of the current RADIUS configuration #> set radius Configure device server to use a primary RADIUS server #> set radius run=on primary=199.150.150.10 secret=xyyzzz Configure two RADIUS servers In this example, the first "set radius" command configures the primary RADIUS server. The second "set radius" command configures the secondary server. Two commands are required because the two servers use different passwords ("secret" option). #> set radius run=on primary=199.150.
set rloginoption set rloginoption Device support This command is supported in all devices. Purpose For remote login (rlogin) sessions, "set rloginoption" allows or disallows the enabling or disabling of flow control by the rlogin application. Required permissions The root user can configure rlogin flow control. Normal users can display rlogin flow-control settings.
set route set route Device support This command is supported in all devices. Purpose The "set route" command is an advanced feature that is intended to be used by experienced device and network users. Use the "set route" command to • Manually configure IP routes. The route table holds up to 50 entries. • Remove routes from the route table. • Display the contents of the route table. Required permissions The root user can configure IP route settings. Normal users can display route table entries.
set route Examples Display entire route table #> set route Display a range of route table entries #> set route range=3-5 Remove an entry from the route table #> set route rmroute=on range=2 Configure a route over a WAN connection #> set route net=199.150.144.8 mask=255.255.255.0 metric=3 wanname=user998 gateway=199.150.100.2 See also • • • • 186 "remove" on page 77 to remove entries from the route table. "revert" on page 79. The “revert route” option reverts the “set route” configuration.
set rpauth set rpauth Device support This command is supported in all devices. Purpose Sets authentication options for RealPort. RealPort has a challengeauthentication protocol that, if enabled, allows only hosts that authenticate to use ports on the Digi device. This authentication protocol is supported for both encrypted and unencrypted versions of RealPort. In order to use RealPort authentication, it must be enabled in both the driver and the Digi device.
set script set script Device support This command is supported in PortServer TS Family devices only. Purpose Use the "set script" command to: • Define a modem or login script. • Display entries in the script table. • Display all stanzas of a script. • Delete a script from the script table. Required permissions The root user can configure, edit, or delete scripts. Normal users can display script settings.
set script Command Description Example Anp Sets the following: • Character size to n, which can be either 7 or 8 bits. • Parity to p, which can be one of the following values: 0=no parity, 1=odd 2=even 3=mark s1=”A70” Bn Transmits a break signal n milliseconds long. If n is not specified, the length is 250 milliseconds. s7=”B100” Cn Sets carrier loss detection. If n is: • 0: carrier loss is not detected. • 1: the modem hangs up if the port loses DCD. S2=”C1” D+m Raises a modem signal.
set script Command Description Example Qn Sets software flow control. If n is: • 0: Flow control is disabled. • 1: Flow control is enabled. s5=”Q0” Sn Defines the time to wait (timeout), in seconds, for a modem signal or input data. s2=”S5” Ts Defines the timeout recovery state. If this timeout is exceeded, control is passed to this stanza. s2=”T8” Un Immediately executes the text of stanza n, as if it were inserted to replace this command. You can nest this command, up to a maximum of 10.
set script Script Escape Sequences The following table describes the escape sequences you can use in E, M, and [ ] command strings in script commands. Escape Sequence Description ^c This is the character transmitted by an ASCII keyboard when the CTRL key is held down and the c key is pressed.
set script Examples Configure a login script This example defines a login script that waits for a login prompt and then supplies a login name, and waits for a password prompt and then supplies a password.
set script Configure a dialer script In this example, a telephone number is passed to the modem.
set secureaccess set secureaccess Device support This command is supported in PortServer TS Family devices only. Purpose Sets secure access for Digi devices by disabling them for users of inbound connections. Required permissions The root user can configure secure access. Normal users can display current secure-access settings.
set secureaccess service={on|off} Turns a service on or off. service can be any of the services listed: If you specify... Examples This service is turned on or off...
set service set service Device support This command is supported in all devices. Purpose Use the "set service" command to • Configure, or associate, names with TCP and UDP service ports for use in filters. • • Display entries in the service table. Remove entries from the service table. Required permissions The root user can configure or remove service table entries. Normal users can display service table entries.
set service Factory Defaults for Service Names and Port Numbers The following table lists the factory default service names, and the port numbers to which they are assigned. Other service names than these can be added through the “set service” command.
set sharing set sharing Device support This command is supported in all Digi One Family and PortServer TS Family devices. Purpose Configures or displays the port sharing feature. A Digi device enabled for port sharing allows more than one client to open a serial port through RealPort, reverse Telnet, reverse SSH, or connect. All clients that share a port will read the same data from the serial port; the data is duplicated and sent to each client.
set sharing control={shared|exclusive} Specifies whether control should be shared by all clients, or controlled exclusively by the Digi device. shared All clients share control of the serial-port parameters, such as baud rate, data bits, parity, flow control, etc. Any changes made to these parameters by one client will affect all clients. exclusive The serial port parameters can only be set from the command line or web UI of the device itself.
set sharing The port-sharing parameters are displayed in four columns. The "current clients" column shows how many clients are currently sharing the port. The "max clients," "control," and "timeout" columns show the value set with the "clients," "control," and "timeout" options.
set snmp set snmp Device support This command is supported in all devices. Purpose Configures, enables, and disables a device server’s Simple Network Management Protocol (SNMP) agent, and displays current SNMP settings. Required permissions The root user can configure SNMP. Normal users can display SNMP settings.
set snmp contact=administrator A text string that identifies a contact person, usually an administrator. If there are spaces in the text, the entry must be surrounded by quotation marks. curr_thresh_exc_trap={on|off} Determines whether an SNMP trap is sent to the SNMP manager when the electrical current threshold on a power control device is exceeded. on The agent sends a trap when the threshold is exceeded. off A trap is not sent when the threshold is exceeded. The default is “off.
set snmp run={on|off} Specifies whether the SNMP daemon is started. on Starts the SNMP daemon. off The SNMP daemon will not start. The default is "off." set_request Displays a prompt of a password required to write to device server SNMP managed objects. The default is private. trap_dest=ipaddress The IP address of the system to which the agent should send traps.
set snmpauth set snmpauth Device support This command is supported in all devices. Purpose Configures or displays access permissions for Simple Network Management Protocol (SNMP) sets and gets. To produce the intended configuration results, follow these principles: • The default for SNMP is unlimited access (assuming a valid SNMP community). • You can configure a new default by removing the default entry in the snmpauth table (the entry that specifies an IP address of 0.0.0.0 and mask of 0.0.0.0).
set snmpauth Configure access for two IP addresses This example requires three commands: • The first removes the default entry from the snmpauth table, which changes the default setting from unrestricted access to no access. • The second and third commands restore access for the IP addresses specified. Note that if “mask” is not specified with “ip,” the mask defaults to 255.255.255.255. remove snmpauth range=1 set snmpauth ip=199.22.33.4 set snmpauth ip=199.22.33.
set sntp set sntp Device support This command is supported in PortServer TS 8/16 Family and PortServer TS 8/16 MEI Family devices only. Purpose Configures a Simple Network Time Protocol (SNTP) client. The purpose of the SNTP client is to get the current time from a Network Time Protocol (NTP) server and set the device’s clock with this time. Required permissions The root user can configure SNTP. Normal users can display SNTP settings.
set sntp Examples Display SNTP configuration #> set sntp Configure SNTP options #> set sntp state=on primary=192.168.0.
set socketid set socketid Device support This command is supported in all devices. Purpose Configures the serial port socket ID feature. Device servers support reverse Telnet and raw reverse Telnet connections, which enable remote users and applications to manage serial devices connected to device server ports. A socket ID is a text string that is sent at the start of a connection between a Digi device’s serial port and a remote host. This feature enables easier identification of the managed device.
set socketid verbose Displays the entire identification string when the string exceeds twenty characters. This option is not necessary for strings under twenty characters.
set switches set switches Device support This command is supported in PortServer TS 8/16 MEI Family devices only. Purpose Configures Multiple Electrical Interface (MEI) settings on a per-port basis, and displays current MEI settings. Required permissions The root user can configure MEI settings. Normal users can display MEI settings.
set switches txcontrol={alwayson|auto} Specifies how the 422/485 drivers should be connected to the lines. As the drivers support Tri-state mode, this option can be set so that transmitter is always on, or actively driving the line, or only on if data is to be transmitted. This option is only valid for four-wire configurations; that is, if the "wires" option is set to "four." In two-wire configurations, the PortServer TS MEI always uses "auto." alwayson The transmitter is always actively driving the line.
set switches pinout={standard|alternate} Allows selection of four-wire pinouts for EIA-422/485 mode. standard Use standard 10-pin settings, as shown in the following table. alternate Use alternate 8-pin settings, as shown in the following table. .
set switches See also • • • Chapter 2 "display" on page 59. The “display switches” command displays the current switch settings that were set by “set switches.” "revert" on page 79. The “revert switches” command reverts the “set switches” configuration. "set mei" on page 158. The “set mei allenables” command performs much the same action as “set switches enable={on|off}”.
set tcpip set tcpip Device support This command is supported in all devices. Purpose Configures or displays operating characteristics of the Transmission Control Protocol (TCP) for the Digi device, including the TCP port used by RealPort, the interval TCP waits before retransmitting an unacknowledged segment, how TCP handles idle connections, and socket service values for reverse Telnet connections. The command options “garp” and “rto_min” can be used to optimize for latency.
set tcpip ip_ttl=hops Sets the initial value of the IP time-to-live variable, which defines the maximum number of hops that a packet can survive before being discarded. The default is 64. keepalive_active={on|off} Enables or disables the keep-alive function. on Enables the keep-alive function. off Disables the keep-alive function. The default is "off." However, the keep-alive function can be turned on by an application regardless of this setting.
set tcpip rto_min=30-1000 The TCP maximum retransmission time out (RTO), in milliseconds. TCP uses progressively larger retransmit values, starting at a minimum value that is calculated from a sliding window of ACK response round-trip times that is bounded at the bottom by “rto_min.” So, essentially, “rto_min” is not necessarily the timeout that will be used as the starting retransmit timeout, but it is the smallest such value that could be used.
set telnetip set telnetip Device support This command is supported in all devices. Purpose Creates and displays entries in the Telnet IP address table. "set telnetip" creates configuration profiles for Telnet communication with particular devices. That is, "set telnetip" links an IP address to particular Telnet operating options. You can also use "set telnetip" to display current Telnet IP address table entries.
set telnetip Examples Display Telnet table entries #> set telnet Add an entry to Telnet table #> set telnet ip=199.86.5.56 mask=255.255.255.0 mode=none See also 218 • • "remove" on page 77 to remove entries from the Telnet table. "revert" on page 79. The “revert telnetip” option reverts the “set telnetip” configuration.
set terms set terms Device support This command is supported in all devices. Purpose Use the "set terms" command to: • Define terminal types and the escape sequence a terminal uses when initiating and maintaining multiple sessions. • Display entries in the term table. The "set terms" command configures a Digi device to handle terminals that are not connected over a network. Required permissions The root user can configure terminal settings. Normal users can display terminal settings.
set terms range=range The range of term table entries to display or remove. Examples Display entire term table #> set terms Display a range of entries in the term table #> set terms range=4-6 Configure a terminal type #> set terms termtype=Jet npages=4 clrseq=^! swtseq=1^] swtseq=2^[swtseq=3^} swtseq=4^{ See also 220 • • "remove" on page 77 to remove entries from the terms table. "revert" on page 79. The “revert terms” option reverts the “set terms” configuration.
set time set time Device support This command is supported in PortServer TS 8/16 Family and PortServer TS 8/16 MEI Family devices only. Purpose Configures or displays the time and date in a device. Required permissions The root user can configure the time and date. Normal users can display the current time and date. Syntax Configure time and date set time [{am|pm}] [date=mn .da y .
set timezone set timezone Device support This command is supported in PortServer TS 8/16 Family and PortServer TS 8/16 MEI Family devices only. Purpose Sets the time zone information for the device. It is necessary to set the time zone information when daylight saving is desired or when the device is using Simple Network Time Protocol (SNTP). Failure to set time zone when using SNTP will result in time always being set to the UTC/GMT time and not the local time.
set timezone dst_rule=date[/time],date[/time] The dates on which Daylight Saving Time (DST) occurs for a given time zone. The “time” and “date” values are specified as follows: time The time at which DST occurs. The time is specified as “hh:[mm[:ss]]” and defaults to 02:00. date The date at which DST occurs. The date can be specified using any of the following forms: Jn (1<=n <=365) Where January 1=1 and December 31=365, and February 29 is not included in the day count.
set trace set trace Device support This command is supported in all devices. Purpose Configures a device server for tracing, or displays tracing information. This command is intended to be used in cooperation with Digi Technical Support. Required permissions The root user can configure trace settings. Normal users can display trace settings. Syntax The syntax and available options for "set trace" may vary by product release.
set udpdest set udpdest Device support This command is supported in all devices. Purpose Configures destinations for serial over User Datagram Protocol (UDP) communication. These destinations are stored in the UDP destination table. The Digi One and PortServer TS devices are devices capable of UDP multicast. UDP multicast is used to send serial data over an Ethernet cable to one or many hosts at the same time.
set udpdest Options description=”string” A description of the destination, used for easy identification. This description can be up to 16 characters long. If it includes spaces, surround the entire string in quotation marks. ipaddress=dest ip The destination’s IP address. ipport=port The UDP port number that will be used for communication with the destination. port=serial port The port or ports on which the serial device or devices reside.
set udpserial set udpserial Device support This command is supported in all devices. Purpose Configures operating options for serial over User Datagram Protocol (UDP) communication, and displays current serial over UDP communication options. Required permissions The root user can configure serial over UDP options. Normal users can display serial over UDP options.
set udpserial delimiters=string The string in the serial data that tells the Digi device that the message is complete and should be forwarded to the destination. If you do not specify a delimiter, the Digi device will forward a message based on the number of bytes accumulated in the buffer (the "rmax" option.) and on the period to wait for the buffer to fill (the "rtime" option.). Rules and guidelines for specifying this string are as follows: • The string can be between 1 and 4 characters long.
set udpserial Examples Discard the message when the buffer fills In this example, the serial message will be forwarded to the destination when two consecutive tab characters are encountered in the data stream. If the buffer fills before this delimiter string is encountered, the message is discarded.
set user set user Device support This command is supported in all devices. However, the number of entries that can be stored in the user table varies by device: • The user table for PortServer TS 8/16 Family devices holds up to 64 entries. To accommodate additional users, PortServer TS 8/16 Family devices can use a RADIUS server. • The user table for Digi One Family and PortServer TS Family devices holds up to 9 users. Purpose Configures and displays user options.
set user [maxsessions=n um b er ] [menu={off|i n de x n um }] [mtu=by te s ] [n1, n2=p h on e n um b er ] [name=na me ] [netrouting={off|send|rec|both}] [netservice={on|off}] [network] [newname=s t ri ng ] [outgoing={on|off}] [p1,p2...
set user Options accesstime=time (PortServer TS 8/16 devices only) The period in which the user can access the device server. Use the "accesstime" option to restrict the user’s access to the time specified. To specify day or days and hours, use the keywords in the following table: Period Keyword Working week (Monday-Friday) wk Sunday su Monday mo Tuesday tu Wednesday we Thursday th Friday fr Saturday sa Specify hour ranges in the form: "hr:min-hr:min" or "hr-hr.
set user asyncmap=map A mask for PPP connections that defines which of the 32 asynchronous control characters to transpose. These characters, in the range 0x00 through 0x1f, are used by some devices to implement software flow control. These devices may misinterpret PPP transmission of control characters and close the link. This mask tells PPP which characters to transpose. The default is FFFF, which means transpose all 32 control characters. Any combination is valid.
set user autoservice={default|telnet|rlogin|raw} An alternate way to specify a TCP port for an autoconnect user (see the "autoport" option). Use this option only if you specify "autoconnect=on." Specify one of the following services: default Normally means the Digi device uses Telnet. The exception is if the "autoport" option is 0 or 513. In that case, rlogin is used. telnet Telnet connection. rlogin Remote login (rlogin) connection.
set user compression={vj|none} Specifies whether compression is used on PPP connections. vj Van Jacobsen header compression is used on PPP connections. none Header compression is not used on PPP connections. The default is "vj." connectesc={off|esc char} The escape character for users using the connect command. The default escape character is Ctrl [(Control key and left bracket). defaultaccess=service Restricts the service accessible to the user.
set user downdly=seconds The number of seconds the dialer script should delay before attempting to establish a PPP connection with a previously inaccessible host. The range is unlimited. The default is 0, which means do not delay in making the attempt to reconnect. flushstchar={default|on|off} Determines whether the first character of an autoconnection is discarded.
set user loadkey=host:key Configures an SSH2 public key for use with this user. This option applies to Digi One IAP and PortServer TS Family devices. host The IP address or DNS name of a host from which the SSH2 public key will be downloaded (using TFTP) to the Digi device. key The name of a DSA file on the host, which contains the SSH2 DSA public key. If your host’s implementation requires a complete path to this file, specify the path here as well.
set user maxsessions=number The maximum number of ports that a Telnet or Rlogin user can be logged into at the same time. A value of 0 means that the user can be simultaneously logged into all ports specified on the "ports" option. menu={off|index num} Specifies whether a menu is presented to the user, and if so, which menu. off and 0 (zero) No menu is presented to the user. index num The menu, identified by an index number in the menu table, that will be presented to this user. The default is "off.
set user netservice={on|off} Specifies whether PPP connections are allowed. on Allows PPP connections for the user. off Allows no PPP connections for the user. To configure inbound PPP users, you must specify "netservice=on." network Displays network-related options associated with the user specified on the "name" option. newname=string A new name for a previously defined user. outgoing={on|off} Specifies whether the user can initiate outgoing serial connections.
set user passpacket=filter The name of a filter designed to allow packets meeting filter criteria to pass through device server serial ports on PPP connections. password={on|off} Specifies whether a device server password is required of this user. on A device server password is required of this user. off A password is not required of this user. The default is "on." ports=ports A port or range of ports that this user can access.
set user range=range Identifies an entry or range of entries in the user table to display or remove. rloginesc=char A different escape character than the ~ (tilde) character. This character is used for disconnecting from the remote host. rmkey={on|off} Enables or disables the SSH2 public key defined on the "loadkey" option. on Enables the SSH2 public key defined on the "loadkey" option. off Disables the SSH2 public key defined on the "loadkey" option. The default is "on.
set user Examples Display entire user table #> set user Display a range of entries in the user table #> set user range=2-7 Display a single user #> set user ra=1 Configure an autoconnect user #> set user name=user4 autoconnect=on autohost=199.193.150.10 autoport=23 defaultaccess=autoconnect Configure an inbound PPP user #> set user name=pppin protocol=ppp defaultaccess=netservice netservice=on #> set user name=pppin ippaddr=ippool localipaddr=192.168.3.
set web set web Device support This command is supported in all devices that support the default Web user interface. Purpose Controls the timeout period for Web UI connections, or resets an active Web UI connection. The timeout period refers to an inactivity timeout, a configurable period after which a user will be logged out of the Web UI. The timeout is reset every time the user views a page.
set wlan set wlan Device support This command is available in PortServer TS W MEI Family devices only. Purpose Configures options for wireless devices and displays the status of wireless devices, by displaying entries in the wireless LAN (wlan) configuration table. Required permissions The root user can configure wireless options. Normal users can display the status of wireless devices.
set wlan auto_ssid={on|off} Specifies whether the wireless device automatically detects available Set Service Identifiers (SSIDs) or uses a configured SSID. on The wireless device automatically detects available SSIDs in its neighborhood, and arbitrarily selects an SSID. If the arbitrarily chosen SSID is using encryption that does not match the current encryption mode and encryption key, the device will be unable to associate with an access point. off The wireless device will use the configured SSID.
set wlan encryption_key1=key] encryption_key2=key] encryption_key3=key] encryption_key4=key] A zero, ten, or 26 digit (depending on encryption mode) hexadecimal encryption key. Ignored if "encryption_mode=none." Enter either zero digits (““), 10 digits, or 26 digits. No other lengths are accepted. If the key does not have the right number of digits for the current “encryption_mode,” or if the encryption key length is changed to zero and “authentication=shared_key,” a warning is displayed.
set wlan rts_threshold=threshold The number of bytes used for the RTS/CTS handshake boundary. The range is 0 through 3000. The default is 1600. ssid=id string The desired Set Service Identifier (SSID) for the wireless device. The SSID is an ASCII printable character string ranging from 1 through 32 bytes in length (excludes the backslash character “\”).
set wlan In addition to the configurable options and their current settings, "set wlan" displays the following information about the wireless device: access_points A list of detected access points including the following information for each: Channel, SSID, bssid, average noise level, average signal level. current_channel Indicates which channel is currently being used in the wireless device. current_link_status Indicates the current status for the link between the radio and the access point.
set wlan Display current settings for a wireless device #> set wlan The Wireless LAN is: Not Activated Diversity : tx_primary_rx_div Country Code : United States RTS Threshold : 1600 Fragmentation Threshold : 2346 Authentication : open_system Density : low Auto SSID : Off Desired SSID : “latency” Current SSID : “latency” Encryption Mode : none Current Channel : 1 Current Link Status : Associated Receive Signal Strength : 55 Current Transmit Speed : 11 Mb Radio Hardware Revision
set wlan See also • • 250 "revert" on page 79. The “revert wlan” command reverts the “set wlan” configuration. "show" on page 251.
show show Device support This command is supported in all devices Purpose Displays current configuration settings, and current versions of the Boot, POST, and OS components for a device. Required permissions Anyone can use this command. Syntax show option [range=range] Options option One of the following options: Displays events associated with... Works with "range" Option altip "set altip" setting yes arp "set arp" settings yes auth "set auth" settings yes boot The boot version.
show Displays events associated with...
show Displays events associated with... Works with "range" Option users "set user" settings yes versions The version of POST, Boot, and EOS running on the device server. no wlan "set wlan" settings no Option range=range A configuration table entry or range of entries. Examples Display current versions of POST, Boot and EOS #> show version Display settings for a particular user #> show user range=3 See also Chapter 2 "revert" on page 79.
status status Device support This command is supported in all devices. Purpose Displays the current list of sessions. This includes any session that was created by a "connect," "rlogin," or "telnet" command. Typically, the "status" command is used to determine which sessions to close. Required permissions Anyone can use this command. Syntax status Example In this example, the "status" command provides information on the user’s current Telnet session.
telnet telnet Device support This command is supported in all devices. Purpose Establishes a Telnet session with a remote system. To establish a character sequence to escape or shell-out of a Telnet session without killing the session, use the “set user” command’s “telnetesc=character” option. The default Telnet escape character sequence is ^] (Ctrl and right bracket). Required permissions Anyone can use this command.
telnet • • • • • 256 "rlogin" on page 83. "send" on page 85. "set user" on page 230. The “telnetesc=character” option sets a Telnet escape character sequence. "status" on page 254. "who" on page 261.
traceroute traceroute Device support This command is supported in all devices. Purpose Displays a list of routers through which an IP packet passes on its way to a particular destination. Required permissions Anyone can use this command. Syntax traceroute i p a dd r |na me Option ip addr | name Either the IP address or the DNS name of the host to which you want a route traced. Examples Trace a route using an IP address #> traceroute 199.150.150.
uptime uptime Device support This command is supported in all devices. Purpose Displays the amount of elapsed time since the last reboot. Required permissions Anyone can use this command.
wan wan Device support This command is supported in PortServer TS Family devices only. Purpose Initiates and controls wide-area network (WAN) connections, or displays the status of current WAN connections. Only incorrectly configured WAN interfaces produce a message in response to this command. If WAN interfaces are configured correctly, no message is returned. Required permissions Anyone can display the status of WAN connections. Root privileges are required to initiate or control WAN connections.
wan Examples Initiate a WAN connection #> wan start=user-ppp01 Close a WAN connection #> wan close=user-ppp01 Display WAN status information In this example, the wan command displays the status of the connection on port 2. #> wan range=2 See also 260 • • "set modem" on page 162. "set filter" on page 111.
who who Device support This command is supported in all devices. Purpose Displays a list of current users of the Digi device. For each user, information displayed includes from where the user is connected from (“Connected from”), the services to which they are connected (“Connected to”), and the number of connections open. Required permissions Anyone can use this command.
who • 262 "telnet" on page 255.
What Is Modem Emulation? Modem Emulation Commands Chapter 3 This chapter describes the commands that can be issued when Digi devices are configured in modem emulation mode. What Is Modem Emulation? Modem emulation enables a system administrator to configure a networked Digi device to act as a modem. The Digi device emulates modem responses to a serial device and seamlessly sends and receives data over an Ethernet network instead of a PSTN (Public Switched Telephone Network).
Common User Scenarios for Modem Emulation Common User Scenarios for Modem Emulation The Digi device in modem emulation mode allows for the easy replacement of modems in almost any environment where there is a LAN or WAN. User Scenario - Diagram A Workstation Serial cable DIG IO NE Digi device Ethernet Server 192.168.25.5 In Diagram A, the Digi device replaces a modem connected to a workstation running an application.
Common User Scenarios for Modem Emulation User Scenario - Diagram B Workstation Serial cable DIG IO NE Ethernet Workstation Digi device Serial cable DIG IO NE Digi device In Diagram B, two Digi devices will replace modems on both sides of the connection. The initiation of the connection occurs with either of the Digi devices. If both ends are Digi devices, the TCP listening port number is 50001 for port 1. An example of the connection command is: ATDT 192.168.25.
Connection Scenarios for Modem Emulation Connection Scenarios for Modem Emulation Modem emulation can involve the following types of connection scenarios: Outgoing Modem Emulation Connection In an outgoing modem emulation connection, a serial device sends an ATDx.x.x.x:y command, which triggers the Digi device to establish a connection to destination IP=x.x.x.x, port=y.
Modem Emulation AT Command Set Modem Emulation AT Command Set The following commands can be issued to perform actions in a modememulation configuration scenario. AT Command Function n+++n When in data mode, this command causes the modem to switch to command mode. The value of n corresponds to the required delay before and after the escape sequence is entered. The delay can be changed by modifying S-register 12. The escape character can be changed by modifying S-register 2.
Modem Emulation AT Command Set AT Command ATO ATQn Function Result Code Return to on-line data mode. If the modem is in the on-line command mode, the modem enters the on-line data mode. If the modem is in the off-line command mode (no connection), ERROR is reported. • O0, O1: If there is an active connection, switches the modem to data mode. OKn = 0 or 1 and a connection exists. ERROR Otherwise or if not connected. Quiet results codes control command.
S-Register Definitions AT Command AT&V Displays current values and settings. • AT&V0- AT&V5: Displays S-Register/command values for the current and stored configuration. • AT&Wn Result Code Function AT&V6: Displays current network settings. OK n=0 to 5 ERROR Otherwise OK n=0 or 1 ERROR Otherwise Store configuration. Stores the specified S-registers in flash memory. S-Register Definitions Following is a description of the S-registers that can be set.
S-Register Definitions Register S14 Function Range Units 138 (8Ah) General Options Status. Indicates the status of command options. • Default: 138 (8Ah) (10001010b) • Bit 0: Ignored. • Bit 1: Command echo (En): Default 0 = Disabled (E0). • 1 = Enabled (E1). (Default.) Bits 2 and 4: Quiet mode (Qn): 0 = Display result codes (Q0). (Default.) 1 = Do not display result codes (Q1). 2 = Disables “CONNECT” result codes (Q2). • 3 = Disables “CONNECT” result codes on incoming connections (Q3).
Result Codes Result Codes Following is a description of the return codes returned by modem emulation commands.
Result Codes 272 Chapter 3 Modem Emulation Commands
Index A AB/Client-Server Protocol 136 AB/DF1 Full Duplex 136 abbreviating commands 48 abcsp 136 abethernet 136 abort output signal 85 access control See security features access permissions configuring 91 displaying 91 access time 232 add line feed characters 68 address compression 232 admin command description 50 alert character 49 Allen-Bradley Client-Server Protocol (abethernet) 136 Allen-Bradley/DF1 Full-Duplex Protocol (df1fullduplex) 136 Allen-Bradley/DF1 Half-Duplex Protocol (df1halfduplex) 136 alte
upgrading firmware 45 configuration table removing entries from 77 configure a device 105 configure access for two IP addresses 92 configure buffers 93 configure mixed access 92 configure no access for an IP Address 92 configuring outbound PPP user 19 connect command 235 description 56 relationship to close command 54 connect session status 254 connections 259 console menu 102 control a device with a device range 74 control a device with an ID 74 copying the configuration to a host or terminal 58 country co
F filter bringup 21, 234 configuring 21, 111 criteria 21 displaying the filter table 111 for PPP connections 21 keepup 21, 236 logpacket 21 passpacket 240 using with TCP service ports 196 filter table creating entries in 111 displaying entries in 111 removing entries from 77 filters passpacket 21 flow control configuring 116 displaying current parameters 116 form-feed character 49 forwarding 120 frame protocol 64 FTP service 197 G go ahead signal 85 H hdial device type 171 help 47 help command description
logport feature 155 loose source routing 71 M match any character, escape sequence for 49 mbasc 136 mbrtu 136 mbtcp 136 MEI See Multiple Electrical Interface menu table configuring entries in 159 displaying entries in 159 removing entries from 77 menus configuring 159 configuring for users 238 displaying 159 removing 159 min device type 170, 171 mio device type 170, 171 Modbus 136 Modbus protocol displaying information for 65 set ia command 125 Modbus/ASCII protocol 136 Modbus/RTU protocol 136 Modbus/TCP p
closing connections 259 configuring 17 configuring connections by set user command 230 configuring inbound PPP user 242 configuring outbound PPP user 242 enabling and disabling connections for users 239 filters for connections 21 inbound connections for 17 initiating connections 259 negotiations 239 outbound connections for 19 protocol compression 240 users 17, 240 printers 170 prn device type 170, 172 protocol statistics for 64 protocol compression 240 protocols AB/Client-Server Protocol 136 AB/DF1 Full Du
security configuration reverting settings 80 security features configuring 35 configuring SSH version 2 encryption 41 controlling access to command line 37 controlling access to inbound ports 36 controlling access to outbound ports 37 controlling access to services 42 controlling access to the configuration 35 issuing user passwords 40 restricting access to inbound ports 37 using CHAP authentication for PPP users 37 using RADIUS to authenticate users 38 send command description 85 send information to the lo
displaying current settings reverting settings 80 set mei command description 158 displaying current settings set menu command 159 description 159 displaying current settings reverting settings 80 set modem command 162 description 162 displaying current settings reverting settings 80, 81 set netlogins command description 164 displaying current settings reverting settings 80 set netport command description 167 displaying current settings reverting settings 80 set pmodem command description 168 displaying cur
show ia all command 251 Simple Network Management Protocol (SNMP) configuring 201 set snmp command 201 Simple Network Time Protocol (SNTP) 206 simple ping 71 SMTP service 197 SNMP See Simple Network Management Protocol SNMP configuration reverting access permission (snmpauth) settings 80 reverting settings 80 snmpauth table removing entries from 77 SNTP See Simple Network Time Protocol socket ID feature 208 split horizon, configuring 122 S-Register definitions 269 SSH version 2 encryption 41 SSIDs 245 start
displaying entries in 244 wlan protocol 64 Index 281
