Copyright
Safety
FCC warning statement
Publishing history
This manual
Who should read this user manual?
Manual organisation
Types of users
Management console
Manual conventions
Where to find additional information
1. Installation
- 1.1. Models
- 1.2. Power connection
- 1.3. Network connection
- 1.4. Serial port connection
- 1.5. USB port connection
- 1.6. Fitting Cellular SIM and Antennas
- 1.7. Digital I/O & environmental sensors
2. System configuration
- 2.1. Management console connection
  - 2.1.1. Connected computer setup
  - 2.1.2. Browser connection
- 2.2. Administrator set-up
- 2.3. Network configuration
  - 2.3.1. IPv6 configuration
  - 2.3.2. Dynamic DNS (DDNS) configuration
- 2.4. Services and service access
  - 2.4.1. Brute force protection
- 2.5. Communications software
- 2.6. Management network configuration
3. Serial port, host, device & user configuration
- 3.1. Configure serial ports
- 3.2. Add & edit users
  - 3.2.1. Setup new group
  - 3.2.2. Setup new users
- 3.3. Authentication
- 3.4. Network hosts
- 3.5. Trusted networks
- 3.6. Serial port cascading
- 3.7. Serial port redirection (PortShare)
- 3.8. Managed devices
- 3.9. IPsec VPN
  - 3.9.1. Enable the VPN gateway
- 3.10. OpenVPN
- 3.11. PPTP VPN
- 3.12. Call home
- 3.13. IP passthrough
4. Firewall, failover, & OOB access
- 4.1. Dial-up modem connection
- 4.2. OOB dial-in access
- 4.3. Dial-out access
  - 4.3.1. Always-on dial-out
  - 4.3.2. Failover dial-out
- 4.4. OOB broadband ethernet access
- 4.5. Broadband ethernet failover
- 4.6. Cellular modem connection
- 4.7. Cellular operation
- 4.8. Firewalls & forwarding
5. SSH tunnels & SDT connector
- 5.1. Configuring for SSH tunnelling to hosts
- 5.2. SDT connector client configuration
- 5.3. SDT connector to management console
- 5.4. SDT connector: telnet or SSH connect to serially-attached devices
- 5.5. Using SDT connector for out-of-band connection to the gateway
- 5.6. Importing and exporting preferences
- 5.7. SDT connector public key authentication
- 5.8. Setting up SDT for remote desktop access
  - 5.8.1. Enable Remote Desktop on the target Windows computer to be accessed
  - 5.8.2. Configure the Remote Desktop connection client
- 5.9. SDT SSH tunnel for VNC
  - 5.9.1. Install & configure the VNC server on the computer to be accessed
  - 5.9.2. Install, configure & connect the VNC viewer
- 5.10. Using SDT to IP connect to hosts that are serially-attached to the gateway
- 5.11. SSH tunnelling using other SSH clients (for example, PuTTY)
- 5.12. VNC security
6. Alerts, auto-response & logging
- 6.1. Configure auto-response
- 6.2. Check conditions
- 6.3. Trigger actions
- 6.4. Resolve actions
- 6.5. Configure SMTP, SMS, SNMP & Nagios service for alert notifications
- 6.6. Logging
7. Power, environment, & digital I/O
- 7.1. Remote power control (RPC)
- 7.2. Uninterruptible power supply (UPS) control
- 7.3. Environmental monitoring
- 7.4. Digital I/O ports
8. Authentication
- 8.1. Authentication configuration
- 8.2. Pluggable authentication modules (PAM)
- 8.3. SSL certificate
9. Nagios integration
- 9.1. Nagios overview
- 9.2. Configuring Nagios distributed monitoring
- 9.3. Advanced distributed monitoring configuration
10. System management
- 10.1. System administration & reset
- 10.2. Firmware upgrades
- 10.3. Date & time configuration
- 10.4. Backup configuration
- 10.5. Delayed configuration commit
- 10.6. FIPS mode
11. Status reports
- 11.1. Port access & active users
- 11.2. Statistics
- 11.3. Support reports
- 11.4. Syslog
- 11.5. Dashboard
  - 11.5.1. Configuring the Dashboard
  - 11.5.2. Creating custom widgets for the Dashboard
12. Management
- 12.1. Device management
- 12.2. Port & host logs
- 12.3. Terminal connection
  - 12.3.1. Web terminal
  - 12.3.2. SDT connector access
- 12.4. Power management
13. Configuration from the command line
- 13.1. Accessing config from the command line
14. Advanced configuration
- 14.1. Custom scripting
- 14.2. Advanced PortManager
  - 14.2.1. PortManager commands
  - 14.2.2. External scripts & alerts
- 14.3. Raw access to serial ports
  - 14.3.1. Access to serial ports
  - 14.3.2. Accessing the console modem port
- 14.4. IP filtering
- 14.5. SNMP status reporting
- 14.6. Secure shell (SSH) public key authentication
- 14.7. Secure sockets layer (SSL) support
- 14.8. HTTPS
- 14.9. Power strip control
- 14.10. IPMItool
- 14.11. Custom development kit (CDK)
- 14.12. Scripts for managing slaves
- 14.13. SMS server tools
- 14.14. Multicast
- 14.15. Bulk provisioning
- 14.16. Zero touch provisioning
- 14.17. Internal storage
Appendix 1. Commands & source code
- Appendix 1.1. Commands
- Appendix 1.2. Source code
Appendix 2. Hardware specifications
- Appendix 2.1. Physical dimensions
- Appendix 2.2. Operating ranges
- Appendix 2.3. CPUs
- Appendix 2.4. Memory & storage
- Appendix 2.5. USB Ports
- Appendix 2.6. Serial ports
- Appendix 2.7. Ethernet ports
Appendix 3. Safety & certifications
- Appendix 3.1. Safety precautions
- Appendix 3.2. FCC warning statement
- Appendix 3.3. WEEE statement
Appendix 4. Connectivity, TCP ports & serial I/O
- Appendix 4.1. Serial port pinouts
- Appendix 4.2. Local console port
- Appendix 4.3. RS232 standard pinouts
- Appendix 4.4. Connectors included in console server
- Appendix 4.5. Other available connectors & adapters
- Appendix 4.6. TCP & UDB port numbers
- Appendix 4.7. Serial port pinouts: ACM5004-20-I, ACM5504-G-I, & ACM5508-2-I
Appendix 5. Terminology
Appendix 6. End-user license agreements
- Appendix 6.1. Opengear end-user license agreement
- Appendix 6.2. JSch license
- Appendix 6.3. GNU general public license (GPL), version 2
- Appendix 6.4. Wireless driver license
Appendix 7. Service & standard warranty
- Appendix 7.1. Standard warranty
- Appendix 7.2. RMA return procedure
- Appendix 7.3. Technical support
- Appendix 7.4. Limitation of Liability

Opengear IM7200 User Manual

Displayed below is the user manual for IM7200 by Opengear which is a product in the Console Servers category. This manual has pages.

Related Manuals

Opengear IM7200 Manual

User Manual

ACM5000 Remote Site Managers

ACM5500 Management Gateways

ACM7000 Resilience Gateways

IM7200 & IM4200 Infrastructure Managers

CM7100 Console Servers

Revision 4.3 2016-11-09

User Manual

Opengear User Manual. Page 4.

Informa!on in this document is subject to change without no!ce and does not represent a

commitment on the part of Opengear. Opengear provides this document “as is,” without

warranty of any kind, expressed or implied, including, but not limited to, the implied

warran!es of ﬁtness or merchantability for a par!cular purpose.

Opengear may make improvements and/or changes in this manual or in the product(s) and/or

the program(s) described in this manual at any !me. This product could include technical

inaccuracies or typographical errors. Changes are periodically made to the informa!on herein;

these changes may be incorporated in new edi!ons of the publica!on.

Safety

Follow the safety precau!ons below when installing and opera!ng the console server:

• do not remove the metal covers. There are no operator serviceable components inside.

Opening or removing the cover may expose you to dangerous voltage which may cause ﬁre

or electric shock. Refer all service to Opengear-qualiﬁed personnel.

• to avoid electric shock the power cord protec!ve grounding conductor must be connected

through to ground.

• always pull on the plug, not the cable, when disconnec!ng the power cord from the socket.

• do not connect or disconnect the console server during an electrical storm.

It is recommended you use a surge suppressor or UPS to protect the equipment from

transients.

Proper back-up systems and necessary safety devices should be u!lized to protect against

injury, death or property damage due to system failure. Such protec!on is the responsibility of

the user.

This console server device is not approved for use as a life-support or medical system.

Any changes or modiﬁca!ons made to this console server device without the explicit approval

and consent of Opengear will void Opengear of any liability or responsibility of injury or loss

caused by any malfunc!on.

This equipment is for indoor use only. All the console’s communica!on wirings are limited to

use inside of a building.

FCC warning statement

This device complies with Part 15 of the FCC rules. Opera!on of this device is subject to the

following condi!ons: (1) This device may not cause harmful interference, and (2) this device

must accept any interference that may cause undesired opera!on.

Opengear User Manual. Page 5.

Publishing history

date

2010/01

2010/03

2010/06

2010/08

2010/12

2011/06

2011/10

2011/11

2012/02

2012/04

2012/07

2012/12

2013/04

2013/09

2013/10

2014/01

2014/03

2014/07

2014/09

2014/10

2015/01

2015/02

2015/06

2015/11

2016/03

2016/04

2016/06

2016/07

2016/09

2016/11

3.8.4

3.8.5

3.9

3.9.1

4.0

4.1

4.2

4.3

4.4

4.5

4.6

4.7

4.8

4.9

4.10

4.11

4.12

4.13

4.14

4.15

4.16

4.17

4.18

4.19

4.20

4.21

4.22

4.23

4.24

4.3

so!ware

3.1

3.2

3.3

3.4

3.5

3.5.2

3.5.2u3

3.5.2u14

3.5.3

3.6

3.7

3.8

3.9

3.10

3.11

3.12

3.15

3.15.1

3.16

3.16.2

3.16.4u2

3.16.5u1

models

SD4001

ACM5004-G

ACM5004-I

IM4216-34

ACM5500

SD4001 rev-01 &

CM4001/4008 EoL.

ACM5504-5-G-W-I

& IM4004-5 EoL.

IM7200

IM7208 &

DDC models

CM7100

CM4100 EoL.

ACM7000

SD4000 EoL.

ACM7004-5

ACM7004-5 RSG

IM7216-2-24U-DAC

features

ﬁxed Failover details & added DDNS.

Shadow password, °F, SNMP, SMS gateway.

OpenVPN, Zenoss, conﬁg commit, & Call

Home.

Firewall router, Web Terminal, & SNMP

updates.

GPS, SNMP monitoring & IPv6, 32-port

models, & SMS over cellular.

Auto-Response.

PPTP, GRE, Groups, FTP server, mul!ple dial-

in, & pmshell.

Kerberos, Cisco RJ in SD4000, & remove KCS.

Cellular redial.

SMS ARM, simple key, & Services page.

Authen!cated NTP.

4G LTE support.

Dual SIM, SNMP DIO, bulk provisioning, &

WEEE.

Connec!on Manager network management

backend & Auto-Response extensions.

New SNMP MIB, OpenLDAP, & LDAPS.

New Manage Devices UI & brute force

protec!on.

IP Passthrough

ZTP

Unauthen!cated SSH & mul!carrier cellular.

Minor document cleanup.

Link Layer Discovery Protocol (LLDP).

disabling AAA accoun!ng UI.

ZTP (conﬁgura!on over DHCP) & USB

consoles.

Edits, Copy-edits and re-format throughout.

Opengear User Manual. Page 6.

This manual

The Opengear User Manual describes the features and capabili!es of the following Opengear

product lines, and provides instruc!ons to best take advantage of them:

Remote Management Gateways

ACM5504-5-G/GV-W-I ACM5508-2

ACM5504-5-G/GV-I ACM5508-2-M

ACM5504-5-LA/LR/LV-I ACM5008-2-P

ACM7005-4

Remote Site Managers

ACM5002-F-E ACM5004-F-E and -G, -GV, -GS, and -LR models

ACM5003-M-F-E ACM5004-2-I with cellular support.

Infrastructure Managers

IM7248-2-DAC and -LA, -LR, and -LV models

IM7232-2-DAC with 4G LTE.

IM7216-2-DAC

Infrastructure Managers

IM4248-2-DAC IM4216-2-DAC and -G and -GV models

IM4248-2-DDC IM4216-2-DDC with cellular support.

IM4232-2-DAC IM4216-34-DAC

IM4232-2-DDC IM4216-34-DDC

IM4208-2-DAC

Console Servers

CM7116-2-DAC

CM7132-2-DAC

CM7148-2-DAC

Each of these products is referred to generically in this manual as a console server.

Where appropriate, product groups may be referred to as console servers, gateways or by

speciﬁc product line name or product group (for example the IM4200 family or the ACM5500).

Who should read this user manual?

You should read this manual if you are responsible for evalua!ng, installing, opera!ng, or

managing an Opengear appliance. This manual assumes you are familiar with the internal

network of your organiza!on, and are familiar with the Internet, IP networks, HTTP, FTP and

basic security opera!ons.

Opengear User Manual. Page 7.

Manual organisa"on

The Opengear User Manual is structured as follows:

1. Introductory material An overview of the console server’s features

and informa!on regarding this manual.

2. Installa!on Physical installa!on of the console server and

the interconnec!ng of managed devices.

3. System conﬁgura!on Ini!al installa!on and conﬁgura!on of the

console server and the supported services.

4. Serial port, host, device & user conﬁgura!on Conﬁguring serial ports and connected

network hosts, and se$ng up users.

5. Firewall, failover, & OOB access Set up the ﬁrewall and the high availability

access features of the console server.

6. SSH tunnels & SDT connector Secure remote access using SSH and con-

ﬁgure for RDP, VNC, HTTP, HTTPS &c access

to network- and serially-connected devices.

7. Alerts, auto-response & logging Set up local and remote event and data logs.

Conﬁgure auto-responses to trigger events.

8. Power, environment, & digital I/O Manage USB, serial and network a%ached

power strips and UPS supplies. Also EMD

environmental sensor conﬁgura!on.

9. Authen!ca!on Access to the console server requires

authenitcated usernames and passwords.

10.Nagios integra!on Set Nagios central management. Conﬁgure

console server as a distributed Nagios server.

11.System management Access to and conﬁgura!on of services to be

run on the console server.

12.Status reports The dashboard summary and detailed status

and logs of serial and network connected

devices (ports, hosts, power and environment).

13.Management Port controls and user-accessible reports.

14.Conﬁgura!on from the command line Command line installa!on and conﬁgura!on

using the conﬁg command.

15.Advanced conﬁgura!on Advanced command line conﬁgura!on

ac!vi!es using Linux commands.

16.Appendices Command deﬁni!ons, speciﬁca!ons,

cer!ﬁca!ons, terminology deﬁni!ons,

licenses, service and warranty details.

The most recent version of this manual is always at h%p://opengear.com/support/

documenta!on/.

Opengear User Manual. Page 8.

Types of users

The console server supports two classes of users:

1. First there are administra!ve users, who have unlimited conﬁgura!on and management

privileges over the console server; and all the connected devices.

Administra!ve users are set up as members of the admin user group. Users in this class are

referred to in this manual as Administrators. An Administrator can access and control the

console server using the conﬁg u!lity, the Linux command line or the browser-based

Management Console. By default, the Administrator has access to all services and ports to

control all the serial connected devices and network connected devices (hosts).

2. The second class of users embraces those who have been set up by an Administrator with

speciﬁc limits of their access and control authority. These users are set up as members of

one of the pre-conﬁgured user groups (pptpd, dialin, &p, pmshell or users) or another user

groups an Administrator has added.

They are only authorized to perform speciﬁed controls on speciﬁc connected devices and

are referred to as Users. These Users (when authorized) can access serial or network

connected devices; and control these devices using the speciﬁed services (eg Telnet,

HHTPS, RDP, IPMI, Serial-over-LAN, Power Control).

An authorized User also has a limited view the Management Console and can only access

authorized conﬁgured devices and review port logs.

In this manual, when the term user (lower case) is used, it is referring to both classes of users

above. This document also uses the term remote users to describe users who are not on the

same LAN segment as the console server.

These remote users may be users, who are on the road connec!ng to managed devices over

the public Internet. They may be an Administrator in another oﬃce connec!ng to the console

server itself over the enterprise VPN. Or the remote user may be in the same room or the

same oﬃce but connected on a separate VLAN to the console server.

Management console

The features of your console server are conﬁgured and monitored using the Opengear

Management Console. When you ﬁrst browse to the Management Console, you can use the

menu displayed on the le& side to conﬁgure the console server. Once you have completed

the ini!al conﬁgura!on, you can con!nue to use the Management Console runs in a browser

and provides a view of the console server and all the connected devices.

Opengear User Manual. Page 9.

Administrators can use the Management Console, either locally or from a remote loca!on, to

conﬁgure and manage the console server, users, ports, hosts, power devices and associated

logs and alerts.

Users can also use the Management Console, but have limited menu access to control select

devices, review their logs and access them using the in-built Web terminal or control power to

them.

The console server runs an embedded Linux opera!ng system, and experienced Linux and

UNIX users may prefer to undertake conﬁgura!on at the command line.

You can gain command line access by cellular, dial-in, or by directly connec!ng to the console

server’s serial console port (aka the console server’s modem port). The shell can also be

accessed by using ssh or Telnet to connect to the console server over a LAN (or by connec!ng

with PPTP, IPsec or OpenVPN).

Manual conven"ons

The Opengear User Manual uses typeface ‘colour’ to dis!nguish between diﬀerent so&ware

elements.

• Procedure steps are denoted with bullet-points like this.

• Bullet-pointed text is also, on occasion, used to present related items in a list.

Bold text in a procedure indicates a user interface element you click on or navigate to.

Italic text in a procedure indicates a user interface element that references a variable you can

change or set.

Italics are also used in the standard typographic fashion to indicate a formal name (the book "tle in

the ﬁrst paragraph of this sec"on, for example). The phrase ‘console server’ — when referring to any

of Opengear’s hardware products — is also italicised throughout.

Links, both to external resources and to other places in the manual are set in blue.

Mono-spaced type indicates a file-name or shell-based interface

element, such as a bash script or application that runs from the

bash shell or the Windows command-line. If you might enter the mono-

spaced string at a shell-prompt or in a text-editor, it will be set

thus.

Note: Not a user-interface element. Indented text set in italics and preﬁxed with the word ‘Note:’ is

text to pay speciﬁc a"en#on to. The Opengear User Manual equivalent to the rare but now

famous phrase ‘hic sunt dracones’ (here be dragons).

Where to ﬁnd addi"onal informa"on

1. The Quick Start Guide that came with your console server.

This provides instruc!ons for the installa!on and conﬁgura!on of Opengear hardware.

2. The Opengear Knowledge Base at h%ps://opengear.zendesk.com/.

This online resource includes technical how-to ar!cles, !ps, FAQs and important

no!ﬁca!ons.

Opengear User Manual. Page 10.

1.Installa!on

1.1. Models

This chapter describes how to install the console server hardware, and connect it to controlled

devices.

There are mul!ple families and models, each with a diﬀerent number of network/serial/USB

ports or power supply and wireless conﬁgura!ons.

Opengear User Manual. Page 11.

model

ACM5002-F-E

ACM5004-F-E

ACM5003-M-F-E

ACM5004-G(S/V)-E

ACM5004-G(S/V)-I

ACM5004-2-I

ACM5504-5-G(V)-I

ACM5504-5-G-W-I

ACM5504-5-Lx-I

ACM5508-2

ACM5508-2-I

ACM5508-2-M

ACM5508-2-L-I

ACM7004

ACM7004-5

ACM7008-2

IM4248-2-DAC/DC

IM4232-2-DAC/DC

IM4216-2-DAC/DC

IM4208-2-DAC/DC

IM4216-34-DAC/DC

IM7208-2-DAC

IM7216-2-DAC

IM7232-2-DAC

IM7248-2-DAC

serial

232

232/422/485

usb

network

100

1000

ﬂash

console

n/a

v.92 modem

n/a

internal

n/a

internal

n/a

internal

wireless

n/a

wap, 3g

n/a

3g opt

n/a

wap, 4g opt

sensors

temp/probes

temp & D I/O

n/a

temp & D I/O

external

rj pinout*

00/01/02

01/02

power

ext ac/dc

dual ac/dc

Opengear User Manual. Page 12.

IM7200-series models have dual 10/100/1000 LAN ports with two RJ45 ports and two SFP ﬁber module slots.

CM7100-seris modesl have dual 10/100/1000 RJ45 LAN ports.

*The RJ pinout values in the model table translate as follows:

00 Opengear Classic.

01 Cisco Rolled.

02 Cisco Straight.

model

IM7216-2-24U-DAC

CM7148-2-SAC

CM7116-2-SAC

CM7148-2-DAC

CM7132-2-DAC

CM7116-2-DAC

serial

232

232/422/485

usb

1 2

network

100 1000

ﬂash

console

v.92 modem

internal

n/a

wireless

wap, 3g, 4g

n/a

sensors

external

rj pinout*

01/02

power

dual ac/dc

single ac

dual ac

Opengear User Manual. Page 13.

The varuous product families support diﬀerent so&ware features.

1.ACM500x-2, ACM550x-2, ACM5504-5 models only.

2.Selected models have 3G/4G cellular, Wi-Fi Wireless Access Points (WAP) or both.

3.ACM5002-F-E, ACM5003-M-F-E and ACM5004-F-E models only.

Note: To avoid physical and electrical hazard please read appendix 3 on Safety

The sec!ons below show the components shipped with each of these models.

1.1.1. ACM5000 kit components

Unpack the ACM5000 kit and verify you have all the parts shown above, and that they all

appear in good working order. The ACM5004-G has an external 3G aerial to be a%ached.

Connect the ACM5000 to the network, the serial ports of the controlled servers and AC

power as shown below.

1.1.2. ACM5500 kit components

component

ACM5002-F-E, ACM5003-M-F-E,

ACM5004-F-E & ACM5004-2-I

Remote Site Manager (plus –SDC

op!ons and -G/GV/GS models with

cellular support)

2 x Cable UTP Cat5 blue

Cisco Connector DB9F-RJ45

straight and DB9F-RJ45 cross-over

Power Supply 12VDC 1.0A Wall mount

Quick Start Guide

part #s

440016

3190014

3190015

4500XX

539000

model

ACM5000

ACM5500

ACM7000

IM4200

IM7200

CM7100

dhcp

yes

ddns

yes

mgt lan

yes¹

yes

cell or wi-ﬁ

yes²

oob

yes

auto-

response

yes

ﬂash

(!p & %tp)

yes³

yes

ﬁp

yes

ipsec, pptp &

openvpn

yes

component

ACM5504-5-G/GV-W-I, ACM5504-5-

G/GV-I, ACM5504-5-LA/LR/LV-I,

ACM5508-2 ACM5508-2-L-I,

ACM5508-2-M and ACM5008-2-P

Remote Management Gateway

2 x Cable UTP Cat5 blue

part #s

440016

Opengear User Manual. Page 14.

Unpack the ACM5500 kit and verify you have all the parts shown above, and that they all

appear in good working order.

The ACM5004-5-G(V)-I and ACM5504-5-LA/LR/LV-I models come with an external cellular

aerial to be a%ached. The ACM5004-5-G(V)-W-I also has an external 802.11 wireless aerial to

be a%ached.

Connect the ACM5500 to the network, serial and USB ports of the controlled devices,

environmental monitors and AC power as shown below.

1.1.3. ACM7004-2, ACM7004-5, ACM7008-2 kit components

1.1.4. ACM7005-4 Remote Site Gateway kit components

component

ACM7004-2-LA, ACM7004-2-LR,

ACM7004-2-LV, ACM7004-2-LMA,

ACM7004-2-LMV, ACM7004-2-

LMCR, ACM7004-2-LMCT,

ACM7008-2-LMA, ACM7008-2-LMV,

ACM7008-2-LMR, ACM7008-2-

LMCR, ACM7008-2-LMCT,

ACM7004-5-LMA, ACM7004-5-LMV,

ACM7004-5-LMCR, ACM7004-5-

LMCT

2 x 4G LTE blade antennas

DB9F-to-RJ45 crossover serial adapter

12V switching DC power supply

Rack kit (1 tab, 1 ear, 2 rack screws, 2

nuts, 4 screws)

Quick Start Guide

part #s

569028

319015

450031

590003

520085

Cisco Connector DB9F-RJ45

straight and DB9F-RJ45 cross-over

Power Supply 12VDC 1.0A Wall mount

Quick Start Guide

3190014

3190015

4500XX

539000

component

ACM7004-5 Remote Site Gateway

DB9F-to-RJ45 crossover serial adapter

12V switching DC power supply

Rack kit (1 tab, 1 ear, 2 rack screws, 2

nuts, 4 screws)

Quick Start Guide

part #s

319015

450031

590003

520085

Opengear User Manual. Page 15.

1.1.5. IM4208-2, IM4216-2, IM4232-2, IM4248-2, & IM4216-34 kit components

Unpack the IM4200 (IM4208-2, IM4216-2, IM4232-2, IM4248-2 Infrastructure Manager or

IM4216-34 Management Gateway) kit and verify you have all the parts shown above, and

that they all appear in good working order.

If you are installing the IM4200 in a rack you will need to a%ach the rack moun!ng brackets

supplied with the unit, and install the unit in the rack. Take care to heed the safety

precau!ons listed in appendix 3.

Connect the IM4200 to the network, to the serial ports of the controlled devices, and to

power as outlined below.

1.1.6. IM7208-2, IM7216-2-24U, IM7232-2, & IM7248-2 kit components

Unpack the IM7200 kit and verify you have all the parts shown above, and that they all

appear in good working order.

If you are installing the IM7200 in a rack you will need to a%ach the rack moun!ng brackets

supplied with the unit, and install the unit in the rack. Take care to heed the safety

precau!ons listed in appendix 3.

component

IM7248-2-DAC, IM7232-2-DAC,

IM7216-2-24U-DAC, IM7216-2-DAC

and IM7208-2-DAC Infrastructure

Managers (and -LA/LR/LV models with

4G LTE)

2 x Cable UTP Cat5 blue

Cisco Straight and Rolled Connectors

DB9M/F -RJ45

Dual IEC AC power cord (DAC models

only)

Quick Start Guide

part #s

440016

319014

319015

319016

319017

319018

319019

440001

539001

component

IM4216-2 Infrastructure Manager

IM4248-2 Infrastructure Manager

IM4208-2 Infrastructure Manager

IM4216-34 Management Gateway

2 x Cable UTP Cat5 blue

DB9F-RJ45S straight adapter and

DB9F-RJ45S cross-over adapter

Dual IEC AC power cord (DAC models

only)

Quick Start Guide

part #s

509006

509007

509008

509009

440016

319000

319001

440001

539001

Opengear User Manual. Page 16.

Connect the IM7200 to the network, to the serial ports of the controlled devices, and to

power as outlined below.

Note: The IM7208-2-DDC, IM7216-2-DDC, IM7232-2-DDC and IM7248-2-DDC products are

DC powered and the kits do not include an IEC AC power cord.

1.1.7. CM7116-2, CM7132-2 and CM7148-2 kit components

Unpack the CM7116-2 (or CM7132-2/CM7148-2) kit and verify you have all the parts shown

above, and that they all appear in good working order.

If you are installing the CM7116-2 (or CM7132-2/CM7148-2) in a rack you will need to

a%ach the rack moun!ng brackets supplied with the unit, and install the unit in the rack. Take

care to heed the safety precau!ons listed in appendix 3.

Connect the CM7116-2 (or CM7132-2/CM7148-2) to the network, to the serial ports of the

controlled devices, and to power as outlined below.

1.2. Power connec"on

1.2.1. All IM7200, IM4200, & CM7100 –DAC models

These standard IM7200, IM4200 and CM7100 console servers all have dual universal AC

power supplies with auto failover built in. These power supplies each accept AC input voltage

between 100 and 240 VAC with a frequency of 50 or 60 Hz and the total power consump!on

per console server is less than 30W.

Two IEC AC power sockets are located at the rear of the metal case, and these IEC power

inlets use conven!onal IEC AC power cords. Power cords for various regions are available,

although the North American power cord is provided by default. There is a warning no!ce

printed on the back of each unit.

Note: To avoid electrical shock the power cord grounding conductor must be connected to ground.

1.2.2. All ACM5000 & ACM7000 models

All ACM5000 models are supplied with an external AC-12V DC wall-mount power supply.

This comes with a selec!on of wall socket adapters for each geographic region (North

component

CM7116-2 Console Server, CM7132-2

Console Server and CM7148-2

Console Server

2 x Cable UTP Cat5 blue

Cisco Connector DB9F-RJ45

straight and DB9F-RJ45 cross-over

Dual IEC AC power cord

Quick Start Guide

part #s

440016

319014

319015

440001

539001

Opengear User Manual. Page 17.

American, Europe, UK, Japan or Australia). The 12V DC connector from the power supply unit

plugs into the 12V DC (PWR) power jack on the side of the console server casing.

• Plug in the power supply AC power cable and the DC power cable.

• Turn on the AC power and conﬁrm the console server Power LED

(PWR) is lit.

The ACM5000 models can also be powered from an external +9V DC

to +30V DC power source by connec!ng the DC power lines to a

power plug that plugs into the 12VDC (PWR) jack.

The industrial ACM5004-2-I model can also be powered externally by

connec!ng a +9 to +30V DC power source to the DC PWR and GND

connectors on the green screw terminal block on the side of the unit.

Note: All ACM5000 models can also be ordered with the -SDC op#on. These

units are supplied with an external DC-DC power converter. This converter

has an integrated power cable/connector that plugs into the 12VDC (PWR)

connector on the ACM5000. The input voltage for the DC-DC converter is

plus or minus 36V DC to 72V DC

1.2.3. All ACM5500 models

All the ACM5500 models are supplied with an external AC-12VDC wall mount power supply.

This comes with a selec!on of wall socket adapters for each geographic region (North

American, Europe, UK, Japan or Australia). The 12V DC connector from the power supply unit

plugs into the 12VDC (PWR) power jack on the side of the console server casing.

• Plug in the power supply AC power cable and the DC power cable.

• Turn on the AC power and conﬁrm the console server Power LED (PWR) is lit.

The ACM5500 models can also be powered via an external +9V DC to +30V DC power

source. Connect the DC power lines to a power plug that plugs into the 12VDC (PWR) jack.

The ACM5500 can also be powered via an external 9V AC to 24V AC power source to this

jack.

The industrial ACM5508-2-I and ACM5504-5-G-

I models also can be powered externally by

connec!ng a +9 to +30V DC power source to

the EXT 9-30V DC and GND connectors on the

green screw terminal block on the side of the

unit.

Note: An external DC-DC power converter can be ordered as an accessory with

any ACM5500 remote management gateway. This converter has an

integrated power cable/connector that plugs into the 12VDC (PWR)

connector on the ACM5500. The input voltage for the DC-DC converter is

plus or minus 36V DC to 72V DC.

1.2.4. IM7200-DDC & IM4200-DDC

The -DDC model console servers all have dual DC power supplies with auto failover built in. To

Opengear User Manual. Page 18.

connect to the DC input supply:

• Strip the DC wire insula!on to expose approximately 10 mm (0.4˝) of conductor.

• Connect the safety ground wire to the ‘E’ safety ground terminal on the terminal block ﬁrst.

The DDC is ﬂoa!ng (with regards to Earth), however the safety terminal on the three way

screw terminal block connects to Earth or Chassis Ground.

• Connect the power wires to the appropriate terminals of the terminal block.

The + terminal on the four way screw terminal block should always be connect to the more

posi!ve voltage (from 0V to +48 V).

The - terminal on the four way screw terminal block should connect to the more nega!ve

voltage (from -48V to 0V).

So the connec!ons for -48 Volt DC input power are:

The connec!ons for +48 Volt DC input power are:

• Tighten the terminal screw to a torque of 0.93 ± 0.05 N⋅m (8.0 ± 0.5 in⋅lbf).

• Repeat the connec!on steps above for the second power supply.

• Turn on the DC power.

Note: The safety covers are an integral part of the DDC product. Do not operate the unit without

the safety cover installed.

Note: Any exposed wire lead from a DC-input power source can conduct harmful levels of

electricity. So ensure that no exposed por#on of the DC-input power source wire extends

from the terminal block plug and safety cover.

1.3. Network connec"on

All Opengear console servers all ship with Ethernet ports.

These ports are located on the front panel of the rack-mount IM4200 units; the rear panel of

the rack-mount CM7100 units; and on the side of the smaller ACM7000, ACM5500 and

ACM5000 units. All physical connec!ons are made using industry standard Cat5 cabling and

connectors.

Ensure you only connect the LAN port to an Ethernet network that supports 10/100, or

10/100/1000 (IM7200, CM7100, ACM7000 only).

Opengear User Manual. Page 19.

The IM7200 has four physical input ports which are logically presented as two ports (NET1 &

NET2). Each logical port consists of a copper 10/100/1000 port and a ﬁber-op!c small form-

factor pluggable (SFP) module slot.

The ACM7004-5 has six physical input ports: an SFP port and an RJ45 port on the front of

the device which are logically paired and marked as NET1; and four RJ45 ports on the back of

the device which cons!tute an independent Ethernet switch and which are marked as NET2.

On all devices with logically-paired SFP and RJ45 ports, you can use only one of the two

physical ports at a !me: either the SFP module port or the 10/100/1000 port.

As well, and again on all console servers with logically-paired SFP and RJ45 ports, the ﬁber-

op!c medium (ie, the SFP module) has priority over the copper medium (ie the RJ45 port).

Only if the SFP module is not plugged in, does the RJ45 copper link becomes ac!ve. This

applies regardless of the connec!on order. If the SFP module is plugged in a&er the copper

medium has established a link, the copper link is disconnected and the ﬁber-op!c medium

becomes ac!ve.

For the ini!al conﬁgura!on of the console server you must connect a computer to the

console server’s principal network port. This port is labeled NET1 (on IM7200 and CM7100),

NETWORK1 (on IM4200), LAN1 (on ACM7000 and ACM5500) and LAN USB1 (on

ACM5000).

1.4. Serial port connec"on

Console servers all come with one to forty eight serial ports, marked SERIAL or SERIAL PORTS.

These ports connect to serially Managed Devices. Each console server also has either a

dedicated Local Console (or modem) port marked LOCAL or CONSOLE, or one or its SERIAL

ports can be so&ware conﬁgured in Local Console mode. This Local Console port can be used

for local command line access (or external serial modem out of band connec!on).

All console server models except the ACM5000, ACM5500 and ACM7000 have a dedicated

local RS232 Console port. This is a DB9 connector located on the front of the IM4200

models, and a RJ45 connector (Cisco Straight) located on the front of the IM7200 and

CM7100 models.

ACM5000, ACM5500 and ACM7000 models have two, three, four, or eight serial ports

presented as RJ45 ports 1–x. By default, port 1 on all these models is conﬁgured in Local

Console mode.

Conven!onal Cat5 cabling with RJ45 jacks is generally used for serial connec!ons. Opengear

supplies a range of cables and adapters that may be required to connect to the more popular

servers and network appliances.

These are also overviewed in appendix 4. More detailed informa!on is available online at

h%ps://opengear.zendesk.com/forums/21087337-cabling.

Before connec!ng the console port of an external device to the console server serial port,

conﬁrm that the device does support the standard RS-232C (EIA-232).

The console servers come with one to forty eight serial connectors for the RS232 serial ports:

The RJ45 serial ports are located on the front face of the ACM5000 and ACM5500; on the

rear of the ACM7000; on the front panel of the rack mount IM4200; and on the rear panel of

the rack mount IM7200.

Opengear User Manual. Page 20.

The ACM5000, ACM5500, ACM7000, CM7100 and IM4216-34 models have Cisco Straight

serial pinouts on the RJ45 connectors (see chapter 1.4.3 below).

All serial ports on the IM7200 are RJ45 and are so&ware selectable for Cisco Straight or Cisco

Rolled pinout.

The IM4200 family is available with a selec!on of alternate RJ45 pinouts e.g. the IM4208-2,

IM4216-2 and IM4248-2 console servers have three RJ45 pinout conﬁgura!ons available:

Opengear Classic, Cisco Straight or Cyclades/Cisco Rolled (see chapter 1.4.1).

These alternate pinouts need to be speciﬁed in the part number at the !me of order e.g. to

order an IM4248-2 dual power supply AC USA model, specify:

IM4248-2-DAC-X2-US for a unit equipped with Cisco Straight RJ pinouts (straight through

cable).

IM4248-2-DAC-X1-US for a unit equipped with Cyclades/Cisco Rolled RJ pinouts (rolled

cable connec!on).

IM4248-2-DAC-X0-US for a unit equipped with Opengear Classic RJ pinouts.

Some console server models support RS-422 and RS-485 as well as RS-232.

The four RJ45 serial ports on the ACM5004-2-I and ACM5504-5-G-I are each

RS-232/422/485 so&ware selectable as are the eight RJ45 serial ports on the ACM5508-2-I.

See appendix 4 for RS422/485 pinout and connec!on details.

In summary:

1.The ﬁrst serial port can be reassigned to be a console port.

1.4.1. Opengear Classic RJ45

The IM4200 console servers are also available with this RJ45 pinout as an op!on:

model

ACM500x

ACM5004-I

ACM550x

serial ports

2,3,4

4,8

connector

pinout

X2 Cisco

rs232

yes

rs422/485

yes

console port

no¹

signal

RTS

DSR

deﬁni"on

request to send

data set ready

direc"on

output

input

Opengear User Manual. Page 21.

1.4.2. Cisco Rolled (Cyclades) RJ45 pinout (op"on -X1)

The IM4200 console servers are available with this RJ45 pinout op!on. The IM7200 console

servers can select this pinout. This makes it easy to replace Avocent Cyclades products, and is

convenient for use with rolled RJ45 cable:

1.4.3. Cisco RJ45 pinout

The ACM5000, ACM5500, ACM7000, CM7100 and IM4216-34 models have Cisco serial

pinouts on its RJ45 connectors. The IM4200 console servers are also available with this RJ45

pinout. The IM7200 console servers can select this pinout (it is the default). This provides

straight through RJ45 cable to equipment such as Cisco, Juniper, Sun, and many more:

1.5. USB port connec"on

Most console servers have external USB ports. IM7200s have USB 3.0 ports. On other models

these ports are mostly USB 2.0. They can be used for:

connec!ng to UPS or PDU managed devices (for managing UPS supplies, for example).

connec!ng an external USB memory s!ck

DCD

RXD

TXD

GND

DTR

CTS

data carrier detect

receive data

transmit data

signal ground

data terminal ready

clear to send

input

output

n/a

output

input

signal

RTS

DTR

TXD

GND

CTS

RXD

DCD

DSR

deﬁni"on

request to send

data terminal ready

transmit data

signal ground

clear to send

receive data

data carrier detect

data set ready

direc"on

output

n/a

input

signal

CTS

DSR

RXD

GND

TXD

DTR

RTS

deﬁni"on

clear to send

data set ready

receive data

signal ground

transmit data

data terminal ready

request to send

direc"on

input

n/a

output

Opengear User Manual. Page 22.

connec!ng to USB Consoles. NB: IM4200/ACM5xx/550x support 2 Cisco Consoles only.

Some console server models also have a USB1.1 port and this is best reserved for use with an

external USB memory s!ck dedicated to recovery ﬁrmware boot images, extended log ﬁle

storage or both.

All the IM4200-X models with internal cellular have one USB1.1 port on the front face and

one USB 2.0 port at the rear face. This USB2.0 port uses a micro-AB USB connector so an

adapter cable is also included. These models also have 16GB ﬂash installed internally via a

USB 2.0 ﬂash drive for improved logging

All the other models in the IM4200-X family (IM42xx-2-DxC-Xx models such as IM4208-2-

DAC-X0, IM4248-2-DDC-X2 and IM4216-34-DAC-X2) have one USB1.1 port on the front

face and two addi!onal USB 2.0 ports at the rear face (adjacent to modem jack). These

IM4200-X models also have an internal 16GB ﬂash drive

The IM7216-2-24U, like all other IM7200-series models, has two front-facing USB 3.0 ports.

The IM7216-2-24U also has 24 rear-facing USB 2.0 ports. These rear-facing USB ports are

presented as serial ports 17–40 and support USB console connec!ons to devices from a wide

range of vendors, including Cisco, HP, Dell and Brocade. Moreover, and aside from their u!lity

as USB connec!ons, all IM7216-2-24U USB ports can func!on as plain RS-232 serial ports

when a USB-to-serial adapter is connected.

The IM7216-2-24U’s two front-facing USB ports are presented as Front, Upper USB and

Front, Lower USB respec!vely. And, although these two ports can also be used as serial ports

with a USB-to-serial adapter, in most instances it is expected the front-facing ports will be

used on the IM7216-2-24U as they are used on other IM7200-series models: to connect to

USB consoles on UPS supplies or Cisco devices; and for in-situ ﬂash drive a%achment to load

updated ﬁrmware or saved conﬁgura!on ﬁles.

Some console server models also come with internal USB connec!ons to cellular modem and/

or ﬂash memory.

The ACM5500 models all have an internal 4GB USB ﬂash drive as well as two unallocated

external USB2.0 ports.

The ACM7000 models all have an internal 4GB USB ﬂash drive as well as four unallocated

external USB2.0 ports. These four unallocated USB ports are labelled 1 – 4 on the device

itself and in the Web interface. Note: a handful of ACM-7004-5s were manufactured with

physical labels A – D on the four USB ports. If you have such an ACM-7004-5, be aware the

Web interface s!ll denotes them as USB ports 1 – 4, as it does with other 7000-series

devices.

The ACM5000 models have two USB2.0 ports. However one or both of these may be pre-

allocated internally. For example the ACM5004-G has one internal USB commi%ed for the

cellular modem adapter, so there is only one external USB port free. Similarly with ACM5004-

F-E model an internal USB ﬂash is ﬁ%ed, using up one of the two USB2.0 ports.

1.6. Fi&ng Cellular SIM and Antennas

The ACM5504-5-G-W-I, ACM5504-5-G-I, ACM5004-G-E and ACM5004-G-I models each

have an internal 3G cellular modem that requires at least one (or more) SIM cards to be

installed and at least one external cellular antenna to be a%ached. The ACM5000-GV/GS and

ACM5500-GV/GS models also have an internal cellular modem requiring external antenna

Opengear User Manual. Page 23.

connec!on. However the Verizon and Sprint 3G networks do not require a SIM card.

Similarly the IM4200-2-DAC-X2-G and IM4216-34-DAC-X2-G models have an internal 3G

cellular modem that requires a SIM card and external antenna. The IM4200-2-DAC-X2-GV/

GS and IM4216-34-DAC-X2-GV/GS models also have an internal cellular modem requiring

external antenna connec!on however they do not require a SIM card.

The ACM5504-5-LA/LR/LV-I, ACM7004-2-LA/LR/LV, ACM5004-LR, ACM5004-LR-I and

IM7200-LA/LR/LV/LM-I models all have an internal 4G LTE cellular modem that requires at

least one SIM card to be installed and two external cellular antennas to be a%ached.

The ACM5504-5-G-W-I and all IM7200 models also have an internal 802.11 wireless modem

that requires at least one external WiFi antenna to be a%ached.

1.6.1. ACM5004 -G & -L models

The ACM5000 -GV/-GS/-G work with Verizon USA, Sprint

USA and global GSM carriers including AT&T USA,

respec!vely. The ACM5000 -LR models work with global

GSM carriers (outside the USA). Your carrier will provide you

with a SIM card for ac!va!ng you data plan (-G models only).

Note: you must install the SIM card before powering on the

device.

Unscrew the cover plate on the side of the insert the SIM

into the SIM garage then screw the cover plate back on.

Note: take care to inset with contacts facing upwards as shown.

Screw the provided antenna on to the MAIN SMA antenna connector on the rear of the unit.

Then place the unit and/or aerial in a loca!on that will ensure the

best signal.

These models come with dual SMA antenna connectors. The AUX

connector can be used for receive diversity. This requires an

external antenna (accessory Part# 569006) and cable (Part#

449041).

With -I models, the AUX connector can also be used for GPS. An

external GPS passive antenna with magne!c base, SMA connector

and 2 meter cable is available (Part # 569008).

These models have two cellular status LEDs. The SIM LED on top of unit should go on solid

when powered and a SIM card has been inserted and detected.

The WWAN LED on top of the unit should go on at a fast blink once a radio connec!on has

been established with your cellular carrier (that is, a&er an APN has been properly conﬁgured).

WWAN LED Status:

Oﬀ: in reset mode or not powered.

Slow blink: searching for service.

Solid Green: ac!ve service; no traﬃc detected.

Fast Blink: ac!ve service; traﬃc (blink propor!onal to traﬃc detected).

Opengear User Manual. Page 24.

1.6.2. ACM5500 -G models

The ACM5500 -GV/-GS/-G work with Verizon USA, Sprint USA and global GSM carriers

including AT&T USA, respec!vely. Your carrier will provide you with a SIM card for ac!va!ng

you data plan (-G models only).

Note: you must install the SIM card before powering on the device.

-G-I models can hold two SIM cards from alternate carriers,

however only requires one SIM to operate. Unscrew the SIM card

access panel and insert the ﬁrst carrier SIM card in the bo%om SIM

slot. A second carrier SIM

can also be installed in the

slot above the ﬁrst. Screw the cover plate back on.

Note: Take care to insert the SIM cards with contacts

facing downward and the notch to the right-hand

side.

Screw the provided cellular antenna on to the main

Cell (M) connector on the rear of the ACM5504-G-I.

Then place the unit and/or aerial in a loca!on that

will ensure the best signal. The ACM5504-5-G-I has

a second SMA antenna connector. This Cell (A)

connector can be used for receive diversity. This

requires an external antenna (accessory Part#

569006) and cable (Part# 449041).

The ACM5504-5-G-I has a second SMA antenna connector. This Cell (A) connector can be

used for receive diversity. This requires an external antenna

(accessory Part# 569006) and cable (Part# 449041).

Alternately, the Cell (A) connector can be used for GPS. An

external GPS passive antenna with magne!c base, SMA

connector and 2 meter cable is available (Part # 569008).

The ACM5504-5-G(V)-W-I models have an internal 802.11 WiFi

adapter and come with an external WiFi antenna. Screw wireless

antenna on to the main WIFI (M) connector.

The ACM5504-5-G(V)-W-I has a second WiFi antenna

connector. This WIFI (A) connector can be used for diversity and

requires an external antenna (part # 569011).

1.6.3. ACM5500 -L models

The ACM5500 -LA/-LV/-LR models work with AT&T USA, Verizon USA, or global 4G LTE

carriers respec!vely. Your carrier will provide you with a SIM card for ac!va!ng you data plan.

-LR models can hold two SIM cards from alternate carriers, however only one SIM is required.

Note: you must install the SIM card before powering on the device.

Unscrew the SIM card access panel and insert the ﬁrst carrier SIM

card in the bo%om SIM slot. A second carrier SIM can also be

Opengear User Manual. Page 25.

installed in the slot above the ﬁrst.

Note: double check you inserted the SIM card in the bo"om SIM slot with contacts facing

downward and the notch to the right-hand side. Then replace the SIM card access panel.

ACM5500-L models are supplied with two external 7-band cellular antennas. Screw the

provided antennas on to the main Cell (M) and diversity Cell (A) SMA connectors on the rear

panel.

An external GPS passive antenna with magne!c base, SMA connector and 2 meter cable is

available (Part #569008). It is screwed on to the GPS SMA connector on the rear panel.

1.6.4. ACM7000 -L models

‘-L’ model ACM7000s come with internal 4G LTE modems and either single (ACM7004-2-LA

and ACM7004-2-LR) or dual (all other ‘-L’ ACM7000-series models) mini-SIM card slots.

The -LA and -LMA models work with AT&T USA. The -LV and -LMV models work with Verizon

USA. And the -LR and -LMR models work with global 4G LTE carriers. NB: -LM models are

also mul!-carrier. The ACM7004-5-LMA, for example, works with AT&T USA by default but

can be re-set to work with Verizon USA. Likewise with a model like the ACM7008-2-LMV: it

works with Verizon USA by default but can be re-set to work with AT&T USA.

Whichever carrier you choose, their SIM card ac!vates the data

plan and must be installed before powering on the device.

On single-SIM models, simply slide the carrier’s SIM card into the

slot on the front of the device, making sure the contacts are facing

upwards and the notch is poin!ng outwards as the card slides into place.

Dual-SIM models use a SIM cradle. The cradle holds the SIM card or cards and slides into the

dual-SIM-card slot on the front of the device. The bo%om slot is the default slot. If you have a

dual-SIM ACM7000 and only one SIM card, insert the card into the bo%om slot of the SIM

cradle. No ma%er the speciﬁc conﬁgura!on, SIM cards go into the cradle with the contacts

upwards and the notch inward and adjacent to the longer cradle arm.

ACM7000 -L models also come with two external 7-band celluar antennas. Screw the

provided antennas on to the main Cell (M) and diversity Cell (A) SMA connectors on the rear

panel. An external GPS passive antenna with magne!c base, SMA connector and 2 meter

cable is available (Part #569008). It is screwed on to the GPS SMA connector on the rear

panel.

1.6.5. IM4200 -G models

The IM4200-2-DAC-X2/X0-G and IM4216-34-DAC-X2-G models have an internal 3G-GSM

HSUPA/UMTS cellular modem (and an internal 16GB ﬂash memory and an addi!onal USB

port at the rear). They are also supplied with an external antenna with extension cable, and a

USB adapter cable. They work with global GSM carriers.

Before powering on the console server:

• Your carrier will provide you with a

SIM card. Insert the SIM card (1). It

will lock into place.

Opengear User Manual. Page 26.

Note: Take care to insert SIM with contacts facing downward.

• Screw the external antenna coax cable onto the MAIN screw mount SMA connector on the

rear of the console server (2).

• The AUX connector can be used either for receive diversity (requires external antenna

Part# 569006 and cable Part# 449041) or for GPS (requires external GPS passive antenna

with cable Part# 569008).

The IM4200-2-DAC-X2/X0-GV/GS and IM4216-34-DAC-X2-GV/GS models also have an

internal cellular modem (and an internal 16GB ﬂash memory and an addi!onal USB port at

the rear). They do not require a SIM card, but the supplied external antenna is installed as

above. These models work with Verizon USA and Sprint USA respec!vely.

1.6.6. All IM7200 models

All the IM7200 models have an internal 802.11 WiFi adapter and come with an external WiFi

antenna.

Before powering on the IM7200:

• Screw wireless antenna on to the WIFI (MAIN) SMA connector.

The IM7200 has a second WiFi antenna connector. This WIFI (AUX) connector can be used

for diversity and requires an external antenna (part #569022).

1.6.7. IM7200 -L models

The IM7200- LA, LV, LR, LMA, and LMV models have a SIM card slot and three SMA cellular

antenna connectors (for cellular with receive diversity and GPS).

LA models work with AT&T USA. LV models work with Verizon USA. LR models work with

global 4G LTE carriers. LMA models default to AT&T but are mul!carrier in the United States

and also work with Verizon. LMV models default to Verizon but are mul!carrier in the United

States and also work with AT&T.

Included in the kit are two cellular antennas (with one 10 foot coaxial cable and magne!c

antenna screw mount base for moun!ng outside the rack). If cellular signal strength is an

issue, higher gain and direc!onal antennas can be sourced.

Before powering on the IM7200 -LA/-LV/-LR:

• Screw one antenna (or antenna cable) onto the CELL (MAIN) screw mount (1) and the

diversity antenna, onto the CELL (AUX) connector.

Note: if you have purchased a GPS antenna, screw it on to GPS.

• Your carrier will provide you with a SIM card. Insert the card into the SIM CARD slot and it

Opengear User Manual. Page 27.

will lock into place (2).

Note: Take care to insert SIM card with contacts facing downwards.

1.7. Digital I/O & environmental sensors

ACM5000 or ACM5500 models with an -I in the model number or ACM5000 models with the

-E op!on ship with an external green connector block for a%aching environmental sensors

and digital I/O devices.

Plug in this block and screw in any external devices.

On the ACM5508-2-I, ACM5504-5-G-I, ACM5504-5-LA/LR/LV-I, ACM5004-2-I, ACM5004-

G/LR-I models this block can also be used for connec!ng the external DC power source.

ACM7000 models ship with an in-built, black, spring cage I/O connector block for a%aching

environmental sensors and digital I/O devices. It cannot be used for connec!ng an external

DC power source.

See chapter 7 for further details.

Opengear User Manual. Page 28.

2.System conﬁgura!on

This chapter provides step-by-step instruc!ons for the ini!al conﬁgura!on of your console

server, and connec!ng it to the Management or Opera!onal LAN. This involves the

Administrator:

• ac!va!ng the Management Console.

• changing the Administrator password.

• se$ng the IP address console server’s principal LAN port.

• selec!ng the services to be enabled and access privileges.

This chapter also discusses the communica!ons so&ware tools that the Administrator may use

in accessing the console server, and the conﬁgura!on of the addi!onal LAN ports.

Note: for guidance on conﬁguring large numbers of Opengear appliances and/or automa#ng

provisioning, please consult the sec#ons en#tled ‘Bulk Provisioning and Zero Touch

Provisioning’.

2.1. Management console connec"on

Your console server comes conﬁgured with the following default IP address and subnet mask:

• IP address: 192.168.0.1.

• Subnet mask: 255.255.255.0.

For ini!al conﬁgura!on it is recommended the console server be connected directly to a single

Opengear User Manual. Page 29.

computer.

If you choose to connect the console server and computer to a LAN before comple!ng the

ini!al setup steps the following condi!ons must be met:

• there must be no other devices on the LAN at IP address 192.168.0.1.

• the console server and the computer must be on the same LAN segment, with no

interposed router appliances.

2.1.1. Connected computer setup

To conﬁgure the console server with a browser, the connected PC/worksta!on should have an

IP address in the same range as the console server (for example, 192.168.0.100):

To conﬁgure the IP address of a computer running Linux, macOS, or Unix:

• run ifconfig.

To conﬁgure the IP address of a computer running Windows:

• Click Start -> (Se!ngs ->) Control Panel and double click Network Connec"ons (for

Windows 95/98/Me, double-click Network).

• Right-click on Local Area Connec"on and select Proper"es.

• Select Internet Protocol (TCP/IP) and click Proper"es.

• Select Use the following IP address and enter the following details:

IP address: 192.168.0.100

Subnet mask: 255.255.255.0

• If you want to retain your exis!ng IP se$ngs for this network connec!on, click Advanced

and add the above details as a secondary IP connec!on.

If it is not convenient to change your computer’s network address, you can use the ARP-

Ping command to reset the console server’s IP address. To do this from a computer running

Windows:

• Click Start -> Run (or select All Programs > Accessories > Run).

• Type cmd and click OK to bring up the cmd.exe shell prompt .

• Type arp –d to ﬂush the ARP cache.

• Type arp –a to view the current ARP cache (this should be empty).

Opengear User Manual. Page 30.

Now add a sta!c entry to the ARP table and ping the console server to assign the IP address

to the console server.

In the example below, a console server has the MAC Address 00:13:C6:00:02:0F (designated

on the label on the bo%om of the unit) and its IP address is set to 192.168.100.23.

Note: the computer issuing the arp command must be on the same network segment as the

console server (that is, have an IP address of 192.168.100.xxx).

• On Windows: type arp -s 192.168.100.23 00-13-C6-00-02-0F

• On Linux, macOS or Unix: type arp -s 192.168.100.23 00:13:C6:00:02:0F

• Type ping -t 192.18.100.23 to start a con!nuous ping to the new IP Address.

• Turn on the console server and wait for it to conﬁgure itself with the new IP address. It will

start replying to the ping at this point.

• Type arp –d to ﬂush the ARP cache again.

2.1.2. Browser connec"on

Launch or switch to your preferred browser on the connected computer and enter https://

192.168.0.1.

Note: Console servers ship with a self-signed SSL cer#ﬁcate and are factory conﬁgured with

HTTPS access enabled and HTTP access disabled.

The Management Console supports all current versions of the popular browsers: Internet

Explorer, Firefox, Chrome, Safari and more.

You will be prompted to log in.

• Enter the default administra!on username and administra!on password:

Opengear User Manual. Page 31.

Username: root

Password: default

A Welcome page, which lists ini!al conﬁgura!on steps, will display.

These steps are:

• Change default administra!on password (Users page. See chapter 2.2.)

• Conﬁgure the local network se$ngs (System/IP page. See chapter 2.3.)

• Conﬁgure serial ports se$ngs (Serial & Network/Serial Port page. See chapter 3.)

• Conﬁgure user port access (Serial & Network/Users page. See chapter 3.)

If your system has a cellular modem steps to conﬁgure the cellular router features will also

present:

• Conﬁgure the cellular modem connec!on (System/Dial page. See chapter 4.)

• Allow forwarding to the cellular des!na!on network (System/Firewall page. See chapter 4.)

• Enable IP masquerading for cellular connec!on (System/Firewall page. See chapter 4.)

A&er comple!ng each of the above steps, return to the conﬁgura!on list by clicking the

Opengear logo in the top le& corner of the page.

Note: if you are not able to connect to the Management Console at 192.168.0.1 or if the default

Username and Password were not accepted then reset your console server (See chapter

10).

2.2. Administrator set-up

2.2.1. Change default root system password

For security reasons, only the administra!ve user named root can ini!ally log into a console

server. So only those people who know the root password can access and reconﬁgure the

console server itself.

The corollary is that anyone who correctly guesses the root password can gain access and

control of a console server. And the ini!al root password is default. It is essen!al, therefore to

Opengear User Manual. Page 32.

enter and conﬁrm a new password before giving the console server any access to, or control

of, other computers and network appliances.

• Select Change default administra"on password from the Welcome page.

• The Serial & Network > Users & Groups page loads. From here a new, conﬁrmed password

for the root user can be set.

Note: There are no character restric#ons in a console server user’s password. And passwords can

be up to 254 characters long. Only the ﬁrst eight characters are used to make the password

hash, however.

• If the console server has ﬂash memory (such as the IM7200) you will be given the op!on to

Save Password across ﬁrmware erases.

Checking this will save the password hash in the non-vola!le conﬁgura!on par!!on, which

does not get erased on ﬁrmware reset. Take care as if this password is lost, however. In

such an event, the aﬀected console server will need to be ﬁrmware recovered.

• Click Apply.

Since the root password has changed a new log-in prompt will present. This !me use the

new password.

2.2.2. Setup a new administrator

A new Administrator user should be setup and this new user should be used for ongoing

console server administra!on, rather than relying on the root user.

This new user can be conﬁgured in the admin group with full access privileges by selec!ng

Serial & Network > Users & Groups >Add a New User (see chapter 2.2 for details).

Opengear User Manual. Page 33.

2.2.3. Name the system

• Select System > Administra"on.

• Enter a System Name and System Descrip"on for the console server to give it a unique ID and

make it simple to iden!fy.

Note: The System Name can contain from 1 to 64 alphanumeric characters as well as the following

special characters . - _. There are no restric#ons on the characters that can be used in

the System Descrip#on, which can contain up to 254 characters.

•Op!onal: text entered in the MOTD Banner ﬁeld is displayed to users when the log-in to

the console server.

• Click Apply.

Note: If you are not conﬁdent your console server has been supplied with the current release of

ﬁrmware, you can upgrade it. (See chapter 10 for details.)

2.3. Network conﬁgura"on

The next step is to enter an IP address for the principal Ethernet (LAN/Network/Network1)

port on the console server; or enable its DHCP client so that it automa!cally obtains an IP

address from a DHCP server on the network it is to be connected to.

• On the System > IP menu select the Network Interface page then check DHCP or Sta"c for

the Conﬁgura"on Method.

• If you selected Sta"c you must manually enter the new IP Address, Subnet Mask, Gateway

and DNS server details. This selec!on automa!cally disables the DHCP client.

• By default the console server LAN port auto detects the Ethernet connec!on speed. To lock

the Ethernet port to 10 Mb/s or 100Mb/s and to Full Duplex (FD) or Half Duplex (HD)

select a speed and duplex se$ng from the Media pop-up menu.

If you encounter packet loss or poor network performance with the default auto-

nego!a!on se$ng, try manually se$ng the Media se$ngs on both the console server and

Opengear User Manual. Page 34.

the device it is connected to. In most cases, select 100baseTx-FD (100 megabits, full

duplex). Make sure both sides are set iden!cally.

• If you selected DHCP the console server will look for conﬁgura!on details from a DHCP

server. This selec!on automa!cally disables any sta!c address. The console server’s MAC

address can be found on a label on the base plate.

In its factory default state (with no Conﬁgura"on Method selected) the console server has its

DHCP client enabled, so it automa!cally accepts any network IP address assigned by a

DHCP server on your network. In this ini!al state, the console server will then respond to

both its Sta!c address (192.168.0.1) and its newly assigned DHCP address.

You may also enter a secondary address or comma-separated list of addresses in CIDR

nota!on as an IP Alias. For example: 192.168.1.1/24.

Note: If you changed the console server’s IP address, you may need to reconﬁgure your computer

so it has an IP address that is in the same network range as this new address (as detailed

earlier in this chapter).

• Click Apply.

• Reconnect the browser on the computer that is connected to the console server by

entering https://new-ip-address-here/.

2.3.1. IPv6 conﬁgura"on

By default, the console server Ethernet interfaces support IPv4. They can also be conﬁgured

for IPv6 opera!on, however.

• Select System > IP.

• Click the General Se#ngs tab.

• Check the Enable IPv6 check box.

• Click the Network Interface to access the IPv6 se#ngs sec!on.

Opengear User Manual. Page 35.

• Conﬁgure the IPv6 se#ngs.

2.3.2. Dynamic DNS (DDNS) conﬁgura"on

With Dynamic DNS (DDNS) a console server which IP address is dynamically assigned (and

that may change from !me to !me) can be located using a ﬁxed host or domain name.

• The ﬁrst step in enabling DDNS is to create an account with the supported DDNS service

provider of your choice. Supported DDNS providers include:

Note: Two previously supported DDNS providers are ODS, which is no longer opera#ng, and TZO,

which was bought by Dyn and is no longer opera#ng independently.

Upon registering with the DDNS service provider, select a username and password, as well as

a hostname that you will use as the DNS name (to allow external access to your machine

using a URL).

Dynamic DNS service providers allow the user to choose a hostname URL and set an ini!al IP

address to correspond to that hostname URL. Many Dynamic DNS providers oﬀer a selec!on

of URL hostnames available for free use with their service. However, with a paid plan, any

URL hostname (including your own registered domain name) can be used.

You can now enable and conﬁgure DDNS on any of the Ethernet or cellular network

connec!ons on the console server (by default DDNS is disabled on all ports):

• Select the DDNS service provider from the drop down Dynamic DNS list on the System >

IP or System > Dial menu.

• In DDNS Hostname enter the fully qualiﬁed DNS hostname for your console server (for

example, your-hostname.dyndns.org.

provider

DyNS

Dyn

GNUDip

Pubyun

url

h%p://dyns.cx/

h%ps://dyn.com/

h%p://freecode.com/projects/

gnudip

h%p://pubyun.com/

notes

formerly DynDNS.

An open-source DDNS tool for use by

ISPs. Check if your ISP supports GNUDip.

Chinese DDNS provider. Formerly

operated as 3322.org.

Opengear User Manual. Page 36.

• Enter the DDNS Username and DDNS Password for the DDNS service provider account.

• Specify the Maximum interval between updates in days. A DDNS update will be sent even if

the address has not changed.

• Specify the Minimum interval between checks for changed addresses in seconds. Updates

will s!ll only be sent if the address has changed.

• Specify the Maximum a$empts per update (that is, the number of !mes to a%empt an

update before giving up). By default this is set to 3.

2.4. Services and service access

The Administrator can access the console server, connected serial ports, and managed devices

using a range of access protocols and services. For each such access:

• the par!cular service must ﬁrst be conﬁgured and enabled to run on the console server.

• then access through the ﬁrewall must be enabled for each network connec!on.

To enable and conﬁgure a service:

• Navigate to System > Services.

• Select the Service Se!ngs tab.

Opengear User Manual. Page 37.

Note: With ﬁrmware releases prior to version 3.5.3, services are enabled and conﬁgured using the

Service Access tab on the System > Firewall page.

• Enable and conﬁgure basic services.

•HTTP

By default the HTTP service is running and it cannot be fully disabled. However by default

HTTP access is disabled on all interfaces and it is recommended this access remains

disabled, if the console server is to be remotely accessed over the Internet.

Alternate HTTP also enables you to conﬁgure an alternate HTTP port to listen on.

However the HTTP service will con!nue internally listening on TCP port 80 (for CMS and

sdt-connector communica!ons) but will be inaccessible through the ﬁrewall.

•HTTPS

By default the HTTPS service is running and this service is enabled on all network

interfaces. It is recommended that only HTTPS access be used if the console server is to be

managed over any public network (e.g. the Internet). This ensures the Administrator has

secure browser access to all the menus on the console server. It also allows appropriately

conﬁgured Users secure browser access to selected Manage menus. For informa!on on

cer!ﬁcate and user client so&ware conﬁgura!on see chapter 8, Authen!ca!on.

The HTTPS service can be completely disabled (or re-enabled) by checking HTTPS Web

Management and an alternate port speciﬁed (default port is 443).

•Telnet

By default the Telnet service is running. However by default the service is disabled on all

network interfaces.

Telnet can be used to give the Administrator access to the system command line shell.

While this may be suitable for a local direct connec!on over a management LAN, it is

recommended this service be disabled if the console server is to be remotely administered.

This service may also be useful for local Administrator and the User access to selected

serial consoles.

The Enable telnet command shell checkbox will completely enable or disable the telnet

service. An alternate telnet port to listen on can be speciﬁed in Alternate Telnet Port

(default port is 23).

•SSH

This service provides secure SSH access to the console server and a%ached devices – and

by default the SSH service is running and enabled on all interfaces. It is recommended you

choose SSH as the protocol where the Administrator connects to the console server over

the Internet or any other public network. This will provide authen!cated communica!ons

between the SSH client program on the remote computer and the SSH sever in the console

server. For more informa!on on SSH conﬁgura!on see chapter 8, Authen!ca!on.

The Enable SSH command shell checkbox will completely enable or disable this service. An

alternate SSH port to listen on can be speciﬁed in SSH command shell port (default port is

22).

• Enable and conﬁgure other services.

Opengear User Manual. Page 38.

•TFTP/FTP

If a USB ﬂash card or internal ﬂash is detected on a console server (for example, an

ACM5000, ACM5500, ACM7000, CM7100, IM7200 or IM4200) then checking Enable

TFTP (FTP) service will enable this service and set up default *tp and &p server on the USB

ﬂash.

These servers are used to store conﬁg ﬁles, maintain access and transac!on logs etc. Files

transferred using tftp and ftp will be stored under /var/mnt/storage.usb/

tftpboot/ (or /var/mnt/storage.nvlog/tftpboot/ on ACM7000-series devices).

Unchecking Enable TFTP (FTP) service will completely disable the TFTP (FTP) service.

•DNS Relay

Checking Enable DNS Server/Relay will enable the DNS relay feature so clients can be

conﬁgured with the console server’s IP for their DNS server se$ng, and the console server

will forward the DNS queries to the real DNS server.

•Web Terminal

Checking Enable Web Terminal will allow web browser access to the system command line

shell via Manage > Terminal.

• Specify alternate port numbers for Raw TCP, direct Telnet/SSH and unauthen!cated

Telnet/SSH services.

The console server uses speciﬁc default ranges for the TCP/IP ports for the various access

services that Users and Administrators can use to access devices a%ached to serial ports

(see chapter 3, ‘Serial port, host, device & user conﬁgura!on’). The Administrator can also

set alternate ranges for these services, and these secondary ports will then be used in

addi!on to the defaults.

The default TCP/IP base port address for telnet access is 2000, and the range for

telnet is IP Address: Port (2000 + serial port #), thais is ports 2001 – 2048.

For example, if the Administrator sets 8000 as a secondary base for telnet then serial

port #2 on the console server can be accessed via telnet at IP Address:2002 and at IP

Address:8002.

The default base for SSH is 3000; for Raw TCP the default base is 4000; and for RFC2217

it is 5000.

A number of other services can be enabled and conﬁgured indirectly from this menu by

selec!ng Click here to conﬁgure:

•Nagios

Access to the Nagios NRPE monitoring daemons (see chapter 9).

•NUT

Access to the NUT UPS monitoring daemon (see chapter 10).

•SNMP

This will enable netsnmp in the console server. SNMP is disabled by default (see chapter 6

and chapter 14.5).

Opengear User Manual. Page 39.

•NTP

See chapter 10.

• Click Apply.

As you apply your services selec!ons, the screen will be updated with a conﬁrma!on

message: Message Changes to conﬁgura"on succeeded.

The Services Access se$ngs can now be set to allow or block access.

This speciﬁes which (enabled) services the Administrator can use over each network interface

to connect to the console server and, through the console server, to a%ached serial and

network connected devices.

• Navigate to System > Services.

• Select the Service Access tab.

Note: With ﬁrmware releases pre 3.5.3 the Service Access tab is found at System > Firewall.

The services currently enabled for the console server’s network interfaces present. Depending

on the par!cular console server model the interfaces displayed may include :

Network interface for the principal Ethernet connec!on).

Management LAN/OOB Failover second Ethernet connec!ons).

Dialout/Cellular V90 and 3G modem.

Dial-in internal or external V90 modem.

Wi-Fi 802.11 wireless.

VPN IPsec or Open VPN connec!on over any network interface.

Opengear User Manual. Page 40.

• Check or uncheck for each network to which service access is to be enabled or disabled.

In the example shown below, local administrators on the local Management LAN have telnet

access direct to the console server (and a%ached serial ports) while remote administrators

using Dial-In or Cellular have no telnet access (unless they set up a VPN).

• The Respond to ICMP echos (that is ping) service access op!ons can be conﬁgured at this

stage.

This allows the console server to respond to incoming ICMP echo requests. ping is

enabled by default. For security reasons, however, this service should generally be disabled

post ini!al conﬁgura!on.

• You can also conﬁgure to allow serial port devices to be accessed from nominated network

interfaces using Raw TCP, direct Telnet/SSH, unauthen!cated Telnet/SSH services, etc.

• Click Apply to apply your services access selec!ons.

2.4.1. Brute force protec"on

Brute force protec"on (Micro Fail2ban) temporarily blocks source IPs that show malicious

signs, such as too many password failures.

This may help mi!gate scenarios where the Opengear device’s network services are exposed

to an untrusted network such as the public WAN, and scripted a%acks or so&ware worms are

a%emp!ng to guess (brute force) user creden!als and gain unauthorized access.

Opengear User Manual. Page 41.

Brute force protec"on may be enabled for the listed services.

Once protec!on is enabled, 3 or more failed connec!on a%empts within 60 seconds from a

speciﬁc source IP trigger it to be banned from connec!ng for the next 60 seconds. Ac!ve

Bans are also listed and may be refreshed by reloading the page.

Note: When an Opengear device is running on an untrusted network, it is recommended that a

variety of strategies are used to lock down remote access. This includes strong passwords (or

even be"er, SSH public key authen#ca#on), VPN, and using Firewall Rules to whitelist

remote access from trusted source networks only. Please refer to the Knowledge Base for

details.

2.5. Communica"ons so!ware

You have conﬁgured access protocols for the Administrator client to use when connec!ng to

the console server. User clients (which may be set up later) will also use these protocols when

accessing console server serial a%ached devices and network a%ached hosts.

So you will need to have appropriate communica!ons so&ware tools set up on the

Administrator (and User) client’s computer. Opengear provides the SDT Connector as the

recommended client so&ware tool. Other generic tools such as PuTTY and SSHTerm may be

used, however, and these are all described below.

2.5.1. SDT connector

SDT Connector is a lightweight tool that enables Users and Administrators to securely access

the Console server, and the various computers, network devices and appliances that may be

serially or network connected to the console server.

SDT Connector is a Java client program that couples the trusted SSH tunneling protocol with

popular access tools such as Telnet, SSH, HTTP, HTTPS, VNC, and RDP to provide point-and-

click secure remote management access to all the managed systems and devices.

Informa!on on using SDT Connector for browser access to the console server’s Management

Console, Telnet/SSH access to the console server command line, and TCP/UDP connec!ng to

hosts that are network connected to the console server can be found in chapter 5, SSH

tunnels & SDT connector.

Opengear User Manual. Page 42.

SDT Connector can be installed on computers running Windows or macOS and on most Linux,

UNIX and Solaris systems.

2.5.2. PuTTY

Communica!ons packages like PuTTY can be also used to connect to the Console server

command line (and to connect serially a%ached devices as covered in chapter 3). PuTTY is a

freeware implementa!on of Telnet and SSH for Win32 and UNIX pla*orms. It runs as an

executable applica!on without needing to be installed onto your system. PuTTY (the Telnet

and SSH client itself) can be downloaded from h%p://pu%y.org/.

To use PuTTY for an SSH terminal session

from a Windows client, you enter the

console server’s IP address as the ‘Host

Name (or IP address)’.

To access the console server command line

you select ‘SSH’ as the protocol, and use the

default IP Port 22.

Click ‘Open’ and you will be presented with

the console server login prompt. (You may

also receive a ‘Security Alert’ that the host’s

key is not cached, you will need to choose

‘yes’ to con!nue.)

Using the Telnet protocol is similarly simple,

except you use the default telnet port: port

23.

2.5.3. SSHTerm

Another communica!ons package that may be useful is SSHTerm, an open source package

that can be downloaded from h%p://sourceforge.net/projects/sshtools.

• To use SSHTerm for an SSH terminal session from a Windows client, Select File > New

Connec"on.

•A dialog box appears for your Connec"on Proﬁle.

•Enter the host name or IP address for the console server you are

connec!ng to and the TCP port that the SSH session will use

(port 22).

•

•Enter your username, choose password authen!ca!on, and click

Connect.

•If you receive a message about the host key ﬁngerprint, select

Yes or Always to con!nue.

•The remote system will prompt you for a username and

password. Enter these to login to the console server.

Opengear User Manual. Page 43.

2.6. Management network conﬁgura"on

The IM4200, IM7200, CM7100, ACM5500, ACM7000 and ACM5004-2 console servers

have additional network ports that can be configured to provide management LAN access

and/or failover or out-of-band access.

2.6.1. Enable the management LAN

The IM4200, IM7200, CM7100, ACM7000, ACM5508-2-I/M and ACM5004-2 console

servers can be conﬁgured so the second Ethernet port provides a management LAN gateway.

The gateway has ﬁrewall, router and DHCP server features. However you need to connect an

external LAN switch to Network/LAN 2 to a%ach hosts to this management LAN:

Note: The second ethernet port (Network/LAN2) on the IM4200, IM7200, CM7100, ACM7000,

ACM5508-2-I/M and ACM5004-2 can be conﬁgured as either a Management LAN

gateway port or it can be conﬁgured as an OOB/Failover port. It cannot be both. Do not

allocate Network/LAN 2 as the Failover Interface when you conﬁgured the principal

Network connec#on on the System > IP menu.

The ACM5504-5-G-I, ACM5504-5-LA/LR/LV-I, ACM5504-5-G-W-I and IM4216-34 console

server models have integrated four or thirty-two port management LAN switches (with

ﬁrewall, router, DHCP server and switch func!ons).

Opengear User Manual. Page 44.

The IM4216-34 is normally conﬁgured with an ac!ve 32-port Management LAN (Ethernet

1-32) switch and Network 2 conﬁgured for OOB or Failover.

The ACM5504-5-G-W-I and ACM5504-5-G-I is normally conﬁgured with an ac!ve

Management LAN. This can be a 4 port (ETH1-4) Management LAN switch, or a 3 port

(ETH2-4) switch with ETH 1 conﬁgured for OOB/Failover.

Management LAN features are disabled by default. To conﬁgure a Management LAN gateway:

• Navigate to System > IP.

• Select the Management LAN Interface tab.

• Uncheck Disable.

• Conﬁgure the IP Address and Subnet Mask for the Management LAN. Leave the DNS ﬁelds

blank.

• Click Apply.

The management gateway func!on is now enabled with default ﬁrewall and router rules. By

default these rules are conﬁgured so the Management LAN can only be accessible by SSH

port forwarding. This ensures the remote and local connec!ons to Managed Devices on the

Management LAN are secure.

The LAN ports can also be conﬁgured in bridged or bonded mode (as described later in this

chapter) or they can be manually conﬁgured from the command line.

2.6.2. Conﬁgure the DHCP server

All IM and ACM family devices host a DHCP server. It is, however, disabled by default. The

DHCP server enables the automa!c distribu!on of IP addresses to devices on the

Opengear User Manual. Page 45.

Management LAN that are running DHCP clients. To enable the DHCP server:

• Navigate to System > IP.

• Select the Management LAN Interface tab.

• Check the Enable DHCP Server checkbox.

• Enter the Gateway address to be issued to DHCP clients. If this ﬁeld is le& blank, the

console server’s IP address will be used.

• Enter the Primary DNS and Secondary DNS address to be issued to DHCP clients. Again if

this ﬁeld is le& blank, the console server’s IP address is used. For automa!c DNS server

assignment, leave this ﬁeld blank.

• Enter a Domain Name suﬃx to issue DHCP clients. This is an op!onal value and step.

• Enter the Default Lease !me and Maximum Lease !me in seconds. The lease !me is the !me

that a dynamically assigned IP address is valid before the client must request it again.

• Click Apply.

The DHCP server will sequen!ally issue IP addresses from the speciﬁed address pool or

pools:

• Click Add in the Dynamic Address Alloca"on Pools ﬁeld.

• Enter the DHCP Pool Start Address and End Address.

Opengear User Manual. Page 46.

• Click Apply.

The DHCP server also supports pre-assigning IP addresses to be allocated only to speciﬁc

MAC addresses and reserving IP addresses to be used by connected hosts with ﬁxed IP

addresses. To reserve an IP addresses for a par!cular host:

• Click Add in the Reserved Addresses ﬁeld.

• Enter the Hostname, the Hardware Address (MAC) and the Sta"cally Reserved IP address for

the DHCP client.

• Click Apply.

When DHCP has ini!ally allocated hosts addresses it is recommended to copy these into the

pre-assigned list so the same IP address will be reallocated in the event of a reboot.

2.6.3. Select failover or broadband OOP

The IM4200, IM7200, CM7100, ACM7000, ACM5508-2-I/M, ACM5504-5-G-W-I,

ACM5504-5-G-I, ACM5504-5-LA/LR/LV-I, and ACM5004-2 console servers provide a

failover op!on so in the event of a problem using the main LAN connec!on for accessing the

console server; an alternate access path is used.

By default the failover is not enabled. To enable:

• Navigate to System > IP.

• Select the Network tab.

• Select the Failover Interface to be used in the event of an outage on the main network. This

can be:

an alternate broadband Ethernet connec!on (for example, the Network/LAN2 port on

most models) or

the IM4200 or IM7200 family internal modem or

an external serial modem device connected to the IM4200 or IM7200 Console port (for

out-dialing to an ISP or the remote management oﬃce).

Opengear User Manual. Page 47.

• Click Apply.

Note: The failover method is not ac#ve un#l the external sites to be probed to trigger failover are

speciﬁed and the failover ports themselves are set-up. This is covered in Chapter 4.

Note: The ACM5504-5-G(-W)-I and IM4216-34 can be conﬁgured with an ac#ve Management

LAN/gateway and with one of the switched Ethernet ports conﬁgured for OOB/Failover

(ETH 1 on the ACM5504-5-G(-W)-I or NETWORK 2 on the IM4216-34). On the other

IM4200, IM7200, CM7100, ACM7000, ACM5508-2 and ACM5004-2 models, the second

Ethernet port can be conﬁgured as either a gateway port or as an OOB/Failover port, but

not both.

2.6.4. Aggrega"ng the network ports

By default the console server's Management LAN network ports can only be accessed using

SSH tunneling/port forwarding or by establishing an IPsec VPN tunnel to the console server.

However all the wired network ports on the console servers can be aggregated by being

bridged or bonded.

• Navigate to System > IP.

• Click the General Se!ngs tab.

• Click the Bridge Interfaces or Bond Interfaces radio bu%on to enable wired Ethernet

interface aggrega!on.

When bridging is enabled, network traﬃc is forwarded across all Ethernet ports with no

ﬁrewall restric!ons. All Ethernet ports are transparently connected at the data link layer (layer

2) so they do retain their unique MAC addresses, however.

With bonding, the network traﬃc is carried between the ports but they present with one

MAC address.

Both modes remove all the Management LAN Interface and Out-of-Band/Failover Interface

func!ons and disable the DHCP Server.

Opengear User Manual. Page 48.

Note: In aggrega#on mode all the Ethernet ports are conﬁgured collec#vely via the System > IP >

Network Interface tab.

2.6.5. Wi-Fi wireless LAN

All IM7200 models and the ACM5504-5-G-W-I have an internal 802.11 Wi-Fi adapter and

come with an external Wi-Fi antenna. The Wi-Fi can be conﬁgured as a Wi-Fi Wireless Access

Point (WAP) or as a Wi-Fi client.

The inbuilt Wi-Fi is inac!ve by default. If you wish to use the Wi-Fi facility you will need to

a%ach the Wi-Fi antenna (and any auxiliary Wi-Fi antenna you may have ordered). To ac!vate

and conﬁgure the Wireless Access Point func!onality:

• Navigate to System > IP.

• Click the Wireless Network Interface tab.

• Uncheck the Disable check-box.

• Select the device’s opera!ng mode: Wireless Client or Wireless AP (for Access Point).

If Wireless AP is checked the Wireless AP Se!ngs sec!on becomes visible.

Opengear User Manual. Page 49.

• Set the IP Address, and the netmask in the IP Se#ngs for the Wireless Network.

Generally, if the device is being used as a Wireless AP, a sta!c address is set here. In the

example below, 192.168.10.1 is used.

As well, in the example below, the netmask is set to 255.255.255.0 to give 254 unique

network addresses in the subnet.

• Do not ﬁll in the Gateway, Primary DNS and Secondary DNS values.

These se$ngs are used if the interface is to be the primary network link to the outside

world, or if it will be used for failover.

• Select the correct country from the Country list.

If the correct country is not listed, select the World Regulatory Domain.

• Select an SSID for the network.

This should be unique.

• Check the Broadcast SSID check box.

This should, in general, be done. Not broadcas!ng a wireless network’s SSID is not a

meaningful security measure.

• Select the Network Channel.

The most commonly used channel is 6.

Note: if the unit is being deployed in an environment containing mul#ple Wireless APs (eg a mul#-

ﬂoor oﬃce building), a site survey, to establish what channels are locally unused is

recommended.

• Select the unit’s Hardware Mode.

The unit supports 802.11b, 802.11g, and single band 802.11n. In most cases, selec!ng

802.11b/g/n will provide for the best interoperability with other hardware.

• Select the Supported Authen"ca"on Methods.

WPA/WPA2 with AES encryp!on is recommended. WEP and WPA with TKIP have been

proven vulnerable to cryptanalysis a%ack. Only select these la%er authen!ca!on methods

if you must support client equipment that does not support WPA/WPA2 with AES.

If WPA/WPA2 is the selected Supported Authen"ca"on Method.

• Select one or both of TKIP and AES in WPA/WPA2 Encryp"on Methods.

As noted above, AES is more secure. It is also required for a Wireless AP to adver!se itself

as 802.11n if that is the selected Hardware Mode.

If WEP is the selected Supported Authen"ca"on Method.

• Select either Open System or Shared System in the WEP Mode.

Note: while Open System is more secure than Shared System (due to the way encryp#on keys are

used), known vulnerabili#es mean WEP cannot be considered secure in any sense.

• click Apply and wait for the page to refresh.

Opengear User Manual. Page 50.

The next step is to set up a DHCP server for the wireless clients. Click the link next to DHCP

Server in the IP se$ngs sec!on, or go to System > DHCP Server. More informa!on on

conﬁguring DHCP can be found in chapter 2.6.2.

If Wireless Client is checked the Wireless Client Se!ngs sec!on becomes visible.

•Select DHCP or Sta"c for the Conﬁgura"on Method.

If Sta"c is selected, manually enter the new IP Address, Subnet Mask, Gateway and DNS

server details. This selec!on automa!cally disables the DHCP client.

If DHCP is selected, the device will look for conﬁgura!on details from a DHCP server on

your management LAN. This selec!on automa!cally disables any sta!c address.

Note: the device’s MAC address can be found on a label on the base plate.

Conﬁgure the Wireless client to select the local wireless network which will serve as the main

network connec!on to the console server.

• Select the correct country from the Country list.

Opengear User Manual. Page 51.

If the correct country is not listed, select the World Regulatory Domain.

• Enter the SSID (Set Service Iden!ﬁer) of the wireless access point the Wireless Client will

connect to.

• Select the Wireless Network Type.

Select Infrastructure to connect to a Wireless AP device. Select Ad-hoc to connect directly

to a computer.

• Select the Wireless Security mode of the wireless network (WEP, WPA, etc)

• Enter the required authen!ca!on strings.

When enabled in client mode, the wireless LAN will operate as the main network connec!on

to the device so failover is available (though it not enabled by default).

Use Failover Interface to select the device to failover to in case of wireless outage and specify

Probe Addresses of the peers to probed for connec!vity detec!on.

Note: The Wireless screen in Status > Sta"s"cs will display all the locally accessible wireless

LANs (with SSID and Encryp#on/Authen#ca#on se&ngs). You can also use this screen to

conﬁrm you have successfully connected to the selected access point. See chapter 11 for

more.

2.6.6. Sta"c routes

Firmware 3.4 and later support sta"c routes which provide a quick way to route data from one

subnet to diﬀerent subnet. You can hard code a path that speciﬁes to the console server or

router to get to a certain subnet by using a certain path. This may be useful for remotely

accessing various subnets at a remote site when being accessed using the cellular OOB

connec!on.

To add a sta!c route to the route table of the system:

• Navigate to System > IP > General Se!ngs.

• Select the Route Se!ngs tab.

• Enter a meaningful Route Name for the route.

• In the Des"na"on Network/Host ﬁeld, enter the IP address of the des!na!on network or

host that the route provides access to.

Opengear User Manual. Page 52.

• Enter a value in the Des"na"on netmask ﬁeld that iden!ﬁes the des!na!on network or

host.

Any number between 0 and 32. A subnet mask of 32 iden!ﬁes a host route.

• Fill the Route Gateway ﬁeld with the IP address of a router that will route packets to the

des!na!on network.

This ﬁeld may be le& blank, depending on your network conﬁgura!on.

• Select the Interface to use to reach the des!na!on

This ﬁeld may be le& as None.

• Enter a value in the Metric ﬁeld that represents the metric of this connec!on.

This generally only has to be set if two or more routes conﬂict or have overlapping targets.

Any number equal to or greater than 0.

• Click Apply.

Note: The route details page provides a list of network interfaces and modems to which a route

can be bound. In the case of a modem, the route will be a"ached to any dialup session which

is establish via that device. A route can be speciﬁed with a gateway, an interface or both. If

the speciﬁed interface is not ac#ve for whatever reason, then routes conﬁgured for that

interface will not be ac#ve.

Opengear User Manual. Page 53.

3.Serial port, host, device & user conﬁgura!on

The console server enables access and control of serially-a%ached devices and network-

a%ached devices (hosts). The Administrator must conﬁgure access privileges for each of these

devices, and specify the services that can be used to control the devices. The Administrator

can also set up new users and specify each user’s individual access and control privileges.

This chapter covers each of the steps in conﬁguring network-connected and serially-a%ached

devices:

step

Serial ports

Users & Groups

notes

se$ng up serially connected device protocols.

se$ng up and deﬁning user access permissions.

Opengear User Manual. Page 54.

3.1. Conﬁgure serial ports

The ﬁrst step in conﬁguring a serial port is to set the Common Se!ngs such as the protocols

and the RS232 parameters that are to be used for the data connec!on to that port (for

example, baud rate).

Then you select what mode the port is to operate in. Each port can be set to support one of

these opera!ng modes:

Authen!ca!on

Network hosts

Conﬁguring trusted networks

Serial console port cascading & redirec!on

Power (UPS, PDU & IPMI)

Environmental Monitoring Devices (EMD)

Serial port redirec!on

Managed devices

IPSec

OpenVPN

PPTP

also covered in more detail in Chapter 8.

conﬁguring access to network-connected hosts.

nominate IP addresses trusted users access from.

the PortShare client on Windows and Linux.

the consolidated view of all the connec!ons.

enabling VPN connec!ons.

mode

Disabled

Console server

Device

SDT

Terminal server

Serial bridge

notes

The serial port is inac!ve.

enables general access to serial console port on the serially a%ached

devices.

sets the serial port up to communicate with an intelligent serial controlled

PDU, UPS or Environmental Monitor Devices (EMD).

enables graphical console access (with RDP, VNC, HTTPS etc.) to hosts that

are serially connected.

sets the serial port to await an incoming terminal login session.

enables the transparent interconnec!on of two serial port devices over a

network.

Opengear User Manual. Page 55.

• Navigate to Serial & Network > Serial Port.

Details of the currently setup serial ports presents. By default, each serial port is set in

console server mode.

• Click Edit to reconﬁgure a given serial port.

• Reconﬁgure the common se$ngs (chapter 3.1.1) and the mode (chapters 3.1.2 – 3.1.6) for

each port as needed.

• Set up any remote syslog (chapter 3.1.7).

• click Apply.

Note: to set the same protocol op#ons for mul#ple serial ports at once click Edit Mul"ple Ports

and select which ports you wish to conﬁgure as a group.

• if the console server has been conﬁgured with distributed Nagios monitoring enabled then

you will also be presented with Nagios Se!ngs op!ons to enable nominated services on

the host to be monitored (see chapter 9).

3.1.1. Common se&ngs

There are a number of common se$ngs that can be set for each serial port. These are

independent of the mode in which the port is being used. These serial port parameters must

be set so they match the serial port parameters on the device you a%ach to that port.

• Specify a Label for the port.

• Select the appropriate Baud Rate, Parity, Data Bits, Stop Bits and Flow Control for each port.

• Set the Signaling Protocol. This menu item only presents in ports with RS422/485 op!ons

(all ports on ACM5004-2-I, ACM5508-2-I, ACM5504-5-LA/LR/LV-I and ACM5504-5-G-I).

The op!ons available are RS232, RS422, RS485 and RS485 Echo mode.

• Set the Port Pinout. This menu item only presents for IM7200 ports where pin-out for each

RJ45 serial port can be set as either X2 (Cisco Straight) or X1 (Cisco Rolled).

• Before proceeding with further serial port conﬁgura!on, you should connect the ports to

the serial devices they will be controlling, and ensure they have matching se$ngs.

Opengear User Manual. Page 56.

3.1.2. Console server mode

• Select Console Server Mode to enable remote management access to the serial console that

is a%ached to this serial port.

• Set the desired Logging Level.

This speciﬁes the level of informa!on to be logged and monitored (see chapter 6).

•Enable or disble Telnet access.

When the Telnet service is enabled on the console server, a Telnet client on a User’s or

Administrator’s computer can connect to a serial device a%ached to this serial port on the

console server. Telnet communica!ons are unencrypted so this protocol is generally

recommended only for local or VPN-tunneled connec!ons.

Windows 2000, Windows XP and Windows NT can run telnet from the cmd.exe

command prompt.

Windows Vista and later ship with a Telnet client but it is not enabled by default. You can

install it as follows.

•Click the Start bu%on.

Opengear User Manual. Page 57.

• Click Control Panel.

• Click Programs.

• Click Turn Windows features on or oﬀ.

If you are prompted for an administrator password or conﬁrma!on, type the password or

provide conﬁrma!on.

•In the Windows Features dialog box, select the Telnet Client check box.

• Click OK.

The installa!on may take several minutes.

If remote communica!ons are being tunneled with SDT Connector, then Telnet can be used for

securely accessing these a%ached devices.

Note: In Console Server mode, Users and Administrators can use SDT Connector to set up

secure Telnet connec#ons that are SSH tunneled from their client computers to the serial

port on the console server. SDT Connector can be installed on Windows PCs and on most

Linux pla'orms and it enables secure Telnet connec#ons to be selected with a simple point-

and-click. To use SDT Connector to access consoles on the console server serial ports, you

conﬁgure SDT Connector with the console server as a gateway, then as a host, and you

enable Telnet service on Port 2000 + serial port # (that is Ports 2001–2048). See chapter 5

for more details on using SDT Connector for Telnet and SSH access to devices that are

a"ached to the console server serial ports.

You can also use communica!ons packages like PuTTY to set a direct Telnet (or SSH)

connec!on to the serial ports.

Note: PuTTY supports Telnet (and SSH). Enter the console server’s IP address as the Host Name

(or IP address). Select Telnet as the protocol and set the TCP port to 2000 plus the

Opengear User Manual. Page 58.

physical serial port number (that is a port between 2001 and 2048). Click the Open bu"on.

You may receive a Security Alert that the host’s key is not cached: choose yes to con#nue.

The login prompt of the remote system connected to the serial port chosen on the console

server will now present. You can login as normal and use the host serial console screen.

Pu%y can be downloaded from h%p://pu%y.org/.

Note: In Console Server mode, when you connect to a serial port you connect via pmshell. To

generate a BREAK on the serial port type the character sequence ~b. If you’re doing this

over OpenSSH type ~~b.

•Enable or disable SSH access.

It is recommended you use SSH as the protocol where the User or Administrator connects

to the console server (or connects through the console server to the a%ached serial

consoles) over the Internet or any other public network. This will provide authen!cated

SSH communica!ons between the SSH client program on the remote user’s computer and

the console server, so the user’s communica!on with the serial device a%ached to the

console server is secure

For SSH access to the consoles on devices a%ached to the console server serial ports, you

can use SDT Connector. You conﬁgure SDT Connector with the console server as a gateway,

then as a host, and you enable SSH service on Port 3000 + serial port #. (That is ports

3001 – 3048). See chapter 5 for more informa!on on using SDT Connector for SSH access

to devices that are a%ached to the console server serial ports.

Also you can use common communica!ons packages, like PuTTY or SSHTerm to SSH

connect directly to port address IP Address:Port 3000 + serial port #. (That is ports 3001 –

3048).

Alternately SSH connec!ons can be conﬁgured using the standard SSH port 22. The serial

port being accessed is then iden!ﬁed by appending a descriptor to the username. This

syntax supports any of the following descriptors:

For example, if a User named fred wants to access serial port 2, when se$ng up SSHTerm

or the PuTTY SSH client, instead of typing

username = fred

ssh port = 3002

type

username = fred:port02

username = fred:ttyS1

and

ssh port = 22.

Opengear User Manual. Page 59.

Alterna!vely, by typing

username=fred:serial

and

ssh port = 22

the User is presented with a port selec!on op!on

This syntax enables Users to set up SSH tunnels to all serial ports with only a single IP port

22 having to be opened in their ﬁrewall or gateway.

Note: In Console Server mode, when you connect to a serial port you connect via pmshell. To

generate a BREAK on the serial port type the character sequence ~b. If you’re doing this

over OpenSSH type ~~b.

•Enable or disable Raw TCP access.

RAW TCP allows connec!ons directly to a TCP socket. Communica!ons programs like

PuTTY support RAW TCP. This protocol, however, would usually be used by a custom

applica!on

For RAW TCP, the default port address is IP Address:Port 4000 + serial port # (That is ports

4001 – 4048).

RAW TCP also enables the serial port to be tunneled to a remote console server, so two

serial port devices can be transparently interconnect over a network (see chapter 3.1.6).

•Enable or disable RFC 2217 access.

Enabling RFC 2217 access enables serial port redirec!on on that port. For RFC 2217, the

default port address is IP Address:Port 5000 + serial port # (that is Port #s 5001 – 5048).

Special client so&ware is available for Windows UNIX and Linux that supports RFC 2217

virtual com ports, so a remote host can monitor and manage remote serially a%ached

devices, as though they were connected to the local serial port (see chapter 3.6 for details).

RFC 2217 also enables the serial port to be tunneled to a remote console server, so two

serial port devices can be transparently interconnect over a network (see chapter 3.1.6).

•Enable or disable Unauthen"cated Telnet.

Enabling Unauthen"cated Telnet enables telnet access to the serial port without

authen!ca!on creden!als. When a user accesses the console server to telnet to a serial

port, they are normally given a login prompt. However with unauthen!cated telnet they

connect directly through to the port without any console server login challenge. (If a telnet

client does prompt for authen!ca!on, any entered data will allow connec!on.)

Opengear User Manual. Page 60.

This mode is mainly used when you have an external system (such as conserver) managing

user authen!ca!on and access privileges at the serial device level.

Note: only the connec#on to the console server is unauthen#cated. Logging into a device

connected to the console server may s#ll require authen#ca#on.

For Unauthen"cated Telnet the default port address is IP Address:Port 6000 + serial port #

(that is Port #s 6001 – 6048).

•Enable or disable Web Terminal.

Enabling Web Terminal enables web browser access to the serial port via Manage > Devices

> Serial using the Management Console’s built in AJAX terminal.

Web Terminal connects as the currently authen!cated Management Console user and does

not re-authen!cate. See chapter 12.3 for more details.

•Enter an IP Alias (aliasing for the Network Interface, Management LAN or Out-of-Band/

Failover).

A working IP Alias, enables access to the serial port using a speciﬁc IP address, speciﬁed in

CIDR format. Each serial port can be assigned one or more IP aliases, conﬁgured on a per-

network-interface basis.

A serial port can, for example, be made accessible at both 192.168.0.148 (as part of the

internal network) and 10.10.10.148 (as part of the Management LAN). It is also possible to

make a serial port available on two IP addresses on the same network (for example,

192.168.0.148 and 192.168.0.248).

These IP addresses can only be used to access the speciﬁc serial port, accessible using the

standard protocol TCP port numbers of the console server services. For example, SSH on

serial port 3 would be accessible on port 22 of a serial port IP alias (whereas on the console

server’s primary address it is available on port 2003).

This feature can also be conﬁgured via the mul!ple port edit page. In this case the IP

addresses are applied sequen!ally, with the ﬁrst selected port ge$ng the IP entered and

subsequent ones ge$ng incremented, with numbers being skipped for any unselected

ports. For example if ports 2, 3 and 5 are selected and the IP alias 10.0.0.1/24 is entered

for the Network Interface, the following addresses will be asssigned:

Port 2: 10.0.0.1/24

Port 3: 10.0.0.2/24

Port 5: 10.0.0.4/24

•Enable or disable Encrypt Traﬃc and enable or disable Authen"cate. (These op!ons should

be either enabled or disabled as a pair.)

Enabling these two op!ons turns on trivial encryp!on and authen!ca!on of RFC2217

serial communica!ons using Portshare. For strong encryp!on use VPN.

•Set an Accumula"on Period.

Once a connec!on has been established for a par!cular serial port (such as a RFC2217

redirec!on or Telnet connec!on to a remote computer) any incoming characters on that

port are forwarded over the network on a character by character basis. The accumula!on

period changes this by specifying a period of !me that incoming characters will be

Opengear User Manual. Page 61.

collected before then being sent as a packet over the network.

•Set a custom Escape Character.

This enables you to change the character used for sending escape characters. The default

is ~.

•Enable or disable the Power Menu.

This se$ng enables the shell power command so a user can control the power connec!on

to a Managed Device from the command line when they are telnet- or ssh-connected to

the device. To operate the Managed Device must be set up with both its Serial port

connec!on and Power connec!on conﬁgured. The command to bring up the power menu

is ~p.

•Enable or disable Single Connec"on.

Enabling this se$ng limits the port to a single connec!on. If this is enabled and mul!ple

users have access privileges for a par!cular port, only one user at a !me can be accessing

that port (that is, port snooping is not permi%ed).

3.1.3. SDT mode

Opengear User Manual. Page 62.

This Secure Tunneling se$ng allows port forwarding of RDP, VNC, HTPP, HTTPS, SSH, Telnet

and other LAN protocols through to computers which are locally connected to the console

server by their serial COM port. However such port forwarding requires a PPP link to be set

up over this serial port.

For conﬁgura!on details refer to chapter 5.6.

3.1.4. Device (RPC, UPS, EMD) mode

This mode conﬁgures the selected serial port to communicate with a serial controlled

Uninterruptable Power Supply (UPS), Remote Power Controller / Power Distribu!on Units

(RPC) or Environmental Monitoring Device (EMD).

• Select the desired Device Type (UPS, RPC or EMD).

• Proceed to the appropriate device conﬁgura!on page: Serial & Network > UPS

Connec"ons, RPC Connec"on or Environmental) as detailed in chapter 7.

3.1.5. Terminal server mode

• Enable Terminal Server Mode and set the Terminal Type (vt220, vt102, vt100, Linux or ANSI)

to enable a ge$y on the selected serial port.

The ge$y will then conﬁgure the port and wait for a connec!on to be made. An ac!ve

connec!on on a serial device is usually indicated by the Data Carrier Detect (DCD) pin on the

serial device being raised. When a connec!on is detected, the ge%y program issues a login:

prompt, and then invokes the login program to handle the actual system login.

Note: Selec#ng Terminal Server mode will disable Port Manager for that serial port, so data is no

longer logged for alerts etc.

Opengear User Manual. Page 63.

3.1.6. Serial bridging mode

With serial bridging, the serial data on a nominated serial port on one console server is

encapsulated into network packets and then transported over a network to a second console

server where is then represented as serial data. So the two console servers eﬀec!vely act as a

virtual serial cable over an IP network.

One console server is conﬁgured to be the Server. The Server serial port to be bridged is set in

Console Server mode with either RFC2217 or RAW enabled (as described in chapter 3.1.2).

For the Client console server, the serial port to be bridged must be set in Bridging Mode.

• Enable Serial Bridging Mode and specify the IP address of the Server console server and the

TCP port address of the remote serial port (for RFC2217 bridging this will be 5001-5048).

• By default the bridging client will use RAW TCP so you must select RFC2217 if this is the

console Server mode you have speciﬁed on the server console server.

• You may secure the communica!ons over the local Ethernet by enabling SSH however you

will need to generate and upload keys (see chapter 14).

3.1.7. Syslog

In addi!on to inbuilt logging and monitoring (which can be applied to serial-a%ached and

network-a%ached management accesses, as covered in chapter 6) the console server can also

be conﬁgured to support the remote syslog protocol on a per serial port basis.

• Select the Syslog Facility and Syslog Priority ﬁelds to enable logging of traﬃc on the selected

serial port to a syslog server and to appropriately sort and ac!on those logged messages

(for example, redirect them or send an alert email).

For example if the computer a%ached to serial port 3 should never send anything out on its

Opengear User Manual. Page 64.

serial console port, the Administrator can set the Syslog Facility for that port to local0 (local0 –

local7 are meant for site local values), and the Syslog Priority to cri!cal. At this priority, if the

console server syslog server does receive a message, it will automa!cally raise an alert. See

chapter 6 for more.

3.1.8. NMEA streaming

The ACM5004-G-I, ACM5504-5-G(-W)-I, ACM5504-5-LA/LR/LV-I, ACM7000-L and

IM4200-G can provide GPS NMEA data streaming from the internal GPS /cellular modem.

This data stream presents as a serial data stream on port 5 on the ACM models. For the

IM4200-G with an internal cellular modem, the NMEA data stream presents on ports

9/17/33/49 for the IM4208/16/32/48 models.

The Common Se$ngs (baud rate etc.) are ignored when conﬁguring the NMEA “serial port”.

However you can specify the Fix Frequency (i.e. this GPS ﬁx rate determines how o&en GPS

ﬁxes are obtained). You can also apply all the Console Server Mode, Syslog and Serial Bridging

se$ngs to this port.

Note: The NMEA Streaming menu item should display on the Serial & Network > Serial

Port menu. However for earlier revision ACM5004-G-I units you may need to update

the se'set se&ngs from the command line.

setfset -r lists all of the current feature set variables.

You look for the factory_opts variable, and then add 3g-gps to it.

For example, factory_opts=rs485,3g,ind.

To update it to 3g-gps, you do the following:

setfset -u factory_opts=rs485,3g-gps,ind.

Then run setfset -r again, and make sure you can see the update.

You can use pmshell, webshell, SSH, RFC2217 or RawTCP to get at the stream:

Opengear User Manual. Page 65.

For example, using the Web Terminal:

Note: This GPS support is also available for IM4200-G with an internal cellular modem. The NMEA

data stream presents on ports 9/17/33/49 for the IM4208/16/32/48 models.

3.1.9. Cisco USB console connec"on

The ACM5000-, ACM5500-, and IM4200-family console servers support direct USB 2.0

connec!on to one or two Cisco USB console ports (in addi!on to the tradi!onal RS-232 serial

console port connec!ons).

With such a USB console connec!on, users can send IOS commands through the USB

console port remotely (using a browser and the console server’s built-in AJAX terminal) or

monitor messages from the Cisco USB console ports and take rule book ac!ons (using the

console server’s built-in Auto-Response capabili!es).

For conﬁgura!on and control, these USB consoles are presented as new “serial ports”. For

example, on an ACM5504-5-G with cellular GPS conﬁgured on Port 5 (as shown above), any

Cisco USB console ports would present as Port 6 and 7.

For the IM4200-series (without any internal GPS modem func!ons) any conﬁgured Cisco USB

console ports would present as follows:

ports 19 & 10 on the IM4208.

ports 17 & 18 on the IM4216.

ports 33 & 34 on the IM4232.

ports 49 & 50 on the IM4248.

The Common Se$ngs (baud rate etc) are ignored when conﬁguring the Cisco USB “serial

port”.

However you can apply all the Console Server Mode, Syslog and Serial Bridging se$ngs to

this port.

Opengear User Manual. Page 66.

Note: The Cisco USB console must be manually conﬁgured on ini#al connec#on. However any USB

console disconnec#on is auto-detected. USB console re-connec#on on the same physical

USB port will also be auto-detected, but only if the console server has been power cycled.

3.1.10. USB consoles

Opengear ACM7000, CM7100 and IM7200 family console servers running ﬁrmware 3.16.5

or later support USB console connec!ons to devices from a wide range of vendors, including

Cisco, HP, Dell and Brocade. Moreover, and aside from their u!lity as USB connec!ons, all the

USB ports on these console servers can func!on as plain RS-232 serial ports when a USB-to-

serial adapter is connected.

These USB ports are available as regular portmanager ports and are presented numerically in

the web UI a&er all RJ45 serial ports.

The ACM7008-2, for example, has eight RJ45 serial ports on the rear of the console server

and four USB ports on the front. In Serial & Network > Serial Port these are listed as

If the par!cular ACM7008-2 is a cellular model, port #13 — for the GPS — will also be listed.

As a further example, consider the 7216-24U. It has 16 RJ45 serial ports and 24 USB ports

on its rear-face as well as two front-facing USB ports and (in the cellular model) a GPS.

The RJ45 serial ports are presented in Serial & Network > Serial Port as port numbers 1–16.

port #

connector

RJ45

USB

Opengear User Manual. Page 67.

The 24 rear-facing USB ports take port numbers 17–40, and the front-facing USB ports are

listed at port numbers 41 and 42 respec!vely. And, as with the ACM7008-2, if the par!cular

7216-24U is a cellular model, the GPS is presented at port number 43.

The common se$ngs (baud rate etc.) are used when conﬁguring the ports, but some

opera!ons (for example, sending serial breaks) may not work depending on the

implementa!on of the underlying USB serial chip.

3.1.11. Link layer discovery protocol (LLDP)

The Link Layer Discovery Protocol (LLDP) is a protocol that allows system administrators to

glean informa!on about devices physically connected to managed switches. It is available for

use on IM7200, CM7100 and ACM7000 devices.

The LLDP service is enabled through the System > Services page. When the service is

enabled, the lldpd daemon is loaded and runs. The Service Access tab controls which

network interfaces are monitored by the lldpd daemon.

When LLDP is granted access to an interface, it will use that interface even if the interface

has been disabled via System > IP.

LLDP neighbors are visible through the Status > LLDP Neighbors page. This page shows

neighbors heard, and also indicates the informa!on that the console manager is sending.

Note: although the LLDP service can be granted access to non-ethernet interfaces (for example,

G3, G4 and PSTN dial-up interfaces), it currently ignores non-ethernet interfaces.

The lldpcli shell client interacts with and conﬁgures the running LLDP service.

Persistent custom conﬁgura!on changes can be added to the system through conﬁgura!on

ﬁles placed in /etc/config/lldpd.d/. Custom conﬁgura!on ﬁles — which must have

ﬁlenames ending with .conf — will be read and executed by lldpcli when the LLDP

service starts.

The /etc/ directory is read-only on Opengear hardware. Most default conﬁgura!on ﬁles

otherwise stored in /etc/ are, on Opengear hardware, in /etc/config/, which is

writeable.

The default lldpd conﬁgura!on ﬁle — lldpd.conf — is stored in /etc/config/ on

Opengear hardware. It is not safe as a store of custom conﬁgura!on details, however. There

are circumstances in which this ﬁle is regenerated automa!cally, in which case all

customisa!ons will be lost.

The etc/config/lldpd.d/ directory, which is also writable and which is created on ﬁrst

boot, is safe to write to. Any Custom LLDP conﬁgura!ons must be stored as *.conf ﬁles in

this directory.

When enabled, LLDP frames issued by an Opengear Console Manager will reveal sensi!ve

informa!on such as hostname, and ﬁrmware version.

However, LLDP frames are not passed through by 802.3ab compliant switches, and Opengear

Console Managers have the LLDP service disabled by default.

Both lldpd and lldpcli have standard man pages but, because of space concerns, these

pages are not shipped with Opengear hardware.

Opengear User Manual. Page 68.

Both man pages are available on the lldpd project web-site however: man lldpd is at h%ps://

vincentbernat.github.io/lldpd/usage.html#lldpd8; and man lldpcli is at h%ps://

vincentbernat.github.io/lldpd/usage.html#lldpcli8.

Note: Opengear uses lldpd 0.9.2.

3.1.12. Conﬁgura"on over DHCP (ZTP)

Conﬁg-over-DHCP is available for all Opengear console managers running ﬁrmware release

3.16 or later. Using this feature, Opengear devices can be provisioned during their ini!al boot

from a DHCP server. Provisioning on untrusted networks can be facilitated by providing keys

on a USB ﬂash drive.

The typical steps for conﬁgura!on over a trusted network are:

• Manually conﬁgure a same-model Opengear device.

• Save its conﬁgura!on as an Opengear backup (.opg) ﬁle.

• Select System > Conﬁgura"on Backup > Remote Backup.

• Click Save Backup.

A backup conﬁgura!on ﬁle — model-name_iso-format-date_config.opg — is

downloaded from the Opengear device to the local system.

Alterna!vely, you can save the conﬁgura!on as an xml ﬁle:

• Select System > Conﬁgura"on Backup > XML Conﬁgura"on.

An editable ﬁeld containing the conﬁgura!on ﬁle in XML format is presented.

• Click into the ﬁeld to make it ac!ve.

• If you are running any browser on Windows or Linux, right-click and choose Select All from

the contextual menu or press Control-A. Then right-click and choose Copy from the

contextual menu or press Control-C.

• If you are using any browser on macOS, choose Edit > Select All or press Command-A.

Then choose Edit > Copy or press Command-C.

• In your preferred text-editor, create a new empty document, paste the copied data into the

empty document and save the ﬁle. Whatever ﬁle-name you choose, it must include the.xml

ﬁlename suﬃx.

• Copy the saved .opg or .xml ﬁle to a public-facing directory on a ﬁle server serving at

least one of the following protocols: HTTPS, HTTP, FTP or TFTP.

Note: Only HTTPS can be used if the connec#on between the ﬁle server and a to-be-conﬁgured

Opengear device travels over an untrusted network.

• Conﬁgure your DHCP server to include a ‘vendor speciﬁc’ op!on for Opengear devices.

(This will be done in a DHCP server-speciﬁc way.) The vendor speciﬁc op!on should be set

to a string containing the URL of the published .opg or .xml ﬁle in the step above. The

op!on string must not exceed 250 characters and it must end in either .opg or .xml.

• Connect a new Opengear device (either factory-reset or Conﬁg-Erased) to the network and

Opengear User Manual. Page 69.

apply power.

Note: it may take up to 5 minutes for the device to ﬁnd the .opg or .xml ﬁle via DHCP, download

and install the ﬁle and then reboot itself.

Example ISC DHCP (dhcpd) server conﬁgura"on

The following is an example DHCP server conﬁgura!on fragment for serving an .opg

conﬁgura!on image via the ISC DHCP server, dhcpd:

option space opengear code width 1 length width 1;

option opengear.config-url code 1 = text;

class "opengear-config-over-dhcp-test" {

match if option vendor-class-identifier ~~ "^Opengear/";

vendor-option-space opengear;

option opengear.config-url "https://example.com/opg/$ \

{class}.opg";

}

Setup when the LAN is untrusted

If the connec!on between the ﬁle server and a to-be-conﬁgured Opengear device includes an

untrusted network, a two-handed approach can mi!gate the issue.

Note: this approach introduces two physical steps where trust can be diﬃcult, if not impossible, to

establish completely. First, the custody chain from the crea#on of the data-carrying USB

ﬂash drive to its deployment. Second, the hands connec#ng the USB ﬂash drive to the

Opengear device.

• Generate an X.509 cer!ﬁcate for the Opengear device.

• Concatenate the cer!ﬁcate and its private key into a single ﬁle named client.pem.

• Copy client.pem onto a USB ﬂash drive.

• Set up an HTTPS server such that access to the .opg or .xml ﬁle is restricted to clients

that can provide the X.509 client cer!ﬁcate generated above.

• Put a copy of the CA cert that signed the HTTP server’s cer!ﬁcate — ca-bundle.crt —

onto the USB ﬂash drive bearing client.pem.

• Insert the USB ﬂash drive into the Opengear device before a%aching power or network.

• Con!nue the procedure from ‘Copy the saved .opg or .xml ﬁle to a public-facing directory

on a ﬁle server’ above using the HTTPS protocol between the client and server.

Prepare a USB drive and create the X.509 cer"ﬁcate and private key

• Generate the CA cer!ﬁcate so the client and server Cer!ﬁcate Signing Requests (CSRs) can

be signed.

# cp /etc/ssl/openssl.cnf .

# mkdir -p exampleCA/newcerts

# echo 00 > exampleCA/serial

# echo 00 > exampleCA/crlnumber

# touch exampleCA/index.txt

# openssl genrsa -out ca.key 8192

Opengear User Manual. Page 70.

# openssl req -new -x509 -days 3650 -key ca.key -out demoCA/

\cacert.pem -subj /CN=ExampleCA

# cp demoCA/cacert.pem ca-bundle.crt

Note: This procedure generates a cer#ﬁcate called ExampleCA but any allowed cer#ﬁcate name

can be used. Also, this procedure uses openssl ca. If your organisa#on has an enterprise-

wide, secure CA genera#on process, that should be used instead.

• Generate the client cer!ﬁcate.

# openssl genrsa -out client.key 4096

# openssl req -new -key client.key -out client.csr -subj \

/CN=ExampleClient

# openssl ca -days 365 -in client.csr -out client.crt \

-keyfile ca.key -policy policy_anything -batch -notext

# cat client.key client.crt > client.pem

• Format a USB ﬂash drive as a single FAT32 volume.

• Move the client.pem and ca-bundle.crt ﬁles onto the ﬂash drive’s root directory.

3.2. Add & edit users

The Administrator uses this menu selec!on to set up, edit and delete users and to deﬁne the

access permissions for each of these users.

Users can be authorized to access speciﬁed services, serial ports, power devices and speciﬁed

network-a%ached hosts. These users can also be given full Administrator status (with full

conﬁgura!on and management and access privileges).

To simplify user set up, they can be conﬁgured as members of Groups. With ﬁrmware V3.5.2

and later there are six Groups set up by default (earlier versions only had admin and user by

default):

group

admin

descrip"on

Provides users with unlimited conﬁgura!on and management privileges.

Opengear User Manual. Page 71.

Membership of the admin group provides the user with full Administrator privileges. The

admin user (Administrator) can access the console server using any of the services which have

been enabled in System: Services e.g. if only HTTPS has been enabled then the Administrator

can only access the console server using HTTPS. However once logged in they can

reconﬁgure the console server se$ngs (e.g. to enabled HTTP/Telnet for future access). They

can also access any of the connected Hosts or serial port devices using any of the services

that have been enabled for these connec!ons. But again the Administrator can reconﬁgure

the access services for any Host or serial port. So only trusted users should have

Administrator access

Membership of the user group provides the user with limited access to the console server and

connected Hosts and serial devices. These Users can access only the Management sec!on of

the Management Console menu and they have no command line access to the console server.

They also can only access those Hosts and serial devices that have been checked for them,

using services that have been enabled

If a user is set up with pptd, dialin, &p or pmshell group membership they will have restricted

user shell access to the nominated managed devices but they will not have any direct access

to the console server itself. To add this the users must also be a member of the "users" or

"admin" groups

The Administrator can also set up addi!onal Groups with speciﬁc power device, serial port and

host access permissions. However users in these addi!onal groups don’t have any access to

the Management Console menu nor do they have any command line access to the console

server itself.

The Administrator can also set up users with speciﬁc power device, serial port and host access

permissions, who are not a member of any Groups. Similarly these users don’t have any access

to the Management Console menu nor do they have any command line access to the console

server itself.

For convenience the SDT Connector “Retrieve Hosts” func!on retrieves and auto-conﬁgures

checked serial ports and checked hosts only, even for admin group users

3.2.1. Setup new group

To set up new Groups and new users, and to classify users as members of par!cular Groups:

• Select Serial & Network > Users & Groups to display the conﬁgured Groups and Users.

• Click Add Group to add a new Group.

• Add a Group name and Descrip"on for each new Group, then nominate the Accessible Hosts,

Accessible Ports and Accessible RPC Outlet(s) that you wish any users in this new Group to

be able to access.

pptpd

dialin

pmshell

users

Group to allow access to the PPTP VPN server. Users in this group will have their

password stored in clear text.

Group to allow access to the PPTP VPN server. Users in this group will have their

password stored in clear text.

Group to allow &p access and ﬁle access to storage devices.

Group to set default shell to pmshell.

Provides users with basic management privileges.

Opengear User Manual. Page 72.

• Click Apply.

• The Administrator can Edit or Delete any added group.

3.2.2. Setup new users

To set up new users, and to classify users as members of par!cular Groups:

• Select Serial & Network > Users & Groups to display the conﬁgured Groups and Users.

• Click Add User to add a new user.

• Add a Username for each new user. You may also include informa!on related to the user

(e.g. contact details) in the Descrip"on ﬁeld.

Note: the User Name can contain from 1 to 127 alphanumeric characters as wel as the following

characters: - _ . (hyphen, underscore, and full-stop or period).

• Specify which Group (or Groups) you wish the user to be a member of.

• Add a conﬁrmed Password for each new user.

Note: a user’s Password can contain up to 254 characters. There are no restric#ons on what

characters are allowed in a password. However only the ﬁrst eight characters are used to

make the password hash.

• SSH pass-key authen!ca!on can be used. This is more secure than password-based

authen!ca!on. Paste the public keys of authorized public/private keypairs for this user in

the Authorized SSH Keys ﬁeld

• Check Disable Password Authen"ca"on if you wish to only allow public key authen!ca!on

for this user when using SSH.

Opengear User Manual. Page 73.

• Check Enable Dial-Back in the Dial-in Op"ons menu to allow an out-going dial-back

connec!on to be triggered by logging into this port.

• Enter the Dial-Back Phone Number with the phone number to call-back when the user logs

in.

• Check speciﬁc Accessible Hosts and Accessible Ports to nominate the serial ports and

network connected hosts you wish the user to have access privileges to.

• If there are conﬁgured RPCs you can check Accessible RPC Outlets to specify which outlets

the user is able to control (that is, power on and oﬀ).

• Click Apply.

The new user will now be able to access the Network Devices, Ports and RPC Outlets you

nominated as accessible plus, if the user is a Group member they can also access any other

device/port/outlet that was set up as accessible to the Group

Note: there are no speciﬁc limits on user number; nor on the number of users per serial port or

host. So mul#ple users (Users and Administrators) can control or monitor a port or host.

Similarly there are no speciﬁc limits on the group number and users can be a member of a

number of Groups (and gain the cumula#ve access privileges of each Group). A user does not

have to be a member of any Groups (but if the User is not even a member of the default user

group then cannot use the Management Console to manage ports).

Note: while there are no speciﬁc limits, the #me to re-conﬁgure does increase as the number and

complexity increases. The aggregate number of users and groups should be kept under 250.

The Administrator can also edit the access se$ngs for any exis!ng users:

Opengear User Manual. Page 74.

• Select Serial & Network > Users & Groups and click Edit to modify User access privileges.

• Alterna!vely click Delete to remove the user or Disable to temporarily block access.

Note: for more on enabling the SDT Connector so each user has secure tunneled remote RPD/

VNC/Telnet/HHTP/HTTPS/SoL access to the network connected hosts see chapter 5.

3.3. Authen"ca"on

See chapter 8.1 for authen!ca!on conﬁgura!on details.

3.4. Network hosts

To monitor and remotely access a locally networked computer or device (referred to as a

Host) iden!fy the Host and specify the TCP or UDP ports/services used to control that Host.

• Select Serial & Network > Network Hosts.

All network-connected Hosts that have been enabled for access present as well as the

related access TCP ports/services.

Opengear User Manual. Page 75.

• Click Add Host to enable access to a new Host (or select Edit to update the se$ngs for

exis!ng Host).

• Enter the IP Address or the DNS Name and Host Name (up to 254 alphanumeric characters)

for the new network connected Host.

• enter a Descrip"on (this is an op!onal step).

• Add or edit the Permi$ed Services (or TCP/UDP port numbers) that are authorized to be

used in controlling this host.

Only these permi%ed services will be forwarded through by SDT to the Host. All other

services (TCP/UDP ports) will be blocked.

• Set the Logging Level.

This speciﬁes the level of informa!on to be logged and monitored for each Host access.

See chapter 6 for more.

• If the Host is a PDU or UPS power device or a server with IPMI power control, specify RPC

(for IPMI and PDU) or UPS and the Device Type.

The Administrator can conﬁgure these devices and enable which users have permissions to

remotely cycle power etc. (see chapter 7). Otherwise leave the Device Type set to None.

• If the console server has been conﬁgured with distributed Nagios monitoring enabled then

you will also be presented with Nagios Se$ngs op!ons to enable nominated services on

the Host to be monitored. See Chapter 9 for more.

• Click Apply.

This will create the new Host and also create a new Managed Device (with the same name).

3.5. Trusted networks

The Trusted Networks facility allows you an nominate speciﬁc IP addresses that users

(Administrators and Users) must be located at, to have access to console server serial ports:

• Select Serial & Network > Trusted Networks.

Opengear User Manual. Page 76.

• Click Add Rule to add a new trusted network.

Note: In the absence of Rules, there are no access limita#ons as to the IP address at which Users

or Administrators can be located.

• Select the Accessible Port(s) that the new rule is to be applied to.

• Enter the Network Address of the subnet to be permi%ed access.

• Specify the range of addresses that are to be permi%ed by entering a Network Mask for

that permi%ed IP range.

• For example, to permit all users located in the 204.15.5.0 Class C network to connect to

the nominated port, would add the following Trusted Network rule:

Network IP address: 204.15.5.0

Subnet Mask 255.255.255.0

• To permit only the user located at a speciﬁc IP address (in this case 204.15.5.13) to

connect:

Network IP address: 204.15.5.13

Subnet Mask 255.255.255.255

• To allow all users opera!ng from within a speciﬁc range of IP addresses (in this case the 30

addresses from 204.15.5.129 to 204.15.5.158) to be permi%ed connec!on to the

nominated port:

Network IP address: 204.15.5.128

Subnet Mask 255.255.255.224

• Click Apply.

Note: The above Trusted Networks will limit access by Users and Administrators to the console

serial ports. However they do not restrict access by the Administrator to the console server

itself or to a"ached hosts. To change the default se&ngs for this access, you will to need to

edit the IPtables rules as described in chapter 14.

3.6. Serial port cascading

Cascaded Ports enables you to cluster distributed console servers so up to 1000 serial ports

Opengear User Manual. Page 77.

can be conﬁgured and accessed through one IP address and managed through the one

Management Console. One console server, the Master, controls other console servers as Slave

units and all the serial ports on the Slave units appear as if they are part of the Master.

Opengear’s clustering connects each Slave to the Master with an SSH connec!on. This is

done using public key authen!ca!on so the Master can access each Slave using the SSH key

pair (rather than using passwords). This ensures secure authen!cated communica!ons

between Master and Slaves enabling the Slave console server units to be distributed locally on

a LAN or remotely around the world.

3.6.1. Automa"cally generate & upload SSH keys

To set up public key authen!ca!on ﬁrst generate an RSA or DSA key pair and upload them

into the master and slave console servers. This can be done automa!cally from the Master.

• Select System > Administra"on on the master’s Management Console.

• Check Generate SSH keys automa!cally.

• click Apply.

Next select whether to generate keys using RSA and/or DSA (if unsure, select only RSA).

Genera!ng each set of keys will require approximately two minutes and the new keys will

destroy any old keys of that type that may previously been uploaded. Also while the new

genera!on is underway on the master func!ons relying on SSH keys (e.g. cascading) may stop

func!oning un!l they are updated with the new set of keys. To generate keys:

Opengear User Manual. Page 78.

• Check RSA Keys, DSA Keys, or both.

• Click Apply.

• Once the new keys have been generated, Click here to return and the keys will automa!cally

be uploaded to the master and connected slaves.

3.6.2. Manually generate & upload SSH keys

To manually upload the key public and private key pair to the Master console server:

• Select System > Administra"on on the master’s Management Console.

• Browse to the loca!on you have stored RSA (or DSA) Public Key and upload it to SSH RSA

(DSA) Public Key.

• Browse to the stored RSA (or DSA) Private Key and upload it to SSH RSA (DSA) Private Key.

• Click Apply.

Next, you must register the Public Key as an Authorized Key on the slave. In the simple case

with only one master with mul!ple slaves, you need only upload the one RSA or DSA public

key for each slave.

Note: The use of key pairs can be confusing as in many cases one ﬁle (Public Key) fulﬁlls two roles –

Public Key and Authorized Key. For a more detailed explana#on see the Authorized Keys

sec#on of chapter 14.6. Also refer to this chapter if you need to use more than one set of

Authorized Keys in the slave.

• Select System > Administra"on on the slave’s Management Console.

• Browse again to the stored RSA (or DSA) Public Key and upload it to Slave’s SSH

Opengear User Manual. Page 79.

Authorized Key.

• Click Apply.

The next step is to Fingerprint each new slave-master connec!on. This once-oﬀ step will

validate that you are establishing an SSH session to who you think you are. On the ﬁrst

connec!on the Slave will receive a ﬁngerprint from the Master which will be used on all

future connec!ons.

• Log in to the master console server as root.

• Establish an SSH connec!on to the remote slave host:

# ssh remote-host-name

Once the SSH connec!on has been established you will be asked to accept the key. Answer

yes and the ﬁngerprint will be added to the list of known hosts. For more detail on

Fingerprin!ng see chapter 14.6.

Note: If you are asked to supply a password, then there has been a problem with uploading keys.

The keys should remove any need to supply a password.

3.6.3. Conﬁgure the slaves and their serial ports

You can now begin se$ng up the slaves and conﬁguring slave serial ports from the master

console server.

• Select Serial & Network > Cascaded Ports on the master’s Management Console.

• Click Add Slave to add clustering support.

Note: you cannot add any slaves un#l you have automa#cally or manually generated SSH keys.

To deﬁne and conﬁgure a slave:

• Enter the remote IP Address (or DNS Name) for the Slave console server.

• Enter a brief Descrip"on and a short Label for the slave

Use a conven!on here that enables eﬀec!ve management of large networks of clustered

console servers and the connected devices.

• Enter the full number of serial ports on the slave unit in Number of Ports.

Opengear User Manual. Page 80.

• Click Apply.

This will establish the SSH tunnel between the master and the new slave.

The Serial & Network > Cascaded Ports menu displays all the slaves and the port numbers

that have been allocated on the master. If the master console server has 16 ports of its own

then ports 1–16 are pre-allocated to the master, so the ﬁrst slave added will be assigned port

number 17 onwards.

Once you have added all the slave console servers, the slave serial ports and the connected

devices are conﬁgurable and accessible from the master’s Management Console menu and

accessible through the Master’s IP address.

• Select the appropriate Serial & Network > Serial Port and Edit to conﬁgure the serial ports

on the slave.

• Select the appropriate Serial & Network > Users & Groups to add new users with access

privileges to the slave serial ports (or to extend exis!ng users access privileges).

• Select the appropriate Serial & Network > Trusted Networks to specify network addresses

that can access nominated slave serial ports.

• Select the appropriate Alerts & Logging > Alerts to conﬁgure slave port Connec"on, State

Change or Pa$ern Match alerts.

• click Apply.

The conﬁgura!on changes made on the master are propagated out to all the Slaves.

3.6.4. Managing the slaves

The master is in control of the slave serial ports. So for example if change a User access

privileges or edit any serial port se$ng on the master, the updated conﬁgura!on ﬁles will be

sent out to each slave in parallel. Each slave will then automa!cally make changes to their

local conﬁgura!ons (and only make those changes that relate to its par!cular serial ports).

You can s!ll use the local slave Management Console to change the se$ngs on any slave

serial port (such as alter the baud rates). However these changes will be overwri%en next !me

the master sends out a conﬁgura!on ﬁle update.

Opengear User Manual. Page 81.

Also while the master is in control of all slave serial port related func!ons, it is not master

over the slave network host connec!ons or over the slave console server system itself.

So slave func!ons such as IP, SMTP & SNMP Se$ngs, Date &Time, DHCP server must be

managed by accessing each slave directly and these func!ons are not over wri%en when

conﬁgura!on changes are propagated from the master. Similarly the slaves Network Host and

IPMI se$ngs have to be conﬁgured at each slave.

Also the master’s Management Console provides a consolidated view of the se$ngs for its

own and the en!re slave’s serial ports, however the master does not provide a fully

consolidated view. For example if you want to ﬁnd out who's logged in to cascaded serial

ports from the master, you’ll see that Status > Ac"ve Users only displays those users ac!ve

on the master’s ports, so you may need to write custom scripts to provide this view. This is

covered in chapter 10.

3.7. Serial port redirec"on (PortShare)

Opengear’s PortShare so&ware delivers the virtual serial port technology your Windows and

Linux applica!ons need to open remote serial ports and read the data from serial devices that

are connected to your console server.

PortShare is supplied free with each console server and you are licensed to install PortShare

on one or more computers for accessing any serial device connected to a console server port.

PortShare for Windows

The portshare_setup.exe program is included on the CD supplied with your console

server. A copy can be freely downloaded from the &p site. Refer to the PortShare User Manual

and Quick Start for details on installa!on and opera!on.

PortShare for Linux

The PortShare driver for Linux maps the console server serial port to a host tty port.

Opengear has released the portshare-serial-client as an open source u!lity for Linux, AIX,

HPUX, SCO, Solaris and UnixWare. This u!lity can be freely downloaded from the &p site.

The PortShare serial port redirector allows you to use a serial device connected to the remote

console server as if it were connected to your local serial port. The portshare-serial-

client creates a pseudo %y port, connects the serial applica!on to the pseudo %y port,

receives data from the pseudo %y port, transmits it to the console server through network and

receives data from the console server through network and transmits it to the pseudo-%y port.

The .tar ﬁle can be freely downloaded from the &p site. Refer to the PortShare User Manual

and Quick Start for details on installa!on and opera!on.

3.8. Managed devices

Managed Devices presents a consolidated view of all the connec!ons to a device that can be

accessed and monitored through the console server. To view the connec!ons to the devices:

• Select Serial & Network > Managed Devices.

This screen displays all the Managed Device with their Descrip!on, Notes and lists of all the

conﬁgured Connec!ons:

Serial Port # if serially connected.

Opengear User Manual. Page 82.

USB if USB connected.

IP Address if network connected.

Power PDU/outlet if applicable.

UPS connec"ons if applicable.

Devices such as servers will commonly have more than one power connec!ons (e.g. dual

power supplied) and more than one network connec!on (for example, for BMC/service

processor).

All users can view (but not edit) these Managed Device connec!ons by selec!ng Manage >

Devices. Whereas the Administrator can edit, add to and delete these Managed Devices and

their connec!ons.

To edit an exis!ng device and add a new connec!on:

• Select Serial & Network > Managed Devices.

• Click Edit.

• Click Add Connec"on.

• Select the connec!on type for the new connec!on (Serial, Network Host, UPS or RPC).

• Select the speciﬁc connec!on from the presented list of conﬁgured unallocated hosts/

ports/outlets.

Opengear User Manual. Page 83.

To add a new network connected Managed Device:

• The Administrator adds a new network connected Managed Device using Add Host on the

Serial & Network > Network Host menu. This automa!cally creates a corresponding new

Managed Device (as covered in chapter 3.4).

• When adding a new network connected RPC or UPS power device, you set up a Network

Host, designate it as RPC or UPS, then go to RPC Connec"ons (or UPS Connec"ons) to

conﬁgure the relevant connec!on.

• A corresponding new Managed Device (with the same Name and Descrip"on as the RPC/

UPS Host) is not created un!l this connec!on step is completed (see chapter 8).

Note: the outlet names on a newly created PDU will, by default, be “Outlet 1” and “Outlet 2”.

When you connect an par#cular Managed Device (that draws power from the outlet) the

outlet will take up the name of the powered Managed Device.

To add a new serially connected Managed Device:

• Conﬁgure the serial port using the Serial & Network > Serial Port menu (see chapter 3.1).

• Select Serial & Network > Managed Devices.

• Click Add Device.

• Enter a Device Name and Descrip"on for the Managed Device.

• Click Add Connec"on and select Serial and the Port that connects to the Managed Device.

• click Add Connec"on to add a UPS/RPC power connec!on or network connec!on or

another serial connec!on.

• Click Apply.

Note: To set up a new serially connected RPC UPS or EMD device, you conﬁgure the serial port,

designate it as a Device then enter a Name and Descrip#on for that device in the Serial &

Network: RPC Connec#ons (or UPS Connec#ons or Environmental). When applied, this will

automa#cally create a corresponding new Managed Device with the same Name and

Descrip#on as the RPC/UPS Host (see chapter 7).

Note: the outlet names on the PDU will, by default, be “Outlet 1” and “Outlet 2”. When you

connect a par#cular Managed Device (that draws power from the outlet) the outlet will take

up the name of the powered Managed Device.

Opengear User Manual. Page 84.

3.9. IPsec VPN

The ACM7000, ACM5500, ACM5000, CM7100, IM7200 and IM4200 family of advanced

console servers include Openswan, a Linux implementa!on of the IPsec (IP Security)

protocols, which can be used to conﬁgure a Virtual Private Network (VPN). The VPN allows

mul!ple sites or remote administrators to access the Opengear advanced console server (and

Managed Devices) securely over the Internet.

The administrator can establish an encrypted authen!cated VPN connec!ons between

advanced console serves distributed at remote sites and a VPN gateway (such as Cisco router

running IOS IPsec) on their central oﬃce network.

Users and administrators at the central oﬃce can then securely access the remote console

servers and connected serial console devices and machines on the Management LAN subnet

at the remote loca!on as though they were local.

All these remote console servers can then be monitored with a CMS6000 on the central

network.

With serial bridging, serial data from controller at the central oﬃce machine can be securely

connected to the serially controlled devices at the remote sites (see chapter 3.1.)

The road warrior administrator can use a VPN IPsec so&ware client such as TheGreenBow

(h%ps://thegreenbow.com/) or Shrew So& (h%ps://shrew.net/) to remotely access the

advanced console server and every machine on the Management LAN subnet at the remote

loca!on.

Conﬁgura!on of IPsec is quite complex so Opengear provides a simple GUI interface for basic

set up as described below. However for more detailed informa!on on conﬁguring Openswan

IPsec at the command line and interconnec!ng with other IPsec VPN gateways and road

warrior IPsec so&ware see h%p://wiki.openswan.org and h%p://opengear.com/faq.html.

3.9.1. Enable the VPN gateway

• Select Serial & Networks > IPsec VPN.

• Click Add.

• complete the Add IPsec Tunnel screen.

Opengear User Manual. Page 85.

• Enter a descrip!ve name to iden!fy the added IPsec Tunnel. For example West-St-Outlet.

• Select the Authen!ca!on Method: either RSA digital signatures or a Shared secret (PSK).

If you select RSA you will asked to click here to generate keys. This will generate an RSA

public key for the console server (the Le& Public Key). You will need to ﬁnd out the key to be

used on the remote gateway, then cut and paste it into the Right Public Key.

If you select Shared secret you will need to enter a Pre-shared secret (PSK). The PSK must

match the PSK conﬁgured at the other end of the tunnel.

• In Authen"ca"on Protocol select the authen!ca!on protocol to be used. Either authen!cate

as part of ESP (Encapsula"ng Security Payload) encryp!on or separately using the AH

(Authen"ca"on Header) protocol.

• Enter a Le& ID and Right ID. This is the iden!ﬁer that the Local host/gateway and remote

host/gateway use for IPsec nego!a!on and authen!ca!on.

Each ID must include an @ and can include a fully qualiﬁed domain name preceded by @

(for example, le&@example.com).

• Enter the public IP or DNS address of this Opengear VPN gateway as the Le& Address. You

can leave this blank to use the interface of the default route.

• In Right Address, if the remote end has a sta!c or dyndns address, enter the public IP or

DNS address of the remote end of the tunnel. Otherwise leave this blank.

• If the Opengear VPN gateway is serving as a VPN gateway to a local subnet (for example,

the console server has a Management LAN conﬁgured) enter the private subnet details in

Le& Subnet.

Opengear User Manual. Page 86.

Use the CIDR nota!on, where the IP address number is followed by a slash and the number

of ‘one’ bits in the binary nota!on of the netmask.

For example 192.168.0.0/24 indicates an IP address where the ﬁrst 24 bits are used as the

network address. This is the same as 255.255.255.0.

If the VPN access is only to the console server itself and to its a%ached serial console

devices then leave Le& Subnet blank.

• If there is a VPN gateway at the remote end, enter the private subnet details in Right

Subnet.

Again use CIDR nota!on and leave blank if there is only a remote host.

• Select Ini"ate Tunnel if the tunnel connec!on is to be ini!ated from the Le& console

server end.

This can only be ini!ated from the VPN gateway (Le&) if the remote end was conﬁgured

with a sta!c (or dyndns) IP address.

• Click Apply to save changes.

Note: It is essen#al the conﬁgura#on details set up on the advanced console server (referred to as

the Le( or Local host) exactly matches the set up entered when conﬁguring the Remote

Opengear User Manual. Page 87.

(Right) host/gateway or so(ware client. Refer to the h"p://www.opengear.com/faq.html for

details on conﬁguring these remote ends.

3.10. OpenVPN

The ACM7000, ACM5500, ACM5000, CM7100, IM7200 and IM4200 family of advanced

console servers with Firmware v3.2 and later, include OpenVPN. OpenVPN uses the OpenSSL

library for encryp!on, authen!ca!on, and cer!ﬁca!on, which means it uses SSL/TSL (Secure

Socket Layer/Transport Layer Security) for key exchange and can encrypt both data and

control channels. Using OpenVPN allows for the building of cross-pla*orm, point-to-point

VPNs using either X.509 PKI (Public Key Infrastructure) or custom conﬁgura!on ﬁles.

OpenVPN allows secure tunneling of data through a single TCP/UDP port over an unsecured

network, thus providing secure access to mul!ple sites and secure remote administra!on to a

console server over the Internet.

OpenVPN also allows the use of Dynamic IP addresses by both the server and client thus

providing client mobility. For example, an OpenVPN tunnel may be established between a

roaming windows client and an Opengear advanced console server within a data center.

Conﬁgura!on of OpenVPN can be complex so Opengear provides a simple GUI interface for

basic set up as described below. However for more detailed informa!on on conﬁguring

OpenVPN Access server or client refer to the HOW TO and FAQs at h%ps://openvpn.net/.

3.10.1. Enable the OpenVPN

• Select Serial & Netwoks > OpenVPN.

• Click Add.

• Fill-out the required ﬁelds on the Add OpenVPN Tunnel screen.

• Enter a descrip!ve name to iden!fy the added IPsec Tunnel. For example West-St-Outlet.

Opengear User Manual. Page 88.

• Select the authen!ca!on method to be used.

To authen!cate using cer!ﬁcates select PKI (X.509 Cer"ﬁcates).

To authen!cate using a custom conﬁgura!on select Custom Conﬁgura"on to upload custom

conﬁgura!on ﬁles.

Note: Custom conﬁgura#ons must be stored in /etc/config.

If you select PKI (public key infrastructure) you will need to establish:

• a separate cer!ﬁcate (also known as a public key).

This Cer!ﬁcate File will be a *.crt ﬁle type.

• a Private Key for the server and each client.

This Private Key File will be a *.key ﬁle type.

• A master Cer!ﬁcate Authority (CA) cer!ﬁcate and key which is used to sign each of the

server and client cer!ﬁcates.

This Root CA Cer!ﬁcate will be a *.crt ﬁle type.

For a server you may also need dh1024.pem (Diﬃe Hellman parameters).

See h%p://openvpn.net/easyrsa.html for a guide to basic RSA key management. For

alterna!ve authen!ca!on methods see h%p://openvpn.net/index.php/documenta!on/

howto.html#auth. For more informa!on also see h%p://openvpn.net/howto.html.

• Select the Device Driver to be used, either Tun-IP or Tap-Ethernet.

The TUN (network tunnel) and TAP (network tap) drivers are virtual network drivers that

support IP tunneling and Ethernet tunneling, respec!vely. TUN and TAP are part of the

Linux kernel.

Opengear User Manual. Page 89.

• Select either UDP or TCP as the Protocol.

UDP is the default and preferred protocol for OpenVPN.

• In Tunnel Mode, nominate whether this is the Client or Server end of the tunnel.

When running as a server, the advanced console server supports mul!ple clients

connec!ng to the VPN server over the same port.

• Check or uncheck the Compression bu%on to enable or disable compression.

3.10.2. Conﬁgure as server or client

• Complete the Client Details or Server Details depending on the Tunnel Mode selected.

If Client has been selected, the Primary Server Address will be the address of the OpenVPN

Server.

If Server has been selected, enter the IP Pool Network address and the IP Pool Network

mask for the IP Pool. The network deﬁned by the IP Pool Network address/mask is used to

provide the addresses for connec!ng clients.

• Click Apply.

• To enter authen!ca!on cer!ﬁcates and ﬁles, Edit the OpenVPN tunnel.

Opengear User Manual. Page 90.

• Select the Manage OpenVPN Files tab. Upload or browse to relevant authen!ca!on

cer!ﬁcates and ﬁles.

• Click Apply.

Saved ﬁles will be displayed in red on the right-hand side of the Upload bu%on.

• To enable OpenVPN, Edit the OpenVPN tunnel.

• Check the Enabled bu%on.

• Click Apply.

Note: the console server system #me must be correct. Otherwise authen#ca#on issues can arise.

• Select Status > Sta"s"cs to verify that the tunnel is opera!onal.

3.10.3. Windows OpenVPN client & server setup

Windows does not come standard with any OpenVPN server or client. This sec!on outlines

the installa!on and conﬁgura!on of a Windows OpenVPN client or a Windows OpenVPN

server and se$ng up a VPN connec!on to a console server.

Console servers with ﬁrmware V3.5.2 and later will generate Windows client conﬁg

Opengear User Manual. Page 91.

automa!cally from the GUI for Pre-shared Secret (Sta!c Key File) conﬁgura!ons.

Alternately OpenVPN GUI for Windows so&ware (which includes the standard OpenVPN

package plus a Windows GUI) can be downloaded from h%ps://openvpn.net/.

Once installed on the Windows machine, an OpenVPN icon will present in the No!ﬁca!on

Area located in the right side of the taskbar.

• Right click on this icon to start (and stop) VPN connec!ons, and to edit conﬁgura!ons and

view logs.

When the OpenVPN so&ware is started, the C:\Program Files\OpenVPN\config

folder will be scanned for .opvn ﬁles. This folder is rechecked for new conﬁgura!on ﬁles

whenever the OpenVPN GUI icon is right-clicked.

So once the OpenVPN client is installed, a conﬁgura!on ﬁle will need to be created.

• Using a text editor, create an xxxx.ovpn ﬁle and save in C:\Program Files\OpenVPN

\config\. For example, C:\Program Files\OpenVPN\config\client.ovpn.

• An example OpenVPN Windows client conﬁgura!on ﬁle:

# description: IM4216_client

client

proto udp

verb 3

dev tun

remote 192.168.250.152

port 1194

ca c:\\openvpnkeys\\ca.crt

cert c:\\openvpnkeys\\client.crt

key c:\\openvpnkeys\\client.key

nobind

persist-key

persist-tun

comp-lzo

• An example OpenVPN Windows server conﬁgura!on ﬁle:

server 10.100.10.0 255.255.255.0

port 1194

Opengear User Manual. Page 92.

keepalive 10 120

proto udp

mssfix 1400

persist-key

persist-tun

dev tun

ca c:\\openvpnkeys\\ca.crt

cert c:\\openvpnkeys\\server.crt

key c:\\openvpnkeys\\server.key

dh c:\\openvpnkeys\\dh.pem

comp-lzo

verb 1

syslog IM4216_OpenVPN_Server

The Windows client/server conﬁgura!on ﬁle op!ons are:

op"ons

# comments and notes

client or server

proto [udp | tcp]

mssﬁx size

verb level

dev [tun | tap]

remote host

Port

Keepalive ping-value down-value

h%p-proxy proxy-server proxy-port-#

descrip"on

Lines beginning with # are ignored by OpenVPN.

Specify whether this will be a client or server

conﬁgura!on ﬁle. In the server conﬁgura!on ﬁle, deﬁne

the IP address pool and netmask. For example

server 10.100.10.0 255.255.255.0

Set the protocol.

Client and server must be the same.

Set a packet’s maximum size.

Only useful for UDP if problems occur.

Set log-ﬁle verbosity. Values range from 0–15.

0 = silent except for fatal errors.

3 = medium output logging. Good for general use.

5 = helps with debugging connec!on problems.

9 = extremely verbose. Excellent for troubleshoo!ng.

Set dev tun to create a routed IP tunnel.

Set dev tup to create an Ethernet tunnel.

Client and server must be the same.

Set the hostname or IP address of the OpenVPN server.

Mandatory but a client-only se$ng.

The UDP or TCP port of the OpenVPN server.

Uses ping to keep the OpenVPN session alive.

For example:

Keepalive 10 120

pings the server every ten seconds and assumes the

remote peer is down if no ping is received a&er 120

seconds (two minutes).

If a proxy is required to access a server, enter the

proxy-server’s hostname or IP address and its port #.

Opengear User Manual. Page 93.

To ini!ate the OpenVPN tunnel following the crea!on of the client/server conﬁgura!on ﬁles:

•Right click on the OpenVPN icon in the No!ﬁca!on Area.

•Select the newly created client or server conﬁgura!on.

• Click Connect in the presented sub-menu.

• The log ﬁle will display as the connec!on is established.

• Once established, the OpenVPN icon will display a message no!fying of the successful

ca ﬁle-name

cert ﬁle-name

key ﬁle-name

dh ﬁle-name

Nobind

persist-key

persist-tun

cipher [BF-CBC Blowﬁsh | AES-128-

CBC AES | DES-EDE3-CBC Triple

DES]

comp-lzo

syslog

Enter the CA cer!ﬁcate ﬁle name and loca!on

The same CA cer!ﬁcate can be used by the server and

all clients.

Ensure each \ in the directory path is escaped.

For example c:\openvpnkeys\ca.crt

must be entered as c:\\openvpnkeys\\ca.crt

Enter the client’s or server’s cer!ﬁcate ﬁle name and

loca!on

Each client should have its own cer!ﬁcate and key ﬁles.

As above, each \ in the directory path must be escaped.

Enter the client’s or server’s key ﬁle name and loca!on

Each client should have its own cer!ﬁcate and key ﬁles.

As above, each \ in the directory path must be escaped.

Enter the path to thekey with the Diﬃe-Hellman

parameters.

A server-only se$ng.

Used when clients do not need to bind to a local

address or speciﬁc local port number.

This is the case in most client conﬁgura!ons.

Prevents the reloading of keys across restarts.

Prevents the closing and reopening of TUN/TAP

devices across restarts.

Sets the cryptographic cipher.

BF-CBC Blowﬁsh is the default if no cipher is explicitly

set.

The client and server must use the same se$ngs.

Enables compression on the OpenVPN link.

If enabledit must be set on the client and the server.

Located in syslog on Linux or Unix.

Located in \Program Files\OpenVPN\log\ if

running as a service on Windows.

Opengear User Manual. Page 94.

connec!on and assigned IP.

This informa!on, as well as the !me the connec!on was established, is available any!me

by scrolling over the OpenVPN icon.

Note: An alternate, open-source OpenVPN Windows client can be downloaded from h"ps://

openvpn.net/index.php/open-source/downloads.html. See h"ps://openvpn.net/index.php/

access-server/docs for help.

3.11. PPTP VPN

The ACM7000, ACM5500, ACM5000, CM7100, IM7200 and IM4200 family of advanced

console servers with Firmware V3.5.2 and later, include a PPTP (Point-to-Point Tunneling

Protocol) server. PPTP is typically used for communica!ons over a physical or virtual serial

link. The PPP endpoints deﬁne a virtual IP address to themselves. Routes to networks can

Opengear User Manual. Page 95.

then be deﬁned with these IP addresses as the gateway, which results in traﬃc being sent

across the tunnel. PPTP establishes a tunnel between the physical PPP endpoints and

securely transports data across the tunnel.

The strength of PPTP is its ease of conﬁgura!on and integra!on into exis!ng Microso&

infrastructure. It is generally used for connec!ng single remote Windows clients. If you take

your portable computer on a business trip, you can dial a local number to connect to your

Internet access service provider (ISP) and then create a second connec!on (tunnel) into your

oﬃce network across the Internet and have the same access to your corporate network as if

you were connected directly from your oﬃce. Similarly, telecommuters can also set up a VPN

tunnel over their cable modem or DSL links to their local ISP.

To set up a PPTP connec!on from a remote Windows client to your Opengear appliance and

local network:

• Enable and conﬁgure the PPTP VPN server on your Opengear appliance.

• Set up VPN user accounts on the Opengear appliance and enable the appropriate

authen!ca!on.

• Conﬁgure the VPN clients at the remote sites. The client does not require special so&ware

as the PPTP Server supports the standard PPTP client so&ware included with Windows NT

and later.

• Connect to the remote VPN.

3.11.1. Enable the PPTP VPN server

• Select PPTP VPN on the Serial & Networks menu.

• Click the Enable check box to enable the PPTP Server.

• Select the Minimum Authen"ca"on Required.

Opengear User Manual. Page 96.

Access is denied to remote users a%emp!ng to connect using an authen!ca!on scheme

weaker than the selected scheme. The schemes are described below, from strongest to

weakest.

Encrypted Authen"ca"on (MS-CHAP v2). The strongest type of authen!ca!on to use. This is

the recommended op!on.

Weakly Encrypted Authen"ca"on (CHAP). This is the weakest type of encrypted password

authen!ca!on to use. It is not recommended that clients connect using this as it provides

very li%le password protec!on. Also note that clients connec!ng using CHAP are unable to

encrypt traﬃc.

Unencrypted Authen"ca"on (PAP). This is plain text password authen!ca!on. When using

this type of authen!ca!on, the client password is transmi%ed unencrypted.

None. No encryp!on at all.

• Select the Required Encryp"on Level.

Access is denied to remote users a%emp!ng to connect not using this encryp!on level. 40

bit or 128 bit encryp"on is recommended.

• In Local Address enter the IP address to assign to the server’s end of the VPN connec!on.

• In Remote Addresses enter the pool of IP addresses to assign to the incoming client’s VPN

connec!ons (e.g. 192.168.1.10-20).

These must be free IP addresses, from the network (typically the LAN) that remote users

are assigned while connected to the Opengear appliance.

• Enter the desired value of the Maximum Transmission Unit (MTU) for the PPTP interfaces

into the MTU ﬁeld (defaults to 1400).

• In the DNS Server ﬁeld, enter the IP address of the DNS server that assigns IP addresses to

connec!ng PPTP clients.

• In the WINS Server ﬁeld, enter the IP address of the WINS server that assigns IP addresses

to connec!ng PPTP client.

• Enable Verbose Logging to assist in debugging connec!on problems.

• Click Apply.

3.11.2. Add a PPTP user

• Navigate to Serial & Networks > Users & Groups.

• Complete the ﬁelds as covered in chapter 3.2.

• Ensure the pptpd Group has been checked, to allow access to the PPTP VPN server.

Note: users in this group will have their password stored in clear text.

• Keep note of the username and password for when you need to connect to the VPN

connec!on.

• Click Apply.

Opengear User Manual. Page 97.

3.11.3. Setup a remote PPTP client

Ensure the remote VPN client PC has Internet connec!vity. To create a VPN connec!on

across the Internet, you must set up two networking connec!ons. One connec!on is for the

ISP, and the other connec!on is for the VPN tunnel to the Opengear appliance.

Note: This procedure sets up a PPTP client under Windows 7 Professional. The steps may vary

slightly depending on your network access or if you are using a diﬀerent version of Windows.

• Login to your Windows system with administrator privileges.

• From the Network & Sharing Center in the Control Panel select Network Connec"ons and

create a new connec!on.

Opengear User Manual. Page 98.

• Select Use My Internet Connec"on (VPN) and enter the IP Address of the Opengear

appliance.

Note: To connect remote VPN clients to the local network, you need to know the user name and

password for the PPTP account you added, as well as the Internet IP address of the

Opengear appliance. If your ISP has not allocated you a sta#c IP address, consider using a

dynamic DNS service. Otherwise you must modify the PPTP client conﬁgura#on each #me

your Internet IP address changes.

3.12. Call home

All console servers with Firmware V3.2 and later, include the Call Home feature which ini!ates

the setup of a secure SSH tunnel from the console server to a centralized Lighthouse VM,

Lighthouse Standard, Lighthouse Enterprise, CMS6100 or VCMS server (referred to herein as

CMS). The console server then registers as a “candidate” on the CMS. Once accepted there it

becomes a Managed Console Server.

The CMS will then monitor the Managed Console Server, and administrators can access the

remote Managed Console Server, through the CMS. This access is available even when the

remote console server is behind a third party ﬁrewall or has a private non-routable IP

addresses (which is o&en the case when the console server is connected via a cellular modem

connec!on).

CMS maintains public key authen!cated SSH connec!ons to each of its Managed Console

Servers. These connec!ons are used for monitoring, commanding and accessing the Managed

Console Servers and the Managed Devices connected to the Managed Console Server.

To manage Local Console Servers, or console servers that are reachable from the CMS, the

SSH connec!ons are ini!ated by CMS.

To manage Remote Console Servers, or console servers that are ﬁrewalled, not routable, or

otherwise unreachable from the CMS, the SSH connec!ons are ini!ated by the Managed

Console Server via an ini!al Call Home connec!on.

This ensures secure, authen!cated communica!ons and enables Managed Console Servers

units to be distributed locally on a LAN, or remotely around the world.

3.12.1. Setup call home candidate

To set up the console server as a Call Home management candidate on the CMS:

• Select Call Home on the Serial & Network menu.

• If you have not already generated or uploaded an SSH key pair for this console server, you

will need to do so before proceeding (see chapter 2).

Opengear User Manual. Page 99.

• Click Add.

• Enter the IP address or DNS name (for example, the dynamic DNS address) of the CMS.

• Enter the Password that you conﬁgured on the CMS as the Call Home Password.

• Click Apply.

These steps ini!ate the Call Home connec!on from the console server to the CMS. This

creates an SSH listening port on the CMS, and sets the console server up as a candidate.

Once the candidate has been accepted on the CMS (as outlined in the next sec!on) an SSH

tunnel to the console server is then redirected back across the Call Home connec!on. The

console server has now become a Managed Console Server and the CMS can connect to and

monitor it through this tunnel.

3.12.2. Accept call home candidate as managed console

This sec!on gives an overview on conﬁguring the CMS to monitor console servers that are

connected via Call Home. For more details refer to the Lighthouse CMS User Manual.

You ﬁrst must enter a new Call Home Password on the CMS. This password is used solely for

accep!ng Call Home connec!ons from candidate console servers.

So the CMS can be contacted by the console server it must have either a sta!c IP address or —

if using DHCP — be conﬁgured to use a dynamic DNS service.

The Conﬁgure > Managed Console Servers screen on the CMS shows the status of local and

remote Managed Console Servers and candidates.

The Managed Console Server sec!on shows the console servers currently being monitored

by the CMS.

Opengear User Manual. Page 100.

The Detected Console Servers sec!on shows the Local Console Servers drop down list (which

lists all the console servers which are on the same subnet as the CMS but which not currently

being monitored) and the Remote Console Servers drop down list (which lists all the console

servers that have established a Call Home connec!on but which are not currently being

monitored). Put another way, the Remote Console Servers drop down list lists CMS candidates.

To update either list, click Refresh.

To add a console server candidate to the Managed Console Server list:

• Select it from the Remote Console Servers drop down list.

• click Add.

• Enter the IP Address and SSH Port (if these ﬁelds have not been auto-completed).

• Enter a Descrip"on and unique Name for the Managed Console Server you are adding.

• Enter the Remote Root Password (that is, the System Password that has been set on this

Managed Console Server).

This password is used by the CMS to propagate auto generated SSH keys and then

forgo%en. It will not be stored.

• Click Apply.

The CMS will now set up secure SSH connec!ons to and from the Managed Console

Server and will retrieve its Managed Devices, user account details and conﬁgured alerts.

3.12.3. Calling home to a generic central SSH server

If you are connec!ng to a generic SSH server (not a Lighthouse CMS) you may conﬁgure

Advanced se$ngs.

• Enter the SSH Server Port and SSH User to authen!cate as.

• Enter the details for the SSH port forward(s) to create.

Opengear User Manual. Page 101.

By selec!ng Listening Server, you may create a Remote port forward from the Server to this

unit, or a Local port forward from this unit to the Server.

• Specify a Listening Port to forward from.

Leave this ﬁeld blank to allocate an unused port

• Enter the Target Server and Target Port that will be the recipient of forwarded connec!ons.

• Click Add.

3.13. IP passthrough

IP Passthrough is used to make a modem connec!on (for example, the Opengear’s internal

cellular modem) appear like a regular Ethernet connec!on to a third-party downstream router,

allowing the downstream router to use the Opengear’s modem connec!on as a primary or

backup WAN interface.

The Opengear provides the modem IP address and DNS details to the downstream device

over DHCP and transparently passes network traﬃc to and from the modem and router.

While IP Passthrough essen!ally turns an Opengear into a modem-to-Ethernet half bridge,

some speciﬁc layer 4 services (HTTP/HTTPS/SSH) may s!ll be terminated at the Opengear

(Service Intercepts). Also, services running on the Opengear can ini!ate outbound cellular

connec!ons independent of the downstream router.

This allows the Opengear to con!nue to be used for out-of-band management and aler!ng

and also be managed via Lighthouse, while in IP Passthrough mode.

3.13.1. Downstream router setup

To use failover connec!vity on the downstream router (aka Failover to Cellular or F2C), it

must have two or more WAN interfaces.

Note: Failover in IP Passthrough context is performed en#rely by the downstream router, and the

built-in out-of-band failover logic on the Opengear itself is not available while in IP

Passthrough mode.

• Connect an Ethernet WAN interface on the downstream router to the Opengear’s

Network Interface or Management LAN port with an Ethernet cable.

• Conﬁgure this interface on the downstream router to receive its network se$ngs via

DHCP.

• If failover is required, conﬁgure the downstream router for failover between its primary

interface and the Ethernet port connected to the Opengear.

3.13.2. IP passthrough pre-requisite pre-conﬁgura"on steps.

Conﬁgure the Network Interface and, where applicable, Management LAN interfaces with sta!c

network se$ngs.

• Click Serial & Network > IP.

• For Network Interface and, where applicable, Management LAN, select Sta"c for the

Opengear User Manual. Page 102.

Conﬁgura"on Method and enter the network se$ngs (see the chapter 2.3 for detailed

instruc!ons).

• For the interface connected to the downstream router, you may choose any dedicated

private network. This network will only exist between the Opengear and downstream

router and will not normally be accessible.

• For the other interface, conﬁgure it as you would per normal on the local network.

• For both interfaces, leave Gateway blank.

Conﬁgure the Opengear modem in Always On Out-of-band mode.

• For a cellular connec!on, click System > Dial > Internal Cellular Modem.

• Select Enable Dial-Out and enter carrier details such as APN (see chapter 4.6 for detailed

instruc!ons).

3.13.3. IP passthrough cer"ﬁca"on

To conﬁgure IP Passthrough:

• Click Serial & Network > IP Passthrough.

• check Enable.

• Select the Opengear Modem to use for upstream connec!vity.

•Op!onally, enter the MAC Address of the downstream router’s connected interface.

Note: if an MAC address is not speciﬁed, the Opengear will passthrough to the ﬁrst downstream

device reques#ng a DHCP address.

• Select the Opengear Ethernet Interface to use for connec!vity to the downstream router

• Click Apply.

3.13.4. Service intercepts

These allow the Opengear to con!nue to provide services for e.g. out-of-band management

when in IP Passthrough mode. Connec!ons to the modem address on the speciﬁed intercept

port(s) will be handled by the Opengear, rather than being passed through to the downstream

router.

Opengear User Manual. Page 103.

• For the required service of HTTP, HTTPS or SSH, check Enable.

•Op!onally, modify the Intercept Port to an alternate port (for example, 8443 for HTTPS).

This is useful if you want to con!nue to allow the downstream router to remain accessible

via its regular port.

3.13.5. IP passthrough status

• Refresh the page to view the Status sec!on.

It displays the modem’s External IP Address being passed through, the Internal MAC

Address of the downstream router (only populated when the downstream router accepts

the DHCP lease), and the overall running status of the IP Passthrough service.

Addi!onally, you may be alerted to the failover status of the downstream router by

conﬁguring a Routed Data Usage Check under Alerts & Logging > Auto-Response.

3.13.6. Caveats

Some downstream routers may be incompa!ble with the gateway route. This may happen

when IP Passthrough is bridging a 3G cellular network where the gateway address is a point-

to-point des!na!on address and no subnet informa!on is available.

The console server sends a DHCP netmask of 255.255.255.255. Devices will normally

correctly construe this as a ‘single host route’ on the interface, but as this is an unusual se$ng

for Ethernet, some older downstream devices may have issues.

Intercepts for local services will not work if the Opengear is using a default route other than

the modem. As per normal opera!on, they will also not work unless the service is enabled and

access to the service is enabled (see System > Services > Service Access > Dialout/Cellular).

Outbound connec!ons origina!ng from consoler servers to remote services are supported (for

example, sending SMTP email alerts, SNMP traps, ge$ng NTP !me, and IPSec tunnels). There

is, however, a miniscule risk of connec!on failure should both the console server and the

downstream device try to access the same UDP or TCP port on the same remote host at the

same !me where they have randomly chosen the same origina!ng local port number.

Opengear User Manual. Page 104.

4.Firewall, failover, & OOB access

The console server has a number of out-of-band access capabili!es and transparent fail-over

features, to ensure high availability. So if there’s diﬃculty in accessing the console server

through the main network path, all console server models provide out-of-band (OOB) access

and the Administrator can s!ll access it (and its Managed Devices) from a remote loca!on.

All console server models support serially a%aching an external dial-up modem and conﬁguring

dial-in OOB access. Some models with USB ports support a%aching an external USB modem.

Some models also come standard with an internal modem. These modems can also be

conﬁgured for dial-in OOB access.

All console server models with an internal or externally a%ached modem (and V3.4 ﬁrmware or

later) can be conﬁgured for out-dial to be permanently connected .

The advanced console server models can also be conﬁgured for transparent out-dial failover.

So in the event of a disrup!on in the principal management network, an external dial-up ppp

connec!on is automa!cally established.

These advanced console server models can also be accessed out-of-band using an alternate

broadband link and also oﬀer transparent broadband failover.

Models with an internal cellular modem can be conﬁgured for OOB cellular access or for

cellular transparent failover or can be conﬁgured as a cellular router.

4.1. Dial-up modem connec"on

To enable dial-in or dial-out you must ﬁrst ensure there is a modem a%ached to the console

server.

Opengear User Manual. Page 105.

All IM4200 and IM7200 models, ACM5508-2-M and ACM5003-M come with an internal

modem which can provide for OOB dial-in access. These models will display an Internal

Modem Port tab under System > Dial as well as the Serial DB9 Port tab.

The other CM7100, ACM7000, ACM5500 and ACM5000 models also support external USB

modems. The USB modem will be auto-detected and an External USB Modem Port tab will

come up under System > Dial in addi!on to the Serial DB9 Port tab. All console server models

support an external modem (any brand) a%ached via a serial cable to the console/modem port

for OOB dial-in access.

The serial ports on the ACM7000, ACM5500 and ACM5000 are, by default, all conﬁgured as

RJ serial Console Server ports. However Port 1 can be conﬁgured to be the Local Console/

Modem port.

4.2. OOB dial-in access

Once a modem has been a%ached to the console server you can conﬁgure the console server

for dial-in PPP access. The console server will then await an incoming connec!on from a dial-in

at remote site. Next the remote client dial-in so&ware needs to be conﬁgured to establish the

connec!on between the Administrator’s client modem to the dial in modem on the console

server.

4.2.1. Conﬁgure dial-in PPP

Enable PPP access on the internal or externally a%ached modem:

• Navigate to System > Dial.

• In the sec!on appropriate to the port being conﬁgured (Serial DB9 Port or Internal Modem

Port or External USB Port) Select the Baud Rate and Flow Control that will communicate

with the modem.

By default the modem port on all console servers is set with so&ware ﬂow control and the

baud rate is set at:

115200 baud for external modems connected to the local console port on CM7100,

IM7200 and IM4200 console servers

Opengear User Manual. Page 106.

9600 baud for the internal modem or external USB modem and for external modems

connected to the Console serial ports which have been reassigned for dial-in access (on

ACM5000, ACM5500 and ACM7000.

When enabling OOB dial-in it is recommended that the Serial Se$ngs be changed to

38400 Baud Rate with Hardware Flow Control.

Note: you can further conﬁgure the console/modem port (e.g. to include modem init strings) by

edi#ng /etc/mgetty.config ﬁles as described in the chapter 13.

• Check the Enable Dial-In Access check box.

• In the Remote Address ﬁeld, enter the IP address to be assigned to the dial-in client.

You can select any address for the Remote IP Address. However it must be in the same

network range as the Local IP Address (for example, 200.100.1.12 and 200.100.1.67).

• In the Local Address ﬁeld enter the IP address for the Dial-In PPP Server.

This is the IP address that will be used by the remote client to access console server once

the modem connec!on is established. Again you can select any address for the Local IP

Address but it must both be in the same network range as the Remote IP Address.

• The Default Route op!on sets the dialed PPP connec!on as the default console server route.

• The Custom Modem Ini"aliza"on op!on allows a custom AT string modem ini!aliza!on

string to be entered (e.g. AT&C1&D3&K3).

• Select the Authen"ca"on Type required.

Access is denied to remote users a%emp!ng to connect using an authen!ca!on scheme

weaker than the selected scheme. The schemes, from strongest to weakest, are:

Encrypted Authen"ca"on (MS-CHAP v2). Recommended. The strongest authen!ca!on.

Weakly Encrypted Authen"ca"on (CHAP). This is the weakest encrypted password

authen!ca!on to use. Not recommended as it provides very li%le password protec!on.

Also note that clients connec!ng using CHAP are unable to encrypt traﬃc.

Unencrypted Authen"ca"on (PAP). This is plain text password authen!ca!on. When using

this type of authen!ca!on, the client password is transmi%ed unencrypted.

None. No encryp!on at all.

• Select the Required Encryp"on Level. Access is denied to remote users a%emp!ng to

connect not using this encryp!on level. 40 bit or 128 bit encryp"on is recommended.

Note: Firmware v3.5.2 and later support mul#ple dial-in users, setup with dialin Group

membership. The User name and Password for the dial-in PPP link, and any dial-back phone

numbers are conﬁgured during User set up. Earlier ﬁrmware only supports one PPP dial-in

account.

Chapter 14 has Linux command examples to control modem port opera!on at the shell.

4.2.2. Using SDT connector client

Administrators can use their SDT Connector client to set up secure OOB dial-in access to

Opengear User Manual. Page 107.

remote console servers. The SDT Connector Java client so&ware provides point-and-click

secure remote access. OOB access uses an alternate path for connec!ng to the console

server to that used for regular data traﬃc.

Start an OOB connec!on in SDT Connector by ini!a!ng a dial-up connec!on, or adding an

alternate route to the console server. SDT Connector allows for maximum ﬂexibility in this

regard, by allowing you to provide your own scripts or commands for star!ng and stopping

the OOB connec!on. See chapter 5.5 for more.

4.2.3. Setup Windows XP or later client

Navigate to Start Menu > Control Panel.

Click Network Connec"ons.

Click the New Connec"on Wizard.

Select Connect to the Internet

Click Next.

On the Ge$ng Ready screen select Set up my connec"on manually.

Click Next.

On the Internet Connec!on screen select Connect using a dial-up modem.

Click Next.

Enter a Connec"on Name (any name you choose)

Enter the dial-up Phone number that will connect thru to the console server modem.

Enter the PPP User name and Password you have set up for the console server.

4.2.4. Setup earlier Windows clients

For Windows 2000, the PPP client set up procedure is the same as above, except you get to

the Dial-Up Networking Folder by clicking Start and selec!ng Se!ngs. Then click through

Network > Dial-up Connec"ons > Make New Connec"on.

4.2.5. Setup Linux clients

The online tutorial h%p://yolinux.com/TUTORIALS/LinuxTutorialPPP.html presents a selec!on

of methods for establishing a dial up PPP connec!on.

• Command line PPP and manual conﬁgura!on (which works with any Linux distribu!on).

• Using the Linuxconf conﬁgura!on tool (for Red Hat compa!ble distribu!ons).

This conﬁgures the scripts ifup and ifdown to start and stop a PPP connec!on.

• Using the Gnome control panel conﬁgura!on tool.

• Using WVDIAL and the Redhat Dialup conﬁgura!on tool.

• Using the GUI dial program X-isp.

Opengear User Manual. Page 108.

Note: for all PPP clients set up TCP/IP as the only protocol enabled; set the Server to assign IP

address and do DNS; do not set console server PPP as the default Internet connec#on.

4.3. Dial-out access

A console server modem, internal or external, can be set in Failover mode (dialing-out a&er a

ping failure) or with always-on dial-out. In either case, if disrupted, the console server tries to

re-establish connec!on.

4.3.1. Always-on dial-out

With ﬁrmware v3.4 and later console server modems can be conﬁgured for always-on dial-out,

with a permanent external dial-up ppp connec!on.

• Navigate to System > Dial.

Opengear User Manual. Page 109.

• check the Enable Dial-Out to allow outgoing modem communica!ons.

• select the Baud Rate and Flow Control that will communicate with the modem.

• In the Dial-Out Se!ngs — Always On Out-of-Band ﬁelds enter the access details for the

remote PPP server to be called.

The Override DNS sec!on is available for PPP Devices such as modems. Override DNS

allows the use of alternate DNS servers from those provided by your ISP. For example, an

alterna!ve DNS may be required for OpenDNS used for content ﬁltering.

To enable Override DNS:

• check the Override returned DNS Servers checkbox.

• Enter the IP address of the alterna!ve DNS servers in the DNS Server 1 and DNS Server 2

entry ﬁelds.

• Click Apply.

4.3.2. Failover dial-out

The ACM7000, ACM5500, ACM5000, CM7100, IM7200 and IM4200 series of advanced

console servers can be conﬁgured so a dial-out PPP connec!on is automa!cally set up in the

event of a disrup!on in the principal management network.

Note: with ﬁrmware v3.0.1 and earlier, only SSH access is enabled on the failover connec#on. In

later ﬁrmware versions 3.0.2 and later HTTPS access is also enabled. Once the dial-out PPP

connec#on is established the administrator can connect to the console server via SSH (or

HTTPS on console servers running ﬁrmware 3.0.2 or later) and ﬁx the problem.

Opengear User Manual. Page 110.

When conﬁguring the principal network connec!on in System > IP specify the Failover

Interface to be used when a fault has been detected with Network or Network1 (that is, eth0).

This can be either the Internal Modem, Dial Serial DB9 (if you are using an external modem on

the console port), or USB Modem (if you are using a plug-on USB modem on an ACM7000,

ACM5500 or ACM5000).

• Set the Probe Addresses of two sites (the Primary and Secondary) that the IM console server

is to ping to determine if Network or Network1 is s!ll opera!onal.

• Navigate to System > Dial.

• Select the port to be conﬁgured: Serial DB9 Port, PC Card, or Internal Modem Port.

• Select the Baud Rate and Flow Control that will communicate with the modem.

• Check the Enable Dial-Out Access checkbox.

• In the Dial-Out Se!ngs — Always On Out-of-Band ﬁelds enter the access details for the

remote PPP server to be called.

The Override DNS sec!on is available for PPP Devices such as modems. Override DNS

allows the use of alternate DNS servers from those provided by your ISP. For example, an

alterna!ve DNS may be required for OpenDNS used for content ﬁltering.

To enable Override DNS:

• check the Override returned DNS Servers checkbox.

• Enter the IP address of the alterna!ve DNS servers in the DNS Server 1 and DNS Server 2

entry ﬁelds.

Opengear User Manual. Page 111.

• Click Apply.

Note: as of ﬁrmware v3.1.0 and later, the advanced console server, by default, supports

automa#c failure-recovery back to the state extant prior to the failover. The advanced

console server con#nually pings probe addresses whilst in original and failover states. The

original state will automa#cally be set as a priority and reestablished following three

successful pings of the probe addresses during failover. The failover state will be removed

once the original state has been re-established.

4.4. OOB broadband ethernet access

The ACM7000, ACM5500, ACM5000, CM7100, IM7200 and IM4200 family of advanced

console servers have a second ethernet port which can be conﬁgured for alternate and OOB

(out-of-band) broadband access.

With two ac!ve broadband access paths to these advanced console servers, in the event you

are unable to access through the primary management network (LAN1, Network or

Network1) you can s!ll access it through the alternate broadband path.

• Navigate to System > IP.

• select Management LAN Interface (ACM5004-2, CM7100, IM7200, and IM4200).

• conﬁgure the IP Address, Subnet Mask, Gateway and DNS with the access se$ngs that

relate to the alternate link.

Note: when conﬁguring the principal Network Interface connec#on, the Failover Interface must

be set to None.

4.5. Broadband ethernet failover

The second Ethernet port on the ACM7000, ACM5500, ACM5000, CM7100, IM7200 and

IM4200 family of advanced console servers can also be conﬁgured for failover to ensure

transparent high availability.

console server

ACM5004-2, ACM5508-2-I/M and ACM5504-3-P

CM7100 and ACM7000

IM4200-2

IM4216-34 and ACM5504-5-G(-W)-I)

label indica"ng second ethernet port

LAN2

NET2

Network 2

ETH-1

Opengear User Manual. Page 112.

• Navigate to System > IP > Network Interface.

• Select Management LAN from the Failover Interface pop-up menu.

• Enter the Primary Probe Address and the Secondary Probe Address.

These are the IP addresses or hostnames of the two hosts (the Primary and Secondary) that

Opengear User Manual. Page 113.

the advanced console server is to ping to determine if a Network Interface is s!ll

opera!onal.

• Select the Out-of-Band/Failover Interface tab.

• Enter the Out-of-Band/Failover IP Address, Subnet Mask, and Gateway values.

These values should be the same as used for the Network Interface.

In this mode, the Management LAN Interface is available as the transparent back-up port to

Network Interface for accessing the management network. Management LAN Interface will

automa!cally and transparently take over the work of Network Interface, in the event

Network Interface becomes unavailable for any reason.

Note: In console servers running ﬁrmware v3.0.1 and earlier, only SSH access is enabled on the

failover connec#on. In later ﬁrmware versions 3.0.2 and later HTTPS access is also enabled.

Once the dial-out PPP connec#on is established the administrator can connect to the

console server via SSH (or HTTPS on console servers running ﬁrmware 3.0.2 or later) and

ﬁx the problem.

As of ﬁrmware v3.1.0 and later, the advanced console server, by default, supports automa!c

failure-recovery back to the state extant prior to the failover. The advanced console server

con!nually pings probe addresses whilst in original and failover states. The original state will

automa!cally be set as a priority and reestablished following three successful pings of the

probe addresses during failover. The failover state will be removed once the original state has

been re-established.

For ﬁrmware versions prior to v3.1.0 the advanced console server does not support automa!c

failure-recovery back to the original state prior to the failover. To restore networking to a

recovered state the following command then needs to be run:

rm -f /var/run/*-failed-over && config -r ipconfig

If required, you can run a custom bash script when the device fails over. It is possible to use

this script to implement automa!c failure recovery, depending on your network setup. The

script to create is:

/etc/config/scripts/interface-failover-alert

4.6. Cellular modem connec"on

The ACM7000, ACM5500, ACM5000, IM7200 and IM4200 family of advanced console

servers support internal cellular modems.

These modems ﬁrst need to be installed (as documented in 4.6.1, 4.6.2 and 4.6.3 below) and

then set up to validate they can connect to the carrier network (as documented 4.6.4 and

4.6.5 below).

They then can be conﬁgured for opera!on in Always-on cellular router or OOB mode, or in

Failover mode (as documented in 4.7 below).

4.6.1. Connec"ng to a GSM HSUPA/UMTS carrier network

Console server models denoted with -G have an internal GSM modem that will connect to any

major GSM carrier globally.

Opengear User Manual. Page 114.

Note: before powering on any -G model console server (for example, the ACM5004-G,

ACM5004-G-I, ACM55044-5-G-I or the IM4200-X2-G), install the SIM card provided by

your cellular carrier and a"ach the external aerial. Also, The ACM5004-G(-I) and

ACM55044-5-G-I have two cellular status LEDs. The SIM LED on top of the unit should go

on solid when a SIM card has been inserted and detected.

• Navigate to System > Dial.

• Click the Internal Cellular Modem tab.

• Check the Enable Dial-Out radio bu%on in the Internal Cellular Modem Dial Se!ngs

sec!on.

Your carrier may have provided details for conﬁguring the connec!on including:

value

APN

descrip"on

Access Point Name.

Opengear User Manual. Page 115.

• Enter the carrier’s APN.

Example APNs include:

Note: the APN is, in most cases, the only value needed. The other ﬁelds can be le( blank.

• If the SIM Card is conﬁgured with a PIN Code, unlock the Card by entering the PIN Code.

Note: if the PIN Code is entered incorrectly three #mes, the PUK Code will be required to unlock

the Card.

You may also need to use Override DNS to set alternate DNS servers from those provided by

your carrier. If this is necessary:

• On System > Dial > Internal Cellular Modem, check the Override returned DNS servers

checkbox.

• Enter the alterna!ve DNS servers in the DNS Server 1 and DNS Server 2 ﬁelds.

• Click Apply.

A radio connec!on will be established with your cellular carrier.

4.6.2. Connec"ng to a CDMA EV-DO carrier network

Console server models denoted with -GV or -GS have an internal CDMA modem and will

connect to the Verizon network in North America.

A&er crea!ng an account with the CDMA carrier, some carriers require an addi!onal step to

provision the Internal Cellular Modem, known as Provisioning. The ACM5004-GV and

IM4200-DAC-X2 support

• Over-the-Air Service Provisioning (OTASP) where modem-speciﬁc parameters can be

retrieved via a voice call to a special phone number, and

• a manual process where the phone number and other parameters are entered manually.

OTASP

Note: before this can be achieved, a working account and an ac#vated device are required. In this

case an ac#vated device is an Opengear console server which has had its ESN (Electronic

PIN code

Phone Number

Username

Password

Custom Modem Ini!aliza!on

If the carrier-provided SIM card is locked, a PIN Code may be

required to unlock it.

the dial sequence which establishes the connec!on. By default

this is *99***1#.

Op!onal.

Op!onal AT command sequence to in!alize the modem.

carrier

AT&T (USA)

T-Mobile (USA)

Internode (Australia)

Telstra (Australia

APN

i2gold

epc.tmobile.com

internode

telstra.internet

Opengear User Manual. Page 116.

Serial Number) registered with an appropriate plan on your carrier’s account.

• Navigate to System > Dial.

• Click the Internal Cellular Modem tab.

• Enter the par!cular phone number which must be dialed to complete OTASP.

For example, Verizon uses *22899 and Telus uses *22886.

• Click Ac"vate.

This ini!ates the OTASP call.

The process is successful if no errors are displayed and you no longer see the CDMA

Modem Ac!va!on form.

If OTASP is unsuccessful consult the System Logs at Status > Syslog for clues to what went

wrong.

• When OTASP has completed enable the Internal Cellular Modem by entering the carrier’s

phone number

By default, this number is #777.

• click Apply.

To conﬁrm OTASP success, and to display the modem’s current state:

• navigate to Status> Sta"s"cs.

• click the Cellular tab.

The current state of the modem will present.

OTASP success will result in a valid phone number being placed in the NAM Proﬁle Account

MDN ﬁeld.

Opengear User Manual. Page 117.

Manual ac"va"on

If a carrier does not support OTASP it will be necessary to manually provision the modem.

• Navigate to System > Dial.

• Click the Internal Cellular Modem tab.

• Enter the MSL, MDN and MSID values.

These values are speciﬁc to your carrier and for manual ac!va!on you will have to learn

what values your carrier uses in each ﬁeld.

Verizon, for example, has been known to use an MSL of 000000 and the phone number

assigned to the Opengear device as both the MDN and MSID with no spaces or hyphens.

So an assigned phone number of 555-123-1234 is entered in the MDN and MSID ﬁelds as

5551231234.

• Click Ac"vate.

If no errors occur you will see the new values entered into the NAM Proﬁle Account. To check

this:

• navigate to Status> Sta"s"cs.

Opengear User Manual. Page 118.

• click the Cellular tab.

To connect to your carrier’s 3G network:

• navigate to System > Dial.

• click the Internal Cellular Modem tab.

• enter the appropriate Phone Number.

This is usually #777.

• If required by your account plan, enter the supplied Username and Password.

• Check the Enable check-box.

• click Apply.

The Always On Out-of-Band connec!on is ini!ated.

4.6.3. Connec"ng to a 4G LTE carrier network

Console server models denoted with -LV, -LA, or -LR have an internal modem that will connect

to any major 4G LTE carrier globally.

Note: before powering on any -LV, -LA, or -LR model console server, install the SIM card provided

by your cellular carrier and a"ach the external aerial.

• Navigate to System > Dial.

• Click the Internal Cellular Modem tab.

• Check the Enable Dial-Out radio bu%on in the Internal Cellular Modem Dial Se!ngs

sec!on.

Your carrier may have provided details for conﬁguring the connec!on including:

value

APN

PIN code

Phone Number

Username

descrip"on

Access Point Name.

If the carrier-provided SIM card is locked, a PIN Code is required to unlock

it.

the dial sequence to establish the connec!on. By default this is *99***1#.

Op!onal.

Opengear User Manual. Page 119.

• Enter the carrier’s APN.

Example APNs include:

Note: the APN is, in most cases, the only value needed. The other ﬁelds can be le( blank.

• If the SIM Card is conﬁgured with a PIN Code, unlock the Card by entering the PIN Code.

Note: if the PIN Code is entered incorrectly three #mes, the PUK Code will be required to unlock

the Card.

You may also need to use Override DNS to set alternate DNS servers from those provided by

your carrier. If this is necessary:

• On System > Dial > Internal Cellular Modem, check the Override returned DNS servers

checkbox.

• Enter the alterna!ve DNS servers in the DNS Server 1 and DNS Server 2 ﬁelds.

• Click Apply.

A radio connec!on will be established with your cellular carrier.

4.6.4. Verifying the cellular connec"on

Out-of-band access is enabled by default so the cellular modem connec!on should now be

on. To verify this:

• navigate to Status > Sta"s"cs.

• select the Cellular tab.

• verify the Mode is set to Online.

• select the Failover & Out-of-Band tab.

Password Op!onal.

carrier

AT&T (USA)

T-Mobile (USA)

Internode (Australia)

Telstra (Australia

APN

i2gold

epc.tmobile.com

internode

telstra.internet

Opengear User Manual. Page 120.

• verify the Connec"on Status reads as Connected.

To measure the received signal strength:

• navigate to Status > Sta"s"cs.

The current state of the cellular modem, including the Received Signal Strength Indicator (RSSI),

will present. Note the RSSI coverage value.

RSSI is a measure of the Radio Frequency (RF) power present in a received radio signal. It is

generally expressed in decibel-milliwa%s (dBm). The best throughput comes from placing the

receiving device in a loca!on with the highest possible RSSI.

With the cellular modem connec!on on the connec!on status is also visible via the LEDs on

top of console server.

Note: The ACM5004-G/LR(-I), ACM5504-5-G(-W)-I and ACM5504-5-LA/R/V-I each have two

cellular status LEDs. The WWAN LED is OFF when in reset mode or not powered. When

powered it will go ON and while searching for service it will ﬂash oﬀ brieﬂy every ﬁve

seconds.

4.6.5. Cellular modem watchdog

As of with ﬁrmware V3.5.2u13 and later, when you check the Enable Dial-Out check-box at

System > Dial, you will be given the op!on to conﬁgure a cellar modem watchdog service.

value

≤ -100 dBm

-99 to -90 dBm

descrip"on

unacceptable

weak-to-medium

value

-89 to -70 dBm

≥ -69 dBm

descrip"on

medium-to-strong

very strong

Opengear User Manual. Page 121.

This service will periodically ping a conﬁgurable IP address. If a threshold number of

consecu!ve a%empts fail, the service will cause the unit to reboot. This can be used to force a

clean restart of the modem and its services to work around any carrier issues.

4.6.6. Dual-SIM failover

Some console server models (as of 2016/11, the ACM5500-Gx and ACM5500–Lx families)

allow you to insert two SIM cards, allowing for selec!ve connec!on to two carrier networks.

The dual-SIM failover feature allows the cell modem to selec!vely failover to the secondary

SIM when communica!on over the primary SIM fails.

To conﬁgure dual-SIM failover:

• navigate to System > Dial.

• click the Internal Cellular Modem tab.

• in the SIM Conﬁgura"on sec!on, set the Primary SIM to either Bo$om Slot or Top Slot.

Choose the slot which contains the SIM from your primary carrier network.

•vheck the Enable SIM Failover checkbox.

• specify how the device will failback from the failover SIM to the Primary SIM.

There are two op!ons:

On Disconnect. With this op!on the console server will failback to the Primary SIM only

a&er the connec!on on the failover SIM has failed its ping test.

On Timeout. With this op!on, the console server will failback to the Primary SIM a&er the

connec!on on the failover SIM has been up for the !meout period.

•if On Timeout is the selected failback op!on, set the Failback Timout value.

The Failback Timout is the number of seconds the failover SIM must be connected before

the console server switches back to the Primary SIM.

If no number is entered here, the default value of 600 seconds (10 minutes) applies.

•conﬁgure each SIM connec!on with the informa!on necessary (APN, and, if required, the

PIN, Phone Number, Username and Password) to enable it to make a successful

connec!on, assuming suﬃcient signal strength from the cell service provider.

See 4.6.1, 4.6.2, and 4.6.3 above for details.

•enter a Failback Test IP address for each SIM.

This IP address is used to ping test the status of the cell modem connec!on and to

determine if SIM failover or failback is to take place.

• op!onally conﬁgure DDNS and the Modem Watchdog (see chapter 4.6.5).

DDNS, when conﬁgured, will be applied to the cell modem dial out connec!on regardless

of which SIM is currently in use.

Note: dual-SIM failover is for dial out connec#ons only.

Opengear User Manual. Page 122.

4.6.7. Mul"-carrier cellular support

Some cellular carriers require the console server’s cellular modem to be programmed with

carrier-speciﬁc ﬁrmware to operate on their network. Some console server models, however,

are equipped with a reprogrammable cellular modem, allowing them to operate on more than

one such carrier network.

Note: changes to the cellular modem ﬁrmware are unaﬀected by Opengear ﬁrmware upgrades or

factory erase/conﬁgura#on reset opera#ons.

On console servers with mul!-carrier capability:

• navigate to System > Dial.

•select the Internal Cellular Modem tab.

The Internal Cellular Modem Carrier Se!ngs sec!on (which provides control over which

carrier’s ﬁrmware is installed on the modem) will present.

• select the desired Carrier radio bu%on.

The modem’s ﬂash memory will have the carrier-speciﬁc ﬁrmware image installed.

Flashing takes several minutes during which the cellular modem is unavailable. During this

!me, the page periodically refreshes with status informa!on.

Upon successful comple!on, the page displays the message: Cellular Firmware carrier

change completed.

Mul!-carrier capable models ship with cellular modem ﬁrmware for each supported carrier

pre-loaded onto internal non-vola!le or USB storage. Periodically, new cellular modem

ﬁrmware becomes available and is published on the Opengear downloads site.

Note: if your unit’s cellular connec#on is opera#ng correctly, there is typically no need to upgrade

its cellular ﬁrmware.

On console servers with mul!-carrier capablity, to download and apply new cellular ﬁrmware

using the Management Console UI:

• navigate to System > Firmware.

A sec!on presents showing the local cellular ﬁrmware image status and a Check for

Update bu%on that starts the ﬁrmware update process.

The Cellular Firmware Status sec!on indicates the date of the last ﬁrmware download, and

shows a cryptographic ﬁngerprint. This can be used to verify the local ﬁles’ integrity against

the ﬁngerprint published in the Opengear Knowledge Base.

Opengear User Manual. Page 123.

• click the Check for Update bu%on.

The Management Console contacts the remote server, &p://&p.opengear.com/, and

displays an update summary.

This summary indicates the local and remote ﬁngerprints for comparison, without altering

any local ﬁles.

• op!onally, expand the Advanced sec!on.

This sec!on shows a full list of ﬁles to be downloaded or deleted, along with their SHA1

hashes. (Temporary ﬁles downloaded during the in!al Check for Updates may be listed as

simple ﬁles to copy into place, as they do not have to be re-downloaded.)

• click Download and Apply.

Note: the modem will only be ﬂashed if new ﬁrmware is available for the currently selected carrier.

During the download and ﬂashing of the ﬁrmware, an inters!!al screen displays, showing

Currently upgrading cellular modem ﬁrmware. Once completed the status of the ﬁrmware

update is displayed at System > Firmware.

• alterna!vely, click Cancel to reject the update.

It is also possible to control mul!-carrier features at the console server shell.

• Show currently selected carrier.

cellctl -is | egrep "^preferred-carrier" | cut -d " " -f 2

• Show current modem ﬁrmware version.

cellctl -is | egrep "^current-firmware" | cut -d " " -f 2

• List available carriers supported on installed modem.

/etc/scripts/cell-fw-update -l

• Check for availability of ﬁrmware updates.

/etc/scripts/cell-fw-update -u

Output is the remote ﬁngerprint followed by the list of ac!ons that would be taken by

cell-fw-update -d.

• Download latest ﬁrmware for all carriers supported by the modem.

/etc/scripts/cell-fw-update -d

• Flash modem with latest local ﬁrmware for carrier.

/etc/scripts/cell-fw-update -c <carrier>

<carrier> is one of the carrier iden!ﬁers emi%ed by cell-fw-update -l.

This command can be used to switch carriers or to update the ﬁrmware of the current

carrier.

Note: if the ﬁrmware version informa#on on the modem is iden#cal, the modem may reject the

update without error.

Opengear User Manual. Page 124.

4.7. Cellular opera"on

When set up as a console server, the 3G cellular modem can be set up to connect to the

carrier in one of four mode.

OOB mode. In this mode the dial-out connec!on to the carrier cellular network is always on,

awai!ng incoming access from a remote site wan!ng to access to the console server or

a%ached serial consoles/network hosts.

Failover mode. In this mode a dial-out cellular connec!on is only established in event of a

ping failure.

Cellular router mode. In this mode, the dial-out connec!on to the carrier cellular network is

always on, and IP traﬃc is routed between the cellular connected network and the console

server’s local network ports. This is the default mode of opera!on for ACM5000-G and

ACM5500-L and ACM5500-G models.

Circuit Switched Data (CSD) mode. In this dial-in mode, the cellular modem can receive

incoming calls from remote modems who dial a special Data Termina!ng number. This is a 3G-

only mode.

4.7.1. OOB access set-up

In this mode the dial-out connec!on to the carrier cellular network is always on, awai!ng any

incoming traﬃc. By default, the only traﬃc enabled is incoming SSH access to the console

server and its serial ports, and incoming HTTPS access to the console server. There is a low

level of keep alive and management traﬃc going over the cellular network. Generally,

however, the status reports, alerts and other traﬃc from the site can be carried over the main

network.

This mode is typically used for out of band access to remote sites. Consequently, to be

directly accessed, the appliance needs to have a Public IP address and it must not have SSH

access ﬁrewalled. This OOB mode is the default for IM7200 and IM4200 appliances with

internal cellular modems. Out-of-band access is enabled by default and the cellular modem

connec!on is always on.

Almost all carriers oﬀer corporate mobile data service/plans with a Public (sta!c or dynamic)

IP address. These plans do, however, o&en have a service fee a%ached.

With a sta!c Public IP address plan you can try accessing the console server using the Public IP

Address provided by the carrier. By default, however, only HTTPS and SSH access is enabled

on the OOB connec!on: you can browse to the console server, but you cannot ping it.

With a dynamic Public IP address plan, a DDNS service will need to be conﬁgured to allow

the remote administrator to ini!ate incoming access. Once this is done you can then also try

accessing the console server using the allocated domain name.

By default, most providers oﬀer a consumer-grade service which provides dynamic Private IP

address assignments to 3G devices. This IP address is not visible across the Internet but

generally it is adequate for home and general business use.

To conﬁrm a consumer-grade service:

• Navigate to the Status > Sta"s"cs.

•Click the Failover & Out-of-Band tab.

Opengear User Manual. Page 125.

• In the Always on Out-of-Band — Internal Cellular Modem (cellmodem) sec!on, check the

value presented for IP Address.

If the value is in one of the private IP Address ranges —

10.0.0.0 – 10.255.255.255

172.16.0.0 – 172.31.255.255

192.168.0.0 – 192.168.255.255

— you have a consumer-grade cellular service.

For inbound OOB connec!on with such a plan you will need to use Call Home with a

Lighthouse/VCMS/CMS6110 or set up a VPN.

In Out of Band access mode, the internal cellular modem will con!nually stay connected. The

alterna!ve is to set up Failover mode on the console server as detailed in the next sec!on.

4.7.2. Cellular failover

In this mode a dial-out cellular connec!on is only established in event of disrup!on to the

main network. The cellular connec!on normally remains idle and in a low power state. It is

only ac!vated in event of a ping failure. This standby mode suits remote sites with expensive

power or high cellular traﬃc costs.

In this mode, the appliance con!nually pings nominated probe addresses over the main

network connec!on. In the event of ping failure it dials out and sets up a dial-out ppp

connec!on over the cellular modem and access is switched transparently to this network

connec!on. Then when the main network connec!on is restored, access is switched back.

Once you have conﬁgured the carrier connec!on, the cellular modem can be conﬁgured for

failover.

This will tell the cellular connec!on to remain idle in a low power state. If the primary and

secondary probe addresses are not available it will bring up the cellular connec!on and

connect back to the cellular carrier.

• Navigate to System > IP.

Opengear User Manual. Page 126.

• Select Internal Cellular Modem (cellmodem01) from the Failover Interface pop-up menu.

• Enter the Primary Probe Address and the Secondary Probe Address.

These are the two sites the console server pings to determine if the principal network is

opera!onal.

In event of principal network failure the cellular network connec!on is ac!vated as the access

path to the console server and any managed devices.

Note: only HTTPS and SSH access are enabled on the failover connec#on. This allows an

administrator to connect to the console server to diagnose and correct the network failure

without oﬀering third-par#es a large a"ack surface.

As of ﬁrmware v3.1.0, the advanced console server supports automa!c failure-recovery back

to the original state prior to failover by default.

The advanced console server con!nually pings probe addresses whilst in original and failover

states. The original state will automa!cally be set as a priority and re-established following

three successful pings of the probe addresses during failover. The failover state will be

removed once the original state has been re-established.

For earlier ﬁrmware, which does not support automa!c failure-recovery, to restore

networking to a recovered state the following command then needs to be run:

rm -f /var/run/*-failed-over && config -r ipconfig

If required, you can run a custom bash script when the device fails over. It is possible to use

this script to implement automa!c failure recovery, depending on your network setup. The

script to create is:

/etc/config/scripts/interface-failover-alert

To check the connec!on status:

• navigate to Status > Sta"s"cs.

• click the Failover & Out-of-Band tab.

• Note the Ac"ve Connec"on value.

If the Main Connec"on is good, the Ac"ve Connec"on value will be Main.

Opengear User Manual. Page 127.

If the Main Connec"on is down, the Out-of-Band/Failover sec!on displays informa!on

rela!ng to a conﬁgured Out-of-Band/Failover interface and the status of that connec!on.

The IP Address of the Out-of-Band/Failover interface will be presented in the Out-of-

Band/Failover sec!on once the Out-of-Band/Failover connec!on has been triggered and

made.

4.7.3. Cellular rou"ng

Once you have a conﬁgured carrier connec!on, the cellular modem can be conﬁgured to

route traﬃc through the console server. This requires se$ng up forwarding and masquerading

as detailed in chapter 4.8.

4.7.4. Cellular CSD dial-in

CSD is a legacy form of data transmission developed for TDMA-based mobile phone systems

like GSM. CSD uses a single radio !me slot to deliver 9.6kb/s data transmission to the

GSM Network and Switching Subsystem where it could be connected through the equivalent

of a normal modem to the Public Switched Telephone Network (PSTN) allowing direct calls to

any dial-up service.

CSD is provided selec!vely by carriers and it is important you receive a Data Termina!ng

number as part of the mobile service your carrier provides. This is the number which external

modems will call to access the console server.

Once you have conﬁgured carrier connec!on, the cellular modem can be conﬁgured to

receive Circuit Switched Data (CSD) calls.

• Navigate to System > Dial.

• Click the Internal Cellular Modem tab.

• Check the Enable Dial-In radio bu%on.

• Enter the required informa!on in the Dial-In Se!ngs sec!on.

4.8. Firewalls & forwarding

Console servers with ﬁrmware v3.3 and later have basic rou!ng, NAT (Network Address

Transla!on), packet ﬁltering and port forwarding support on all network interfaces.

This enables the console server to func!on as an Internet or external network gateway, via

cellular connec!ons or via other Ethernet networks on two Ethernet port models.

Network Forwarding allows the network packets on one network interface (for example LAN1

aka eth0) to be forwarded to another network interface (for example, LAN2 or dial-out/

cellular). So locally networked devices can IP connect through the console server to devices

on remote networks.

Opengear User Manual. Page 128.

IP Masquerading is used to allow all the devices on your local private network to hide behind

and share the one public IP address when connec!ng to a public network. This type of

transla!on is only used for connec!ons origina!ng within the private network des!ned for

the outside public network, and each outbound connec!on is maintained by using a diﬀerent

source IP port number.

When using IP Masquerading, devices on the external network cannot ini!ate connec!ons to

devices on the internal network. Port Forwards allows external users to connect to a speciﬁc

port on the external interface of the console server and be redirected to a speciﬁed internal

address for a device on the internal network.

With Firewall Rules, packet ﬁltering inspects each packet passing through the ﬁrewall and

accepts or rejects it based on user-deﬁned rules.

Then Service Access Rules can be set for connec!ng to the console server/router itself.

Opengear User Manual. Page 129.

4.8.1. Conﬁguring network forwarding & IP masquerading

To use a console server as an Internet or external network gateway requires establishing an

external network connec!on (for example, for the ACM5004-G it means se$ng up the 3G

cellular link as detailed in chapter 4) and then se$ng up forwarding and masquerading.

By default, all console server models are conﬁgured so that they will not route traﬃc between

networks. To use the console server as an Internet or external network gateway, forwarding

must be enabled so that traﬃc can be routed from the internal network to the Internet or an

external network.

Note: Network forwarding allows the network packets on one network interface (for example,

LAN1/eth0) to be forwarded to another network interface (for example LAN2/eth1 or dial-

out/cellular). Locally networked devices can IP-connect through the console server to

devices on a remote network. IP masquerading is used to allow all the devices on your local

private network to hide behind and share the one public IP address when connec#ng to a

public network. This type of transla#on is only used for connec#ons origina#ng within the

private network des#ned for the outside public network, and each outbound connec#on is

maintained by using a diﬀerent source IP port number.

• Navigate to System > Firewall.

• Select the Forwarding & Masquerading tab.

• Find the Source Network to be routed and !ck the relevant Des"na"on Network.

For example, to conﬁgure a single-Ethernet device such as the ACM5004-G as a cellular

router set:

the Source Network to Network Interface

the Des"na"on Network to Dialout/Cellular.

IP Masquerading is generally required if the console server will be rou!ng to the Internet, or if

the external network being routed to does not have rou!ng informa!on about the internal

network behind the console server.

IP Masquerading performs Source Network Address Transla!on (SNAT) on outgoing packets,

to make them appear like they’ve come from the console server rather than devices on the

Opengear User Manual. Page 130.

internal network.

When response packets come back devices on the external network, the console server

translates the packet address back to the internal IP, so that it is routed correctly. This allows

the console server to provide full outgoing connec!vity for internal devices using a single IP

Address on the external network.

By default IP Masquerading is disabled for all networks. To enable masquerading:

• navigate to System > Firewall.

• select the Forwarding & Masquerading tab.

• check Enable IP Masquerading (SNAT) on the network interface where masquerading is to be

enabled.

4.8.2. Conﬁguring client devices

Client devices on the local network must be conﬁgured with Gateway and DNS se$ngs. This

can be done sta!cally on each device, or, in IM- and ACM-series devices, using DHCP.

Manual conﬁgura"on

Manually set a sta!c gateway address (being the address of the console server) and set the

DNS server address to be the same as used on the external network. That is, if the console

server is ac!ng as an internet gateway or a cellular router, use the ISP-provided DNS server

address.

DHCP conﬁgura"on

Note: DHCP conﬁgura#on is only available on IM- and ACM-series devices.

• Navigate to System > IP.

• Click the tab of the interface connected to the internal network.

• To use DHCP, a sta!c address must be set: check that the IP Address and Subnet Mask ﬁelds

Opengear User Manual. Page 131.

have speciﬁc and sta!c values entered.

• Click the Disabled link adjacent the DHCP Server entry.

System > DHCP Server will load.

• Check the DHCP Server checkbox.

• Check the Use interface address as gateway checkbox.

• Set the Primary DNS and Secondary DNS addresses to the same addresses as are used on

the external network.

That is, if the console server is ac!ng as an internal gateway or a cellular router, use the ISP-

provided DNS server addresses.

• Enter the Default Lease !me in seconds.

• Enter the Maximum Lease !me in seconds.

Least !mes are the number of seconds a dynamically assigned IP address is valid before the

client must request it again.

• click Apply.

The DHCP server issue IP addresses sequen!ally from a speciﬁed address pool or pools.

• Click Add in the Dynamic Address Alloca"on Pool sec!on.

Opengear User Manual. Page 132.

• Enter the DHCP Pool Start Address.

• Enter the DHCP Pool End Address.

• click Apply.

4.8.3. Port & protocol forwarding

When using IP Masquerading, devices on the external network cannot ini!ate connec!ons to

devices on the internal network.

To work around this, Port Forwards can be set up to allow external users to connect to a

speciﬁc port, or range of ports on the external interface of the console server or cellular router.

Port forwarding also allows the console server or cellular router to redirect data to a speciﬁed

internal address and port range.

To setup a port and protocal forward:

• navigate to System > Firewall.

• click the Port/Protocol Forwarding tab.

• Click New Port/Protocol Forward.

Opengear User Manual. Page 133.

• Fill in the following ﬁelds.

For example, to forward port 8443 to an internal HTTPS server on 192.168.10.2, use the

following se$ngs:

4.8.4. Firewall rules

Firewall rules can be used to block or allow traﬃc through an interface based on port number,

the source IP address, the des!na!on IP address or range, the direc!on (ingress or egress),

the protocol or any combina!on of these. This can be used to allow custom on-box services,

ﬁeld

Name

Input Interface

Source Address/Address Range

purpose

Name for the port forward. This should describe the

target and the service that the port forward is used to

access.

This allows the user to only forward the port from a

speciﬁc interface. In most cases, this should be le& as

Any.

This allows the user to restrict access to a port forward

to a speciﬁc source IP address or IP address range of

the data. This may be le& blank. IP address ranges use

the format ip/netmask (where netmask is in bits 1-32).

ﬁeld

Name

Input Interface

Source Address/Address Range

Des!na!on Address/Address Range

Input Port Range

Protocol

Output Address

Output Port Range

value

Administrator’s choice.

Any

Leave blank.

8443

TCP

192.168.10.2

443

Opengear User Manual. Page 134.

or block traﬃc based on policy.

To setup a ﬁrewall rule:

• navigate to System > Firewall.

• click the Firewall Rules tab.

Note: prior to ﬁrmware v3.4 this tab was labeled Port Rules and fewer ﬁrewall rules could be

conﬁgured.

• Click New Firewall Rule.

• Fill in the following ﬁelds.

For example, to block all SSH traﬃc from leaving Dialout Interface, use the following se$ngs:

ﬁeld

Name

Interface

Port Range

Source MAC Address

Source Address Range

Des!na!on Range

Protocol

Direc!on

Ac!on

purpose

Name the rule. This name should describe the policy the

ﬁrewall rule is being used to implement (for example,

Block FTP or Allow Tony).

Select the interface that the ﬁrewall rule will be applied

to. Choices include Any, Dialout/Cellular, VPN, Network

Interface, and Dial-in.

Specify the Port or range of Ports (for example 1000 –

1500) that the rule will apply to. This may be le& blank

for Any.

Specify the source MAC address to be matched. This

may be le& blank for Any. MAC addresses use the

format XX:XX:XX:XX:XX:XX, where XX are hex digits.

Specify the source IP address (or address range) to

match. IP address ranges use the format ip/netmask

(where netmask is in bits 1-32). This may be le& blank

for Any.

Specify the des!na!on IP address/address range to

match. IP address ranges use the format ip/netmask

(where netmask is in bits 1-32). This may be le& blank.

Select if the ﬁrewall rule will apply to TCP, UDP, TCP and

UDP, ICMP, ESP, GRE, or Any.

Select the traﬃc direc!on that the ﬁrewall rule will

apply to: Ingress = incoming; Egress = outgoing.

Select the ac!on (Accept or Block) to be applied to the

packets detected that match the Interface + Port Range

+ Source Address + Des!na!on Range+ Protocol+

Direc!on.

ﬁeld

Name

Interface

Port Range

Source MAC Address

value

Administrator’s choice.

Dialout/Cellular

Le& blank.

Opengear User Manual. Page 135.

Firewall rules are processed in a set order, from top to bo%om. So rule placement is

important.

For example with the following rules, all traﬃc coming in over the Network Interface is

blocked except when it comes from two nominated IP addresses (SysAdmin and Tony):

If the Rule Order is changed so the Block Everyone Else rule was second on the list, Tony’s

traﬃc — coming in over the Network Interface — would be blocked.

Source Address Range

Des!na!on Range

Protocol

Direc!on

Ac!on

Le& blank (Any).

Le& blank.

TCP

Egress

Block

ﬁeld

Interface

Port Range

Source MAC Address

Source Address Range

Des!na!on Range

Protocol

Direc!on

Ac!on

allow SysAdmin

Any

SysAdmin’s IP address

Any

TCP

Ingress

allow Tony

Any

Tony’s IP address

Any

TCP

Ingress

Block Everyone Else

Network Interface

Any

TCP

Ingress

Block

Opengear User Manual. Page 136.

5.SSH tunnels & SDT connector

Each Opengear console server has an embedded SSH server and uses SSH tunneling so

remote users can securely connect through the console server to Managed Devices using

text-based console tools (such as SSH, telnet, SoL) or graphical tools (such VNC, RDP, HTTPS,

HTTP, X11, VMware, DRAC, iLO).

The Managed Devices being accessed can be located on the same local network as the

console server or they can be a%ached to the console server via a serial port. The remote

User/Administrator connects to the console server thru an SSH tunnel via dial-up, wireless or

ISDN modem; a broadband Internet connec!on; the enterprise VPN network or the local

network:

Opengear User Manual. Page 137.

To set up the secure SSH tunnel from the Client PC to the console server, you must install (if

necessary) and launch SSH client so&ware on the User’s or Administrator’s PC.

Opengear recommends you use the SDT Connector client so&ware that is supplied with the

console server for this. SDT Connector is simple to install and auto-conﬁgure and it will

provides all your users with point-and-click access to all the systems and devices in the secure

network.

With one click, SDT Connector sets up a secure SSH tunnel from the client to the selected

console server, then establishes a port forward connec!on to the target network connected

host or serial connected device, then executes the client applica!on that will be used in

communica!ng with the host.

This chapter details the basic SDT Connector opera!ons:

• Conﬁguring the console server for SSH tunneled access to network a%ached hosts and

se$ng up permi%ed Services and user access.

•Se$ng up the SDT Connector client with gateway, host, service and client applica!on

details and making connec!ons between the Client PC and hosts connected to the console

server.

• Using SDT Connector to browser access the Management Console.

• Using SDT Connector to Telnet or SSH connect to devices that are serially a%ached to the

console server.

The chapter then covers more advanced SDT Connector and SSH tunneling topics:

• Using SDT Connector for out of band access.

• Automa!c impor!ng and expor!ng of conﬁgura!ons.

• Conﬁguring Public Key Authen!ca!on.

•Se$ng up a SDT Secure Tunnel for Remote Desktop.

•Se$ng up a SDT Secure Tunnel for VNC.

• Using SDT to IP connect to hosts that are serially a%ached to the console server.

5.1. Conﬁguring for SSH tunnelling to hosts

To set up the console server for SSH tunneled access a network a%ached host:

• Add the new host and the permi%ed services using the Serial & Network > Network Hosts

menu as detailed in Network Hosts (chapter 3.4). Only these permi%ed services will be

forwarded through by SSH to the host. All other services (TCP/UDP ports) will be blocked.

• following are some of the TCP Ports used by SDT in the console server:

port

3389

applica"on

SSH

Telnet

HTTP

RDP

notes

All SDT tunneled connec!ons.

On local LAN. Forwarded inside tunnel.

Opengear User Manual. Page 138.

• Add the new Users using Serial & Network > Users & Groups menu as detailed in Network

Hosts (chapter 3.4). Users can be authorized to access the console server ports and

speciﬁed network-a%ached hosts.

To simplify conﬁgura!on, the Administrator can ﬁrst set up Groups with group access

permissions, then Users can be classiﬁed as members of par!cular Groups.

5.2. SDT connector client conﬁgura"on

The SDT Connector client works with all Opengear console servers. Each of these remote

console servers has an embedded OpenSSH based server which can be conﬁgured to port

forward connec!ons from the SDT Connector client to hosts on their local network, as

detailed in the previous chapter.

The SDT Connector can also be pre-conﬁgured with the access tools and applica!ons that will

be available to be run when access to a par!cular host has been established.

SDT Connector can connect to the console server using an alternate OOB access. It can also

access the console server itself and access devices connected to serial ports on the console

server.

5.2.1. SDT connector client installa"on

The SDT Connector set up program, SDTConnector Setup-1.n.exe or

sdtcon-1.n.tar.gz, is included on the CD supplied with your Opengear console server

product. Alterna!vely a copy can be freely download from Opengear’s website.

To install, run the set-up program.

For Windows clients, SDTConnectorSetup-1.n.exe applica!on will install SDT

Connector 1.n.exe and the conﬁg ﬁle defaults.xml. If there is already a conﬁg ﬁle on

5900

73xx

79xx

VNC

RDP over serial

VNC over serial

On local LAN. Forwarded inside tunnel.

From local LAN. xx is the serial port # (eg 7301–7348 on a 48-port

console server.

From local LAN. xx is the serial port # (eg 7301–7348 on a 48-port

console server.

Opengear User Manual. Page 139.

the Windows PC it will not be overwri%en. To remove earlier conﬁg ﬁle run the regedit

command, search for “SDT Connector” and remove the directory with this name.

For Linux and other Unix clients, SDTConnector.tar.gz will install the sdtcon-1.n.jar

and the conﬁg ﬁle defaults.xml.

Once the installer completes you will have a working SDT Connector client installed on your

machine and an icon on your desktop.

To launch the SDT Connector client, double-click this icon.

Note: SDT Connector is a Java applica#on so it must have a Java Run#me Environment (JRE)

installed. It will install on Windows 2000 and later and on most Linux pla'orms. Solaris

pla'orms are also supported however they must have Firefox installed. SDT Connector can

run on any system with Java 1.4.2 and above installed, but it assumes the web browser is

Firefox, and that xterm -e telnet opens a telnet window.

To operate SDT Connector, you ﬁrst need to add new gateways to the client so&ware by

entering the access details for each console server (see chapter 5.2.2) then let the client auto-

conﬁgure with all host and serial port connec!ons from each console server (see sec!on

5.2.3) then point-and-click to connect to the Hosts and serial devices (see chapter 5.2.4).

Alternately you can manually add network connected hosts (see chapter 5.2.5) and manually

conﬁgure new services to be used in accessing the console server and the hosts (see chapter

5.2.6) then manually conﬁguring clients to run on the PC that will use the service to connect

to the hosts and serial port devices (see chapter 5.2.7). SDT Connector can also be set up to

make an out-of-band connec!on to the console server.

5.2.2. Conﬁguring a new gateway in the SDT connector client

To create a secure SSH tunnel to a new console server:

Opengear User Manual. Page 140.

• select File > New Gateway or click the New Gateway icon.

• enter the IP address or hostname of the console server.

• enter the SSH port (typically port 22).

If SDT Connector is connec!ng to a remote console server through the public Internet or a

routed network you will need to:

• determine the public IP address of the console server or the public IP address of the router

or ﬁrewall that connects the console server to the Internet.

One way to ﬁnd the public IP address is to access / or / from a computer on the same

network as the console server and note the reported IP address.

• Setup port-forwarding for TCP port 22 on any ﬁrewall, router or NAT service located

between SDT Connector and the console server.

h%p://www.por*orward.com/ has port-forwarding instruc!ons for a range of routers. The

Open Port Check tool from h%p://www.canyouseeme.org/ can be used to check if port-

forwarding through a ﬁrewall, router or NAT service has been properly conﬁgured.

• enter the Username and Password of a user on the gateway who has been enabled to

connect via SSH.

• op!onally, enter a Descrip"ve Name to display instead of the IP address or hostname.

• op!onally enter desired informa!on in the Descrip"on/Notes ﬁeld.

For example: the console server’s site loca!on; the console server’s running ﬁrmware version;

or details on the site’s network conﬁgura!on.

• click OK.

The new gateway will appear in the SDT Connector home page.

Note: For an SDT Connector user to access a console server and then access speciﬁc hosts or

serial devices connected to that console server, that user must ﬁrst be setup on the

console server, and must be authorized to access the speciﬁc ports on the speciﬁc hosts

(see chapter 4). Only these permi"ed services will be forwarded through by SSH to the Host.

All other services (TCP/UDP ports) are blocked.

5.2.3. Auto-conﬁgure SDT connector client with the user’s access privileges

Each user on the console server has an access proﬁle which has been conﬁgured with those

speciﬁc connected hosts and serial port devices the user has authority to access, and a

speciﬁc set of the enabled services for each of these. This conﬁgura!on can be auto-uploaded

into the SDT Connector client.

• Select File > New Gateway (or click the New Gateway icon).

• Click Retrieve Hosts.

SDT Connector will:

• conﬁgure access to network connected Hosts that the user is authorized to access and will,

for each of these Hosts, set up the services (for example, HTTPS, IPMI2.0) and the related

Opengear User Manual. Page 141.

IP ports being redirected.

• conﬁgure access to the console server itself. This is shown as a Local Services host.

• conﬁgure access with the enabled services for the serial port devices connected to the

console server.

Note: Retrieve Hosts auto-conﬁgures all classes of user whether they are members of user, admin,

some other group, or no group. SDT Connector will not, however, auto-conﬁgure the root.

Further, it is recommended that root only be used for ini#al conﬁg and for adding an ini#al

admin account to the console server.

5.2.4. Make an SDT connec"on through the gateway to a host

• Select the host to be accessed.

• Click the Service to be used in accessing that host.

The SSH tunnel to the gateway is established, the appropriate ports redirected through to

the host, and the appropriate local client applica!on is launched poin!ng at the local

endpoint of the redirec!on.

The SDT Connector client can be conﬁgured with an unlimited number of gateways and each

gateway can be conﬁgured to port forward to an unlimited number of locally networked

Hosts. Similarly there is no limit on the number of SDT Connector clients who can be

Opengear User Manual. Page 142.

conﬁgured to access the one Gateway. Nor are there limits on the number of Host

connec!ons that an SDT Connector client can concurrently have open through the one

Gateway tunnel.

However there is a limit to the number of SDT Connector SSH tunnels that can be open at

the one !me on a par!cular Gateway. IM4200, ACM5000 and ACM5500 models each

support at least 50 such concurrent connec!ons. So for a site with a IM4200 gateway you

can have, at any !me up to 50 users securely controlling an unlimited number of network

a%ached computers and appliances (servers, routers, etc.) at that site. ACM7000, IM7200 and

CM7100 support many hundreds of simultaneous client tunnels.

5.2.5. Manually adding a host to the SDT connector gateway

For each gateway, you can manually specify the network connected hosts that will be

accessed through that console server; and for each host, specify the services that will used in

communica!ng with the host.

• Select File > New Host (or select a gateway and click the Host icon).

Opengear User Manual. Page 143.

• Enter the IP address or hostname of the host.

Note: a hostname must be resolvable by the gateway.

• Select which Services are to be used in accessing the new host.

A range of service op!ons are pre-conﬁgured in the default SDT Connector client (RDP,

VNC, HTTP, HTTPS, Dell RAC, VMware etc). If you wish to add services beyond the pre-

conﬁgured range, proceed to the next sec!on then return here.

•Op!onally, enter a Descrip"ve Name to display instead of the IP address or hostname.

•Op!onally enter desired informa!on in the Descrip"on/Notes ﬁeld.

For example: the console server’s site loca!on; the console server’s running ﬁrmware version;

or details on the site’s network conﬁgura!on.

• Click OK.

5.2.6. Manually adding new services to the new hosts

To extend the range of services that can be used when accessing hosts with SDT Connector:

• select Edit > Preferences.

• click the Services tab.

• Click Add.

• enter a Service Name.

• click Add.

• under the General tab, enter the TCP Port that this service runs on (for example, port 80

for HTTP).

• op!onally, select the client to use to access the local endpoint of the redirec!on.

• select which client applica!on is associated with the new service.

A range of client applica!on op!ons are pre-conﬁgured in the default SDT Connector (RDP

client, VNC client, HTTP browser, HTTPS browser, Telnet client etc). However if you wish

to add new client applica!ons to this range proceed to the next sec!on then return here.

Opengear User Manual. Page 144.

• Click OK.

• Click Close.

A service typically consists of a single SSH port redirec!on and a local client to access it.

However it may consist of several redirec!ons; some or all of which may have clients

associated with them.

An example is the Dell RAC service. The ﬁrst redirec!on is for the HTTPS connec!on to the

RAC server. It has a client associated with it (web browser) that is launched immediately upon

clicking the bu%on for this service.

The second redirec!on is for the VNC service that the user may choose to later launch from

the RAC web console. It automa!cally loads in a Java client served through the web browser,

so it does not need a local client associated with it.

On the Add Service screen you can click Add as many !mes as needed to add mul!ple new

port redirec!ons and associated clients.

You may also specify Advanced port redirec!on op!ons:

• enter the local address to bind to when crea!ng the local endpoint of the redirec!on.

It is not usually necessary to change this from localhost.

Opengear User Manual. Page 145.

• enter a local TCP port to bind to when crea!ng the local endpoint of the redirec!on.

If this is le& blank, a random port will be selected.

Note: SDT Connector can also tunnel UDP services. SDT Connector tunnels the UDP traﬃc

through the TCP SSH redirec#on, so in eﬀect it is a tunnel within a tunnel. Enter the UDP

port on which the service is running on the host. This will also be the local UDP port that

SDT Connector binds as the local endpoint of the tunnel. For UDP services, you s#ll need to

specify a TCP port under General. This will be an arbitrary TCP port that is not in use on the

gateway. An example of this is the SOL Proxy service. It redirects local UDP port 623 to

remote UDP port 623 over the arbitrary TCP port 6667.

5.2.7. Adding a client program to be started for the new service

Clients are local applica!ons that may be launched when a related service is clicked. To add to

the pool of client programs:

• select Edit > Preferences.

• click the Client tab.

• click Add.

• enter a Client name.

•enter the Path to the client executable ﬁle or click Browse to locate the client applica!on.

• enter a Command line format for client executable associated with launching the client.

SDT Connector typically launches a client using command line arguments to point it at the

local endpoint of the redirec!on. Three keywords specify the command line format. When

launching the client, SDT Connector subs!tutes these keywords with appropriate values.

keyword

%path%

descrip"on

The path to the executable ﬁle. Takes the previous ﬁeld value: Path to the client

executable ﬁle.

Opengear User Manual. Page 146.

For example, SDT Connector is preconﬁgured for Windows with an HTTP client that connects

to the Windows user’s default browser. If there is no default browser Firefox is used.

Some clients are launched in a command line or terminal window. The Telnet client for

example. In this case, Path to client executable ﬁle is telnet and the Command line format for

client executable is cmd /c start %path% %host% %port%.

•Click OK.

5.2.8. Dial-in conﬁgura"on

If the client is dialing into the console server’s Local/Console port, setup a dial-in PPP link.

%host%

%port%

The local address to which the local endpoint of the redirec!on is bound. That is,

the Local Address ﬁeld for the Service redirec!on Advanced op!ons.

The local port to which the local endpoint of the redirec!on is bound. That is the

Local TCP Port ﬁeld for the Service redirec!on Advanced op!ons.

If port is unspeciﬁed (Any) an appropriate randomly selected port is subs!tuted.

Opengear User Manual. Page 147.

• Conﬁgure the console server for dial-in access, following the steps in chapter 4.1.

• Set up the PPP client so&ware on the remote computer, following the steps in chapter 4.

Once you have a dial-in PPP connec!on established, set up the secure SSH tunnel from the

remote computer to the console server.

5.3. SDT connector to management console

SDT Connector can also be conﬁgured for browser access to the gateway’s Management

Console and for Telnet or SSH access to the gateway’s shell. For these connec!ons to the

gateway itself, you must conﬁgure SDT Connector to access the gateway by se$ng the console

server up as a host, and then conﬁguring the appropriate services.

• Launch SDT Connector on your PC.

• Assuming you have already set up the console server as a Gateway in your SDT Connector

client (with username, password etc) select this newly added Gateway and click the Host

icon to create a host.

• Alterna!vely, select File > New Host.

• Enter 127.0.0.1 as the Host Address.

•Op!onally add details in the Descrip"ve Name and Descrip"on/Notes ﬁelds.

• Click OK.

• Click the HTTP or HTTPS services icon to access the gateway’s Management Console.

• Click SSH or Telnet to access the gateway’s command line console.

To enable SDT access to the gateway console, you must conﬁgure the console server to allow

port forwarded network access to itself.

As of ﬁrmware v3.3, this can be done using the console server’s Management Console.

• Navigate to System > Firewall.

Opengear User Manual. Page 148.

• Click the Service Access tab.

• Enable SSH Command Shell access on the Network Interface and on any Out-of-band

Interfaces.

With ﬁrmware versions prior to v3.3, do the following.

• Navigate to Serial & Network > Network Hosts.

• Click Add Host.

• In the IP Address/DNS Name ﬁeld enter 127.0.0.1.

This is the loopback address.

• Enter Loopback in the Descrip"on ﬁeld.

• Remove all entries under Permi$ed Services except for those that will be used in accessing

the Management Console (80/h%p or 443/h%ps) or the command line (22/ssh or 23/

telnet).

• click Apply.

By default, Administrators have gateway access privileges. For Users to access the gateway

Management Console, however, the required access privileges must be granted.

• Navigate to Serial & Network > Users & Groups.

• Click Add User.

• Enter a Username, Descrip"on and Password.

• Select 127.0.0.1 from the Accessible Host(s) pop-up menu.

• click Apply.

5.4. SDT connector: telnet or SSH connect to serially-a'ached devices

SDT Connector can also be used to access text consoles on devices that are a%ached to the

console server’s serial ports. For these connec!ons, conﬁgure the SDT Connector client

so&ware with a Service that will access the target gateway serial port, and then set the

gateway up as a host.

• Launch SDT Connector on your PC.

• Select Edit > Preferences.

• Click Add.

• Enter Serial Port 2 as the Service Name.

• Click Add.

• Select Telnet as the Client.

• Enter 2002 as the TCP Port.

• Click OK.

• Close the Add Service window.

Opengear User Manual. Page 149.

• Close the SDTConnector Preferences window.

• Assuming you have already set up the console server as a Gateway in your SDT Connector

client (with username, password etc) select this newly added Gateway and click the Host

icon to create a host.

• Alterna!vely, select File > New Host.

• Enter 127.0.0.1 as the Host Address.

•Op!onally add details in the Descrip"ve Name and Descrip"on/Notes ﬁelds.

• Click OK.

• Click the Serial Port 2 icon for Telnet access to the serial console on the device a%ached to

serial port #2 on the gateway.

To enable SDT Connector to access to devices connected to the gateway’s serial ports,

conﬁgure the console server to allow port forwarded network access to itself, and enable

access to the nominated serial port.

• Navigate to Serial & Network > Serial Port.

• Click Edit next to the selected Port.

For example, click Edit next to Port 2 if the target device is a%ached to the second serial

port.

• Ensure the port's serial conﬁgura!on is appropriate for the a%ached device.

• Set the Console Server Se#ng to Console Server Mode.

• click Apply.

• Navigate to Serial & Network > Network Hosts.

• click Add Host.

• In the IP Address/DNS Name ﬁeld enter 127.0.0.1.

Opengear User Manual. Page 150.

This is the loopback address.

• Enter Loopback in the Descrip"on ﬁeld.

• Remove all entries under Permi$ed Services.

• Select TCP.

• Enter 200n in the Port ﬁeld.

Note: ‘n’ corresponds to the Serial Port selected in the step above. For Serial Port 2, for example,

enter 2002.

•Click Add.

• Click Apply.

By default, Administrators have gateway and serial port access privileges. For Users to access

the gateway Management Console and the serial port, however, the required access privileges

must be granted.

• Navigate to Serial & Network > Users & Groups.

• Click Add User.

• Enter a Username, Descrip"on and Password.

• Select 127.0.0.1 from the Accessible Host(s) pop-up menu.

• Select Port 2 from the Accessible Port(s) pop-up menu.

• click Apply.

5.5. Using SDT connector for out-of-band connec"on to the gateway

SDT Connector can also be set up to connect to the console server out-of-band (OOB). OOB

access uses an alternate path for connec!ng to the console server to that used for regular data

traﬃc. OOB access is useful for when the primary link into the console server is unavailable or

unreliable.

Typically a console server’s primary link is a broadband Internet connec!on or Internet

connec!on via a LAN or VPN, and the secondary out-of-band connec!vity is provided by a

dial-up or wireless modem directly a%ached to the console server.

So out-of-band access enables you to access the hosts and serial devices on the network,

diagnose any connec!vity issues, and restore the console server’s primary link.

In SDT Connector, OOB access is conﬁgured by providing the secondary IP address of the

gateway, and telling SDT Connector how to start and stop the OOB connec!on. Star!ng an

OOB connec!on may be achieved by ini!a!ng a dial up connec!on, or adding an alternate

route to the console server. SDT Connector allows for maximum ﬂexibility is this regard, by

allowing you to provide your own scripts or commands for star!ng and stopping the OOB

connec!on.

To conﬁgure SDT Connector for OOB access:

• Choose File > New Gateway.

Opengear User Manual. Page 151.

• Click the Out Of Band tab.

• Enter the console server’s Out of Band IP address in the Secondary Address ﬁeld.

The console server’s Out of Band IP address is the address the console server is accessbile

from when using the Out of Band access route.

• Change the Port value if the console server is using a port other than the default 22 for SSH

access.

• Enter the command or path to a script to start the OOB connec!on in the Start Command

ﬁeld.

• To ini!ate a pre-conﬁgured dial-up connec!on under Windows, use the following Start

Command string:

cmd /c start "Starting Out of Band Connection" /wait /min rasdial

network_connection login password

where network_connection is the name of the network connec!on as displayed in

Control Panel > Network Connec"ons, login is the console server’s dial-in username, and

password is the console server’s dial-in password.

• To ini!ate a pre-conﬁgured dial-up connec!on under Linux, use the following Start

Command string:

pon network_connection

where network_connection is the name of the connec!on.

• Enter the command or path to a script to stop the OOB connec!on in the Stop Command

ﬁeld.

• To stop a pre-conﬁgured dial-up connec!on under Windows, use the following Stop

Command string:

cmd /c start "Stopping Out of Band Connection" /wait /min rasdial

network_connection /disconnect

where network_connection is the name of the network connec!on as displayed in

Control Panel > Network Connec"ons.

• To stop a pre-conﬁgured dial-up connec!on under Linux, use the following Stop Command

string:

poff network_connection

To make the OOB connec!on using SDT Connector:

• Select the console server to connect to.

• Click the Out Of Band bu%on.

The status bar changes color to indicate this console server is being accessed using the

OOB link rather than the primary link.

When you connect to a service on a host behind the console server, or to the console server

itself, SDT Connector will ini!ate the OOB connec!on using the provided Start Command. The

OOB connec!on isn’t stopped (using the provided Stop Command) un!l Out Of Band under

Opengear User Manual. Page 152.

Gateway Ac"ons is clicked oﬀ, at which point the status bar will return to its normal color.

5.6. Impor"ng and expor"ng preferences

To enable the distribu!on of pre-conﬁgured client conﬁg ﬁles, SDT Connector has an Import

and Export facility:

To save a conﬁgura!on .xml ﬁle for backup or for impor!ng into other SDT Connector

clients):

• select File > Export Preferences.

• select the loca!on to save the conﬁgura!on ﬁle.

To import a conﬁgura!on:

• select File > Import Preferences.

• select the .xml conﬁgura!on ﬁle to be installed.

5.7. SDT connector public key authen"ca"on

SDT Connector can authen!cate against an SSH gateway using your SSH key pair rather than

requiring you to enter your password. This is known as public key authen!ca!on.

To use public key authen!ca!on with SDT Connector, ﬁrst you must add the public part of

your SSH key pair to your SSH gateway.

• Ensure the SSH gateway allows public key authen!ca!on.

This is typically the default behavior.

• If you do not already have a public/private key pair for your client PC (the one running SDT

Connector) generate them now using ssh-keygen, PuTTYgen or a similar tool.

See chapter 14.6 for details on genera!ng and installing public/private key pairs.

Note: You can use RSA or DSA. In this case, however, leave the passphrase ﬁeld blank.

• Upload the public part of your SSH key pair (typically named id_rsa.pub or

id_dsa.pub) to the SSH gateway, or otherwise add to .ssh/authorized keys in your

home directory on the SSH gateway.

• Add the private SSH key (typically named id_rsa or id_dsa) to SDT Connector.

• Click Edit > Preferences.

Opengear User Manual. Page 153.

• Select Private Keys.

• click Add.

• navigate to and select the private key ﬁle.

• Click OK.

You do not have to add the public SSH key: it is calculated using the private key.

SDT Connector will now use public key authen!ca!on when connec!ng through the SSH

console server.

Note: you may have to restart SDT Connector to shut down exis#ng SSH tunnels established

using password authen#ca#on.

If you have a host behind the console server that you connect to by clicking the SSH bu%on in

SDT Connector you may wish to conﬁgure access to it for public key authen!ca!on as well.

This conﬁgura!on is en!rely independent of SDT Connector and the SSH console server. You

must conﬁgure the SSH client that SDT Connector launches (for example Pu%y or OpenSSH)

and the host’s SSH server for public key authen!ca!on. Essen!ally what you are using is SSH

over SSH, and the two SSH connec!ons are en!rely separate.

5.8. Se&ng up SDT for remote desktop access

Microso&’s Remote Desktop Protocol (RDP) enables the system manager to:

• securely access and manages remote Windows computers

• to reconﬁgure applica!ons and user proﬁles on Windows computers

• to upgrade a Windows server opera!ng system.

• reboot the machine and more.

Opengear’s Secure Tunneling uses SSH tunneling, so this RDP traﬃc is securely transferred

through an authen!cated and encrypted tunnel.

SDT with RDP also allows remote Users to connect to Windows XP and later computers and

to Windows 2000 Terminal Servers; and to have access to all of the applica!ons, ﬁles, and

network resources (with full graphical interface just as though they were in front of the

computer screen at work).

To set up a secure Remote Desktop connec!on you must enable Remote Desktop on the

target Windows computer that is to be accessed and conﬁgure the RPD client so&ware on

the client PC.

5.8.1. Enable Remote Desktop on the target Windows computer to be accessed

Note: Windows XP Professional and Windows Vista only support one Remote Desktop session and

it connects directly to the Windows root console. Windows Server 2003 supports three

sessions: the console session and two other general sessions. Windows Server 2008

supports mul#ple sessions.

To enable Remote Desktop on the Windows computer being accessed:

Opengear User Manual. Page 154.

• navigate to Start Menu > Control Panel.

• double-click the System icon.

• click the Remote tab.

• check the Allow users to connect remotely to this computer checkbox.

• click the Select Remote Users… bu%on.

The Remote Desktop Users window opens.

• Click the Add… bu%on to add users to the list of those allowed to remotely access the

system using the RDP protocol.

• Click OK to close the Remote Desktop Users window.

• Click OK to close the System Proper"es window.

Windows generates the available user list from local accounts on the target Windows

computer. If you need to setup new users to then add them to the Remote Desktop Users

list:

• navigate to Start Menu > Control Panel.

• double-click the User Accounts icon.

• create new users as required.

Note: when a remote user connects to the accessed computer via the root console, Remote

Desktop automa#cally locks that computer (so no other user can access the applica#ons and

ﬁles). When you come back to your computer, you can unlock it by typing CTRL+ALT+DEL.

5.8.2. Conﬁgure the Remote Desktop connec"on client

Opengear User Manual. Page 155.

Once the Client computer is securely connected to the console server (either locally, or

remotely through an enterprise VPN, a secure SSH internet tunnel or a dial-in SSH tunnel)

you can establish the Remote Desktop connec!on from the Client. To do this enable the

Remote Desktop Connec!on on the remote client PC then point it to the SDT Secure Tunnel

port in the console server.

On a Windows client

• Navigate to Start Menu > Programs > Accessories > Communica"ons.

• Click Remote Desktop Connec"on.

• Enter the appropriate IP address and port number in Computer.

Where there is a local connec!on or enterprise VPN connec!on, enter the IP Address of

the console server, and the port number of the SDT Secure Tunnel for the console server

serial port that is a%ached to the Windows computer to be controlled.

For example, if the Windows computer is connected to serial Port 3 on a console server

located at 192.168.0.50 enter 192.168.0.50:7303.

Where there is an SSH tunnel over a dial up PPP connec!on or over a public internet

connec!on or private network connec!on, enter localhost as the IP address (that is,

127.0.0.1). For Port Number, enter the source port you created when se$ng up SSH

tunneling/port forwarding (see chapter 5.1).

• Click Op"on.

• Specify an appropriate color depth in the Display sec!on.

For example, for a connec!on running over a modem, don’t set the color depth to greater

than 256 colors (8-bit).

• In Local Resources specify the peripherals and ports on the remote Windows computer

that are available to be controlled (for example, a directly connected printer or the serial

port on the Windows PC).

• Click Connect.

On a Linux or UNIX client

• Launch the open source rdesktop client from a shell. For example:

Opengear User Manual. Page 156.

rdesktop -u windows-user-id -p windows-password -g 1200x950 ms-

windows-terminal-server-host-name

You can use GUI front end tools such as the GNOME Terminal Services Client tsclient to

conﬁgure and launch the rdesktop client.

Using tsclient also enables you to store mul!ple conﬁgura!ons of rdesktop for

connec!on to many servers.

On an OS X client

• Download Microso&’s free Remote Desktop Connec!on client from h%ps://microso&.com/

en-us/download/details.aspx?id=18140.

Note: Microso( Remote Desktop Connec#on Client for OS X is not supported for use with OS X

v10.7 (Lion) or later.

5.9. SDT SSH tunnel for VNC

Alternately, with SDT and Virtual Network Compu!ng (VNC), Users and Administrators can

securely access and control computers running Windows, Linux, macOS, Solaris and UNIX.

There is a range of VNC so&ware available (UltraVNC, RealVNC, TightVNC), both open source

and commercial.

To set up a secure VNC connec!on you must

• install and conﬁgure the VNC Server so&ware on the computer to be accessed.

• install and conﬁgure the VNC Viewer so&ware on the Viewer PC.

5.9.1. Install & conﬁgure the VNC server on the computer to be accessed

Virtual Network Compu!ng (VNC) so&ware enables users to remotely access computers

running Linux, macOS, Solaris, UNIX, all versions of Windows and most other opera!ng

systems.

VNC Servers

RealVNC Connect, h%ps://realvnc.com/, is a mul!-pla*orm VNC server that runs on Windows,

macOS, Linux, Solaris, HP-UX, AIX, and Raspberry Pi. RealVNC also oﬀers a VNC client,

RealVNC Viewer, which runs on these pla*orms as well as iOS, Android, and Chrome.

rdesktop op"on

-a

-r

-g

-p

descrip"on

Color depth. Valid values are 8, 16, and 24.

Device redirec!on. Redirects remote machine sound to the local device.

Display geometry. Either widthxheight in pixels, or % of local screen.

Sets rdesktop to receive a password prompt form the remote machine.

Opengear User Manual. Page 157.

TightVNC, h%ps://!ghtvnc.com/, is a dual-licensed (GPL and commercial) VNC server for

Windows. TightVNC also oﬀer a Java-based VNC viewer. It works on any system with Java SE

version 1.6 or later installed.

UltraVNC, h%p://uvnc.com/, is a free VN server and viewer for Windows.

Most Linux distribu!ons now ship with VNC servers and viewers pre-installed. If a running

Linux instance does not have VNC so&ware installed, it will almost certainly be available for

immediate download and install via the distro’s secure so&ware repository.

For example, to turn the VNC server on in Centos 7:

• Navigate to Applica"ons > System Tools > Se!ngs.

• Click Sharing.

• Click Screen Sharing.

• Click the On-Oﬀ control to start the VNC server.

Immediately below the Screen Sharing !tle bar is the vnc-protocol URL the computer is

accessible via.

Opengear User Manual. Page 158.

• Click the Require a password radio bu%on.

• Create and Enter the Password remote clients must enter to view the Centos screen.

• Click the Close box in the top right-hand corner of the Screen Sharing window.

• Click the Close box in the top right-hand corner of the Sharing window.

macOS also ships with a VNC server. To turn this server on and make a macOS computer

available to VNC clients:

• Choose Apple Menu > System Preferences.

• Click the Sharing icon (or choose View > Sharing).

• Check the Screen Sharing checkbox.

The built-in VNC server is now running. Immediately below the text Screen Sharing: On is

the vnc-protocol URL the computer is accessible via.

• Click the Computer Se!ngs… bu%on.

• Check the VNC viewers may control screen with password checkbox.

• Create and enter the password said VNC viewer applica!ons will need to supply.

• Click OK.

5.9.2. Install, conﬁgure & connect the VNC viewer

VNC is pla*orm-independent so a VNC viewer on any opera!ng system can connect to a

VNC server on any other opera!ng system.

There are viewers and servers from a wide selec!on of sources (for example, UltraVNC

TightVNC or RealVNC) for most opera!ng systems. There are also a wealth of Java viewers

available so that any desktop can be viewed with any Java-capable browser. h%p://

en.wikipedia.org/wiki/VNC lists many of the VNC viewers sources.

To make VNC faster, when you set up the VNC viewer:

• if you have a fast enough CPU, set encoding to ZRLE.

• decrease the color level (for example, 64-bit).

• disable the background transmission on the server, or use a plain wallpaper.

See h%p://doc.uvnc.com/ for detailed conﬁgura!on instruc!ons.

To establish a VNC connec!on:

• enter the VNC server IP address and port.

When the VNC viewer is connected to the console server via an SSH tunnel, whether over

the public Internet, a dial-in connec!on, or a private network connec!on, enter localhost or

127.0.0.1 as the VNC server’s IP address.

The port number is the number entered when se$ng up SSH tunneling/port forwarding in

sec!on 5.2.6. For example: 1234.

Opengear User Manual. Page 159.

When the VNC viewer is connected directly to the console server (that is locally or remotely

through a VPN or dial in connec!on) and the VNC server is serially connected to the

console server, enter the IP address of the console server unit with the TCP port that the SDT

tunnel will use.

The TCP port will be 7900 plus the physical serial port number (that is 7901 to 7948). All

traﬃc directed to port 79xx on the console server is tunneled thru to port 5900 on the PPP

connec!on on serial Port xx.

For example, for a Windows computer using UltraVNC as the viewer connec!ng to a VNC

server which is a%ached to Port 1 on a console server located 192.168.0.1:

• establish the VNC connec!on by ac!va!ng the VNC viewer and entering the Password.

Opengear User Manual. Page 160.
For background reading on Remote Desktop and VNC access we recommend the following:
The Microso& Remote Desktop How-To: h%p://www.microso&.com/windowsxp/using/
mobility/getstarted/remoteintro.mspx.
The Illustrated Network Remote Desktop help page: h%p://theillustratednetwork.mvps.org/
RemoteDesktop/RemoteDesktopSetupandTroubleshoo!ng.html.
What is Remote Desktop in Windows XP and Windows Server 2003? by Daniel Petri: h%p://
www.petri.co.il/what's_remote_desktop.htm.
Frequently Asked Ques!ons about Remote Desktop: h%p://www.microso&.com/windowsxp/
using/mobility/rdfaq.mspx.
Secure remote access of a home network using SSH, Remote Desktop and VNC for the home 
user: h%p://theillustratednetwork.mvps.org/RemoteDesktop/SSH-RDP-VNC/
RemoteDesktopVNCandSSH.html.
Taking your desktop virtual with VNC: Red Hat magazine / and /.
Wikipedia’s general background ar!cle on VNC: h%p://en.wikipedia.org/wiki/VNC.
5.10. Using SDT to IP connect to hosts that are serially-a'ached to the gateway
Network (IP) protocols like RDP, VNC and HTTP can also be used for connec!ng to host 
devices that are serially connected through their COM port to the console server. To do this 
you must:
• establish a PPP connec!on between the host and the gateway. See chapter 5.10.1.
• set up Secure Tunneling Ports on the console server. See chapter 5.10.2.
• conﬁgure SDT Connector to use the appropriate network protocol to access IP consoles on 
the host devices that are a%ached to the console server serial ports. See chapter 5.10.3.
5.10.1. Establish a PPP connec"on between the host COM port & console server
• (This step is only necessary for serially-connected computers.) Physically connect the COM 
port on the host computer that is to be accessed, to the serial port on the console server.
• On computers running Linux, UNIX, Solaris and other Unix-like opera!ng systems, 
establishy a PPP connec!on over the serial port.
The online tutorial at h%p://yolinux.com/TUTORIALS/LinuxTutorialPPP.html presents a 
selec!on of methods for establishing a PPP connec!on using a computer running Linux.
• On computers running Windows, follow the procedure below to set up an advanced 
network connec!on between the Windows computer’s COM port and the console server.
Windows allows for the crea!on of a simple dial-in service which can be used for a Remote 
Desktop or VNX or HTTP/X connec!on to the console server.
• Navigate to Start Menu > Control Panel.
• Double-click the Network Connec"ons icon.
• Click the New Connec"on Wizard.

Opengear User Manual. Page 161.

• Select the Set up an advanced connec"on radio bu%on.

• Select Accept Incoming Connec"ons in the Advanced Connec"on Op"ons window.

• click Next.

• Select COM1 as the Connec"on Device (that is, the COM port on the computer that is

connected to the console server’s serial port).

• Set the COM port to its maximum baud rate.

• Click Next.

• Select Do not allow virtual private connec"ons in the Incoming VPN Connec"on Op"ons

window.

• Click Next.

• Select which users will be allowed to use this connec!on.

This should be the same users given Remote Desktop access privileges in the earlier step.

• Click Next.

• Select TCP/IP in the Network Connec"ons window.

• Click Proper"es.

• Select Specify TCP/IP addresses in the Incoming TCP/IP Proper"es window.

• Enter IP addresses in the From and To ﬁelds.

Choose any TCP/IP addresses so long as they are addresses which are not used anywhere

else on your network.

The From address will be assigned to the computer running Windows. The To address will

be used by the console server. For simplicity use the IP address shown in the illustra!on

above:

Opengear User Manual. Page 162.

From 169.134.13.1

To 169.134.13.2

Alterna!vely, set the advanced connec!on and access on the computer running Windows

to use the console server defaults:

From 10.233.111.254

Allow calling computer to specify its own IP address checked.

• Click OK.

Another op!on is to use the console server’s default username and password to setup the

Remote Desktop user and give this user permission to use the advancd connec!uon to access

the computer running Windows.

• The console server’s default Username is portXX where XX is the serial port number on the

console server.

• The console server’s default Password is portXX where XX is the serial port number on the

console server.

For example, for an RDP connec!on to serial port 2 on the console server, setup a Windows

user named port02 with appropriate permissions.

When the PPP connec!on has been set up, a network icon appears in the Windows task bar.

The above notes describe se$ng up an incoming connec!on for Windows XP. The steps are

similar for later versions of Windows although the set up screens present slightly diﬀerently.

If presented with an Incoming Connec"ons Proper"es window such as above, check the

Always allow directly connected devices such as palmtop computers to connect without providing a

password check box.

Also the op!on to Set up an advanced connec"on is not available in Windows 2003 if RRAS

is conﬁgured. If RRAS has been conﬁgured enable the null modem connec!on for the dial-in

conﬁgura!on.

Opengear User Manual. Page 163.

5.10.2. Set up SDT serial ports on console server

To set up RDP (and VNC) forwarding on the console server Serial Port that is connected to the

Windows computer COM port:

• Navigate to Serial & Network > Serial Port.

• click Edit for the par!cular Serial Port connected to the Windows computer’s COM port.

• Select SDT Mode in the SDT Se!ngs sec!on.

This will enable port forwarding and SSH tunneling.

Note: Enabling SDT overrides all other conﬁgura#on protocols on this port.

• enter a Username and User Password.

If you leave the Username and User Password ﬁelds blank, they both default to portXX

where XX is the serial port number. For example, the default username and password for

Secure RDP over Port 2 is port02.

• Set the console server’s serial port Common Se#ngs (Baud Rate and Flow Control) to the

same values as were set up on the Windows computer’ COM port.

• click Apply.

RDP and VNC forwarding over serial ports is enabled on a per-Port basis. You can add Users

who can have access to these ports (or reconﬁgure User proﬁles) by naviga!ng to Serial &

Network > User & Groups as documented in chapter 3.

5.10.3. Set up SDT connector to SSH port forward over the console server serial port

In the SDT Connector so&ware running on your remote computer, specify the gateway IP

address of your console server and specify a username and password for a user you have setup

on the console server that has access to the desired port.

Next add a New SDT Host.

In the Host address put portxx where xx is the port you are connec!ng to.

For example, for port 3 enter a Host Address of port03 and then check the RDP Service check

box.

5.11. SSH tunnelling using other SSH clients (for example, PuTTY)

SDT Connector, which is supplied with console servers is Opengear’s recommended SSH client.

Opengear User Manual. Page 164.

There are, however, other SSH client programs that can provide secure SSH connec!ons to

console servers and connected devices, including:

This sec!on documents the use of the PuTTY client to establish an SSH-tunneled connec!on

to a network-connected device.

• Launch PuTTY.

The PuTTY Conﬁgura"on window opens.

• Click Session in the Category sec!on.

• Enter the IP address of the console server to connect to in the Host Name or IP address ﬁeld.

For dial-in connec!ons, this IP address will be the Local Address that you assigned to the

console server when you set it up as the Dial-In PPP Server.

For Internet or local/VPN connec!ons this will be the public IP address of the console

server.

• Leave the port number as 22 (unless you’ve conﬁgured the console server to run SSH on a

port other than the default value of 22).

• Click the SSH radio bu%on under Connec"on type.

• Click Tunnels in the Category sec!on (in the disclosure tree this is in Connec"on > SSH).

• Enter any high, unused port number (for example: 55555) in the Source port ﬁeld under Add

new forwarded port.

• Enter the Des"na"on IP address and port.

If your des!na!on device is network connected to the console server and you are

connec!ng using RDP, set the Des!na!on as

managed-device-ipaddress-or-hostname:3389

For example, if, when se$ng up the Managed Device as Network Host on the console

server its IP address was sets to

192.168.253.1

or its hostname was set to

accounts.myco.intranet.com

ssh client

PuTTY

SSHTerm

Tec!a SSH

Reﬂec!on for Secure

source

h%p://pu%y.org/

h%p://sourceforge.net/projects/sshtools

h%ps://ssh.com/products/tec!a-ssh/

h%ps://www.microfocus.com/products/

reﬂec!on-secure-it

descrip"on

An open-source SSH

implementa!on for

Windows.

A Java-based open-source

SSH communia!ons suite.

A commercial SSH client

and server.

A commercial SSH client

and server.

Opengear User Manual. Page 165.

then set the Des"na"on to

192.168.523.1:3389

accounts.myco.intranet.com:3389

Note: only devices which have been conﬁgured as networked Hosts can be accessed using SSH

tunneling (except by the root user who can tunnel to any IP address the console server can

route to).

If your des!na!on computer is serially-connected to the console server, set the Des"na"on

port-label:3389

For example, if the Label you speciﬁed on the serial port on the console server is win2k3,

then specify the remote host as

win2k3:3389

Alterna!vely, set the Des"na"on as

portXX:3389

where XX is the SDT-enabled serial port number.

For exmaple, if port 4 on the console server carries the RDP traﬃc then set the Des"na"on

port04:3389

• Select the Local radio bu%on.

• Click Add.

•Click Open.

A shell prompt window will open promp!ng you to login as:

•Enter a username and press Return.

The shell will return a password prompt.

•Enter the user’s password. and press Return.

If you are connec!ng as a user in the users group you can only SSH tunnel to hosts and

serial ports where you have speciﬁc access permissions.

If you are connec!ng as an administrator (that is, a user in the admin group) then you can

connect to any conﬁgured host or serial port which has SDT enabled.

To set up the secure SSH tunnel for a HTTP browser connec!on to the managed device,

specify port 80 (rather than port 3389, used for RDP) in the Des"na"on IP ﬁeld.

To set up the secure SSH tunnel from the Client PC to the console server for VNC, conﬁgure

the VNC port redirec!on by specifying port 5900 in the Des"na"on IP ﬁeld.

Opengear User Manual. Page 166.

5.12. VNC security

How secure is VNC? VNC access generally allows access to your whole computer, so security

is very important. VNC uses a random challenge-response system to provide the basic

authen!ca!on that allows you to connect to a VNC server. This is reasonably secure and the

password is not sent over the network.

However, once connected, all subsequent VNC traﬃc is unencrypted. So a malicious user

could snoop your VNC session. Also there are VNC scanning programs available, which will

scan a subnet looking for PCs which are listening on one of the ports which VNC uses.

Tunneling VNC over a SSH connec!on ensures all traﬃc is strongly encrypted. Also no VNC

port is ever open to the internet, so anyone scanning for open VNC ports will not be able to

ﬁnd your computers. When tunneling VNC over a SSH connec!on, the only port which you

are opening on your console server is the SDT port (port 22).

It may be prudent to tunnel VNC through SSH even when the Viewer PC and the console

server are both on the same local network.

Opengear User Manual. Page 167.

6.Alerts, auto-response & logging

This chapter describes the automated response, alert genera!on and logging features of the

console server.

The Auto-Response facility extends on the basic Alert facility available in earlier (pre V3.5)

ﬁrmware revisions. With Auto-Response the console server monitors selected serial ports,

logins, the power status and environmental monitors and probes for Check Condi!on triggers.

The console server will then ini!ate a sequence of ac!ons in response to these triggers. To

conﬁgure Auto-Response you:

• set the general parameters.

• select and conﬁgure the Check Condi"ons (the condi!ons that trigger the response).

• specify the Trigger Ac"ons (the ac!on sequence ini!ated in event of the trigger condi!on).

• specify the Resolve Ac"ons (the ac!ons performed when trigger condi!ons are resolved).

Also all console server models can maintain log records of all access and communica!ons with

the console server and with the a%ached serial devices. A log of all system ac!vity is also

maintained as is a history of the status of any a%ached environmental monitors.

Some models can also log access and communica!ons with network a%ached hosts and

maintain a history of the UPS and PDU power status.

If port logs are to be maintained on a remote server, then the access path to this loca!on

need to be conﬁgured Then you need to ac!vate and set the desired levels of logging for each

serial and network port and for power and environment UPS (see chapter 7).

Opengear User Manual. Page 168.

6.1. Conﬁgure auto-response

With the Auto-Response facility, a sequence of Trigger Ac!ons is ini!ated in the event of a

speciﬁed trigger condi!on (the Check Condi"on). Subsequent Resolve Ac"ons can also be

performed when the trigger condi!on has been resolved.

First set the general parameters that will be applied to all Auto-Responses.

• Navigate to Alerts & Logging > Auto-Response.

• Check the Log Events checkbox in the Global Auto-Response Se!ngs sec!on.

This enables logging of all Auto-Response ac!vi!es.

• Set the Delay a&er boot !me (in seconds) to establish the delay between a console server

boo!ng and the same console server processing events.

To conﬁgure a new Auto-Response:

• Select New Auto-Response in the Conﬁgured Auto-Response ﬁeld.

A new Auto-Response Se!ngs page presents.

• Enter a unique Name for the new Auto-Response.

• Specify the Reset Timeout for the !me in seconds a&er resolu!on to delay before this

Auto-Response can be triggered again.

Opengear User Manual. Page 169.

• Check Repeat Trigger Ac"ons to repeat trigger ac!ons un!l the check is resolved.

• Enter any required delay !me before repea!ng trigger ac!ons in Repeat Trigger Ac"on

Delay. This delay starts a&er the last ac!on is queued.

• Check Disable Auto-Response at speciﬁc "mes and you will be able to periodically disable

auto-Responses between speciﬁed !mes of day.

6.2. Check condi"ons

To conﬁgure the condi!on that will trigger the Auto-Response:

• Click on the Check Condi"on type (for example, Environmental, UPS Status or ICMP ping) to

be conﬁgured as the trigger for this Auto-Response in the Auto-Response Se!ngs menu.

6.2.1. Environmental

To conﬁgure Humidity or Temperature levels as the trigger event:

Opengear User Manual. Page 170.

• Click on Environmental as the Check Condi"on.

• In the Environmental Check menu, select the speciﬁc environmental sensor to be checked

for the trigger

• Specify the Trigger value (in °C or °F for temperature and % for humidity) that the check

measurement must exceed or drop below to trigger the AutoResponse.

• Select Comparison type as being Above Trigger Value or Below Trigger Value to trigger

• Specify any Hysteresis factor that is to be applied to environmental measurements. For

example, if an Auto-Response was set up with a trigger event of a temp reading above

49°C with a Hysteresis of 4, then the trigger condi!on would not be seen as having been

resolved !ll the temperature reading was below 45°C.

• Check Save Auto-Response.

Note: before conﬁguring Environmental Checks as the trigger in Auto-Response you will need

ﬁrst to conﬁgure the Temperature sensores, the Humidity sensors or both on your ACM5000

or a"ached EMD.

6.2.2. Alarms & digital inputs

To set the status of any a%ached Smoke or Water sensors or digital inputs as the trigger

event:

• Click on Alarms/Digital Inputs as the Check Condi"on.

• In the Alarms/Digital Inputs Check menu, select the speciﬁc Alarm/Digital IO Pin that will

trigger the Auto-Response.

• Select Trigger on Change to trigger when alarm signal changes, or select to trigger when the

alarm signal state changes to either a Trigger Value of Open (0) or Closed (1).

• Check Save Auto-Response.

Note: before conﬁguring Alarms/Digital Inputs checks in Auto-Response you ﬁrst must conﬁgure

the sensor/DIO that is to be a"ached to your EMD or ACM5000.

6.2.3. UPS & power supply

To use the proper!es of any a%ached UPS as the trigger event:

• select UPS/Power Supply as the Check Condi"on.

• Select the UPS Power Device Property (Input Voltage, Ba%ery Charge %, Load %, Input

Frequency Hz or Temperature in °C) to be checked for the trigger.

• specify the Trigger value that the check measurement must exceed or drop below to trigger

the AutoResponse.

• select the Comparison type as being Above Trigger Value or Below Trigger Value to trigger.

• specify any Hysteresis factor to be applied to environmental measurements.

For example, if an Auto-Response is set up with a trigger event of a ba%ery charge below

20% with a Hysteresis of 5 then the trigger condi!on will not be set to resolved un!l the

Opengear User Manual. Page 171.

ba%ery charge is above 25%.

• Check Save Auto-Response.

Note: before conﬁguring UPS checks in Auto-Response you ﬁrst must conﬁgure the a"ached UPS

6.2.4. UPS status

To use the alert state of any a%ached UPS as the Auto-Response trigger event:

• click on UPS Status as the Check Condi"on.

• select the reported UPS State to trigger the Auto-Response (either On Ba%ery or Low

Ba%ery).

The Auto-Response will resolve when the UPS state returns to the Online state.

• select which connected UPS Device to monitor.

• Click Save Auto-Response.

Note: before conﬁguring UPS state checks in Auto-Response the a"ached UPS must be conﬁgured.

6.2.5. Serial log-in, signal or pa'ern

To monitor serial ports and check for login/logout or pa%ern matches for Auto-Response

triggers events:

• click on Serial Login/Logout as the Check Condi"on.

• in the Serial Login/Logout Check menu select Trigger on Login (to trigger when any user logs

into the serial port) or Trigger on Logout.

• specify Serial Port to perform check on.

• click on Serial Signal as the Check Condi"on.

Opengear User Manual. Page 172.

The above two op!ons can be set individually or together.

• in the Serial Signal Check menu select the Signal (CTS, DCD, DSR) to trigger the condi!on

(either on serial signal change, or check level).

• specify Serial Port to perform check on.

• click on Serial Pa$ern as the Check Condi"on.

The above two op!ons can be set individually or together.

• in the Serial Pa$ern Check menu select the PCRE pa%ern to trigger on and the serial line

(TX or RX) and Serial Port to pa%ern check on.

Note: With Serial Pa%ern checks you can nominate to Disconnect Immediately all users from

the serial port being monitored in the event of a successful pa"ern match.

Note: for devices with an inbuilt cellular modem with GPS enabled, the GPS will be displayed as an

addi#onal port and it can be monitored for trigger events. For example, with an

ACM5504-5-G-I with 4 serial ports, the GPS will be shown as Port 5.

• Click Save Auto-Response.

Note: before conﬁguring serial port checks in Auto-Response the aﬀected serial port must be

conﬁgured in Console server mode. Also, most serial port checks are not resolvable so resolve

ac#ons will not run.

6.2.6. USB console status

Note: USB port labels in the Web interface match the USB port labels printed on a console server

with two excep#ons. Some console servers include discrete pairs of USB ports which do not

have printed labels. In this case, the Web interface denotes them as either Upper or Lower.

That is, the Web interface lists them by their physical rela#onship to each other. Also, some

console servers ship with an array of four USB ports. A limited number of these console

Opengear User Manual. Page 173.

servers have labels A – D printed by these ports even though the Web interface will denote

them as USB ports 1 – 4.

To monitor USB ports:

• Select USB Console Status as the Check Condi"on.

• Check the Trigger on Connect checkbox, the Trigger on Disconnect checkbox, or both

checkboxes to set which ac!ons trigger the Auto-Response.

• Check each USB port to be monitored (or click the Select/Unselect all Ports checkbox to

select or deselect all USB ports).

• Click the Save Auto-Response bu%on.

• Select an op!on from the Add Trigger Ac"on list.

• Enter a unique Ac"on Name for the trigger ac!on being created.

• Set an Ac"on Delay Time.

By default, this is 0 seconds.

• Enter the speciﬁc details of the selected ac!on. For example, the Send Email ac!on requires

a Recipient Email Address and allows for a Subject and Email Text.

• Click the Save New Ac"on bu%on.

Note: USB console status checks are not resolvable. Trigger ac#ons run but Resolve ac#ons do not.

6.2.7. ICMP ping

To use a ping result as the Auto-Response trigger event:

• select ICMP Ping as the Check Condi"on.

• specify which Address to Ping (that is, the IP address or DNS name to send ICMP pings to).

• specify which Interface to send ICMP pings from (for example, the Management LAN or

Wireless network).

• set the Check Frequency.

This is the !me in seconds between checks.

• set the Number of ICMP Ping packets to send.

• check Save Auto-Response.

6.2.8. Cellular data

This check monitors the aggregate data traﬃc inbound and outbound through the cellular

modem as an Auto-Response trigger event.

• Select Cellular Data as the Check Condi"on.

Note: before conﬁguring cellular data checks in Auto-Response, the internal cellular modem must

be conﬁgured and detected by the console server.

Opengear User Manual. Page 174.

6.2.9. Custom check

This check allows users to run a nominated custom script with nominated arguments whose

return value is used as an Auto-Response trigger event:

• Click on Custom Check as the Check Condi"on.

• Create an executable trigger check script ﬁle.

For example /etc/config/test.sh

#!/bin/sh

logger "A test script"

logger Argument1 = $1

logger Argument2 = $2

logger Argument3 = $3

logger Argument4 = $4

if [ -f /etc/config/customscript.0 ]; then

rm /etc/config/customscript.0

exit 7

touch /etc/config/customscript.0

exit 1

Note: refer to the Opengear FAQ for a sample web page html check and other script ﬁle templates.

• Enter the Script Executable ﬁle name.

Opengear User Manual. Page 175.

For example /etc/config/test.sh.

• Set the Check Frequency.

This is the !me, in seconds, between re-running the script.

• Set the Script Timeout.

This is the maximum run-!me for the script.

• Specify the Successful Return Code.

An Auto-Response is triggered if the return code from the script is not this value.

• Enter Arguments that are to be passed to the script.

For example, with a web page html check script, these Arguments might specify the web

page address/DNS and user logins.

Check Save Auto-Response.

6.2.10. SMS command

An incoming SMS command from a nominated caller can trigger an Auto-Response:

• Select SMS Command as the Check Condi"on.

• Set the Phone number. For mul!ple SMS sources comma-separate the numbers.

Note: enter the phone number in interna#onal format without the plus-sign (+) preﬁx.

• Set the Incoming Message Pa$ern to match to create trigger event.

This pa%ern is a PCRE regular expression.

Note: the SMS command trigger condi#on can only be set if an internal cellular modem detected.

• Click Save Auto-Response.

6.2.11. Log-in & log-out check

To conﬁgure Web Log In/Out as the trigger event:

• select Web UI Authen"ca"on as the Check Condi"on.

• check Trigger on Login or Trigger on Logout to trigger if a user logs into or out of the Web UI.

• Check Trigger on Authen"ca"on Error to trigger when Web UI user authen!ca!on fails.

Opengear User Manual. Page 176.

Note: this check is not resolvable. Resolve ac#ons will not, as a consequence, run.

• Click Save Auto-Response.

6.2.12. Network interface event

You may wish to conﬁgure a change in the network status as the trigger event (e.g. to send an

alert or restart a VPN tunnel connec!on):

• select Network Interface as the Check Condi"on.

• select the Interface to monitor.

• check the interface Event to trigger on.

Note: this check is not resolvable. Resolve ac#ons will not, as a consequence, run.

• Click Save Auto-Response.

6.2.13. Routed data usage check

This check monitors the speciﬁed input interface for data usage that is being routed through

the Opengear and out another interface such as the Internal Cellular Modem.

It is par!cularly useful in IP Passthrough mode, to detect when the downstream router has

failed over and is now rou!ng via the Opengear’s modem as a backup connec!on.

This check may be conﬁgured with these parameters:

• the Opengear’s incoming Interface to monitor.

Opengear User Manual. Page 177.

• an op!onal Source MAC address or source IP Address, to monitor traﬃc from a speciﬁc host

(for example, the downstream router).

• a Data Limit threshold and speciﬁed Time Period.

The Auto-Response will trigger when the limit is hit in the speciﬁed !me.

The Auto-Response will resolve if no matching data is routed for the Resolve Period.

6.3. Trigger ac"ons

To conﬁgure the sequence of ac!ons that is to be taken in the event of the trigger condi!on:

• for a nominated Auto-Response with a deﬁned Check Condi"on, select an Add Trigger

Ac"on (for example, Send Email or Run Custom Script).

This selects the ac!on type to be taken.

• conﬁgure the selected ac!on (as detailed in the sec!ons following).

Each ac!on is conﬁgured with a nominated Ac"on Delay Time which speciﬁes how long (in

seconds) a&er the Auto-Response trigger event to wait before performing the ac!on.

Note: you can add follow-on ac#ons to create a sequence of ac#ons that will be taken in the event

of the one trigger condi#on.

To edit or delete an exis!ng ac!on:

• click the Modify or Delete icon in the Scheduled Trigger Ac"on table.

A message text can be sent with Email, SMS and Nagios ac!ons. This conﬁgurable message

can include selected values:

value

$AR_TRIGGER_VAL

$AR_VAL

$AR_CHECK_DEV

$TIMESTAMP

descrip"on

The trigger value for the check. For example the UPS Status trigger

value can be either onba$ or ba$low.

The value returned by the check. For example the ups status value can

be online, onba$, or ba$low.

The name of the device being checked. For example, for Alarm, the

alarm name.

The current !mestamp.

Opengear User Manual. Page 178.

The default message text is:

$TIMESTAMP: This ac!on was run — Check details: value $AR_VAL vs trigger value

$AR_TRIGGER_VAL.

6.3.1. Send e-mail

• Select Send Email as the Add Trigger Ac"on.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

• Specify the Recipient Email Address to send this email to

For mul!ple recipients enter comma-separated addresses.

• Enter a Subject for the email.

• Edit the Email Text message to send.

• click Save New Ac"on.

Note: an SMS alert can also be sent via an SMTP (email) gateway. You will need to specify the

Recipient Email Address in the format speciﬁed by the gateway provider. For example, for T-

Mobile it is phonenumber@tmomail.net.

6.3.2. Send SMS

• Select Send SMS as the Add Trigger Ac"on.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

• Specify the Phone number that the SMS will be sent to.

This must be in interna!onal format bit without the leading plus (+) sign.

• Edit the Message Text to send

• click Save New Ac"on.

Note: the SMS alert can be sent if there is an internal cellular modem a"ached. Alterna#vely an

SMS alert can also be sent via a SMTP SMS gateway as documented in chapter 6.5.2.

6.3.3. Perform RPC ac"on

• Select Perform RPC Acr"on as the Add Trigger Ac"on.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

• Select a power Outlet.

• Specify the Ac"on (Power On, Power Oﬀ, or Cycle) to be performed.

$HOSTNAME The hostname of the console server.

Opengear User Manual. Page 179.

• click Save New Ac"on.

6.3.4. Run custom script

• Select Run Custom Script as the Add Trigger Ac"on.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

• Create a script ﬁle to execute when this ac!on is triggered.

• Enter the Script Executable’s ﬁle name.

For example /etc/config/action.sh.

• Set the Script Timeout.

This is the maximum run-!me for the script. Set this at 0 for unlimited !me.

• Enter any Arguments that are to be passed to the script.

• click Save New Ac"on.

6.3.5. Send SNMP trap

• Select Send SNMP Trap as the Add Trigger Ac"on.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

Note: the SNMP Trap ac#ons are valid for Serial, Environmental, UPS and Cellular data triggers.

• click Save New Ac"on.

6.3.6. Send Nagios event

• Select Send Nagios Event as the Add Trigger Ac"on.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

• Edit the Nagios Event Message text to display on the Nagios status screen for the service.

• Specify the Nagios Event State (OK, Warning, Cri"cal, or Unknown) to return to Nagios for

this service.

• click Save New Ac"on.

Note: to no#fy the central Nagios server of Alerts, NSCA must be enabled under System > Nagios

and Nagios must be enabled for each applicable host or port.

6.3.7. Perform interface ac"on

• Select Perform Interface Ac"on as the Add Trigger Ac"on.

Opengear User Manual. Page 180.

• Enter a unique Ac"on Name.

• Set the Ac"on Delay Time.

• Select the Interface (Modem or VPN Service).

• Select the Ac"on (Start Interface or Stop Interface) to be taken.

For example, you may wish to start an IPsec VPN service in response to an incoming SMS

message, or set up an OpenVPN tunnel whenever your console server fails over to use the

cellular connec!on.

• click Save New Ac"on.

Note: If any IPsec service or OpenVPN tunnel is to be controlled by the Network Interface Event

Ac"on, the Control by Auto-Response checkbox must be checked when conﬁguring that

service. Also, if selected, the default state for the VPN tunnel or service will be Down.

6.4. Resolve ac"ons

Ac!ons can also be scheduled to be taken a trigger condi!on has been resolved.

• For a nominated Auto-Response with a deﬁned trigger Check Condi!on, click Add Resolve

Ac"on (for example, Send Email or Run Custom Script) to select the ac!on type to be taken.

Note: Resolve Ac"ons are conﬁgured the same way as Trigger Ac"ons except the designated

Resolve Ac"ons are all executed on resolu#on of the trigger condi#on and there are no

Ac"on Delay Times to set.

6.5. Conﬁgure SMTP, SMS, SNMP & Nagios service for alert no"ﬁca"ons

The Auto-Response facility enables remote alerts to be sent as Trigger and Resolve Ac!ons.

Before such alert no!ﬁca!ons can be sent, you must conﬁgure the nominated alert service.

6.5.1. Send e-mail alerts

The console server uses SMTP (Simple Mail Transfer Protocol) for sending the email alert

no!ﬁca!ons. To use SMTP, the Administrator must conﬁgure a valid SMTP server for sending

the email.

• Navigate to Alerts & Logging > SMTP & SMS > SMTP Server.

• Enter the IP address of the outgoing mail Server in the Server ﬁeld.

• If this mail server uses a Secure Connec"on, select its type.

• Specify the IP port to use.

The default SMTP Port is 25.

•Op!onally enter a Sender email address.

This will appear as the From address in all email no!ﬁca!ons sent from this console server.

Note: many SMTP servers check the sender’s email address with the host domain name to verify

the address as authen#c. So it may be useful to assign an email address for the console

server such as consoleserver2@mydomian.com.

Opengear User Manual. Page 181.

• If the SMTP server requires authen!ca!on, enter the required Username and Password.

•Op!onally, enter a Subject Line that will be sent with all email no!ﬁca!ons.

Note: some SMTP servers require a non-blank Subject ﬁeld.

• Click Apply.

SMTP is ac!vated.

6.5.2. Send SMS alerts

With any model console server you can use email-to-SMS services to send SMS alert

no!ﬁca!ons to mobile devices. Almost all mobile phone carriers provide an SMS gateway

service that forwards email to mobile phones on their networks. There’s also a wide selec!on

of SMS gateway aggregators which provide email to SMS forwarding to phones on any

carriers.

Alternately if your console server has an embedded or externally a%ached cellular modem you

will be given the op!on to send the SMS directly over the carrier connec!on.

SMS via e-mail gateway

To use SMTP SMS the Administrator must conﬁgure a valid SMTP server for sending the

email.

• Navigate to Alerts & Logging > SMTP & SMS.

• Select the SMS Gateway radio bu%on in the SMS Se!ngs sec!on.

An SMS via Email Gateway sec!on will appear.

• Enter the IP address of the outgoing SMS gateway Server.

• Select a Secure Connec"on (if applicable).

Opengear User Manual. Page 182.

• specify the SMTP port to be used.

The default SMTP Port is 25.

•Op!onally enter a Sender email address.

This will appear as the From address in all email no!ﬁca!ons sent from this console server.

Note: some SMS gateway service providers only forward email to SMS when the email has been

received from authorized senders. So you may need to assign a speciﬁc authorized email

address for the console server.

• If the SMTP server requires authen!ca!on, enter the required Username and Password.

•Op!onally, enter a Subject Line that will be sent with all no!ﬁca!ons.

Note: generally the email subject will contain a truncated version of the alert no#ﬁca#on message

(which is contained in full in the body of the email). However some SMS gateway service

providers require blank subjects or require speciﬁc authen#ca#on headers to be included in

the subject line.

• Click Apply Se!ngs.

The SMS-SMTP connec!on is ac!vated.

SMS via cellular modem

To use an a%ached or internal cellular modem for SMS the Administrator must enable SMS.

• Navigate to Alerts & Logging > SMTP & SMS.

• Select the Cellular Modem radio bu%on in the SMS Se!ngs sec!on.

• Check Receive Messages to enable incoming SMS messages to be received.

A custom script will be called on receipt of incoming SMS messages.

Opengear User Manual. Page 183.

• You may need to enter the phone number of the carrier’s SMS Message Centre

Only enter this if advised by your carrier or by Opengear support.

• Click Apply Se!ngs.

The SMS-SMTP connec!on is ac!vated.

Note: the op#on to directly send SMS alerts via the cellular modem was included in the

Management GUI as of ﬁrmware v3.4. Advanced console servers have had the gateway

so(ware (SMS Server Tools 3) embedded since ﬁrmware v3.1 however you this could only be

accessed from the command line to send SMS messages. see the Opengear FAQ for more.

6.5.3. Sends SNMP trap alerts

The Administrator can conﬁgure the Simple Network Management Protocol (SNMP) agent

that resides on the console server to send SNMP trap alerts to an NMS management

applica!on.

• Navigate to Alerts & Logging > SNMP.

• Click the Primary SNMP Manager tab.

The Primary SNMP Manager and Secondary SNMP Manager tabs are used to conﬁgure

where and how outgoing SNMP alerts and no!ﬁca!ons are sent.

If you require your console server to send alerts via SNMP a Primary SNMP Manager must

be conﬁgured.

Op!onally, a second SNMP Network Manager, with its own SNMP se$ngs, can be

speciﬁed on the Secondary SNMP Manager tab.

Note: console servers can also be conﬁgured to provide status informa#on on demand using

snmpd. This SNMP agent is conﬁgured using the SNMP Service Detail at Alerts & Logging

> SNMP. See chapter 14 for more.

• Select the Manager Protocol.

SNMP is generally a UDP-based protocol though infrequently it uses TCP instead.

• Enter the host address of the SNMP Network Manager in the Manager Address ﬁeld.

• Enter the TCP/IP port number into the Manager Trap Port ﬁeld

By default this port number is 162.

Opengear User Manual. Page 184.

• Select the Version to be used.

The console server SNMP agent supports SNMP v1, v2 and v3.

• Enter the Community name for SNMP v1 or SNMP v2c.

At a minimum, a community needs to be set for either SNMP v1 or v2c traps to work. An

SNMP community is the group to which devices and management sta!ons running SNMP

belong. It helps deﬁne where informa!on is sent. SNMP default communi!es are private

for Write and public for Read.

• If required, conﬁgure SNMP v3.

For SNMP v3 messages, the user’s details and security level must match what the receiving

SNMP Network Manager is expec!ng. SNMP v3 mandates that the message will be

rejected unless the SNMPv3 user sending the trap already exists in the user database on

the SNMP Manager. The user database in a SNMP v3 applica!on is actually referenced by

a combina!on of the Username and the Engine ID for the given SNMP applica!on you are

talking to.

Opengear User Manual. Page 185.

• Enter the Engine ID for the user sending messages.

This is a hex number. For example: 0x8000000001020304.

• Specify the Security Level.

The security level has to be compa!ble with the se$ngs of the remote SNMP Network

Manager.

• Complete the Username.

This is the Security Name of the SNMPv3 user sending the message. This ﬁeld is

mandatory and must be completed when conﬁguring the console server for SNMPv3.

• If the required Security Level is authNoPriv or authPrive, select an Authen"ca"on Protocol

(either SHA or MD5) and an Authen"ca"on Password.

The password must contain at least 8 characters.

• If the required Security Level is authPriv, select a Privacy Protocol (DES or AES).

AES is recommended. A password of at least 8 characters must be provided for encryp!on

to work.

• Click Apply.

Note: Console servers with ﬁrmware v3.0 and later also embed the net-snmpd dæmon. This

dæmon can accept SNMP requests from remote SNMP management servers and provides

informa#on on alert status, serial port status and device status (see chapter 14.5 for more

details). Console servers with ﬁrmware earlier than v3.3 can only conﬁgure a Primary

SNMP server from the Management Console. See chapter 14.5 for details on conﬁguring the

snmptrap daemon to send traps/no#ﬁca#ons to mul#ple remote SNMP servers.

As of ﬁrmware v3.10.2, new SNMP status and trap MIBS were created to provide more and

be%er structured SNMP status and traps from console servers.

There is an op!on in Alerts & Logging > SNMP to Use Legacy No"ﬁca"ons for the SNMP traps.

Se$ng this op!on sets the console server to SNMP traps that are compa!ble with those sent

in older ﬁrmware before the new MIBS were added. Se$ng this op!on ensures a ﬁrmware

upgrade to v3.10.2 or later does not break exis!ng SNMP management.

When upgrading from ﬁrmware which does not support the newer SNMP MIBs/traps (that

ﬁrmware versions before 3.10.2) to ﬁrmware that does support the new MIBs/traps:

security level

noAuthNoPriv

authNoPriv

authPriv

meaning

No authen!ca!on or encryp!on

Authen!ca!on only. An authen!ca!on protocol (SHA or MD5)

and password are required.

Authen!ca!on and encryp!on. Requires an encryp!on protocol

(DES or AES) and an authen!ca!on protocol password.

Opengear User Manual. Page 186.

If the SNMP service was enabled and an SNMP manager was conﬁgured before upgrading the

ﬁrmware, the console server will be conﬁgured to use the legacy traps a&er upgrading

If the SNMP service was not enabled or no SNMP manger was conﬁgured before the upgrade,

the console server will be conﬁgured to use the new SNMP traps a&er the upgrade. This

won’t have any eﬀect un!l the SNMP service is turned on and an SNMP manager is

conﬁgured.

6.5.4. Send Nagios event alerts

To no!fy the central Nagios server of Alerts, NSCA must be enabled under System > Nagios

and Nagios must be enabled for each applicable host or port under Serial & Network >

Network Hosts or Serial & Network > Serial Ports (see chapter 9).

Note: in a Lighthouse CMS centrally managed environment you can check the Nagios alert op#on.

On the trigger condi#on (for matched pa"erns, logins, power events and signal changes) an

NSCA check warning result will be sent to the central Nagios server. This condi#on is

displayed on the Nagios status screen and triggers a no#ﬁca#on, which can then cause the

Nagios central server itself to send out an email or an SMS, page, etc.

6.6. Logging

The console server can maintain log records of auto-response events. It can also log records of

all access and communica!ons events with both the console server and with a%ached serial,

network and power devices.

A log of all system ac!vity is also maintained by default, as is a history of the status of any

a%ached environmental monitors.

6.6.1. Log storage

Before ac!va!ng any Event, Serial, Network or UPS logging, you must specify where those

logs are to be saved. These records are stored oﬀ-server or in the ACM/IM gateway USB ﬂash

memory.

• Navigate to Alerts & Logging > Port Log.

Opengear User Manual. Page 187.

• Specify the Server Type to be used.

• add the required server details to enable log server access.

The Administrator can view serial, network, and power device logs stored in the console

reserve memory (or on a USB-connected ﬂash device) in Manage > Devices.

A User will only see logs for the Managed Devices they (or their Group) have been given

access privileges for (see chapter 12).

View USB event logs in a web terminal or by ssh or telnet to the console server.

6.6.2. Serial port logging

In Console Server mode, ac!vity logs can be maintained of all serial port ac!vity. To specify

which serial ports are to have ac!vi!es recorded and to what level data is to be logged:

• navigate to Serial & Network > Serial Port.

• click Edit for the port to be logged.

• Specify the Logging Level for each port.

Note: logging levels are not a progression from no logging to all logging. Logging Level 0 is no

logging, but Logging Level 4 is not ‘more’ logging than Logging Level 3: these two levels, for

example, are diﬀerent but 4 is not a more comprehensive amount of logging than 3.

• click Apply.

Note: in addi#on to the Logs which are transmi"ed for remote/USB ﬂash storage, a cache of the

most recent 8K of logged data per serial port is maintained locally. To view the local cache of

logged serial port data select Manage > Port Logs.

level

user connec"on events

not logged

logged

data transferred to

the port

not logged

logged

not logged

logged

data transferred from

the port

not logged

logged

not logged

hardware ﬂow

control changes

not logged

logged

Opengear User Manual. Page 188.

6.6.3. Network TCP & UDB port logging

The console server supports op!onal logging of access to and communica!ons with network

a%ached Hosts.

For each Host, when you set up the Permi%ed Services which are authorized to be used, you

also must set up the level of logging that is to be maintained for each service.

• Specify the logging level that is to be maintained for that par!cular TDC/UDP port/service,

on that par!cular Host:

• Click Add.

• click Apply.

6.6.4. Auto-response event logging

• Navigate to Alerts & Logging > Auto-Response.

• In the Global Auto-Response Se!ngs sec!on, check the Log Events check box.

• Click Save Se!ngs.

6.6.5. Power device logging

The console server also logs access and communica!ons with network a%ached hosts and

maintain a history of the UPS and PDU power status.

To ac!vate and set the desired levels of logging for UPS and PDU devices see chapter 7.

level

what is logged

Turns oﬀ logging for the selected TDC/UDP port to the selected Host.

Logs all connec!on events to the port.

Logs all data transferred to and from the port.

Opengear User Manual. Page 189.

7.Power, environment, & digital I/O

Opengear console servers manage Remote Power Control devices (RPCs including PDUs and

IPMI devices) and Uninterrup!ble Power Supplies (UPSes). They also monitor remote

opera!ng environments using Environmental Monitoring Devices (EMDs) and sensors, and

can provide digital I/O control.

7.1. Remote power control (RPC)

The console server Management Console monitors and controls Remote Power Control (RPC)

devices using the embedded PowerMan and Network UPS Tools open source management

tools and Opengear’s power management so&ware. RPCs include power distribu!on units

(PDUs) and IPMI power devices.

Serial PDUs invariably can be controlled using their command line console, so you could

manage the PDU through the console server using a remote Telnet client. Also you could use

proprietary so&ware tools no doubt supplied by the vendor. This generally runs on a remote

Windows PC and you could conﬁgure the console server serial port to operate with a serial

COM port redirector in the PC (as detailed in chapter 3).

Similarly, network-a%ached PDUs can be controlled with a browser (with SDT as detailed in

chapter 5.3) or an SNMP management package or using the vendor supplied control so&ware.

Also servers and network-a%ached appliances with embedded IPMI service processors or

BMCs invariably are supplied with their own management tools (like SoL) that provide secure

management when connected using with SDT Connector.

For simplicity, however, all these devices can now all be controlled through the one window

using the Management Console’s RPC remote power control tools.

Opengear User Manual. Page 190.

7.1.1. RPC connec"on

Serial and network connected RPCs must ﬁrst be connected to, and conﬁgured to

communicate with, the console server.

• For serial RPCs connect the PDU to the selected serial port on the console server.

• Navigate to Serial & Network > Serial Port.

• Conﬁgure the Common Se!ngs of that port with the RS232 proper!es etc required by the

PDU (see chapter 3.1.1).

• Select RPC as the Device Type.

• Similarly for each network connected RPC, go to Serial & Network > Network Hosts and

conﬁgure the RPC as a connected Host by specifying its Device Type as RPC

• click Apply.

See chapter 4.4 for more on Network Hosts.

• Navigate to Serial & Network > RPC Connec"ons.

The RPC connec!ons that have already been conﬁgured will present.

• Click Add RPC.

•Connected Via presents a list of serial ports and network Host connec!ons that you have

set up with device type RPC but have yet to connect to a speciﬁc RPC device.

Opengear User Manual. Page 191.

• When you select Connected Via for a Network RPC connec!on, the corresponding Host

Name/Descrip"on set up for that connec!on will be entered as the Name and Descrip"on

for the power device.

• Alterna!vely if you select Serial connec!on for Connected Via, you will need to enter a

Name and Descrip!on for the power device.

• Select the appropriate RPC Type for the PDU (or IPMI) being connected.

If you are connec!ng to the RPC via the network you will be presented with the IPMI

protocol op!ons and the SNMP RPC Types currently supported by the embedded Network

UPS Tools.

If you are connec!ng to the RPC by a serial port you will be presented with all the serial

RPC types currently supported by the embedded PowerMan and Opengear’s power

manager.

• Enter the Username and Password used to login into the RPC

These login creden!als are not related to the Users and access privileges conﬁgured in

Serial & Networks > Users & Groups.

• If SNMP protocol is selected enter the SNMP v1 or v2c Community for Read/Write access.

By default this would be private.

• Check Log Status.

Opengear User Manual. Page 192.

• Secify the Log Rate (minutes between samples) if you wish the status from this RPC to be

logged.

These logs can be views from Status > RPC Status.

• Click Apply.

For SNMP PDUs the console server will now probe the conﬁgured RPC to conﬁrm the RPC

Type matches and will report the number of outlets it ﬁnds that can be controlled. If

unsuccessful it will report Unable to probe outlets and you will need to check the RPC se$ngs,

the network connec!on or the serial connec!on.

For serially connected RPC devices, a new Managed Device (with the same name as given to

the RPC) will be created. The console server will then conﬁgure the RPC with the number of

outlets speciﬁed in the selected RPC Type or will query the RPC itself for this informa!on.

Note: Opengear’s console servers support the majority of the popular network and serial PDUs. If

your PDU is not on the default list then support can be added directly (see chapter 14) or by

having the PDU supported added to either the Network UPS Tools or PowerMan open

source projects.

IPMI service processors and BMCs can be conﬁgured so all authorized users can use the

Management Console to remotely cycle power and reboot computers, even when their

opera!ng system is unresponsive. To set up IPMI power control:

• enter the IP address or domain name of the BMC or service processor (for example, a Dell

DRAC) in Serial & Network > Network Hosts.

• then in Serial & Network > RPC Connec"ons specify the RPC Type to be IPMI1.5 or 2.0.

7.1.2. RPC access privileges & alerts

Opengear User Manual. Page 193.

Set PDU and IPMI alerts using Alerts & Logging > Alerts (see chapter 6). Assign users to

access and control outlets on each RPC via Serial & Network > User & Groups (see chapter 3).

7.1.3. User power management

The Power Manager allows users and administrators to access and control conﬁgured serial- &

network-a%ached PDU power strips, and servers with embedded IPMI processors or BMCs.

• Select Manage > Power.

• Select the Target power device to be controlled.

• If the RPC supports outlet level control, select the Outlet to be controlled.

• Ini!ate the desired Ac!on by selec!ng the appropriate icon:

Note: icons will present only for opera#ons that are supported by the Target you have selected.

Turn On.

Turn Oﬀ.

Cycle.

Status.

Opengear User Manual. Page 194.

7.1.4. RPC status

You can monitor the current status of your network and serially connected PDUs and IPMI

RPCs.

• Select Status > RPC Status.

A table with the summary status of all connected RPC hardware will display.

• Click on View Log or select the RPCLogs tab.

A table of the history and detailed graphical informa!on on the selected RPC will present.

• Click Manage to query or control the individual power outlet.

This will take you to Manage > Power.

7.2. Uninterrup"ble power supply (UPS) control

Opengear console servers can be conﬁgured to manage locally and remotely connected UPS

hardware using Network UPS Tools.

Network UPS Tools (NUT) is a group of open source programs that provide a common

interface for monitoring and administering UPS hardware; and ensuring safe shutdowns of

the systems which are connected. NUT is built on a networked model with a layered scheme

of drivers, server and clients. It is covered in some detail in chapter 7.2.6.

7.2.1. Managed UPS connec"ons

Opengear User Manual. Page 195.

A Managed UPS is a UPS that is directly connected as a Managed Device to the console server.

It can be connected by serial or USB cable or by the network. The console server becomes the

master of this UPS, and runs a upsd server to allow other computers that are drawing power

through the UPS (slaves) to monitor the UPS status and take appropriate ac!on, such as

shutdown, in event of low UPS ba%ery.

The console server may or may not be drawing power itself through the Managed UPS. When

the UPS’s ba%ery power reaches cri!cal, the console server signals, waits for slaves to shut

down, then powers oﬀ the UPS.

Serial and network connected UPSes must ﬁrst be connected to, and conﬁgured to

communicate with the console server.

For serial UPSes a%ach the UPS to the selected serial port on the console server:

• navigate to Serial and Network > Serial Port.

Opengear User Manual. Page 196.

• conﬁgure the Common Se!ngs of that port with the proper!es (RS232 etc) required by

the UPS (see chapter 3.1.1).

• select UPS as the Device Type.

For each network connected UPS:

• navigate to Serial & Network > Network Hosts.

• conﬁgure the UPS as a connected Host by specifying its Device Type as UPS.

• click Apply.

Note: USB-connected UPS hardware requires no equivalent conﬁgura#on.

• Navigate to Serial & Network > UPS Connec"ons.

The Managed UPSes sec!on will display all UPS connec!ons which have already been

conﬁgured.

• Click Add Managed UPS.

• Select if the UPS will be Connected Via USB or over a pre-conﬁgured serial port or via

SNMP/HTTP/HTTPS over the preconﬁgured network Host connec!on.

Note: when you select a network UPS connec#on, the corresponding Host Name/Descrip#on that

you set up for that connec#on will be entered as the Name and Descrip#on for the power

device. Alterna#vely, if you select to Connect Via a USB or serial connec#on you will need to

enter a Name and Descrip#on for the power device. These details will also be used to create

a new Managed Device entry for the serial/USB connected UPS devices.

• Enter the login details.

This Username and Password is used by slaves of this UPS (that is, other computers that

are drawing power through this UPS) to connect to the console server to monitor the UPS

status so they can shut themselves down when ba%ery power is low.

Monitoring will typically be performed using the upsmon client running on the slave server

(see chapter 7.2.3).

Note: these login creden#als are not related to the Users and access privileges conﬁgured in Serial

Opengear User Manual. Page 197.

& Networks > Users & Groups.

• Select the ac!on to take when UPS ba%ery power becomes cri!cal: Shut down the UPS or

Shut down all Managed UPSes or simply Run un!l failure.

the shutdown script /etc/scripts/ups-shutdown can be customized so, in the event of

a cri!cal power failure (when the UPS ba%ery runs out) you can program the console server to

perform last gasp ac!ons before power is lost. See the Opengear FAQ for details. It is

generally simpler, however, to perform such last gasp ac!ons by triggering Auto-Response on

the UPS hi$ng ba$ or lowba$. See chapter 6.

• If you have mul!ple UPSes and require them to be shut down in a speciﬁc order, specify

the Shutdown Order for this UPS.

This is a whole posi!ve number, a 0 or -1. 0s are shut down ﬁrst, then 1s, 2s, 3s and so on.

-1s are not shut down at all. The default value is 0.

• Select the Driver that will be used to communicate with the UPS.

• Click New Op"ons in Driver Op"ons if you need to set driver-speciﬁc op!ons for your

selected NUT driver and hardware combina!on.

Opengear User Manual. Page 198.

For more details see h%p://www.networkupstools.org/doc.

• Check Log Status and specify the Log Rate (minutes between samples) if you wish the

status from this UPS to be logged.

These logs can then be viewed at Status > UPS Status.

If you have enabled Nagios services you will presented with an op!on for Nagios monitoring.

• Check Enable Nagios to enable this UPS to be monitored using Nagios central management.

• Check Enable Shutdown Script if this is the UPS providing power to the console server itself.

In the event of a cri!cal power failure you can perform last gasp ac!ons on the console

server before power is lost.

This is achieved by placing a custom script in /etc/config/scripts/ups-shutdown

(you may use the provided /etc/scripts/ups-shutdown as a template). This script is

only run when then UPS reaches cri!cal ba%ery status.

Click Apply.

Note: you can customize the upsmon, upsd and upsc se&ngs for this UPS hardware directly

from the command line.

7.2.2. Remote UPS management

A Remote UPS is a UPS that is connected as a Managed Device to some remote console server

which is being monitored (but not managed) by your console server.

The upsc and upslog clients in the Opengear console server can conﬁgured to monitor

remote servers that are running Network UPS Tools managing their locally connected UPSes.

These remote servers might be other Opengear console servers or generic Linux servers

running NUT. So all these distributed UPSes (which may be spread in a row in a data center,

or around a campus property or across the country) can be centrally monitored through the

one central console server window.

An example where centrally monitoring remotely distributed UPSes is useful is a campus or

large business complex where there’s a mul!tude of computer and other equipment sites

spread afar, each with their own UPS supply. Many of these (par!cularly the smaller sites) will

be USB or serially connected.

Having a ACM5000 or ACM5500 at these remote sites allows the systems manager to

centrally monitor the power supply status at all sites, centralize alarms, and, consequently, be

warned to ini!ate a call-out or take shut down ac!ons.

To add a Remote UPS:

Opengear User Manual. Page 199.

• navigate to Serial & Network > UPS.

The Remote UPSes sec!on displays all the remote UPS devices being monitored

• click Add Remote UPS.

• enter the UPS Name of the remote UPS to be remotely monitored.

This name must be the name that the remote UPS was conﬁgured with on the remote

console server as the remote console server may itself have mul!ple UPSes a%ached that it is

managing locally with NUT.

• op!onally enter a Descrip!on.

• enter the IP Address or DNS name of the remote console server that is managing the

remote UPS.

This may be another Opengear console server or it may be a generic Linux server running

Network UPS Tools.

• check Log Status.

• specify the Log Rate (minutes between samples) if you wish the status from this UPS to be

logged.

These logs can then be viewed at Status > UPS Status.

Opengear User Manual. Page 200.

• check Enable Shutdown Script if this remote UPS is the UPS providing power to the console

server itself.

In the event the UPS reaches cri!cal ba%ery status the custom script in /etc/config/

scripts/ups-shutdown is run enabling you to perform any ‘last gasp’ ac!ons.

click Apply.

Note: the Remote UPS feature is supported on all console servers running ﬁrmware v2.8 and later.

Earlier versions supported a single remote ]Monitored UPS which could be set to trigger the

console server shutdown script.

7.2.3. Controlling UPS-powered computers

One of the advantages of having a Managed UPS is that you can conﬁgure computers that

draw power through that UPS to be shut down gracefully in the event of UPS problems.

For Linux computers this can be done by se$ng up upsmon on each computer and direc!ng

them to monitor the console server that is managing their UPS.

This will set the speciﬁc condi!ons that will be used to ini!ate a power down of the

computer. For example, non-cri!cal servers may be powered down some seconds a&er the

UPS starts running on ba%ery where more cri!cal servers may not be shut down un!l a low

ba%ery warning is received. Refer to the online NUT documenta!on for details on how this is

done:

h%p://eu1.networkupstools.org/doc/2.2.0/INSTALL.html

h%p://linux.die.net/man/5/upsmon.conf

h%p://linux.die.net/man/8/upsmon

An example upsmon.conf entry might look like:

MONITOR managedups@192.168.0.1 1 username password slave

There are NUT monitoring clients available for Windows computers (for example, WinNUT).

If you have an RPC (PDU) it is also possible to shut down UPS-powered computers and other

equipment without them have a client running (for example, communica!ons and surveillance

gear). Set up a UPS alert and use this to trigger a script which controls a PDU to shut oﬀ the

power (see chapter 14).

7.2.4. UPS alerts

Set UPS alerts using Alerts & Logging > Alerts. See chapter 6.

7.2.5. UPS status

upsmon.conf por"on

manageup

192.168.0.1

username

password

meaning

The UPS Name of the managed UPS.

The IP address of the Opengear console server.

Indicates the server has a single power supply a%ached to this UPS.

The username of the managed UPS.

The password of the managed UPS.

Opengear User Manual. Page 201.

You can monitor the current status of your network-connected, serially-connected or USB-

connected Managed UPSes and any conﬁgured Remote UPSes.

• Navigate to Status > UPS Status.

A table with the summary status of all connected UPS hardware will display.

• Click on any given UPS System name in the table.

More detailed graphical informa!on on the select UPS System will present.

• Click on any given UPS System’s All Data link in the table.

Status and conﬁgura!on informa!on on the selected UPS System presents.

• Select UPS Logs.

The log table of the load, ba%ery charge level, temperature and other status informa!on

Opengear User Manual. Page 202.

from all the managed and monitored UPS systems is presented.

This informa!on is logged for all UPSes which were conﬁgured with Log Status checked.

The informa!on is also presented graphically.

7.2.6. Overview of Network UPS tools (NUT)

Network UPS Tools (NUT) is built on a networked model with a layered scheme of drivers,

server and clients. NUT can be conﬁgured using the Management Console as described

above, or you can conﬁgure the tools and manage the UPSes directly from the command line.

This sec!on provides an overview of NUT., Full NUT documenta!on is available at h%p://

networkupstools.org/documenta!on.html.

The driver programs talk directly to the UPS equipment and run on the same host as the NUT

network server (upsd). Drivers are provided for a wide assortment of equipment from most of

the popular UPS vendors and understand the speciﬁc language of each UPS. They

communicate to serial-, USB- and SNMP network- connected UPS hardware and map the

communica!ons back to a compa!bility layer. This means both an expensive ‘smart’ protocol

UPS and a simple ‘power strip’ model can be handled transparently.

The NUT network server program upsd is responsible for passing status data from the drivers

to the client programs via the network. upsd can cache the status from mul!ple UPSes and

then serve this status data to many clients. upsd also contains access control features to limit

the abili!es of the clients (for example, so only authorized hosts may monitor or control the

UPS hardware).

There are a number of NUT clients that connect to upsd to check on the status of the UPS

hardware and do things based on the status. These clients can run on the same host as the

NUT server or they can communicate with the NUT server over the network (enabling them

to monitor any UPS anywhere).

Opengear User Manual. Page 203.

• The upsc client provides a quick way to poll the status of a UPS server. It can be used

inside shell scripts and other programs that need UPS data but don’t want to include the

full interface

• The upsmon client enables servers that draw power through the UPS to shutdown

gracefully when the ba%ery power reaches cri!cal

• There are also logging clients (upslog) and third party interface clients (Big Sister, Cac!,

Nagios, Windows and more).

The latest release of NUT (2.7.4) also controls PDU systems. It can do this either na!vely

using SNMP or through a binding to Powerman (open source so&ware from Livermore Labs

that is also embedded in Opengear console servers).

These NUT clients and servers are all embedded in each Opengear console server (with a

Management Console presenta!on layer added). They also run remotely on distributed

console servers and other remote NUT monitoring systems. This layered distributed NUT

architecture enables:

•Mul!ple manufacturer support.

NUT can monitor UPS models from 79 diﬀerent manufacturers and PDUs from a growing

number of vendors, all via a uniﬁed interface.

•Mul!ple architecture support.

NUT can manage serial- and USB-connected UPS models with the same common

interface. Network-connected USB and PDU equipment can also be monitored using

SNMP.

•Mul!ple clients monitoring the one UPS.

Mul!ple systems may monitor a single UPS using only their network connec!ons. As well

there is a wide selec!on of client programs which support monitoring UPS hardware via

NUT (Big Sister, Cac!, Nagios and more).

• Central management of mul!ple NUT servers.

A central NUT client can monitor mul!ple NUT servers that may be distributed throughout

the data center, across a campus or around the world.

NUT supports the more complex power architectures found in data centers, communica!ons

centers and distributed oﬃce environments where: UPSes from many vendors power many

systems with many clients; and larger UPSes power mul!ple devices; and many of these

UPSes are, in turn, dual powered.

7.3. Environmental monitoring

Opengear console servers can be conﬁgured to monitor their opera!ng environment.

External Environmental Monitor Devices (EMDs) can be connected to any Opengear console

Opengear User Manual. Page 204.

server serial port. Each console server can support mul!ple EMDs.

Each EMD device has an internal temperature and humidity sensor plus one or two general

purpose status sensor ports which can be connected to smoke detectors, water detectors,

vibra!on sensors or open-door sensors.

The ACM5000 and ACM5500 advanced console server models also each have an internal

temperature sensor and can op!onally be conﬁgured to have up to four general purpose

status sensor ports (which can be connected to smoke detectors, water detectors, vibra!on

sensors, or open-door sensors) directly connected.

Using the Management Console, Administrators can view the ambient temperature (in °C or

°F) and humidity (as a percentage) and conﬁgure alerts to monitor the status and sensors to

automa!cally send alarms progressively from warning levels to cri!cal.

7.3.1. Connec"ng the EMD & its sensors

The Environmental Monitor Device (EMD) connects to any serial port on the console server

via a special EMD Adapter and standard CAT5 cable. The sensors then screw into the EMD.

Note: the EMD is powered over the serial port connec#on and communicates using a custom

handshake protocol. It is not an RS232 device and should not

be connected without the adapter.

• Plug the male RJ plug on the EMD Adapter into the EMD.

• Connect the Adapter to the console server serial port using

the provided UTP cable.

If the 2 meter (6ʹ) UTP cable provided with the EMD is not

long enough it can be replaced with a standard Cat5 UTP

cable up to 10 meters (33ʹ) in length.

• Screw the bare wires on any smoke detector, water detector,

vibra!on sensor, open-door sensor or general purpose open/

close status sensors into the terminals on the EMD.

Note: you can a"ach two sensors onto the terminals on EMDs that

are connected to console servers with Opengear Classic

pinouts. However console servers with -01 and -02 pinouts

only support a"aching a single sensor to each EMD.

EMDs work with Opengear console servers only and cannot be

connected to standard RS232 serial ports on other appliances.

• Navigate to Serial & Network > Serial Port.

• Select Environmental as the Device Type.

No par!cular se$ngs are required.

Opengear User Manual. Page 205.

• Click Apply.

7.3.2. Connec"ng sensors to ACM5000s, ACM5500s, & ACM7000s

You can connect EMDs (and their a%ached environmental sensors) to the ACM5000’s serial

ports, as detailed above. ACM5000s also supports direct environmental sensor connec!on.

All ACM5000 models (except the ACM5004-2-I) can be conﬁgured with the environmental

op!on –E. Models with this op!on have a green connector block on the side (marked

SENSORS 1 -4) and up to four environmental sensors can be directly a%ached to this block.

The ACM5004-2-I model is supplied with a green connector block on the side by default. The

ﬁrst two connectors on this block (marked DIO1 and DIO2) can be conﬁgured to have

external environmental sensors a%ached.

ACM5508-2-I and ACM5504-5-G-I models also ship with a green connector block on the

side. The ﬁrst two connectors on this block (marked DIO1 and DIO2) can be conﬁgured to

have external environmental sensors a%ached.

ACM7000 models ship with an in-built, black, spring cage I/O connector block for a%aching

environmental sensors and digital I/O devices.

ACM5000-E sensor inputs are four dry contact inputs. These are normally open (NO) and

sensed as TTL high or digital 1. When ac!vated, external devices (door close, vibra!on, water,

smoke) present a short circuit, the contact closes to ground and is read as TTL low or digital 0.

For custom applica!ons the state (closed or open) of non-Opengear dry contact sensors can

be sensed through the UI or command line.The sensor pins can also be controlled as outputs:

set the pins as TTL high (1) or low (0) as required for their low voltage/low current applica!on.

ACM5000s and ACM5000 -Is have dedicated I/O (DIO1 & DIO2) and output only pins (OUT1

& OUT2), the la%er having inver!ng outputs with higher voltage/current transistor. By default

each SENSOR and DIO port is conﬁgured as an Input for external environmental sensors.

• To conﬁrm the direc!on and state conﬁgura!ons for these ports navigate to System > I/O.

A table with the summary status of the four digital I/O ports will present.

• Screw the bare wires on a smoke detector, water detector, vibra!on sensor, open-door

sensor or general purpose open/close status sensor into the SENSOR or DIO terminals on

the green connector block.

As Inputs, the SENSOR and DIO ports are no!onally a%ached to the internal EMD.

port label

I/O Port 1

I/O Port 2

I/O Port 3

I/O Port 4

equivalent hardware label

DIO1 or SENSOR1

DIO2 or SENSOR2

SENSOR3

SENSOR4

Opengear User Manual. Page 206.

• Navigate to Serial & Network > Environmental Status.

• Enable the Internal EMD.

• Conﬁgure the a%ached sensors as alarms.

Details for doing this are covered in the next sec!on.

7.3.3. Adding EMD & conﬁguring the sensors

• Navigate to Serial & Network > Environmental.

This will display external EMDs and internal EMD (that is, sensors that may be directly

a%ached to an ACM) that have already been conﬁgured.

• To add a new EMD click Add.

• enter a Name.

•Op!onally enter a Descrip"on.

• Select the pre-conﬁgured serial port that the EMD will be Connected Via.

•Op!onally calibrate the EMD with a Temperature Oﬀset (+ or - °C) or Humidity Oﬀset (+ or

percent).

Opengear User Manual. Page 207.

Note: if you check Temperature in Fahrenheit the temperature will be reported in Fahrenheit.

Otherwise it will be reported in degrees Celsius.

• Provide Labels for each of the alarm sensors used (for example, Door Open or Smoke

Alarm).

• Check Log Status.

• Specify the Log Rate (minutes between samples) if you wish the status from this EMD to be

logged. These logs can be viewed at Status > Environmental Status.

• Click Apply.

This will also create a new Managed Device with the same name.

• For the ACM5000-E select Serial & Network > Environmental.

Opengear User Manual. Page 208.

• check Enabled.

• Set temperature oﬀsets and label the sensors as described above.

7.3.4. Environmental alerts

Set temperature, humidity and probe status alerts using Alerts & Logging> Alerts. See chapter

7.3.5. Environmental status

You can monitor the current status of any and all conﬁgured external EMDs and their sensors,

and any internal or directly a%ached sensors.

• Navigate to Status > Environmental Status.

A table with the summary status of all connected EMD hardware will display.

• Click on View Log or click the Environmental Logs tab.

A table and graphical plot of the log history of the select EMD will present.

Opengear User Manual. Page 209.

7.4. Digital I/O ports

ACM5000 -I models and ACM5500 -I models have four digital interface ports which present

on a green connector block on the side of the unit.

DIO1 and DIO2 are two TTL level digital I/O ports: 5V max @ 20mA.

OUT1 and OUT2 are two High-Voltage digital output ports: >5V to <= 30V @100mA.

ACM7000 models ship with an in-built, black, spring cage I/O connector block for a%aching

environmental sensors and digital I/O devices.

These I/O ports are conﬁgured via System > I/O Ports. Each port can be conﬁgured with a

default direc!on and state.

• Navigate to System > I/O Ports.

7.4.1. Digital I/O output conﬁgura"on

Each of the two digital I/O ports (DIO1 and DIO2) can be conﬁgured as an Input or Output

port. To use them as digital outputs ﬁrst conﬁgure the port direc!on on System > I/O Ports.

The DIO1 and DIO2 pins are current limited by the chip to 20mA and accept 5V levels, so

they cannot, for example, drive a relay.

Opengear User Manual. Page 210.

You can change the output states using the ioc command line u!lity. The following text is

the ioc help text (also available by running ioc --help):

-p pin_num pin number (1 to 4)

-d pin_dir pin direction (0 = output 1 = input)

-v pin_val pin electrical value in output mode \

(0 = low 1 = high)

-r reset pins to all inputs and low

-g displays the pin directions and current values

-l load pin configuration from configlity

For example, to set pin 1 to a low output, type:

ioc -p 1 -d 0 -v 0

To pulse one of these outputs, use a script like the following:

ioc -p 1 -d 0 -v 1

sleep 1

ioc -p 1 -d 0 -v 0

This sets the output high for 1 second, then returns it to low (assuming the ini!al state is low).

7.4.2. Digital I/O input conﬁgura"on

When either of the two digital I/O (DIO1 & DIO2) outlets is conﬁgured as an Input on the

System > I/O Ports, it can be used to monitor the current status of any a%ached sensor.

When conﬁgured as inputs (the factory default) these ﬁrst two ports are no!onally a%ached

to an internal EMD. To conﬁgure them as alarms, go to the Status > Environmental Status and

edit and enable the Internal EMD.

Note: the low voltage circuits in DIO1 and DIO2 should not be wired to voltages greater than 5V

DC.

ALterna!vely, these input ports can be monitored using the ioc command line u!lity (as

detailed in 7.4.1 above).

7.4.3. High-voltage outputs

OUT1 and OUT2 (internally, DIO3 & DIO4) outlets are wired as high voltage outputs. The

way these outputs are expected to be used is to pull a power connected line to ground (that

is, the OUT1 and OUT2 transistors are open collector).

The I/O port header includes a 12v reference line (VIN) which can be used to detect the line

state change.

For example, to light a 12v LED using the high voltage outputs, connect the posi!ve leg of the

LED to the 12v reference, and the nega!ve leg to output pin 4. Due to the way that the I/O

port is connected internally, the output has to be set high to pull the output to ground.

The following command will switch on the led:

ioc -p 4 -d 0 -v 1

OUT1 and OUT2 transistors can operate with a supply of >5V to <= 30V @100mA. This

Opengear User Manual. Page 211.

means to drive a relay circuit you must guarantee it doesn’t provide more than 100mA when

set to 1.

7.4.4. DIO SNMP status

As of ﬁrmware v3.9, there is a SNMP status table which reports on the status of the digital IO

ports.

The table’s OID is OG-STATUSv2-MIB::ogEmdDioTable. Performing an snmpwalk on this

table on a console server with DIO produces something like the following (the speciﬁcs will

vary depending on device status):

$ snmpwalk -v2c -c public -M $MIBSDIR -m ALL t5:161

1.3.6.1.4.1.25049.16.5

OG-STATUS-MIB::ogDioStatusName.1 = STRING: DIO 1

OG-STATUS-MIB::ogDioStatusName.2 = STRING: DIO 2

OG-STATUS-MIB::ogDioStatusName.3 = STRING: DIO 3

OG-STATUS-MIB::ogDioStatusName.4 = STRING: DIO 4

OG-STATUS-MIB::ogDioStatusType.1 = INTEGER: ttlInputOutput(0)

OG-STATUS-MIB::ogDioStatusType.2 = INTEGER: ttlInputOutput(0)

OG-STATUS-MIB::ogDioStatusType.3 = INTEGER: highVoltageOutput(1)

OG-STATUS-MIB::ogDioStatusType.4 = INTEGER: highVoltageOutput(1)

OG-STATUS-MIB::ogDioStatusDirection.1 = INTEGER: input(1)

OG-STATUS-MIB::ogDioStatusDirection.2 = INTEGER: input(1)

OG-STATUS-MIB::ogDioStatusDirection.3 = INTEGER: input(1)

OG-STATUS-MIB::ogDioStatusDirection.4 = INTEGER: input(1)

OG-STATUS-MIB::ogDioStatusState.1 = INTEGER: low(0)

OG-STATUS-MIB::ogDioStatusState.2 = INTEGER: high(1)

OG-STATUS-MIB::ogDioStatusState.3 = INTEGER: high(1)

OG-STATUS-MIB::ogDioStatusState.4 = INTEGER: high(1)

OG-STATUS-MIB::ogDioStatusCounter.1 = Counter64: 0

OG-STATUS-MIB::ogDioStatusCounter.2 = Counter64: 0

OG-STATUS-MIB::ogDioStatusCounter.3 = Counter64: 0

OG-STATUS-MIB::ogDioStatusCounter.4 = Counter64: 0

OG-STATUS-MIB::ogDioStatusTriggerMode.1 = INTEGER:

risingFallingEdge(3)

OG-STATUS-MIB::ogDioStatusTriggerMode.2 = INTEGER:

risingFallingEdge(3)

OG-STATUS-MIB::ogDioStatusTriggerMode.3 = INTEGER:

risingFallingEdge(3)

OG-STATUS-MIB::ogDioStatusTriggerMode.4 = INTEGER:

risingFallingEdge(3)

Opengear User Manual. Page 212.

8.Authen!ca!on

The console server pla*orm is a dedicated Linux computer, and it embodies a myriad of

popular and proven Linux so&ware modules for networking, secure access (OpenSSH), secure

communica!ons (OpenSSL) and sophis!cated user authen!ca!on (PAM, RADIUS, TACACS+,

Kerberos and LDAP).

This chapter details how the Administrator can use the Management Console to establish

remote AAA authen!ca!on for all connec!ons to the console server and a%ached serial and

network host devices.

Opengear User Manual. Page 213.

This chapter also covers establishing a secure link to the Management Console using HTTPS

and using OpenSSL and OpenSSH for establishing secure Administra!on connec!on to the

console server.

More details on RSA SecurID and working with Windows IAS can be found in the FAQs at

h%ps://opengear.zendesk.com/.

8.1. Authen"ca"on conﬁgura"on

Authen!ca!on can be performed locally, or remotely using an LDAP, Radius, Kerberos or

TACACS+ authen!ca!on server. The default authen!ca!on method for the console server is

Local.

Any authen!ca!on method that is conﬁgured will be used for authen!ca!on of any user who

a%empts to log in through Telnet, SSH or the Web Manager to the console server and any

connected serial port or network host devices.

The console server can be conﬁgured to the default (Local) or an alternate authen!ca!on

method (TACACS, RADIUS, LDAP or Kerberos) with the op!on of a selected order in which local

and remote authen!ca!on is to be used.

•Local/TACACS/RADIUS/LDAP/Kerberos

Tries local authen!ca!on ﬁrst, falling back to remote if local fails.

•TACACS/RADIUS/LDAP/Kerberos Local

Tries remote authen!ca!on ﬁrst, falling back to local if remote fails.

•TACACS/RADIUS/LDAP/Kerberos Down/Local

Tries remote authen!ca!on ﬁrst, falling back to local if the remote authen!ca!on returns

an error condi!on (e.g. the remote authen!ca!on server is down or inaccessible).

8.1.1. Local authen"ca"on

• Navigate to Serial and Network > Authen!ca!on.

• Check Local.

• Click Apply.

8.1.2. TACACS authen"ca"on

Perform the following procedure to conﬁgure the TACACS+ authen!ca!on method to be

used whenever the console server or any of its serial ports or hosts is accessed.

• Select Serial and Network > Authen"ca"on.

• check TACAS, LocalTACACS, TACACSLocal or TACACSDownLocal.

• Enter the Server Address (IP or host name) of the remote Authen!ca!on/Authoriza!on

server.

Mul!ple remote servers may be speciﬁed in a comma separated list. Each server is tried in

succession.

Opengear User Manual. Page 214.

• Session accoun!ng is on by default. If session accoun!ng informa!on is not wanted, check

the Disable Accoun!ng checkbox.

One reason for not wan!ng session accoun!ng: if the authen!ca!on server does not

respond to accoun!ng requests, said request may introduce a delay when logging in.

• In addi!on to mul!ple remote servers you can also enter for separate lists of

Authen!ca!on/Authoriza!on servers and Accoun!ng servers.

If no Accoun!ng servers are speciﬁed, the Authen!ca!on/Authoriza!on servers are used

instead.

• Enter and conﬁrm the Server Password.

• Select the method to be used to authen!cate to the server (defaults to PAP).

To use DES encrypted passwords, select Login.

• If required, enter the TACACS Group Membership A$ribute to be used to indicate group

memberships (defaults to groupname#n).

• If required, specify TACACS Service to authen!cate with.

This determines which set of a%ributes are returned by the server (defaults to raccess).

• If required, check Default Admin Privileges to give all TACAS+ authen!cated users admin

privileges.

•Use Remote Groups must also be !cked for these privileges to be granted.

• The TACACS Privilege Level feature only applies to TACACS remote authen!ca!on.

Opengear User Manual. Page 215.

When Ignore Privilege Level is enabled, the priv-lvl se$ng for all of the users deﬁned on

the TACACS AAA server will be ignored.

Note: An Opengear device normally interprets a user with a TACACS priv-lvl of 12 or above as

an admin user. There is a special case where a user with a priv-lvl of 15 is also given

access to all conﬁgured serial ports. When the Ignore Privilege Level op#on is enabled (that

is, it is checked in the UI) there are no escala#ons of privileges based on the priv-lvl

value from the TACACS server. Also: if the only thing conﬁgured for one or more TACACS

users is the priv-lvl (for example, no speciﬁc port access or group memberships are set),

then enabling this feature will revoke access to the console server for those users as the

they won’t be a member of any groups, even if the Retrieve Remote groups op#on in the

Authen"ca"on menu is enabled.

• Click Apply.

TACAS+ remote authen!ca!on will now be used for all user access to console server and

serially or network a%ached devices.

The Terminal Access Controller Access Control System (TACACS+) security protocol is a

protocol developed by Cisco. It provides detailed accoun!ng informa!on and ﬂexible

administra!ve control over the authen!ca!on and authoriza!on processes.

TACACS+ allows for a single access control server (the TACACS+ daemon) to provide

authen!ca!on, authoriza!on, and accoun!ng services independently. Each service can be

!ed into its own database to take advantage of other services available on that server or on

the network, depending on the capabili!es of the daemon.

8.1.3. RADIUS authen"ca"on

The Remote Authen!ca!on Dial-In User Service (RADIUS) protocol was developed by

Livingston Enterprises as an access server authen!ca!on and accoun!ng protocol.

The RADIUS server can support a variety of methods to authen!cate a user.

When it is provided with the username and original password given by the user, it can support

PPP, PAP or CHAP, UNIX login, and other authen!ca!on mechanisms.

More informa!on on conﬁguring remote RADIUS servers can be found h%ps://freeradius.org/

and h%ps://cisco.com/c/en/us/support/docs/security-vpn/remote-authen!ca!on-dial-user-

service-radius/12433-32.html.

Perform the following procedure to conﬁgure the RADIUS authen!ca!on method to be used

whenever the console server or any of its serial ports or hosts is accessed:

• Select Serial & Network > Authen"ca"on and check RADIUS, LocalRADIUS, RADIUSLocal or

RADIUSDownLocal.

• Enter the Server Address (IP or host name) of the remote Authen"ca"on and Authoriza"on

server.

Mul!ple remote servers may be speciﬁed in a comma separated list. Each server is tried in

succession.

• Session accoun!ng is on by default. If session accoun!ng informa!on is not wanted, check

the Disable Accoun"ng checkbox.

Opengear User Manual. Page 216.

One reason for not wan!ng session accoun!ng: if the authen!ca!on server does not

respond to accoun!ng requests, said request may introduce a delay when logging in.

• In addi!on to mul!ple remote servers, you can also enter separate lists of Authen"ca"on

and Authoriza"on servers and Accoun"ng servers.

If no Accoun"ng servers are speciﬁed, the Authen"ca"on and Authoriza"on servers are used

instead.

• Enter the Server Password.

• Click Apply.

RADIUS remote authen!ca!on will now be used for all user access to console server and

serially or network a%ached devices.

8.1.4. LDAP authen"ca"on

The Lightweight Directory Access Protocol (LDAP) is based on the X.500 standard, but

signiﬁcantly simpler and more readily adapted to meet custom needs. The core LDAP

speciﬁca!ons are all deﬁned in RFCs. LDAP is a protocol used to access informa!on stored in

an LDAP server.

With ﬁrmware v3.11 and later, LDAP authen!ca!on now supports OpenLDAP servers, using

the POSIX -style schema for user and group deﬁni!ons.

Performing simple authen!ca!on against any LDAP server (AD or OpenLDAP) is straight

forward, as they both follow the common LDAP standards and protocols. The harder part is

conﬁguring how to get the extra data about the users (for example, the groups they are in).

On an Opengear device, we may be conﬁgured to look at group informa!on from an LDAP

server for authen!ca!on and authoriza!on. This group informa!on is poten!ally stored in a

number of diﬀerent ways. Ac!ve Directory has one method, and OpenLDAP has two other

methods.

Ac"ve Directory method

Each entry for a user will have mul!ple memberOf a%ributes. Each memberOf value is the full

DN of the group they belong to. (The entry for the user will be of objectClass user.)

OpenLDAP/POSIX method 1

Opengear User Manual. Page 217.

Each entry for a user must have a gidNumber a%ribute. This will be an integer value, which is

the user’s primary group (for example, mapping to the /etc/passwd ﬁle, with the group ID

ﬁeld).

To determine which group this is, search for an entry in the directory that has that group ID,

which will give the group name. (The users are of objectClass posixAccount, and the groups

are of objectClass posixGroup.)

OpenLDAP/POSIX method 2

Each group entry in the group tree of objectClass posixGroup may have mul!ple memberUid

a%ributes. These represent secondary groups (for example, mapping to the /etc/groups

ﬁle). Each a%ribute would contain a username.

To cater for all these possibili!es, the pam_ldap module has been modiﬁed to do group

lookups for each of these three styles. This allows us to have a rela!vely generic

conﬁgura!on, and not be concerned with how the LDAP directory is set up.

There are only two parameters that need to be conﬁgured, based on what the user wishes to

look up: the LDAP username and group membership a%ributes.

To clarify to the user what parameters to use, the descrip!ons for these ﬁelds have been

updated to prompt the user for common or likely a%ributes. For example, the two

conﬁgura!on ﬁelds have descrip!ons as follows:

LDAP Username A$ribute: the LDAP a%ribute that corresponds to the login name of the user

(commonly ‘sAMAccountName’ for Ac!ve Directory, and ‘uid’ for OpenLDAP).

LDAP Group Membership A$ribute: the LDAP a%ribute that indicates group membership in a

user record (commonly ‘memberOf’ for Ac!ve Directory, and unused for OpenLDAP).

Note: The libldap library is par#cularly fussy about ensuring SSL connec#ons are using cer#ﬁcates

signed by a trusted CA. Consequently it is o(en not easy to set up a connec#on to an LDAP

Opengear User Manual. Page 218.

server using SSL. See h"ps://opengear.zendesk.com/entries/29959515-LDAP-over-SSL for

more.

Perform the following procedure to conﬁgure the LDAP authen!ca!on method to be used

whenever the console server or any of its serial ports or hosts is accessed:

• navigate to Serial & Network > Authen"ca"on.

• check LDAP or LocalLDAP or LDAPLocal or LDAPDownLocal.

• enter the Server Address (IP or host name) of the remote Authen!ca!on server.

Mul!ple remote servers may be speciﬁed in a comma separated list. Each server is tried in

succession.

• check the Server Protocol checkbox to select if SSL is to be used or enforced for

communica!ons with the LDAP server.

Console servers running ﬁrmware v3.11 and above oﬀer three op!ons for LDAPS (LDAP

over SSL):

LDAP over SSL preferred will a%empt to use SSL for authen!ca!on. If it fails, it will fall

back to LDAP without SSL.

LDAP over SSL may fail due to cer!ﬁcate errors or the LDAP server not being contactable

on the LDAPS port.

LDAP over SSL only. This se$ng will conﬁgure the Opengear device to only accept LDAP

over SSL. If LDAP over SSL fails you will only be able to log into the console server as

root.

LDAP (no SSL) only. This se$ng will conﬁgure the Opengear device to only accept LDAP

without SSL. If LDAP without SSL fails you will only be able to log into the console server

as root.

• Check the Ignore SSL Cer"ﬁcate Error check box if you wish to ignore SSL cer!ﬁcate errors,

allowing LDAP over SSL to work regardless of these errors.

This allows you to use any cer!ﬁcate, self-signed or otherwise, on the LDAP server without

having to install any cer!ﬁcates on the console server.

If this se$ng is not checked, you must install the CA (cer!ﬁcate authority) cer!ﬁcate with

which the LDAP server’s cer!ﬁcate was signed, onto the console server. For example, the

LDAP server is serving with a cer!ﬁcate signed using the cer!ﬁcate myCA.crt.

Note: The cer#ﬁcate must be in CRT format and myCA.crt must be installed onto the console

server at /etc/config/ldaps_ca.crt. The ﬁlename must be ldaps_ca.crt. Copy

the ﬁle to this loca#on and ﬁlename manually using scp or the like. For example:

scp /local/path/to/myCA.crt

rt root@console_server:/etc/config/ldaps_ca.crt

• Enter the Server Password.

• Click Apply.

LDAP remote authen!ca!on will now be used for all user access to console server and serially

or network a%ached devices

Opengear User Manual. Page 219.

Further informa!on on conﬁguring remote RADIUS servers can be found at the following

sites: h%p://ldapman.org/ar!cles/intro_to_ldap.html, h%p://ldapman.org/servers.html, h%p://

linuxplanet.com/linuxplanet/tutorials/5050/1/, and h%p://linuxplanet.com/linuxplanet/

tutorials/5074/4/.

8.1.5. RADIUS & TACACS user conﬁgura"on

Users may be added to the local console server appliance. If they are not added and they log

in via remote AAA, a user will be added for them. This user will not show up in the Opengear

conﬁgurators unless they are speciﬁcally added, at which point they are transformed into a

completely local user. The newly added user must authen!cate oﬀ of the remote AAA server,

and will have no access if it is down.

If a local user logs in, they may be authen!cated or authorized from the remote AAA server,

depending on the chosen priority of the remote AAA. A local user’s authoriza!on is the union

of local and remote privileges.

Example 1

User Tim is locally added, and has access to ports 1 and 2. He is also deﬁned on a remote

TACACS server, which says he has access to ports 3 and 4. Tim may log in with either his local

or TACACS password, and will have access to ports 1 through 4. If TACACS is down, he will

need to use his local password, and will only be able to access ports 1 and 2.

Example 2

User Ben is only deﬁned on the TACACS server, which says he has access to ports 5 and 6.

When he a%empts to log in a new user will be created for him, and he will be able to access

ports 5 and 6. If the TACACS server is down he will have no access.

Example 3

User Paul is deﬁned on a RADIUS server only. He has access to all serial ports and network

hosts.

Example 4

User Don is locally deﬁned on an appliance using RADIUS for AAA. Even if Don is also deﬁned

on the RADIUS server he will only have access to those serial ports and network hosts he has

been authorized to use on the appliance.

If a no local AAA op!on is selected, then root will s!ll be authen!cated locally.

Remote users may be added to the admin group via either RADIUS or TACACS. Users may

have a set of authoriza!ons set on the remote TACACS server. Users automa!cally added by

RADIUS will have authoriza!on for all resources, whereas those added locally will s!ll need

their authoriza!ons speciﬁed.

LDAP has not been modiﬁed, and will s!ll need locally deﬁned users.

Note: to interact with RADIUS, TACACS+ and LDAP with console server ﬁrmware v2.4.2 and

erarlier user accounts on the local console server must also be set up. All resource

authoriza#ons must be added to the local appliance. With this release, if remote AAA is

selected, it is used for password checking only. Root is always authen#cated locally. Changes

to PAM conﬁgura#ons will be destroyed next #me the authen#ca#on conﬁgurator is run.

Opengear User Manual. Page 220.

8.1.6. Group support with remote authen"ca"on

All console servers allow remote authen!ca!on via RADIUS, LDAP and TACACS+. With

ﬁrmware v3.2 and later, RADIUS and LDAP can provide addi!onal restric!ons on user access

based on group informa!on or membership. For example, with remote group support, users

can belong to a local group that has been setup to have restricted access to serial ports,

network hosts and managed devices.

Remote authen!ca!on with group support works by matching a local group name with a

remote group name provided by the authen!ca!on service. If the list of remote group names

returned by the authen!ca!on service matches any local group names, the user is given

permissions as conﬁgured in the local groups.

To enable group support to be used by remote authen!ca!on services:

• navigate to Serial & Network > Authen"ca"on.

• select the relevant Authen"ca"on Method.

• check the Use Remote Groups checkbox.

8.1.7. Remote groups with RADIUS authen"ca"on

• Enter the RADIUS Authen"ca"on and Authoriza"on Server Address and Server Password.

• Click Apply.

• Edit the Radius user’s ﬁle to include group informa!on and restart the Radius server.

When using RADIUS authen!ca!on, group names are provided to the console server using the

Framed-Filter-Id a%ribute. This is a standard RADIUS a%ribute, and may be used by

other devices that authen!cate via RADIUS.

To interoperate with other devices using this ﬁeld, the group names can be added to the end

of any exis!ng content in the a%ribute, in the following format:

:group_name=testgroup1,users:

This example sets the remote user as a member of testgroup1 and users, if these groups

exist on the console server. Groups that do not exist on the console server are ignored.

Opengear User Manual. Page 221.

When se$ng the Framed-Filter-Id, the system may also remove the leading colon for an

empty ﬁeld. To work around this, add some dummy text to the start of the string. For

example:

dummy:group_name=testgroup1,users:

If no group is speciﬁed for a user — for example AmandaJones — then the user will have

limited console access, with no user interface or serial port access.

Default groups available on the console server include admin for administrator access and

users for general user access.

TomFraser Cleartext-Password := "FraTom70"

Framed-Filter-Id=":group_name=admin:"

AmandaJones Cleartext-Password := "JonAma83"

FredWhite Cleartext-Password := "WhiFre62"

Framed-Filter-Id=":group_name=testgroup1,users:"

JanetLong Cleartext-Password := "LonJan57"

Framed-Filter-Id=":group_name=admin:"

Addi!onal local groups such as testgroup1 can be added via Users & Groups > Serial &

Network.

Opengear User Manual. Page 222.

8.1.8. Remote groups with LDAP authen"ca"on

Unlike RADIUS, LDAP has built in support for group provisioning, which makes se$ng up

remote groups easier. The console server will retrieve a list of all the remote groups that the

user is a direct member of, and compare their names with local groups on the console server.

Note: spaces in an LDAP group name will be converted to underscores.

For example, in an exis!ng Ac!ve Directory setup, a group of users may be part of the UPS

Admin and Router Admin groups.

On the console server, these users will be required to have access to a group Router_Admin,

with access to port 1 (connected to the router), and another group, UPS_Admin, with access

to port 2 (connected to the UPS).

Once LDAP is setup, users that are members of each group will have the appropriate

permissions to access the router and UPS.

Currently, the only LDAP directory service that supports group provisioning is Microso&

Ac!ve Directory. Support is planned for OpenLDAP at a later !me.

To enable group informa!on to be used with an LDAP server:

• Complete the ﬁelds for standard LDAP authen!ca!on including LDAP Server Address, Server

Password, LDAP Base DN, LDAP Bind DN and LDAP User Name A$ribute.

• Enter memberOf for LDAP Group Membership A$ribute as group membership is currently

only supported on Ac!ve Directory servers.

• If required, enter the group informa!on for LDAP Console Server Group DN, LDAP

Administra"on Group DN, or both.

A user must be a member of the LDAP Console Server Group DN group to gain access to the

console and user interface. For example, the user must be a member of MyGroup on the

Ac!ve Server to gain access to the console server.

Addi!onally, a user must be a member of the LDAP Administra"on Group DN in order to

gain administrator access to the console server. For example, the user must be a member of

AdminGroup on the Ac!ve Server to receive administra!on privileges on the console server.

Opengear User Manual. Page 223.

• Click Apply.

• Ensure the LDAP service is opera!onal and group names are correct within the Ac!ve

Directory.

Note: When you are using remote groups with LDAP remote auth, you need to have corresponding

local groups on the console server. Where the LDAP group names can contain upper case

and space characters, however, the local group name on the console server must be all lower

case and the spaces replaced with underscrores. For example, a remote group on the LDAP

server may be My Ldap Access Group. The corresponding local group on the console server

must be my_ldap_access_group. The local group on the console server must specify what

the group member is granted access to for any group membership to be eﬀec#ve.

8.1.9. Remote groups with TACACS+ authen"ca"on

When using TACACS+ authen!ca!on, there are two ways to grant a remotely authen!cated

user privileges. The ﬁrst is to set the priv-lvl and port a%ributes of the raccess service

to 12. See chapter 8.2 for more.

Addi!onally, or alterna!vely, group names can be provided to the console server using the

groupname custom a%ribute of the raccess service.

An example Linux tac-plus config snippet might look like:

user = myuser {

service = raccess {

groupname="users"

groupname1="routers"

groupname2="dracs"

}

You may also specify mul!ple groups in one comma-delimited. Fore example

groupname="users,routers,dracs"

Note: the maximum length of the a"ribute value string is 255 characters.

To use an a%ribute name other than "groupname", set the Authen"ca"on > TACACS+ >

TACACS Group Membership A%ribute.

8.1.10. Idle "meout

You can specify the !me the console server waits before it terminates an idle ssh, pmshell

or web connec!on.

• Navigate to Serial & Network > Authen"ca"on.

Opengear User Manual. Page 224.

• set a Web Management Session Timeout in minutes.

This speciﬁes the browser console session idle !meout. The default se$ng is 20 minutes.

• Set a CLI Management Session Timeout in minutes.

This speciﬁes the ssh console session idle !meout. The default se$ng is to never expire.

• Set a Console Server Session Timeout in minutes.

This speciﬁes the pmshell serial console server session idle !meout. The default se$ng is

to never expire.

8.1.11. Kerberos authen"ca"on

Kerberos authen!ca!on can be used with UNIX and Windows (Ac!ve Directory) Kerberos

servers. This form of authen!ca!on does not provide group informa!on, so a local user with

the same username must be created, and permissions set.

Note: Kerberos is sensi#ve to #me diﬀerences between the Key Distribu#on Center (KDC)

authen#ca#on server and the client device. Make sure that NTP is enabled, and the #me

zone is set correctly on the console server.

When authen!ca!ng against Ac!ve Directory, the Kerberos Realm will be the domain name,

and the Master KDC will be the address of the primary domain controller.

8.1.12. Authen"ca"on tes"ng

Console servers running ﬁrmware V3.5.2u3 or later include the Serial & Network >

Authen"ca"on > Authen"ca"on Tes"ng tab

This tab enables the connec!on to the remote authen!ca!on server to be tested.

8.2. Pluggable authen"ca"on modules (PAM)

Console servers support RADIUS, TACACS+ and LDAP for two-factor authen!ca!on via PAM

Opengear User Manual. Page 225.

(Pluggable Authen!ca!on Modules). PAM is a ﬂexible mechanism for authen!ca!ng users.

Nowadays a number of new ways of authen!ca!ng users have become popular. The

challenge is that each !me a new authen!ca!on scheme is developed; it requires all the

necessary programs (login, &pd etc.) to be rewri%en to support it.

PAM provides a way to develop programs that are independent of authen!ca!on scheme.

These programs need ‘authen!ca!on modules’ a%ached to them at run-!me in order to work.

Which authen!ca!on module is a%ached is dependent on the local system setup and is at the

discre!on of the local Administrator.

The console server family supports PAM to which we have added the following modules for

remote authen!ca!on:

Further modules can be added as required.

Changes made to ﬁles in /etc/config/pam.d/ will persist, even if the authen!ca!on

conﬁgurator is run.

• Users added on demand.

When a user a%empts to log in, but does not already have an account on the console

server, a new user account will be created. This account will have no rights, and no

password set. They will not appear in the Opengear conﬁgura!on tools.

Automa!cally added accounts will not be able to log in if the remote servers are

unavailable

• Admin rights granted over AAA.

Users may be granted Administrator rights via networked AAA.

For TACACS a priv-lvl of 12 or above indicates an administrator.

For RADIUS, administrators are indicated via the Framed Filter ID. See the example

conﬁgura!on ﬁles below for example.

• Authoriza!on via TACACS, LDAP or RADIUS for using remote groups.

See chapter 8.1.6.

• Authoriza!on via TACACS for both serial ports and host access.

Permission to access resources may be granted via TACACS by indica!ng an Opengear

Appliance and a port or networked host the user may access. See the example

conﬁgura!on ﬁles below for example.

TACACS example

user = tim {

service = raccess {

priv-lvl = 11

port1 = acm7004/port02

module

RADIUS

TACACS+

LDAP

binary

pam_radius_auth

pam_tacplus

pam_ldap

source

h%ps://freeradius.org/pam_radius_auth/

h%ps://github.com/jeroennijhof/pam_tacplus

h%p://padl.com/OSS/pam_ldap.html

Opengear User Manual. Page 226.

}

global = cleartext mit

}

RADIUS example

paul Cleartext-Password: = "luap"

Service-Type = Framed-User,

Fall-Through = No,

Framed-Filter-Id =":group_name=admin:"

The list of groups may include any number of entries separated by a comma. If the admin

group is included, the user will be made an Administrator.

If there is already a Framed-Filter-Id, add the list of group_names a&er the exis!ng

entries, including the separa!ng colon :.

8.3. SSL cer"ﬁcate

The console server uses the Secure Socket Layer (SSL) protocol for encrypted network traﬃc

between itself and a connected user.

During connec!on establishment the console server has to expose its iden!ty to the user’s

browser using a cryptographic cer!ﬁcate. The default cer!ﬁcate that comes with the console

server device upon delivery is for tes!ng purpose only and should not be relied on for secured

global access.

Note: system administrators must not rely on the default cer#ﬁcate as the secured global access

mechanism for use through Internet.

• Switch to your preferred browser.

• enter https://ip-address-or-hostname-of-console-server-here/.

Your browser may respond with a message that veriﬁes the security cer!ﬁcate is valid but

notes that it is not necessarily veriﬁed by a cer!fying authority.

• To proceed you need to click yes if you are using Internet Explorer or select accept this

cer"ﬁcate permanently (or temporarily) if you are using Mozilla Firefox.

• The Management Console login will present.

• Enter an Administrator’s username and password as normal.

Opengear User Manual. Page 227.

Note: it is recommended you generate and install a new base64 X.509 cer#ﬁcate that is unique for

each par#cular console server.

To generate a new base64 X.509 cer!ﬁcate, the console server must be enabled to generate a

new cryptographic key and the associated Cer!ﬁcate Signing Request (CSR) that needs to be

cer!ﬁed by a Cer!ﬁca!on Authority (CA).

A cer!ﬁca!on authority veriﬁes that you are the person who you claim you are, and signs and

issues a SSL cer!ﬁcate to you. To create and install a SSL cer!ﬁcate for the console server:

• Navigate to System > SSL Cer"ﬁcate.

• Fill out the presented ﬁelds.

Common name: the network name of the console server once it is installed in the network.

Usually the fully qualiﬁed domain name. It is iden!cal to the name used to access the

console server with a web browser (without the “h%p://” preﬁx). If the name given here and

the actual network name diﬀer, the browser will pop up a security warning when the

console server is accessed using h%ps.

Organiza"onal Unit: this ﬁeld is used for specifying to which department within an

organiza!on the console server belongs.

Organiza"on: the name of the organiza!on to which the console server belongs.

Locality/City: the city where the organiza!on is located.

State/Province: the state or province where the organiza!on is located.

Country: the two-le%er ISO code designa!ng the country where the organiza!on is located.

For example, DE for Germany and US for the the United States of America.

Opengear User Manual. Page 228.

Note: the country code must be entered in ALL CAPS.

Email: the email address of the person responsible for the console server and its security.

Challenge Password: some cer!ﬁca!on authori!es require a challenge password to

authorize later changes on the cer!ﬁcate (for example, revoca!on of the cer!ﬁcate).

Conﬁrm Challenge Password: conﬁrma!on of the Challenge Password.

Key length: this is the length of the generated key in bits. 1024 Bits are supposed to be

suﬃcient for most cases. Longer keys may result in slower response !me of the console

server during connec!on establishment.

• click Generate CSR.

The Cer!ﬁcate Signing Request (CSR) genera!on is ini!ated.

• Click Download to copy the CSR to your administra!on machine.

• Send the saved CSR string to a Cer!ﬁca!on Authority (CA). for cer!ﬁca!on.

You will get the new cer!ﬁcate from the CA a&er a more or less complicated tradi!onal

authen!ca!on process (depending on the CA).

• Upload the cer!ﬁcate received from your CA to the console server using the Upload bu%on.

A&er comple!ng these steps the console server has its own cer!ﬁcate that is used for

iden!fying the console server to its users.

Note: Informa#on on issuing cer#ﬁcates and conﬁguring HTTPS from the command line can be

found in chapter 14.

Opengear User Manual. Page 229.

9.Nagios integra!on

Nagios is a powerful, highly extensible open source tool for monitoring network hosts and

services. The core Nagios so&ware package will typically be installed on a server or virtual

server, the central Nagios server.

Console servers operate in conjunc!on with a central/upstream Nagios server to provide

distribu!ng monitoring of a%ached network hosts and serial devices. They embed the NSCA

(Nagios Service Checks Acceptor) and NRPE (Nagios Remote Plug-in Executor) add-ons – this

allows them to communicate with the central Nagios server, elimina!ng the need for a

dedicated slave Nagios server at remote sites.

The console server products all support distributed monitoring. Even if distributed monitoring

is not required, the Console servers can be deployed locally alongside the Nagios monitoring

Opengear User Manual. Page 230.

host server, to provide addi!onal diagnos!cs and points of access to managed devices.

Note: If you have an exis#ng Nagios deployment, you may wish to use the console server

gateways in a distributed monitoring server capacity only. If this case and you are already

familiar with Nagios, skip ahead to chapter 9.3.

9.1. Nagios overview

Nagios provides central monitoring of the hosts and services in your distributed network.

Nagios is freely downloadable, open source so&ware. This sec!on oﬀers a quick background

of Nagios and its capabili!es. A complete overview, FAQ and comprehensive documenta!on

is available at h%ps://nagios.org/.

Nagios forms the core of many leading commercial system management solu!ons such as

GroundWork, h%ps://gwos.com/.

Nagios does take some !me to install and conﬁgure. Once it is up and running, however, it

provides an outstanding network monitoring system. With Nagios you can:

• display tables showing the status of each monitored server and network service in real

!me

• use a wide range of freely available plug-ins to make detailed checks of speciﬁc services.

For example, don’t just check a database is accep!ng network connec!ons, check that it

can actually validate requests and return real data.

• Display warnings and send warning e-mails, pager or SMS alerts when a service failure or

degrada!on is detected.

• Assign contact groups who are responsible for speciﬁc services in speciﬁc !me frames.

9.2. Conﬁguring Nagios distributed monitoring

To ac!vate the console server Nagios distributed monitoring:

Nagios integra!on must be enabled and a path established to the central/upstream Nagios

server.

If the console server is to periodically report on Nagios monitored services, then the NSCA

client embedded in the console server must be conﬁgured. The NSCA program enables

scheduled check-ins with the remote Nagios server and is used to send passive check results

across the network to the remote server.

If the Nagios server is to ac!vely request status updates from the console server, then the

NRPE server embedded in the console server must be conﬁgured. The NRPE server is the

Nagios daemon for execu!ng plug-ins on remote hosts.

Each of the Serial Ports and each of the Hosts connected to the console server which are to be

monitored must have Nagios enabled and any speciﬁc Nagios checks conﬁgured.

Lastly the central/upstream Nagios monitoring host must be conﬁgured.

9.2.1. Enable Nagios on the console server

• Navigate to System > Nagios.

Opengear User Manual. Page 231.

• Check Enabled.

• Enter the Nagios Host Name the console server will be referred to in the Nagios server.

This is generated from the local System Name (System > Administra"on) if unspeciﬁed.

• In Nagios Host Address, enter the address or hostname the upstream Nagios server uses to

reach the console server. This defaults to the 1st network port: Network (1) (System > IP).

• In Nagios Server Address enter the IP address or DNS name that the console server will use

to reach the upstream Nagios monitoring server.

• Check the Disable SDT Nagios Extensions op!on to disable SDT Connector integra!on with

your Nagios server at the head end. Only check to run vanilla Nagios monitoring.

• If not, enter the IP address or DNS name the SDT Nagios clients will use to reach the

console server in SDT Gateway Address.

• Check Prefer NRPE to use NRPE when possible (that is, for all communica!on except alerts).

When NRPE and NSCA are both enabled, NSCA is the preferred method for

communica!ng with the upstream Nagios server.

9.2.2. Enable NRPE monitoring

Enabling NRPE allows you to execute plug-ins (such as check_tcp and check_ping) on the

remote console server to monitor serial or network a%ached remote servers.

Opengear User Manual. Page 232.

This will oﬄoad CPU load from the upstream Nagios monitoring machine which is especially

valuable if you are monitoring hundreds or thousands of hosts.

To enable NRPE:

• Select System > Nagios.

• Check NRPE Enabled.

• Enter the details of the user connec!on to the upstream Nagios monitoring server.

Refer the sample Nagios conﬁgura!on example below for details of conﬁguring speciﬁc

NRPE checks.

By default the console server will accept a connec!on between the upstream Nagios

monitoring server and the NRPE server with SSL encryp!on, without SSL, or tunneled

through SSH. The security for the connec!on is conﬁgured at the Nagios server.

9.2.3. Enable NSCA monitoring

NSCA is the mechanism that allows you to send passive check results from the remote

console server to the Nagios daemon running on the monitoring server.

To enable NSCA:

• Navigate to System > Nagios.

• Check the NSCA Enabled checkbox.

• Select the NSCA Encryp"on to be used from the drop down menu.

• Enter an NSCA Secret password.

• Specify an NSCA Interval (in minutes).

Opengear User Manual. Page 233.

For more on conﬁguring speciﬁc NSCA checks, see the sample Nagios conﬁgura!on below.

9.2.4. Conﬁgure selected serial ports for Nagios monitoring

The individual serial ports connected to the console server to be monitored must be

conﬁgured for Nagios checks. See chapter 3.4 for details on enabling Nagios monitoring for

Hosts that are network connected to the console server.

To enable Nagios to monitor on a device connected to the console server serial port:

• navigate to Serial & Network > Serial Port.

• click Edit on the serial Port # to be monitored.

• check the Enable Nagios checkbox.

• specify the Host Name of the device on the upstream server.

• check the checkboxes of the Nagios checks to be run on this port.

Serial Status monitors the handshaking lines on the serial port. Check Port monitors the data

logged for the serial port.

Opengear User Manual. Page 234.

9.2.5. Conﬁgure selected network ports for Nagios monitoring

The individual network hosts connected to the console server to be monitored must also be

conﬁgured for Nagios checks.

• Navigate to Serial & Network > Network Port.

• Click Edit on the Network Host to be monitored

• Check the Enable Nagios checkbox.

• Specify the Host Name of the device as it will appear on the upstream Nagios server.

• Click New Check to add a speciﬁc check which will be run on this host.

• Select Check Permi$ed TCP or Check Permi$ed UDP to monitor a service that you have

previously added as a permi%ed service.

• Alterna!vely, select Check TCP or Check UDP to specify a service port that you wish to

monitor, but do not wish to allow external (SDT Connector) access to.

• The Nagios Check nominated as the check-host-alive check is the check used to determine

whether the network host itself is up or down.

Typically this will be Check Ping, although in some cases the host will be conﬁgured not to

respond to pings.

• You can deselect check-host-alive.

If check-host-alive check is de-selected, the host will always be assumed to be up.

• If required, customize the selected Nagios Checks to use custom arguments.

• Click Apply.

Opengear User Manual. Page 235.

9.2.6. Conﬁgure the upstream Nagios monitoring host

For conﬁguring the upstream server refer to the Nagios documenta!on, at h%ps://nagios.org/

documenta!on/.

The sec!on en!tled Distributed Monitoring steps through what you need to do to conﬁgure

NSCA on the upstream server (under Central Server Conﬁgura!on)

NRPE Documenta!on has recently been added which steps through conﬁguring NRPE on the

upstream server h%p://nagios.sourceforge.net/docs/nrpe/NRPE.pdf

At this stage, Nagios at the upstream monitoring server has been conﬁgured, and individual

serial port and network host connec!ons on the console server conﬁgured for Nagios

monitoring. If NSCA is enabled, each selected check will be executed once over the period of

the check interval. If NRPE is enabled, then the upstream server will be able to request status

updates under its own scheduling.

9.3. Advanced distributed monitoring conﬁgura"on

9.3.1. Sample Nagios conﬁgura"on

An example conﬁgura!on for Nagios is listed below. It shows how to set up a remote console

server to monitor a single host, with both network and serial connec!ons.

For each check it has two conﬁgura!ons: one for NRPE and one for NSCA.

In prac!ce, these would be combined into a single check which used NSCA as a primary

method, falling back to NRPE if a check was late. For details see the Nagios documenta!on —

at h%ps://nagios.org/documenta!on/ — on Service and Host Freshness Checks.

; Host definitions

;

; Opengear console server

define host {

use generic-host

host_name opengear

alias Console server

address 192.168.254.147

}

; Managed Host

define host {

use generic-host

host_name server

alias server

address 192.168.254.227

}

; NRPE daemon on gateway

define command {

command_name check_nrpe_daemon

command_line $USER1$/check_nrpe -H \

192.168.254.147 -p 5666

Opengear User Manual. Page 236.

}

define service {

service_description NRPE Daemon

host_name opengear

use generic-service

check_command check_nrpe_daemon

}

; Serial Status

define command {

command_name check_serial_status

command_line $USER1$/check_nrpe -H \

192.168.254.147 -p 5666 -c \

check_serial_$HOSTNAME$

}

define service {

service_description Serial Status

host_name server

use generic-service

check_command check_serial_status

}

define service {

service_description serial-signals-server

host_name server

use generic-service

check_command check_serial_status

active_checks_enabled 0

passive_checks_enabled 1

}

define servicedependency {

name opengear_nrpe_daemon_dep

host_name opengear

dependent_host_name server

dependent_service_description Serial Status

service_description NRPE Daemon

execution_failure_criteria w,u,c

}

; Port Log

define command {

command_name check_port_log

command_line $USER1$/check_nrpe -H \

192.168.254.147 -p 5666 -c \

port_log_$HOSTNAME$

}

define service {

service_description Port Log

host_name server

Opengear User Manual. Page 237.

use generic-service

check_command check_port_log

}

define service {

service_description port-log-server

host_name server

use generic-service

check_command check_port_log

active_checks_enabled 0

passive_checks_enabled 1

}

define servicedependency {

name opengear_nrpe_daemon_dep

host_name opengear

dependent_host_name server

dependent_service_description Port Log

service_description NRPE Daemon

execution_failure_criteria w,u,c

}

; Ping

define command {

command_name check_ping_via_opengear

command_line $USER1$/check_nrpe -H \

192.168.254.147 -p 5666 -c \

host_ping_$HOSTNAME$

}

define service {

service_description Host Ping

host_name server

use generic-service

check_command check_ping_via_opengear

}

define service {

service_description host-ping-server

host_name server

use generic-service

check_command check_ping_via_opengear

active_checks_enabled 0

passive_checks_enabled 1

}

define servicedependency {

name opengear_nrpe_daemon_dep

host_name opengear

dependent_host_name server

dependent_service_description Host Ping

service_description NRPE Daemon

Opengear User Manual. Page 238.

execution_failure_criteria w,u,c

}

; SSH Port

define command {

command_name check_conn_via_opengear

command_line $USER1$/check_nrpe -H \

192.168.254.147 -p 5666 -c \

host_$HOSTNAME$_$ARG1$_$ARG2$

}

define service {

service_description SSH Port

host_name server

use generic-service

check_command check_conn_via_opengear!tcp!22

}

define service {

service_description host-port-tcp-22-server

; host-port-<protocol>-<port>-<host>

host_name server

use generic-service

check_command check_conn_via_opengear!tcp!22

active_checks_enabled 0

passive_checks_enabled 1

}

define servicedependency {

name opengear_nrpe_daemon_dep

host_name opengear

dependent_host_name server

dependent_service_description SSH Port

service_description NRPE Daemon

execution_failure_criteria w,u,c

}

9.3.2. Basic Nagios plug-ins

Plug-ins are compiled executables or scripts that can be scheduled to be run on the console

server to status check a connected host or service. This status is communicated to the Nagios

server which uses the results to monitor the status of the network. Console servers are

preconﬁgured with a selec!on of checks that are part of the Nagios plug-ins package.

plug-in

check_tcp

check_udp

check_ping

check_nrpe

check_serial_signals

check_port_log

descrip"on and notes

Used to check open ports on network hosts.

Used to check network host availability.

Used to execute arbitrary plug-ins in other devices.

Used to monitor handshaking lines on serial ports. Opengear-speciﬁc.

Used to monitor the data logged for a serial port. Opengear-speciﬁc.

Opengear User Manual. Page 239.

9.3.3. Addi"onal plug-ins

Addi!onal Nagios plug-ins (listed below) are available for all CM7100-, IM7200- and IM4200-

series devices.

These plug-ins from the Nagios plug-ins package can be downloaded from &p://

&p.opengear.com/. There also are bash scripts which can be downloaded and run (primarily

check_log.sh).

To conﬁgure addi!onal checks, the downloaded plug-in program must be saved in the *tp

addins directory on the USB ﬂash drive and the downloaded text plug-in ﬁle saved in /

etc/config/.

To enable these addi!onal plug-ins:

• navigate to Serial & Network > Network Port.

• click Edit for the Network Host to be monitored.

• select New Checks.

The addi!onal check op!ons will have been included in the updated Nagios Checks list,

and you can again customize the arguments.

If you need other plug-ins to be loaded into the CM7100, IM7200 or IM4200 ﬁrmware:

• If the plug-in is a Perl script, it must be rewri%en. The console server does not support Perl

at this point.

If you do require Perl support, please make a feature request to support@opengear.com.

• Individual compiled programs may be generated using gcc for ARM.

Again contact support@opengear.com for details.

9.3.4. Number of supported devices

Ul!mately the number of devices that can be supported by any par!cular console server is a

func!on of the number of checks being made, and how o&en they are performed. Access

method will also play a part. The table below shows the performance of three of the console

server models (1/2-port, 8-port and 16/48 port):

check_apt

check_dig

check_hpjd

check_mrtg

check_ntp

check_real

check_ssmtp

check_users

check_by_ssh

check_dns

check_h%p

check_mrtgtraf

check_nwstat

check_simap

check_swap

check_clamd

check_dummy

check_imap

check_nagios

check_overcr

check_smtp

check_tcp

check_apt

check_fping

check_jabber

check_nntp

check_ping

check_snmp

check_!me

check_by_ssh

check_&p

check_ldap

check_nntps

check_pop

check_spop

check_udp

check_clamd

check_game

check_load

check_nt

check_procs

check_ssh

check_ups

NSCA tests

1 check

100 sequen!al checks

no encryp"on

~ 0.5 sec

100.0 sec

3DES

~ 0.5 sec

100.0 sec

SSH

~ 0.5 sec

100.0 sec

Opengear User Manual. Page 240.

The results were from running tests 5 !mes in succession with no !meouts on any runs.

However there are a number of ways to increase the number of checks you can do:

Usually when using NRPE checks, an individual request will need to set up and tear down an

SSL connec!on. This overhead can be avoided by se$ng up an SSH session to the console

server and tunneling the NRPE port. This allows the NRPE daemon to be run securely without

SSL encryp!on, as SSH will take care of the security.

When the console server submits NSCA results it staggers them over a certain !me period

(e.g. 20 checks over 10 minutes will result in two check results every minute). Staggering the

results like this means that in the event of a power failure or other incident that causes

mul!ple problems, the individual freshness checks will be staggered too.

NSCA checks are also batched. So in the previous example the two checks per minute will be

sent through in a single transac!on.

9.3.5. Distributed monitoring usage scenarios

Below are a number of distributed Nagios monitoring scenarios.

Local oﬃce

In this scenario, the console server is set up to monitor the console of each managed device. It

can be conﬁgured to make a number of checks, either ac!vely at the Nagios server’s request,

10 sequen!al checks, batched upload

100 sequen!al checks, batched upload

NRPE tests

1 check

10 simultaneous checks

max simultaneous checks before "meouts

1-port and 2-port

8-port

16-port and 48-port

1.5 sec

7.0 sec

no encryp"on

0.1 sec

1.0 sec

no encryp"on

2.0 sec

11.0 sec

3DES

0.3 sec

3.0 sec

3DES

1.0 sec

6.0 sec

tunneled over SSH

0.1 sec

1.3 sec

SSH tunnel

Opengear User Manual. Page 241.

or passively at preset intervals, and submit the results to the Nagios server in a batch.

The console server may be augmented at the local oﬃce site by one or more Intelligent Power

Distribu!on Units (IPDUs) to remotely control the power supply to the managed devices.

Remote site

In this scenario the console server NRPE server or NSCA client can be conﬁgured to make

ac!ve checks of conﬁgured services and upload to the Nagios server wai!ng passively. It can

also be conﬁgured to service NRPE commands to perform checks on demand.

In this situa!on, the console server will perform checks based on both serial and network

access.

Remote site with restric"ve ﬁrewall

In this scenario the role of the console server will vary. One aspect may be to upload check

results through NSCA.

Opengear User Manual. Page 242.

Another may be to provide an SSH tunnel to allow the Nagios server to run NRPE commands.

Remote site with no network access

In this scenario the console server allows dial-in access for the Nagios server.

Periodically, the Nagios server will establish a connec!on to the console server and execute

any NRPE commands, before dropping the connec!on.

Opengear User Manual. Page 243.

10. System management

This chapter documents how the Administrator can perform a range of general console server

system administra!on and conﬁgura!on tasks such as:

• applying So& and Hard Resets to the gateway.

• re-ﬂashing the Firmware.

• conﬁguring the Date, Time and NTP.

• se$ng up Backup of the conﬁgura!on ﬁles.

• delayed conﬁgura!on commits.

• conﬁguring the console server in FIPS mode.

System administra!on and conﬁgura!on tasks that are covered elsewhere include

•chapter 2.2 rese$ng the system.

•chapter 2.3 se$ng the console server’s System IP Address.

•chapter 2.4 Se$ng the Services permi%ed to access the console server.

•chapter 4 Se$ng up OOB Dial-in.

•chapter 11 Conﬁguring the Dashboard.

Opengear User Manual. Page 244.

10.1. System administra"on & reset

The Administrator can reboot or reset the gateway to default se$ngs.

To aﬀect a so& reset:

• navigate to System > Administra"on

• Select Reboot.

• click Apply.

The console server reboots with all se$ngs (for example, the assigned network IP address)

preserved. However this so& reset disconnects all users and ends any SSH sessions that had

been established.

A so& reset will also be aﬀected when you switch OFF power from the console server, and

then switch the power back ON.

Note: if you cycle the power and the unit is wri#ng to ﬂash you could corrupt or lose data. The

so(ware reboot is the safer op#on.

To aﬀect a hard reset or hard erase:

• Push the Erase bu%on on the rear panel gently twice within a few seconds period while the

unit is powered on..

A ball point pen or bent paper clip is a suitable tool for performing this procedure. Do not

use a graphite pencil.

This will reset the console server back to its factory default se$ngs and clear the console

server’s stored conﬁgura!on informa!on (for example, the unit’s IP address will be reset to

192.168.0.1).

You will be prompted to log in and must enter the default administra!on username and

password:

Username: root

Password: default

10.2. Firmware upgrades

Before upgrading you should ascertain if you are already running the most current ﬁrmware in

your Opengear device. Your Opengear device will not allow you to upgrade to the same or an

earlier version.

• The Firmware version is displayed in the header of each page.

• Alternately selec!ng Status > Support Report reports the Firmware Version.

Opengear User Manual. Page 245.

• To upgrade, download the latest ﬁrmware image from &p://&p.opengear.com/ or h%p://

opengear.com/ﬁrmware/.

For ACM5000 family download acm500x.flash.

For ACM5500 family download acm500x.flash.

For ACM7000 family download acm700x.flash.

For CM7116/7132/7148-2 download cm71xx.flash.

For IM4216-34 and IM4208/16/32/48-2 download im42xx.flash.

For IM7208/16/32/48-2 download im72xx.flash.

• Save the ﬁrmware image ﬁle on to a system on the same subnet as the Opengear device.

• Also download and read the Release Notes ﬁle for the latest informa!on.

• Select System > Firmware on the system to be upgraded.

• Specify the address and name of the downloaded ﬁrmware upgrade ﬁle, or browse the

local subnet and locate the downloaded ﬁle.

• Click Apply.

The Opengear device will undertake a so& reboot and commence upgrading the ﬁrmware.

This process will take several minutes.

• A&er the ﬁrmware upgrade has completed, click here to return to the Management

Console. Your Opengear device will have retained all its pre-upgrade conﬁgura!on

informa!on.

10.3. Date & "me conﬁgura"on

It is important to set the local Date and Time in your Opengear appliance as soon as it is

conﬁgured. Features such as Syslog and NFS logging use the system !me for !me-stamping

log entries, while cer!ﬁcate genera!on depends on a correct Timestamp to check the validity

period of the cer!ﬁcate.

Your Opengear appliance can synchronize its system !me with a remote Network Time

Protocol (NTP) server. NTP uses Coordinated Universal Time (UCT) for all !me

synchroniza!ons so it is not aﬀected by diﬀerent !me zones. However you do need to specify

your local !me zone so the system clock shows correct local !me.

• Select System > Date & Time.

Opengear User Manual. Page 246.

• Set your appropriate region in the Time Zone selec!on box and click Set Time.

Note: With Version 3.2.0 ﬁrmware the Time Zone can also be set to UTC, which replaced

Greenwich Mean Time as the World standard for #me in 1986.

Conﬁguring NTP ensures the Opengear appliance clock is kept extremely accurate once an

Internet connec!on has been established.

• Select the Enable NTP checkbox in the Network Time Protocol sec!on of the System >

Date & Time page.

• Enter the IP address of the remote NTP Server.

• If your external NTP server requires authen!ca!on, specify the NTP Authen"ca"on Key and

the Key Index to use when authen!ca!ng with the NTP server

• Click Apply NTP Se!ngs.

If remote NTP is not used, the !me can be set manually:

• Enter the Year, Month, Day, Hour and Minute using the Date and Time selec!on boxes

• Check Set Time.

Opengear appliances have an internal, ba%ery-backed hardware clock. Whether set manually,

or set by an NTP server, the hardware clock is automa!cally updated. The clock’s ba%ery

maintains the !me and date across reboots and when the appliance is powered down.

With the NTP peering model, the Opengear appliance can share its !me informa!on with

other devices connected to it, so all devices can be !me synchronized. To do this, !ck Enable

NTP on the Time and Date page, and ensure that the appropriate networks are selected on

the Service Access page.

Opengear User Manual. Page 247.

10.4. Backup conﬁgura"on

It is recommended you back up the console server conﬁgura!on whenever you make

signiﬁcant changes (such as adding new Users or Managed Devices) or before performing a

ﬁrmware upgrade.

• Select System > Conﬁgura"on Backup or click the Backup icon.

Note: conﬁgura#on ﬁles can also be backed up from the command line (see chapter 13).

With all console servers you can save the backup ﬁle remotely on your PC and you can restore

conﬁgura!ons from remote loca!ons:

• Navigate to System > Conﬁgura"on Backup.

• Click the Remote Backup tab.

• Click Save Backup in the Remote Backup sec!on.

The conﬁg backup ﬁle — system-name_date_config.opg — will be downloaded to

your PC and saved in the loca!on you nominate.

To restore a remote backup:

• Navigate to System > Conﬁgura"on Backup.

• Click the Remote Backup tab.

• Click Browse in the Remote Backup sec!on.

• Select the backup ﬁle you wish to restore.

• Click Restore

• Click OK.

Note: this will overwrite all the current conﬁgura#on se&ngs in your console server.

With some console servers you can save the backup ﬁle locally onto the USB storage. To do

this your console server must support USB and you must have an internal or external USB

ﬂash drive installed.

Opengear User Manual. Page 248.

To backup and restore using USB:

• Ensure the USB ﬂash drive is the only USB device a%ached to the console server.

• Navigate to System > Conﬁgura"on Backup.

• Select the Local Backup tab.

• click click here to proceed.

This will set a Volume Label on the USB storage device.

This prepara!on step is only necessary the ﬁrst !me, and will not aﬀect any other

informa!on you have saved onto the USB storage device. However it is recommended that

you back up any cri!cal data from the USB storage device before using it with your console

server. If there are mul!ple USB devices installed you will be warned to remove them.

• To back up to the USB enter a brief Descrip"on of the backup in the Local Backup menu

and select Save Backup.

• The Local Backup menu will display all the conﬁgura!on backup ﬁles you have stored onto

the USB ﬂash drive.

• To restore a backup from the drive, select Restore on the par!cular backup you wish to

restore and click Apply.

A&er saving a local conﬁgura!on backup, you may choose to use it as the alternate default

conﬁgura!on. When the console server is reset to factory defaults, it will then load your

alternate default conﬁgura!on instead of its factory se$ngs.

To set an alternate default conﬁgura!on:

• check Load On Erase

• click Apply.

Note: Before selec#ng Load On Erase ensure you have tested your alternate default conﬁgura#on

by clicking Restore.

If your alternate default conﬁgura!on causes the console server to become unbootable,

recover your unit to factory se$ngs.

If the conﬁgura!on is stored on an external USB storage device, unplug the storage device

and reset to factory defaults as per chapter 10.1.

If the conﬁgura!on is stored on an internal USB storage device, reset to factory defaults using

a specially-prepared USB storage device.

Opengear User Manual. Page 249.

This specially-prepared USB storage device:

• must be forma%ed with a Windows FAT32/VFAT ﬁle system on the ﬁrst par!!on or the

en!re disk.

Most USB thumb drives are sold already forma%ed this way.

• The ﬁle system must have the volume label OPG_DEFAULT.

• Insert this USB storage device into an external USB port on the console server and reset to

factory defaults as per chapter 10.1.

• A&er recovering your console server, ensure the problema!c conﬁgura!on is no longer

selected for Load On Erase.

10.5. Delayed conﬁgura"on commit

This mode allows the grouping or queuing of conﬁgura!on changes and the simultaneous

applica!on of these changes to a speciﬁc device. For example, changes to authen!ca!on

methods or user accounts may be grouped and run once to minimize system down!me. To

enable:

• Navigate to System > Administra"on.

• Check the Delayed Conﬁg Commits checkbox.

• Click Apply.

The Commit Conﬁg icon will present in top right-hand corner of the screen between the

Backup and Log Out icons.

To queue, then run, conﬁgura!on changes:

Opengear User Manual. Page 250.

•Apply all the required changes to the conﬁgura!on.

For example, modify user accounts, amend authen!ca!on method, enable OpenVPN

tunnel or modify system !me.

• Click the Commit Conﬁg bu%on.

This will generate the System > Commit Conﬁgura"on screen displaying all the

conﬁgurators to be run.

•Click Apply.

All the conﬁgurators in the queue will run.

•Alterna!vely, click Cancel.

All the queued conﬁgura!on changes will be lost.

To disable the Delayed Conﬁgura!on Commits mode:

•uncheck the Delayed Conﬁg Commits checkbox under System > Administra"on.

• click Apply.

• click the Commit Conﬁg bu%on in top right-hand corner of the screen

the System > Commit Conﬁgura"on screen displays.

• Click Apply.

The systemse#ngs conﬁgurator runs.

The Commit Conﬁg bu%on will no longer be displayed in the top right-hand corner of the

screen and conﬁgura!ons will no longer be queued.

10.6. FIPS mode

Opengear User Manual. Page 251.

The ACM7000, ACM5500, ACM5000, CM7100, IM7200 and IM4200 family of advanced

console servers all use a FIPS 140-2 validated embedded cryptographic module.

Note: The US Na#onal Ins#tute of Standards and Technology (NIST) publishes the FIPS (Federal

Informa#on Processing Standard) standards. FIPS 140-1 and FIPS 140-2 are both technical

standards and worldwide de-facto standards for cryptographic module implementa#on.

They are issued by NIST for use government-wide. NIST develops FIPS when there are

government requirements, such as for security and interoperability, and no acceptable

industry op#ons. Opengear advanced console servers use an embedded OpenSSL crypto-

graphic module validated to FIPS 140-2 standards and in receipt of Cer#ﬁcate #1051.

When conﬁgured in FIPs mode, all SSH, HTTPS and SDT Connector access to all services on

the console server use the embedded FIPS-compliant module. To connect your browser or

client must also be using FIPs-approved cryptographic algorithms or the connec!on will fail.

• Select System > Administra"on.

• Check FIPS Mode

This will enable FIPS mode a&er a safe reboot

• Check Reboot to safely reboot the console server.

• Click Apply.

The console server reboots. It will take several minutes to reconnect as secure browser

communica!ons are validated.

When reconnected it will display FIPs mode: Enabled in the Management Console banner.

To enable FIPS mode from the command line, login and run these commands:

config -s config.system.fips=on

touch /etc/config/FIPS

chmod 444 /etc/config/FIPS

flatfsd -b

The ﬁnal command saves to ﬂash and reboots the unit. The unit will take a few minutes to

boot into FIPS mode.

To disable FIPS mode from the shell, run these commands:

config -d config.system.fips

rm /etc/config/FIPS

flatfsd –b

Opengear User Manual. Page 252.

11. Status reports

This chapter documents the Dashboard feature and the status reports that are available:

• Port Access and Ac!ve Users

• Sta!s!cs.

• Support Reports.

• Syslog.

• Dashboard.

Other status reports that are covered elsewhere include:

•chapter 7.1 RPC Status.

•chapter 7.2 UPS Status.

•chapter 7.3 Environmental Status.

11.1. Port access & ac"ve users

The Administrator can see which Users have access privileges with which serial ports:

• Select Status > Port Access.

The Administrator can also see the current status of Users who have ac!ve sessions on those

ports:

Opengear User Manual. Page 253.

• Select Status > Ac"ve Users.

With Firmware V3.11 and later the Status > Ac"ve Users menu has been extended to enable

Administrators to selec!vely terminate serial sessions. Connec!on types telnet, SSH, raw TCP

and unauthen"cated telnet can be disconnected. However you cannot disconnect an RFC2217

session

The root user, or any user in the admin group, can access the Ac"ve Users page, which shows

a snapshot of the connected sessions, at the !me indicated by the !mestamp displayed at the

top of the page. Note that this page only shows the local console ports, and does not include

any cascaded ports.

There are Disconnect Sessions bu%ons along the right hand side of the table lis!ng ac!ve

users. These bu%ons disconnect all sessions from the Port they correspond to. If the port is

not set up in Console Server mode, the user will see a pop up error informing them that they

need to conﬁgure the port as Console Server mode before they can connect and disconnect.

A&er the bu%ons have been pressed, the selected sessions will be disconnected, and the

number of disconnect sessions will be displayed to the user.

To allow more detailed control of who to disconnect, there is a table at the bo%om of the

page with drop down lists for all connected users and all connected ports that allow the user

to choose who do disconnect.So if you wish to disconnect the user tester from all ports,

choose tester in the Users box, and All ports in the Ports box then click Disconnect Sessions.

Note: you can also disconnect serial sessions from the command line using the --disconnect

op#on with the pmusers command.

11.2. Sta"s"cs

The Sta!s!cs report provides a snapshot of the status, current traﬃc and other ac!vi!es and

opera!ons of your console server.

• Select Status > Sta"s"cs.

Detailed sta!s!cs reports can be found by selec!ng the various tabs.

Opengear User Manual. Page 254.

For example if you have an ACM5504-5-G-W-I conﬁgured with a wireless LAN connec!on

the Wireless screen will display all the locally accessible wireless LANs.

You can see the SSID and Encryp!on/Authen!ca!on se$ngs for the desired access point.

Also when you have successfully connected the SSID of this access point will then be shown

in the Wireless ESSID ﬁled of ra0 (shows above as “” which is not connected).

11.3. Support reports

The Support Report provides status informa!on that assists the Opengear technical support

team to solve any problems you may experience with your console server. With email support

requests, generate a Support Report when the issue is occurring, and a%ach it as text.

• Select Status > Support Report.

A status snapshot presents.

• Save the ﬁle as a text ﬁle and a%ach it to your support email.

Note: For console servers running ﬁrmware v3.11 and above, for devices where the serial number

can be retrieved, there is now a Feature Set sec#on displaying the serial number. ACM5000,

ACM5500, ACM7000, CM7100 and IM7200 can display their serial number. For devices

not suppor#ng this feature there is no change to the support report.

Opengear User Manual. Page 255.

Note: There is also a new cli command on all devices called showserial which does nothing

more than return the serial number if it is available or 'No serial number informa#on

available'. The command exists on all devices so Lighthouse bulk commands can be run on

many console servers and obtain as many serial numbers as possible in one opera#on.

11.4. Syslog

The console server’s Linux system logger maintains a record of all system messages and errors:

• Select Status > Syslog.

The syslog record can be redirected to a remote Syslog Server:

• Enter the remote Syslog Server Address and Syslog Server Port details.

• click Apply.

The console also maintains a local Syslog. To view this local Syslog ﬁle:

• Select Status > Syslog.

To ﬁnd speciﬁc informa!on in the local Syslog ﬁle, a pa%ern matching ﬁlter tool is provided.

• Specify the Match Pa%ern that is to be searched for

• Click Apply.

The Syslog will present with only those entries that include the speciﬁed pa%ern.

11.5. Dashboard

The Dashboard provides the administrator with a summary of the status of the console server

Opengear User Manual. Page 256.

and its Managed Devices.

Custom dashboards can be conﬁgured for each user group.

11.5.1. Conﬁguring the Dashboard

Only the root user and users who are members of the admin group can conﬁgure and access

the dashboard. To conﬁgure a custom dashboard:

• Select System > Conﬁgure Dashboard.

• Select the user (or group) you are conﬁguring this custom dashboard layout for.

You can conﬁgure a custom dashboard for any admin user or for the admin group or you can

reconﬁgure the default dashboard.

The Status > Dashboard screen is the ﬁrst screen displayed when admin users (other than

root) log into the console manager.

If you log in as john, and john is member of the admin group and there is a dashboard layout

conﬁgured for john, then you will see the dashboard for john on log-in and each !me you click

on the Status > Dashboard menu item.

If there is no dashboard layout conﬁgured for john but there is an admin group dashboard

conﬁgured then you will see the admin group dashboard instead. If there is no user-speciﬁc

dashboard or admin group dashboard conﬁgured, the default dashboard is displayed.

Note: The root user does not have its own dashboard.

The Dashboard displays a conﬁgurable number of widgets. These widgets include status for

major subsystems such as conma, Auto-Response, Managed Devices and cellular.

The admin user can conﬁgure which of these widgets is to be displayed where:

• Go to the Dashboard layout panel and select which widget is to be displayed in each of the

Widget Slots.

• Click Apply.

Opengear User Manual. Page 257.

Note: Dashboard conﬁgura#on is stored in /etc/config/config.xml. Each conﬁgured

dashboard will increase the size of this ﬁle. If this ﬁle gets too big, you can run out of memory

space on the console server.

11.5.2. Crea"ng custom widgets for the Dashboard

To run a custom script in a dashboard widget create a ﬁle called widget-<name>.sh in the

folder /etc/config/scripts/. You can have as many custom dashboard ﬁles as you want.

Put any code inside this ﬁle. When conﬁguring the dashboard, choose widget-<name>.sh

from the dropdown list. The dashboard runs and displays the script’s output inside the widget.

The best way to format the output is to send HTML back to the browser using echo:

echo '<table>'

You can run any command and its output will be displayed in the widget window directly.

Below is an example script. It writes the current date to a ﬁle, and then echo's HTML code

back to the browser. The HTML code gets an image from a URL and displays it in the widget.

#!/bin/sh

date >> /tmp/test

echo '<table>'

echo '<tr><td> This is my custom script running </td></tr>'

echo '<tr><td>'

echo '<img src="http://vinras.com/images/linux-online-inc.jpg">'

echo '</td></tr>'

echo '</table>'

exit 0

Opengear User Manual. Page 258.

12. Management

The console server has a small number of Manage reports and tools that are available to both

Administrators and Users:

• Access and control authorized devices.

• View serial port logs and host logs for those devices.

• Use SSH or the Web Terminal to access serially a%ached consoles.

• Control of power devices (where authorized).

All other Management Console menu items are available to Administrators only.

12.1. Device management

Note: The Manage Devices UI has been signiﬁcantly updated as of ﬁrmware version 3.12.

To display Managed Devices and their grouped serial, network and power connec!ons:

• select Manage > Devices or click the Manage Devices icon in the top right of the UI.

•admin-group users are presented with a list of all conﬁgured Managed Devices and their

cons!tuent connec!ons. user-group users only see the Managed Devices where, for each

Related Connec!on, they have been explicitly permi%ed access.

The Status column displays the current most salient status for each Related Connec!on (for

example, Ac!ve Users for serial connec!ons, and power status for RPC outlet connec!ons)

with links to detailed status.

Opengear User Manual. Page 259.

• The links in the Ac"ons column are used to control the Managed Device (for example, to

connect to a console session or power cycle. Power ac!ons are not performed un!l the

ac!on has been conﬁrmed via pop-up message.)

• alterna!vely, select the Serial tab for an ungrouped view of permi%ed serial port

connec!ons for the current user.

• An addi!onal Signals column displays the current state of the serial pins.

Note: To use the Connect > via SSH links, your computer’s opera#ng system must recognize the

ssh:// URI scheme and have a protocol handler conﬁgured (for example, an SSH client like

SecureCRT).

12.2. Port & host logs

Administrators and Users can view and download logs of data transferred to and from

connected devices.

• Select Manage > Port Logs.

• Select the serial Port # to be displayed.

To display Host logs:

• select Manage > Host Logs.

• Select the Host to be displayed.

Opengear User Manual. Page 260.

12.3. Terminal connec"on

There are two methods for accessing the console server command line and devices a%ached to

the console server serial ports from a web browser.

The Web Terminal service uses AJAX to enable the browser to connect to the console server

using HTTP or HTTPS, as a terminal without addi!onal client installa!on on the user’s PC.

Browser access is available to users who are a member of the admin or users groups.

The SDT Connector service launches a pre-installed SDT Connector client on the user’s PC to

establish SSH access, then uses pre-installed client so&ware on the client PC to connect to

the console server.

12.3.1. Web terminal

The AJAX based Web Terminal service may be used to access the console server command

line or a%ached serial devices.

Note: Any communica#on using the Web Terminal service using HTTP is unencrypted and not

secure. The Web Terminal connects to the command line or serial device using the same

protocol that is being used to browse to the Opengear Management Console. If you browse

using an https:// URL (this is the default), the Web Terminal connects using HTTPS.

To enable the Web Terminal service for the console server:

• Select System > Firewall.

• Check Enable Web Terminal.

• Click Apply.

Administrators can now communicate with the console server shell from their browser.

•Select Manage > Terminal to display the Web Terminal from which you can log in to the

console server command line.

Opengear User Manual. Page 261.

To enable the Web Terminal service for each serial port you want to access:

•Select Serial & Network > Serial Port.

• click Edit.

• Ensure the serial port is in Console Server Mode.

• Check Web Terminal.

• Click Apply.

Administrator and Users can communicate directly with serial port a%ached devices from their

browser:

•Select Manage > Devices.

• Select the Serial tab.

• Under the Ac"on column, click the Web Terminal icon to display the Web Terminal,

connected directly to the a%ached serial device.

Note: The Web Terminal feature was introduced in ﬁrmware v3.3. Earlier releases had an open

source jcterm java terminal applet which could be downloaded into your browser to

connect to the console server and a"ached serial port devices. However jcterm had some

JRE compa#bility issues and is no longer supported.

12.3.2. SDT connector access

Opengear User Manual. Page 262.

Administrators and Users can communicate directly with the console server command line and

with devices a%ached to the console server serial ports using SDT Connector and their local

telnet client.

• Select Manage > Terminal.

• Click Connect to SDT Connector.

This ac!vates the SDT Connector client on the computer you are browsing and loads your

local telnet client to connect to the command line or serial port using SSH.

Note: SDT Connector must be installed on the computer you are browsing from and the console

server must be added as a gateway, as detailed in chapter 5.

12.4. Power management

Administrators and Users can access and manage the connected power devices.

• Select Manage > Power.

This enables the user to Turn On, Turn Oﬀ, or Cycle the power on any power outlet on any

PDU the user has been given access privileges to.

See chapter 7 for details.

Opengear User Manual. Page 263.

13. Conﬁgura!on from the command line

For those who prefer to conﬁgure their console server at the Linux command line level, rather

than use a browser and the Management Console, this chapter describes using command line

access and the conﬁg tool to manage the console server, conﬁgure the ports and so on.

This chapter walks thru command line conﬁgura!on to deliver the func!ons provided

otherwise using the Management Console GUI.

For advanced and custom conﬁgura!ons and for details using other tools and commands see

chapter 14.

When displaying a command, the conven!on used in the rest of this chapter is to use single

quotes ('') for user-deﬁned values (for example, descrip!ons and names). Element values

without single quotes should be typed exactly as shown.

A&er the ini!al sec!on on accessing the conﬁg command the menu items in this document

follow the same structure as the menu items in the web GUI.

13.1. Accessing conﬁg from the command line

The console server runs a standard Linux kernel and embeds a suite of open source

applica!ons. So if you do not want to use a browser and the Management Console tools, you

are free to conﬁgure the console server and to manage connected devices from the command

line using standard Linux and Busybox commands and applica!ons such as ifconfig,

gettyd, stty, powerman, nut etc. However without care these conﬁgura!ons may not

withstand a power-cycle-reset or reconﬁgure.

So Opengear provides a number of custom command line u!li!es and scripts to make it

Opengear User Manual. Page 264.

simple to conﬁgure the console server and ensure the changes are stored in the console

server's ﬂash memory etc.

In par!cular the config u!lity allows manipula!on of the system conﬁgura!on from the

command line. With config a new conﬁgura!on can be ac!vated by running the relevant

conﬁgurator, which performs the ac!on necessary to make the conﬁgura!on changes live.

To access config from the command line:

• Power up the console server and connect the “terminal” device.

If you are connec!ng using the serial line, plug a serial cable between the console server

local DB-9 console port and terminal device. Conﬁgure the serial connec!on of the

terminal device you are using to 115200bps, 8 data bits, no parity and one stop bit.

If you are connec!ng over the LAN, interconnect the Ethernet ports and direct your

terminal emulator program to the IP address of the console server (192.168.0.1 by default).

• Log on to the console server by pressing Return a few !mes.

The console server will request a username and password.

• Enter the username root and the password default.

The command line prompt appears:

Note: This chapter is not intended to teach you Linux. We assume you already have a certain level

of understanding before you execute kernel-level Linux commands.

The conﬁg tool

config [-ahv] [-d id] [-g id] [-p path] [-r configurator] [-s

id=value] [-P id]

The config tool is designed to perform mul!ple ac!ons from one command if need be, so if

necessary op!ons can be chained together.

The config tool allows manipula!on and querying of the system conﬁgura!on from the

command line. Using config the new conﬁgura!on can be ac!vated by running the relevant

conﬁgurator which performs the ac!on necessary to make the conﬁgura!on changes live.

The custom user conﬁgura!on is saved in the /etc/config/config.xml ﬁle. This ﬁle is

transparently accessed and edited when conﬁguring the device using the Management

Console browser GUI. Only the root user can conﬁgure from the shell.

By default, the config elements are separated by a . character (a full-stop or period). The

root of the config tree is called <config>. To address a speciﬁc element place a . between

each node or branch. For example, to access and display the descrip!on of user1 type:

# config -g config.users.user1.description

The root node of the conﬁg tree is <config>. To display the en!re config tree, type:

# config -g config

To display the help text for the config command, type:

Opengear User Manual. Page 265.

# config -h

The config applica!on resides in the /bin directory. The environmental variable called

PATH contains a route to the /bin directory. This allows a user to simply type config at the

command prompt instead of the full /bin/config path.

The registered conﬁgurators are:

alerts ipconﬁg

auth nagios

cascade power

console serialconﬁg

dhcp services

dialin slave

eventlog systemse$ngs

hosts !me

ipaccess ups

users

There are three ways to delete a config element value. The simplest way is use the

delete-node script detailed later in chapter 14. You can also assign the conﬁg element to

"" (null), or delete the en!re config node using -d:

# /bin/config -d 'element name'

All passwords are saved in plaintext except the user passwords and the system passwords,

which are encrypted.

The conﬁg command does not verify whether the nodes edited/added by the user are valid.

This means that any node may be added to the tree. If a user were to run the following

command:

op"ons

-a --run-all

-h --help

-v --verbose

-d --del=id

-g --get=id

-p --path=ﬁle

-r --run=conﬁgurator

-s --set=id=value

-e --export=ﬁle

-i --import=ﬁle

-t --test-import=ﬁle

-S --separator=char

-P --password=id

descrip"on

Run all registered conﬁgurators. This performs every conﬁgura!on

synchroniza!on ac!on pushing all changes to the live system

Display a brief usage message.

Log extra debug informa!on.

Remove the given conﬁgura!on element speciﬁed by a . separated

iden!ﬁer.

Display the value of a conﬁgura!on element

Specify an alternate conﬁgura!on ﬁle to use. The default ﬁle is

located at /etc/config/config.xml.

Run the speciﬁed registered conﬁgurator. Registered conﬁgurators

are listed below.

Change the value of conﬁgura!on element speciﬁed by a .

separated iden!ﬁer.

Save ac!ve conﬁgura!on to ﬁle.

Load conﬁgura!on from ﬁle.

Pretend to load conﬁgura!on from ﬁle.

The pa%ern to separate ﬁelds with. The default is .

Prompt user for a value. Hash the value, then save it in id.

Opengear User Manual. Page 266.

# /bin/config -s config.fruit.apple=sweet

the conﬁgurator will not complain, but this command is clearly useless. When the

conﬁgurators are run (to turn the config.xml ﬁle into live conﬁg) they will simply ignore this

<fruit> node. Administrators must make sure of the spelling when typing conﬁg commands.

Incorrect spelling for a node will not be ﬂagged.

Most conﬁgura!ons made to the XML ﬁle will be immediately ac!ve. To make sure that all

conﬁgura!on changes are ac!ve, especially when edi!ng user passwords, run all the

conﬁgurators:

# /bin/config -a

For informa!on on backing up and restoring the conﬁgura!on ﬁle see chapter 14.

13.1.1. Serial port conﬁgura"on

The ﬁrst set of conﬁgura!ons that needs to be made to any serial port are the RS232

common se$ngs. For example to setup serial port 5 to use the following proper!es:

Baud Rate 9600

Parity None

Data Bits 8

Stop Bits 1

Label Myport

Log level 0

Protocol RS232

Flow control None

To do this use the following commands:

# config -s config.ports.port5.speed=9600

# config -s config.ports.port5.parity=None

# config -s config.ports.port5.charsize=8

# config -s config.ports.port5.stop=1

# config -s config.ports.port5.label=myport

# config -s config.ports.port5.loglevel=0

# config -s config.ports.port5.protocol=RS232

# config -s config.ports.port5.flowcontrol=None

The following command will synchronise the live system with the new conﬁgura!on:

# config -r serialconfig

Opengear User Manual. Page 267.

Addi!onally, before any port can func!on properly, the mode of the port needs to be set. Any

port can be set to run in one of the ﬁve possible modes (see chapter 3 for details):

Console Server mode

Device mode

SDT mode

Terminal server mode

Serial bridge mode

All these modes are mutually exclusive.

Console Server mode

The command to set the port in portmanager mode:

# config -s config.ports.port5.mode=portmanager

property

baud rates

parity values

data-bits

stop-bits

ﬂow-control

supported values

110

134

150

200

300

600

1200

1800

2400

4800

9600

19200

38400

57600

115200

230400

None

Odd

Even

Mark

Space

1.5

Hardware

So&ware

None

Opengear User Manual. Page 268.

To set the following op!onal conﬁg elements for this mode:

Data accumula!on period 100 ms

Escape character % (default is ~)

log level 2 (default is 0)

Shell power command menu Enabled

RFC2217 access Enabled

Limit port to 1 connec!on Enabled

SSH access Enabled

TCP access Enabled

telnet access Disabled

Unauthorized telnet access Disabled

Run the following commands.

# config -s config.ports.port5.delay=100

# config -s config.ports.port5.escapechar=%

# config -s config.ports.port5.loglevel=2

# config -s config.ports.port5.powermenu=on

# config -s config.ports.port5.rfc2217=on

# config -s config.ports.port5.singleconn=on

# config -s config.ports.port5.ssh=on

# config -s config.ports.port5.tcp=on

# config -d config.ports.port5.telnet

# config -d config.ports.port5.unauthtel

Device mode

For a device mode port, set the port type to either ups, rpc, or enviro:

# config -s config.ports.port5.device.type=[ups | rpc | enviro]

For port 5 as a UPS port:

# config -s config.ports.port5.mode=reserved

For port 5 as an RPC port:

# config -s config.ports.port5.mode=powerman

For port 5 as an Environmental port:

# config -s config.ports.port5.mode=reserved

SDT mode

To enable access over SSH to a host connected to serial port 5:

# config -s config.ports.port5.mode=sdt

# config -s config.ports.port5.sdt.ssh=on

To conﬁgure a username and password when accessing this port with Username = user1 and

Password = secret:

# config -s config.ports.port#.sdt.username=user1

# config -s config.ports.port#.sdt.password=secret

Opengear User Manual. Page 269.

Terminal server mode

Enable a TTY login for a local terminal a%ached to serial port 5:

# config -s config.ports.port5.mode=terminal

# config -s config.ports.port5.terminal=\

[vt220 | vt102 | vt100 | linux | ansi]

The default terminal is vt220.

Serial bridge mode

Create a network connec!on to a remote serial port via RFC-2217 on port 5:

# config -s config.ports.port5.mode=bridge

Op!onal conﬁgura!ons for the network address of RFC-2217 server of 192.168.3.3 and TCP

port used by the RFC-2217 service = 2500:

# config -s config.ports.port5.bridge.address=192.168.3.3

# config -s config.ports.port5.bridge.port=2500

To enable RFC-2217 access:

# config -s config.ports.port5.bridge.rfc2217=on

To redirect the serial bridge over an SSH tunnel to the server: #

config -s config.ports.port5.bridge.ssh.enabled=on

Syslog se!ngs

Addi!onally, the global system log se$ngs can be set for any speciﬁc port, in any mode:

# config -s config.ports.port#.syslog.facility='facility'

# config -s config.ports.port#.syslog.priority='priority'

argument

facility

supported values

Default

local 0-7

auth

authpriv

cron

daemon

kern

lpr

mail

news

user

uucp

Opengear User Manual. Page 270.

13.1.2. Adding and removing users

First, determine the total number of exis!ng Users:

# config -g config.users.total

This command should display

config.users.total 1.

Note: if you see config.users.total this means you have 0 Users conﬁgured.

Your new User will be the exis!ng total plus 1. So if the previous command gave you 0 then

you start with user number 1, if you already have 1 user your new user will be number 2 etc.

Assuming the previous command did return config.users.total 1., to add a user with

Username=John, Password=secret and Descrip!on=mySecondUser issue the commands:

# config -s config.users.total=2

# config -s config.users.user2.username=John

# config -s config.users.user2.description=mySecondUser

# config -P config.users.user2.password

Note: the -P parameter will prompt the user for a password, and encrypt it. In fact, the value of any

conﬁg element can be encrypted using the -P parameter, but only encrypted user passwords

and system passwords are supported. If any other element value were to be encrypted, the

value will become inaccessible and will have to be re-set.

To add this user to speciﬁc groups (admin/users):

# config -s config.users.user2.groups.group1='groupname'

# config -s config.users.user2.groups.group2='groupname2'

# [etc...]

To give this user access to a speciﬁc port:

# config -s config.users.user2.port1=on

# config -s config.users.user2.port2=on

# config -s config.users.user2.port5=on

# [etc...]

To remove port access:

# config -s config.users.user2.port1=''

Note: the port1 value is le( blank.

priority Default

warning

no!ce

Info

error

emergency

debug

cri!cal

alert

Opengear User Manual. Page 271.

or simply:

# config -d config.users.user2.port1

The port number can be anything from 1 to 48, depending on the available ports on the

speciﬁc console server.

For example, assume we have an RPC device connected to port 1 on the console server and

the RPC is conﬁgured. To give this user access to RPC outlet number 3 on the RPC device, run

the 2 commands below:

# config -s config.ports.port1.power.outlet3.users.user2=John

# config -s config.ports.port1.power.outlet3.users.total=2

The last command sets the total number of users with access to this outlet. If more users are

given access, increment config.ports.port1.power.outlet3.users.total

accordingly.

To give this user access to network host 5 (assuming the host is conﬁgured):

# config -s config.sdt.hosts.host5.users.user1=John

# config -s config.sdt.hosts.host5.users.total=1

The last command sets the total number of users having access to host.

To give another user called Peter access to the same host:

# config -s config.sdt.hosts.host5.users.user2=Peter

# config -s config.sdt.hosts.host5.users.total=2

The last command sets the total number of users having access to host.

To edit any of the user element values, use the same approach as when adding user elements.

That is, use the -s parameter. If any of the conﬁg elements do not exist, they will

automa!cally be created.

To delete the user called John, use the delete-node script:

# ./delete-node config.users.user2

The following command will synchronize the live system with the new conﬁgura!on:

# config -r users

13.1.3. Adding and removing user groups

The console server is conﬁgured with a few default user groups (only two of these groups are

visible in the Management Console GUI). To ﬁnd out how many groups are already present:

# config -g config.groups.total

Assume this value is six. Make sure to number any new groups you create from seven

onwards.

To add a custom group to the conﬁgura!on with Group name=Group7, Group

descrip!on=MyGroup and Port access= 1,5 issue the commands:

# config -s config.groups.group7.name=Group7

Opengear User Manual. Page 272.

# config -s config.groups.group7.description=MyGroup

# config -s config.groups.total=7

# config -s config.groups.group7.port1=on

# config -s config.groups.group7.port5=on

Assume we have an RPC device connected to port 1 on the console server, and the RPC is

conﬁgured. To give this group access to RPC outlet number 3 on the RPC device, run the two

commands below:

# config -s config.ports.port1.power.outlet3.groups.group1=Group7

# config -s config.ports.port1.power.outlet3.groups.total=1

The second command sets the total number of groups that have access to this outlet. If more

groups are given access to this power outlet, then increment the

config.ports.port1.power.outlet3.groups.total element accordingly.

To give this group access to network host 5:

# config -s config.sdt.hosts.host5.groups.group1=Group7

# config -s config.sdt.hosts.host5.groups.total=1

The second command sets the total number of groups with access to host.

To give another group called Group8 access to the same host:

# config -s config.sdt.hosts.host5.groups.group2=Group8

# config -s config.sdt.hosts.host5.groups.total=2

The second command sets the total number of groups with access to host.

To delete the group called Group7, use the following command:

# rmuser Group7

Note: the rmuser script is a generic script to remove any conﬁg element from conﬁg.xml correctly.

However, any dependencies or references to this group will not be aﬀected. Only the group

details are deleted. The administrator is responsible for going through conﬁg.xml and

removing group dependencies and references manually, speciﬁcally if the group had access

to a host or RPC device.

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.4. Authen"ca"on

To change the type of authen!ca!on for the console server:

# config -s config.auth.type='authtype'

‘authtype’ can be:

Local

LocalTACACS

TACACS

TACACSLocal

TACACSDownLocal

Opengear User Manual. Page 273.

LocalRADIUS

RADIUS

RADIUSLocal

RADIUSDownLocal

LocalLDAP

LDAP

LDAPLocal

LDAPDownLocal

To conﬁgure TACACS authen!ca!on:

# config -s config.auth.tacacs.auth_server='comma-separated-list'

comma-separated-list is a list of remote authen!c!on and authoriza!on servers.

# config -s config.auth.tacacs.acct_server='comma-separated-list'

# config -s config.auth.tacacs.password='password'

comma-separated-list is a list of remote accoun!ng servers. If unset, the Authen!ca!on

and Authoriza!on Server Address will be used.

To conﬁgure RADIUS authen!ca!on:

# config -s config.auth.radius.auth_server='comma-separated-list'

# config -s config.auth.radius.acct_server='comma-separated-list'

# config -s config.auth.radius.password='password'

In the ﬁrst command, comma-separated-list is a list of remote authen!c!on and

authoriza!on servers.

In the second command, comma-separated-list is a list of remote accoun!ng servers. If

unset, Authen!ca!on and Authoriza!on Server Address will be used.

To conﬁgure LDAP authen!ca!on:

# config -s config.auth.ldap.server='comma separated list'

# config -s config.auth.ldap.basedn='name'

# config -s config.auth.ldap.binddn='name'

# config -s config.auth.radius.password='password'

In the ﬁrst command, comma-separated-list is a list of remote servers

In the second command name is the dis!nguished name of the search base. For example:

dc=my-company,dc=com.

In the third command name is the dis!nguished name to bind to the server with. The default

is to bind anonymously.

The following command will synchronize the live system with the new conﬁgura!on:

# config -r auth

13.1.5. Network hosts

To determine the total number of currently conﬁgured hosts:

# config -g config.sdt.hosts.total

Opengear User Manual. Page 274.

Assume the value returned is 3. If you add another host, increment the total number of hosts

from 3 to 4:

# config -s config.sdt.hosts.total=4

If the output is config.sdt.hosts.total, 0 hosts are conﬁgured.

Add power device host

To add a UPS/RPC network host with the following details:

Issue the following commands:

# config -s config.sdt.hosts.host4.address=192.168.2.5

# config -s config.sdt.hosts.host4.name=remoteUPS

# config -s config.sdt.hosts.host4.description=UPSroom3

# config -s config.sdt.hosts.host4.device.type=ups

# config -s config.sdt.hosts.host4.tcpports.tcpport1=22

# config -s config.sdt.hosts.host4.tcpports.tcpport1.loglevel=0

# config -s config.sdt.hosts.host4.udpports.udpport2=443

# config -s config.sdt.hosts.host4.udpports.udpport2.loglevel=0

loglevel can have a value of 0 or 1.

The default services that should be conﬁgured are: 22/tcp (ssh), 23/tcp (telnet), 80/tcp (h%p),

443/tcp (h%ps), 1494/tcp (ica), 3389/tcp (rdp), 5900/tcp (vnc).

Add other network host

To add any other type of network host with the following details:

Issue the commands below. If the Host is not a PDU or UPS power device or a server with

IPMI power control then leave the device type blank:

# config -s config.sdt.hosts.host4.address=192.168.3.10

# config -s config.sdt.hosts.host4.description=MyPC

# config -s config.sdt.hosts.host4.name=OfficePC

# config -s config.sdt.hosts.host4.device.type=''

# config -s config.sdt.hosts.host4.tcpports.tcpport1=22

se&ng

IP address or DNS name

Host name

Descrip!on

Type

Allowed services

Log level for services

value

192.168.2.5

remoteUPS

UPSroom3

UPS

ssh port 22 and h%ps port 443

se&ng

IP address or DNS name

Host name

Descrip!on

Allowed services

Log level for services

value

192.168.3.10

OﬃcePC

MyPC

ssh port 22 and h%ps port 443

Opengear User Manual. Page 275.

# config -s config.sdt.hosts.host4.tcpports.tcpport1.loglevel=1

# config -s config.sdt.hosts.host4.udpports.tcppport2=443

# config -s config.sdt.hosts.host4.udpports.tcpport2.loglevel=1

Note: type should be le( blank.

If you want to add the new host as a managed device, make sure to use the current total

number of managed devices + 1, for the new device number.

To get the current number of managed devices:

# config -g config.devices.total

Assuming we already have one managed device, our new device will be device 2. Issue the

following commands:

# config -s config.

devices.device2.connections.connection1.name=192.168.3.10

# config -s config.

devices.device2.connections.connection1.type=Host

# config -s config. devices.device2.name=OfficePC

# config -s config. devices.device2.description=MyPC

# config -s config.devices.total=2

The following command will synchronize the live system with the new conﬁgura!on:

# config -hosts

13.1.6. Trusted networks

You can further restrict remote access to serial ports based on the source IP address. To

conﬁgure this via the command line you need to do the following:

Determine the total number of exis!ng trusted network rules (if you have no exis!ng rules)

you can assume this is 0

# config -g config.portaccess.total

This command should display

config.portaccess.total 1

If you see config.portaccess.total you have 0 rules conﬁgured.

Your new rule will be the exis!ng total plus 1. If the previous command gave you 0 start with

rule number 1. If you already have 1 rule your new rule will be number 2. And so on.

Assuming you have a previous rule in place, if you want to restrict access to serial port 5 to

computers from a single class C network (for example, 192.168.5.0) issue the following

commands to add a trusted network:

# config -s config.portaccess.rule2.address=192.168.5.0

# config -s "config.portaccess.rule2.description=foo bar"

# config -s config.portaccess.rule2.netmask=255.255.255.0

# config -s config.portaccess.rule2.port5=on

# config -s config.portaccess.total=2

Opengear User Manual. Page 276.

The following command will synchronize the live system with the new conﬁgura!on:

# config -r serialconfig

13.1.7. Cascaded ports

To add a new slave device with the following se$ngs:

Issue the following commands:

# config -s config.cascade.slaves.slave1.address=192.168.0.153

# config -s "config.cascade.slaves.slave1.description=Office 42"

# config -s config.cascade.slaves.slave1.label=cm7116-5

# config -s config.cascade.slaves.slave1.ports=16

The total number of slaves must also be incremented. If this is the ﬁrst slave being added,

type:

# config -s config.cascade.slaves.total=1

Increment this value when adding more slaves.

Note: if a slave is added using the CLI, the master SSH public key will need to be manually copied

to every slave device before cascaded ports will work (see chapter 3).

The following command will synchronize the live system with the new conﬁgura!on:

# config -r cascade

13.1.8. UPS connec"ons

Managed UPSes

Before adding a managed UPS, make sure that at least 1 port has been conﬁgured to run in

'device mode', and that the device is set to 'ups'.

To add a managed UPS with the following values:

se&ng

IP address or DNS name

Descrip!on

Label

Number of ports

value

192.168.0.153

Oﬃce 42

cm7116-5

se&ng

Connected via

UPS name

Descrip!on

Username to connect to UPS

Password to connect to UPS

shutdown order

Driver

Driver op!on

value

Port 1

My UPS

Room 5 UPS

user2

A-secret-for-2.

2 (0 shuts down ﬁrst

genericups

op!on

Opengear User Manual. Page 277.

Run the following commands

# config -s config.ups.monitors.monitor1.port=/dev/port01

# config -s "config.ups.monitors.monitor1.name=My UPS"

# config -s "config.ups.monitors.monitor1.description=Room 5 UPS"

# config -s config.ups.monitors.monitor1.username=user2

# config -s config.ups.monitors.monitor1.password=A-secret-for-2.

# config -s config.ups.monitors.monitor1.sdorder=2

# config -s config.ups.monitors.monitor1.driver=genericups

# config -s

config.ups.monitors.monitor1.options.option1.opt=option

# config -s

config.ups.monitors.monitor1.options.option1.arg=argument

# config -s config.ups.monitors.monitor1.options.total=1

# config -s config.ups.monitors.monitor1.log.enabled=on

# config -s config.ups.monitors.monitor1.log.interval=2

# config -s config.ups.monitors.monitor1.script.enabled=on

With regards the ﬁrst command above, if the port number is higher than 9 (eg port 13) enter

the command as follows:

# config -s config.ups.monitors.monitor1.port=/dev/port13

Also, make sure to increment the total monitors:

# config -s config.ups.monitors.total=1

Assuming there are already 2 managed devices conﬁgured, the 5 commands below will add

the UPS to Managed Devices.

# config -s

"config.devices.device3.connections.connection1.name=My UPS"

# config -s

"config.devices.device3.connections.connection1.type=UPS Unit"

# config -s "config.devices.device3.name=My UPS"

# config -s "config.devices.device3.description=Room 5 UPS"

# config -s config.devices.total=3

To delete this managed UPS:

# config -d config.ups.monitors.monitor1

Note: decrement monitors.total when dele#ng a managed UPS.

Remote UPSes

To add a remote UPS with the following details (assuming this is our ﬁrst remote UPS):

Driver argument

Logging

Log interval

Run script when power is cri!cal

argument

Enabled

2 minutes

Enabled

se&ng

UPS name

value

oldUPS

Opengear User Manual. Page 278.

# config -s config.ups.remotes.remote1.name=oldUPS

# config -s "config.ups.remotes.remote1.description=Room 2 UPS"

# config -s config.ups.remotes.remote1.address=192.168.50.50

# config -d config.ups.remotes.remote1.log.enabled

# config -s config.ups.remotes.remote1.log.interval=240

# config -s config.ups.remotes.remote1.script.enabled=on

# config -s config.ups.remotes.total=1

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.9. RPC connec"ons

You can add an RPC connec!on from the command line but it is not recommended because

of dependency issues.

Before adding an RPC, the Management Console GUI code makes sure that at least 1 port has

been conﬁgured to run in device mode, and that the device is set to rpc. The CLI-based

approach does not do this.

To add an RPC with the following values:

Run the following commands:

# config -s config.ports.port2.power.type=APC 7900

# config -s config.ports.port2.power.name=MyRPC

# config -s "config.ports.port2.power.description=Room 5 RPC"

# config -s config.ports.port2.power.username=rpclogin

# config -s config.ports.port2.power.password=A-secret-for-2.

# config -s config.ports.port2.power.snmp.community=v1

# config -s config.ports.port2.power.log.enabled=on

# config -s config.ports.port2.power.log.interval=600

Descrip!on

Address

Log status

Log rate

Run shutdown script

Room 2 UPS

192.168.50.50

Disabled

240 seconds

Enabled

se&ng

RPC type

Connected via

UPS name

Descrip!on

SNMP community

Logging

Log interval

Number of power outlets

value

APC 7900

Port 2

MyRPC

Room 5 RPC

rpclogin

A-secret-for-2.

v1 or v2c

enabled

600 seconds

Opengear User Manual. Page 279.

# config -s config.ports.port2.power.outlets=4

The following ﬁve commands are used by the Management Console to add the RPC to

Managed Devices:

# config -s

config.devices.device3.connections.connection1.name=myRPC

# config -s

"config.devices.device3.connections.connection1.type=RPC Unit"

# config -s config.devices.device3.name=myRPC

# config -s "config.devices.device3.description=Room 5 RPC"

# config -s config.devices.total=3

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.10.Environmental

To conﬁgure an environmental monitor with the following details:

Run the following commands:

# config -s config.ports.port3.enviro.name=Envi4

# config -s "config.ports.port3.enviro.description=Room 5 monitor"

# config -s config.ports.port3.enviro.offsets.temp=2

# config -s config.ports.port3.enviro.offsets.humid=5

# config -s config.ports.port3.enviro.alarms.alarm1.alarmstate=on

# config -s config.ports.port3.enviro.alarms.alarm1.label=door

alarm

# config -s config.ports.port3.enviro.alarms.alarm2.alarmstate=on

# config -s config.ports.port3.enviro.alarms.alarm2.label=window

alarm

# config -s config.ports.port3.enviro.alarms.total=2

# config -s config.ports.port3.enviro.log.enabled=on

# config -s config.ports.port3.enviro.log.interval=120

It is important to assign alarms.total=2 even if they are oﬀ.

To get the total number of managed devices:

se&ng

Monitor name

Monitor descrip!on

Temperature oﬀset

Humidity oﬀset

Enable alarm 1?

Alarm 1 label

Enable alarm 2?

Alarm 2 label

value

Envi4

Room 5 monitor

yes

door alarm

yes

window alarm

Opengear User Manual. Page 280.

# config -g config.devices.total

Use the returned total +1 for the new device when adding this environmental monitor to

Managed devices as per the following:

# config -s config.

devices.device5.connections.connection1.name=Envi4

# config -s "config.

devices.device5.connections.connection1.type=EMD Unit"

# config -s config. devices.device5.name=Envi4

# config -s "config. devices.device5.description=Room 5 monitor"

# config -s config.devices.total=5

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.11.Managed devices

To add a managed device: (see chapter 7 for more):

# config -s "config.devices.device8.name=8"

# config -s "config.devices.device8.description=the-8th-device"

# config -s

"config.devices.device8.connections.connection1.name=8"

# config -s

config.devices.device8.connections.connection1.type=type

# config -s config.devices.total=8

type can be serial, Host, UPS, or RPC.

To delete the above managed device:

# config -d config.devices.device8

Note: the config.devices.total total must also be decremented when dele#ng a managed

device.

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.12.Port log

To conﬁgure serial/network port logging:

# config -s config.eventlog.server.address=remote-server-ip

# config -s config.eventlog.server.logfacility=facility

# config -s config.eventlog.server.logpriority=priority

facility and priority can take a speciﬁc range of values:

Opengear User Manual. Page 281.

Assume the remote log server needs a username name1 and password A-secret-for-2.

# config -s config.eventlog.server.username=name1

# config -s config.eventlog.server.password=A-secret-for-2.

To set the remote path as /opengear/logs to save logged data:

# config -s config.eventlog.server.path=/opengear/logs

# config -s config.eventlog.server.type=[none|syslog|nfs|cifs|usb]

If the server type is set to usb, none of the other values need to be set. The mount point for

storing on a remote USB device is /var/run/portmanager/logdir.

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.13.Alerts

You can add an email, SNMP or NAGIOS alert by following the steps below.

The general se!ng for all alerts

Assume this is our second alert, and we want to send email alerts to john@opengear.com and

sms alerts to peter@opengear.com:

# config -s config.alerts.alert2.description=MySecondAlert

# config -s config.alerts.alert2.email=john@opengear.com

# config -s config.alerts.alert2.email2=peter@opengear.com

To use NAGIOS to no!fy of this alert

# config -s config.alerts.alert2.nsca.enabled=on

To use SNMP to no!fy of this alert

variable

facility

priority

allowed values

Daemon

Local 0-7

Authen!ca!on

Kernel

User

Syslog

Mail

News

UUCP

Info

Alert

Cri!cal

Debug

Emergency

Error

No!ce

Warning

Opengear User Manual. Page 282.

# config -s config.alerts.alert2.snmp.enabled=on

To increment the total alerts:

# config -s config.alerts.total=2

Below are the speciﬁc se$ngs depending on the type of alert required.

Connec"on alert

To trigger an alert when a user connects to serial port 5 or network host 3:

# config -s config.alerts.alert2.host3=hostname

# config -s config.alerts.alert2.port5=on

# config -s config.alerts.alert2.sensor=temp

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=login

Signal alert

To trigger an alert when a signal changes state on port 1:

# config -s config.alerts.alert2.port1=on

# config -s config.alerts.alert2.sensor=temp

# config -s config.alerts.alert2.signal=[DSR | DCD | CTS]

# config -s config.alerts.alert2.type=signal

Pa%ern match alert

To trigger an alert if the regular expression .*0.0% id is found in serial port 10’s character

stream.

# config -s "config.alerts.alert2.pattern=.*0.0% id"

# config -s config.alerts.alert2.port10=on

# config -s config.alerts.alert2.sensor=temp

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=pattern

UPS power status alert

To trigger an alert when myUPS (on localhost) or thatUPS (on remote host 192.168.0.50)

power status changes between on line, on ba%ery and low ba%ery.

# config -s config.alerts.alert2.sensor=temp

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=ups

# config -s config.alerts.alert2.ups1=myUPS@localhost

# config -s config.alerts.alert2.ups2=thatUPS@192.168.0.50

Environmental and power sensor alert

# config -s config.alerts.alert2.enviro.high.critical=critical-

value

# config -s config.alerts.alert2.enviro.high.warning=warning-value

# config -s config.alerts.alert2.enviro.hysteresis=value

# config -s config.alerts.alert2.enviro.low.critical=critical-

value

Opengear User Manual. Page 283.

# config -s config.alerts.alert2.enviro.low.warning=warning-value

# config -s config.alerts.alert2.enviro1=Enviro-sensor-name

# config -s config.alerts.alert2.outlet#=RPCname.outlet#

# config -s config.alerts.alert2.rpc#=RPC-name

# config -s config.alerts.alert2.sensor=[temp|humid|load|charge]

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=enviro

# config -s config.alerts.alert2.ups1=UPSname@hostname

alert2.outlet# increments sequen!ally with each added outlet. The second outlet#

refers to the speciﬁc RPC power outlets.

Example 1: to conﬁgure a temperature sensor alert for a sensor called SensorInRoom42.

# config -s config.alerts.alert2.sensor=temp

# config -s config.alerts.alert2.enviro.high.critical=60

# config -s config.alerts.alert2.enviro.high.warning=50

# config -s config.alerts.alert2.enviro.hysteresis=2

# config -s config.alerts.alert2.enviro.low.critical=5

# config -s config.alerts.alert2.enviro.low.warning=10

# config -s config.alerts.alert2.enviro1=SensorInRoom42

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=enviro

Example2: to conﬁgure a load sensor alert for outlets 2 and 4 for an RPC called

RPCInRoom20:

# config -s config.alerts.alert2.outlet1=RPCInRoom20.outlet2

# config -s config.alerts.alert2.outlet2=RPCInRoom20.outlet4

# config -s config.alerts.alert2.enviro.high.critical=300

# config -s config.alerts.alert2.enviro.high.warning=280

# config -s config.alerts.alert2.enviro.hysteresis=20

# config -s config.alerts.alert2.enviro.low.critical=50

# config -s config.alerts.alert2.enviro.low.warning=70

# config -s config.alerts.alert2.rpc1=RPCInRoom20

# config -s config.alerts.alert2.sensor=load

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=enviro

Alarm sensor alert

The commands below set an alert for doorAlarm and windowAlarm, two alarms connected

to an environmental sensor called SensorInRoom3. Both alarms are disabled on Mondays

from 08:15 to 14:30.

# config -s config.alerts.alert2.alarm1=SensorInRoom3.alarm1

(doorAlarm)

# config -s config.alerts.alert2.alarm1=SensorInRoom3.alarm2

(windowAlarm)

# config -s config.alerts.alert2.alarmrange.mon.from.hour=8

# config -s config.alerts.alert2.alarmrange.mon.from.min=15

# config -s config.alerts.alert2.alarmrange.mon.until.hour=14

# config -s config.alerts.alert2.alarmrange.mon.until.min=30

# config -s config.alerts.alert2.description='description'

Opengear User Manual. Page 284.

# config -s config.alerts.alert2.sensor=temp

# config -s config.alerts.alert2.signal=DSR

# config -s config.alerts.alert2.type=alarm

To enable an alarm for the en!re day:

# config -s config.alerts.alert2.alarmrange.mon.from.hour=0

# config -s config.alerts.alert2.alarmrange.mon.from.min=0

# config -s config.alerts.alert2.alarmrange.mon.until.hour=0

# config -s config.alerts.alert2.alarmrange.mon.until.min=0

The following command will synchronize the live system with the new conﬁgura!on:

# config -r alerts

13.1.14.SMTP & SMS

To set-up an SMTP mail or SMS server with the following details:

Run the following commands:

# config -s config.system.smtp.server=mail.opengear.com

# config -s config.system.smtp.encryption=SSL

# config -s config.system.smtp.sender=John@opengear.com

# config -s config.system.smtp.username=john

# config -s config.system.smtp.password=A-little-secret-for-2.

# config -s config.system.smtp.subject=SMTP alerts

To set-up an SMTP SMS server with the same details as above:

# config -s config.system.smtp.server2=mail.opengear.com

# config -s config.system.smtp.encryption2=SSL

# config -s config.system.smtp.sender2=john@opengear.com

# config -s config.system.smtp.username2=john

# config -s config.system.smtp.password2=A-little-secret-for-2.

# config -s config.system.smtp.subject2=SMTP alerts

In both setups, the value for encryption can be SSL, TLS or None.

The following command will synchronize the live system with the new conﬁgura!on:

# config -a

13.1.15.SNMP

To set-up the SNMP agent on the device:

smtp or sms server se&ng

Outgoing server address

Secure conec!on type

Sender

Server username

Server password

Subject line

value

mail.opengear.com

SSL

john@opengear.com

john

A-li%le-secret-for-2.

SMTP alerts

Opengear User Manual. Page 285.

# config -s config.system.snmp.protocol=[UDP | TCP]

# config -s config.system.snmp.trapport=port-number

# config -s config.system.snmp.address=NMS-IP-network-address

# config -s config.system.snmp.community=community-name

# config -s config.system.snmp.engineid=ID

# config -s config.system.snmp.username=username

# config -s config.system.snmp.password=password

# config -s config.system.snmp.version=[1 | 2c | 3]

The default port number is 162.

The community value can only be set on v1 and v2c.

The engineid, username, and password values can only be set on v3.

The following command will synchronize the live system with the new conﬁgura!on:

# config -r auth

13.1.16.Administra"on

To change the administra!on se$ngs to:

Run the following commands:

# config -s config.system.name=og.example.com:

# config -P config.users.user1.password

# config -s "config.system.location="Device in office 2"

The second command has an interac!ve aspect. The -P parameter will prompt the user for a

password. Enter the desired string and press Return: config will accept and encrypt the

string.

Note: any conﬁg element value can be encrypted using the -P parameter. Only encrypted user

passwords and system passwords are supported, however. If any other element value is

encrypted, the value becomes inaccessible and will have to be re-set.

An alterna!ve to the second command above is:

# /etc/scripts/user-mod -P root

The following command will synchronize the live system with the new conﬁgura!on:

# config -r auth

13.1.17.IP se&ngs

To conﬁgure the primary network interface with the following sta!c se$ngs:

system se&ng

System name

System password (root account password)

Descrip!on

value

og.example.com

A-simple-li%le-secret-for-2.

Device in oﬃce 2

Opengear User Manual. Page 286.

# config -s config.interfaces.wan.address=192.168.0.23

# config -s config.interfaces.wan.netmask=255.255.255.0

# config -s config.interfaces.wan.gateway=192.168.0.1

# config -s config.interfaces.wan.dns1=192.168.0.1

# config -s config.interfaces.wan.dns2=192.168.0.2

# config -s config.interfaces.wan.mode=static

# config -s config.interfaces.wan.media=<value>

In the last command, the available op!ons for <value> are: Auto, 100baseTx-FD, 100baseTx-

HD, 10baseT-HD, and 10baseT-FD.

To conﬁgure the management LAN interface, use the same commands as above but replace

config.interfaces.wan with config.interfaces.lan.

To enable bridging between all interfaces:

# config -s config.system.bridge.enabled=on

To enable IPv6 for all interfaces:

# config -s config.system.ipv6.enabled=on

To enable the management LAN interface run the following command:

# config -d config.interfaces.lan.disabled

# config -r ipconfig

Note: not all devices have a management LAN interface.

To conﬁgure a failover device in case of an outage:

# config -s config.interfaces.wan.failover.address1=ip-address

# config -s config.interfaces.wan.failover.address2=ip-address

# config -s config.interfaces.wan.failover.interface=<interface>

In the last command, the available op!ons for <interface> are: eth1, console, modem

Network interfaces can also be conﬁgured automa!cally:

# config -s config.interfaces.wan.mode=dhcp

# config -s config.interfaces.lan.mode=dhcp

Either of the following commands will synchronize the live system with the new

conﬁgura!on:

# /bin/config –-run=ipconfig

# config -r ipconfig

Network interface se&ng

IP address

Netmask

Default gateway

DNS server 1

DNS server 2

value

192.168.0.23

255.255.255.0

192.168.0.1

192.168.0.2

Opengear User Manual. Page 287.

13.1.18.Date & "me se&ngs

To enable NTP using a server at pool.ntp.org issue the following commands:

# config -s config.ntp.enabled=on

# config -s config.ntp.server=pool.ntp.org

Alterna!vely, you can manually change the clock se$ngs.

To change running system !me:

# date MMDDhhmm[CC]YY.ss

# /bin/hwclock --systohc

The ﬁrst command sets a new system !me.

Note: the date command uses a US-style order with month (MM) listed before day (DD). Also,

although the thousands and hundreds column in the Gregorian Year are theore#cally

op#onal, it is strongly recommended that these values be set explicitly.

The second command saves this new system !me to the hardware clock.

Alterna!vely, to ﬁrst change the hardware clock and then set the system !me to the newly

set hardware !me :

# /bin/hwclock --set --date=MMDDhhmm[CC]YY.ss

# /bin/hwclock --hctosys

To change the !mezone:

# config -s config.system.timezone=US/Eastern

The following command will synchronize the live system with the new conﬁgura!on:

# config -r time

13.1.19.Dial-in se&ngs

To enable dial-in access on the DB9 serial port from the command line with the following

a%ributes:

Run the following commands:

# config -s config.console.ppp.localip=172.24.1.1

se&ng

Local IP address

Remote IP address

Authen!ca!on type

Serial port baud rate

Serial port ﬂow control

Custom modem ini!aliza!on

Callback phone number

User to dial as

Password for user

value

172.24.1.1

172.24.1.2

MSCHAPv2

115200

Hardware

ATQ0V1H0

0800223665

user1

A-li%le-secret-for-2.

Opengear User Manual. Page 288.

# config -s config.console.ppp.remoteip=172.24.1.2

# config -s config.console.ppp.auth=MSCHAPv2

# config -s config.console.speed=115200

# config -s config.console.flow=Hardware

# config -s config.console.initstring=ATQ0V1H0

# config -s config.console.ppp.enabled=on

# config -s config.console.ppp.callback.enabled=on

# config -s config.console.ppp.callback.phone1=0800223665

# config -s config.console.ppp.username=user1

# config -s config.console.ppp.password=A-little-secret-for-2.

To make the dialed connec!on the default route:

# config -s config.console.ppp.defaultroute=on

Supported values for se$ngs that are not ﬁxed or user-created are as follows:

If you do not wish to use out-of-band dial-in access the procedure for enabling start-up

messages on the console port is documented in chapter 14.3.2.

The following command will synchronize the live system with the new conﬁgura!on:

# config –a

13.1.20.DHCP server

To enable the DHCP server on the console management LAN, with the following se$ngs:

Run the following commands:

se&ng

Authen!ca!on type

Serial port baud rate

Parity values

Data bits values

Stop-bit values

Serial port ﬂow control

supported values

None, PAP, CHAP, and MSCHAPv2.

9600, 19200, 38400, 57600, 115200, and 230400

None, Odd, Even, Mark, and Space

5, 6, 7, and 8

1, 1.5, and 2

Hardware, So&ware, and None

DHCP server se&ng

Default lease !me

Maximum lease !me

DNS server 1

DNS server 2

Domain name

Default gateway

IP pool 1 start address

IP pool 1 end address

Reserved IP address

MAC to reserve IP for

Name to iden!fy this host

value

200000 seconds

300000 seconds

192.168.2.3

192.168.2.4

company.com

192.168.0.1

192.168.0.20

192.168.0.100

192.168.0.50

00:1e:67:82:72:d9

John-PC

Opengear User Manual. Page 289.

# config -s config.interfaces.lan.dhcpd.enabled=on

# config -s config.interfaces.lan.dhcpd.defaultlease=200000

# config -s config.interfaces.lan.dhcpd.maxlease=300000

# config -s config.interfaces.lan.dhcpd.dns1=192.168.2.3

# config -s config.interfaces.lan.dhcpd.dns2=192.168.2.4

# config -s config.interfaces.lan.dhcpd.domain=company.com

# config -s config.interfaces.lan.dhcpd.gateway=192.168.0.1

# config -s

config.interfaces.lan.dhcpd.pools.pool1.start=192.168.0.20

# config -s

config.interfaces.lan.dhcpd.pools.pool1.end=192.168.0.100

# config -s config.interfaces.lan.dhcpd.pools.total=1

# config -s

config.interfaces.lan.dhcpd.staticips.staticip1.ip=192.168.0.50

# config -s

config.interfaces.lan.dhcpd.staticips.staticip1.mac=00:1e:

67:82:72:d9

# config -s

config.interfaces.lan.dhcpd.staticips.staticip1.host=John-PC

# config -s config.interfaces.lan.dhcpd.staticips.total=1

The following command will synchronize the live system with the new conﬁgura!on:

# config -r auth

13.1.21.Services

You can manually enable or disable network servers from the command line. For example, if

you wanted to guarantee the following server conﬁgura!on:

Run the following commands:

# config -s config.services.http.enabled=on

# config -d config.services.https.enabled

# config -d config.services.telnet.enabled

# config -s config.services.ssh.enabled=on

# config -d config.services.snmp.enabled

# config -d config.services.pingreply.enabled

# config -s config.services.tftp.enabled=on

These services run on default port numbers as follows:

service

HTTP server

HTTPS server

Telnet server

SSH server

SNMP server

Respond to ICMP echo requests (Ping replies)

TFTP server

state

enabled

disabled

enabled

disabled

enabled

Opengear User Manual. Page 290.

To set secondary port ranges for any service the following syntax applies:

# config -s config.services.<service>.portbase=<number>

For example: to set all these services to run on a port number that is ten higher than their

default, run the following commands:

# config -s config.services.telnet.portbase=2010

# config -s config.services.ssh.portbase=3010

# config -s config.services.tcp.portbase=4010

# config -s config.services.rfc2217.portbase=5010

# config -s config.services.unauthtel.portbase=6010

The following command will synchronize the live system with the new conﬁgura!on:

# config -r auth

13.1.22.Nagios

To conﬁgure NAGIOS with the following se$ngs:

Run the following commands:

# config -s config.system.nagios.enabled=on

# config -s config.system.nagios.name=cm7116

# config -s config.system.nagios.address=192.168.0.1

# config -s config.system.nagios.server.address=192.168.0.10

# config -s config.system.nagios.sdt.disabled=on

# config -s config.system.nagios.sdt.address=192.168.0.1

# config -s config.system.nagios.nrpe.prefer=''

The ﬁ&h command disables SDT for Nagios extensions.

To conﬁgure NRPE with following se$ngs:

service

Telnet

SSH

TCP

RFC2217

unauthtel (Unauthorised Telnet)

default port number

2000

3000

4000

5000

6000

se&ng

NAGIOS host name

NAGIOS host address

NAGIOS server address

Enable SDT for NAGIOS ext

SDT gateway address

Prefer NRPE over NSCA

value

cm7116

192.168.0.1

192.168.0.10

Enabled

192.168.0.1

Disabled

notes

Name of this system.

Address of this system.

Address of upstream NAGIOS server

Defaults to host address.

Defaults to disabled.

Opengear User Manual. Page 291.

Run the following commands:

# config -s config.system.nagios.nrpe.enabled=on

# config -s config.system.nagios.nrpe.port=5600

# config -s config.system.nagios.user=user1

# config -s config.system.nagios.nrpe.group=group1

# config -s config.system.nagios.nrpe.cmdargs=on

To conﬁgure NSCA with the following se$ngs:

Run the following commands

# config -s config.system.nagios.nsca.enabled=on

# config -s config.system.nagios.nsca.encryption=BLOWFISH

# config -s config.system.nagios.nsca.secret=secret

# config -s config.system.nagios.nsca.interval=2

# config -s config.system.nagios.nsca.port=5650

# config -s config.system.nagios.nsca.user=user1

# config -s config.system.nagios.nsca.group=group1

The following command will synchronize the live system with the new conﬁgura!on:

# config -r auth

se&ng

NRPE port

NRPE user

NRPE group

Allow command arguments

value

5600

user1

group1

Enabled

notes

Port to listen on for nrpe. Defaults to 5666.

User to run as. Defaults to nrpe.

Group to run as. Defaults to nobody.

se&ng

NSCA encryp!on

NSCA password

NSCA check-in interval

NSCA port

User to run as

Group to run as

value

BLOWFISH

secret

2 minutes

5650

user1

group1

notes

can be None, XOR, DES, TRPLEDES, CAST-256,

BLOWFISH, TWOFISH, RIJNDAEL-256,

SERPENT, GOST

Defaults to 5667

Defaults to nsca

Defaults to nobody

Opengear User Manual. Page 292.

14. Advanced conﬁgura!on

Opengear console servers run the embedded Linux opera!ng system. Administrator class users

can conﬁgure the console server and monitor and manage a%ached serial console and host

devices from the command line using Linux commands and the conﬁg u!lity (as described in

chapter 13).

The Linux kernel in the console server also supports GNU bash shell scripts, enabling the

Administrator to run custom scripts. This chapter presents a number of useful scripts and

scrip!ng tools including

•delete-node, which is a general script for dele!ng users, groups, hosts, UPS’s etc.

•ping-detect, which will run speciﬁed commands when a speciﬁc host stops responding

to ping requests.

This chapter then details how to perform advanced and custom management tasks using

Opengear commands, Linux commands and the open source tools embedded in the console

server:

•portmanager serial port management.

• raw data access to the ports and modems.

•iptables modiﬁca!ons and upda!ng IP ﬁltering rules.

• retrieving status informa!on using SNMP and modifying SNMP with net-snmpd.

• public key authen!cated SSH communica!ons.

Opengear User Manual. Page 293.

• SSL, conﬁguring HTTPS and issuing cer!ﬁcates.

• using pmpower for NUT and PowerMan power device management.

• using IPMItools.

• CDK custom development kit.

• sms server tools.

• disabling mul!cas!ng.

14.1. Custom scrip"ng

The console server supports GNU bash shell commands (see appendix 1) enabling the

Administrator to run custom scripts.

14.1.1. Custom script to run when boo"ng

The /etc/config/rc.local script runs whenever the system boots. By default this script

ﬁle is empty. You can add any commands to this ﬁle if you want them to be run at boot !me.

For example, if you want to display hello world, add the following to rc.local:

#!/bin/sh

echo "Hello World!"

If this script has been copied from a Windows machine you may need to run the following

command on the script before bash can run it successfully:

# dos2unix /etc/config/rc.local

Another scenario would be to call another custom script from the /etc/config/rc.local

ﬁle, ensuring that your custom script will run whenever the system is booted.

14.1.2. Running custom scripts when alerts are triggered

Whenever an alert gets triggered, speciﬁc scripts get called. These scripts all reside in /etc/

scripts/. Below is a list of the default scripts that get run for each applicable alert.

• For a connec!on alert (when a user connects or disconnects from a port or network host):

/etc/scripts/portmanager-user-alert (for port connec!ons).

/etc/scripts/sdt-user-alert (for host connec!ons).

• For a signal alert (when a signal on a port changes state):

/etc/scripts/portmanager-signal-alert

• For a pa%ern match alert (when a speciﬁc regular expression is found in the serial ports

character stream):

/etc/scripts/portmanager-pattern-alert

• For a UPS status alert (when the UPS power status changes between on line, on ba%ery,

and low ba%ery):

/etc/scripts/ups-status-alert

Opengear User Manual. Page 294.

• For an environmental, power and alarm sensor alerts (temperature, humidity, power load

and ba%ery charge alerts):

/etc/scripts/environmental-alert

• For an interface failover alert:

/etc/scripts/interface-failover-alert

All these scripts do a check to see whether you have created a custom script to run instead.

The code that does this check is shown below (an extract from the ﬁle /etc/scripts/

portmanager-pattern-alert):

# If there's a user-configured script, run it instead

scripts[0]="/etc/config/scripts/pattern-alert.${ALERT_PORTNAME}"

scripts[1]="/etc/config/scripts/portmanager-pattern-alert"

for (( i=0 ; i < ${#scripts[@]} ; i++ )); do

if [ -f "${scripts[$i]}" ]; then

exec /bin/sh "${scripts[$i]}"

done

This code shows that there are two alterna!ve scripts that can be run instead of the default

one. This code ﬁrst checks whether a ﬁle — /etc/config/scripts/pattern-alert.$

{ALERT_PORTNAME} — exists.

Note: The variable ${ALERT_PORTNAME} must be replaced with port01 or port13 or

whichever port the alert should run for.

If this ﬁle cannot be found, the script checks whether the ﬁle /etc/config/scripts/

portmanager-pattern-alert exists.

If either of these ﬁles exists, the script calls the exec command on the ﬁrst ﬁle that it ﬁnds

and runs that custom ﬁle/script instead.

As an example, you can copy the /etc/scripts/portmanager-pattern-alert script

ﬁle to /etc/config/scripts/portmanager-pattern-alert:

•# cd /

•# mkdir /etc/config/scripts

Note: this command assumes the directory created does not already exist.

•# cp /etc/scripts/portmanager-pattern-alert \

/etc/config/scripts/portmanager-pattern-alert

The next step is to edit the new script ﬁle.

• Open the ﬁle /etc/config/scripts/portmanager-pattern-alert using vi (or

other text editor).

• remove the lines that check for a custom script (the code from above).

This will prevent the new custom script from repeatedly calling itself.

A&er these lines have been removed, edit the ﬁle, or add any addi!onal scrip!ng to the ﬁle.

Opengear User Manual. Page 295.

14.1.3. Example script: power cycling on pa'ern match

If for example we had an RPC (PDU) connected to port 1 on a console server and also have

some telecommunica!ons device connected to port 2 and which is powered by the RPC

outlet 3. Now assume the telecom device transmits a character stream Emergency out on its

serial console port every !me that it encounters some speciﬁc error, and the only way to ﬁx

this error is to power cycle the telecom device.

The ﬁrst step is to setup a pa%ern-match alert on port 2 to check for the pa%ern Emergency.

Next we need to create a custom script to deal with this alert:

# cd /

# mkdir /etc/config/scripts

/* if the directory does not already exist */

# cp /etc/scripts/portmanager-pattern-alert \

/etc/config/scripts/portmanager-pattern-alert

Note: make sure to remove the if statement (which checks for a custom script) from the new script,

in order to prevent an inﬁnite loop.

The pmpower u!lity is used to send power commands to RPC device in order to power cycle

our telecom device:

# pmpower -l port01 -o 3 cycle

The RPC is on serial port 1. The telecom device is powered by RPC outlet 3.

We can now append this command to our custom script. This will guarantee that our telecom

device will be power cycled every !me the console reads the Emergency character stream on

port 2.

14.1.4. Example script: mul"ple e-mail no"ﬁca"ons on each alert

If you desire to send more than one email when an alert triggers, you have to create a

replacement script using the method described above and add the appropriate lines to your

new script.

Currently, there is a script /etc/scripts/alert-email which gets run from within all the

alert scripts (for example portmanager-user-alert or environmental-alert). The

alert-email script is responsible for sending the email. The line which invokes the email

script looks as follows:

/bin/sh /etc/scripts/alert-email $suffix &

If you wish to send another email to a single address or the same email to many recipients,

edit the custom script appropriately. You can follow the examples in any of the seven alert

scripts listed above. Consider the portmanager-user-alert script. If you need to send

the same alert email to more than one email address, ﬁnd the lines in the script responsible

for invoking the alert-email script, then add the following lines below the exis!ng lines:

export TOADDR="emailaddress@domain.com"

/bin/sh /etc/scripts/alert-email $suffix &

These two lines assign a new email address to TOADDR and invoke the alert-email script in the

background.

Opengear User Manual. Page 296.

14.1.5. Dele"ng conﬁgura"on values from the CLI

The delete-node script is provided to help with dele!ng nodes from the command line. The

delete-node script takes one argument, the node name you want to delete (for example

config.users.user1 or config.sdt.hosts.host1).

delete-node is a general script for dele!ng any node you desire (users, groups, hosts, UPS's

etc) from the command line. The script deletes the speciﬁed node and shuﬄes the remainder

of the node values.

For example if we have ﬁve users conﬁgured and we use the script to delete user 3, then user

4 will become user 3, and user 5 will become user 4.

This creates an obvious complica!on as this script does not check for any other dependencies

that the node being deleted may have had. So you are responsible for making sure that any

references and dependencies connected to the deleted node are removed or corrected in the

config.xml ﬁle.

The script treats all nodes the same. The syntax to run the script is

# ./delete-node {node name}

so to remove, for example, user 3:

# ./delete-node config.users.user3

The delete-note script

# !/bin/bash

# User must provide the node to be removed. eg "config.users.user1"

# Usage: delete-node {full node path}

if [ $# != 1 ]

then

echo "Wrong number of arguments"

echo "Usage: delnode {full '.' delimited node path}"

exit 2

# test for spaces

TEMP=`echo "$1" | sed 's/.* .*/N/'`

if [ "$TEMP" = "N" ]

then

echo "Wrong input format"

echo "Usage: delnode {full '.' delimited node path}"

exit 2

# testing if node exists

TEMP=`config -g config | grep "$1"`

if [ -z "$TEMP" ]

then

echo "Node $1 not found"

exit 0

Opengear User Manual. Page 297.

# LASTFIELD: last field in the node path. eg "user1"

# ROOTNODE: upper level of the node. eg "config.users"

# NUMBER: integer value extracted from LASTFIELD e.g. "1"

# TOTALNODE: node name for the total e.g. "config.users.total"

# TOTAL: value of the total number of items before deleting eg "3"

# NEWTOTAL: modified total i.e. TOTAL-1

# CHECKTOTAL checks if TOTAL is the actual total items in .xml

LASTFIELD=${1##*.}

ROOTNODE=${1%.*}

NUMBER=`echo $LASTFIELD | sed 's/^[a-zA-Z]*//g'`

TOTALNODE=`echo ${1%.*} | sed 's/$.*$/\1.total/'`

TOTAL=`config -g $TOTALNODE | sed 's/.* //'`

NEWTOTAL=$[ $TOTAL -1 ]

# Make backup copy of config file

cp /etc/config/config.xml /etc/config/config.bak

echo "backup of /etc/config/config.xml saved in /etc/config/

config.bak"

if [ -z $NUMBER ] # test whether a singular node is being \

# deleted e.g. config.sdt.hosts

then

echo "Deleting $1"

config -d "$1"

echo Done

exit 0

elif [ $NUMBER = $TOTAL ] # Test if only one item exists

then

echo "only one item exists"

# Deleting node

echo "Deleting $1"

config -d "$1"

# Modifying item total.

config -s "$TOTALNODE=0"

echo Done

exit 0

elif [ $NUMBER -lt $TOTAL ] # more than one item exists

then

# Modify the users list so user numbers are sequential

# by shifting the users into the gap one at a time...

echo "Deleting $1"

LASTFIELDTEXT=`echo $LASTFIELD | sed 's/[0-9]//g'`

CHECKTOTAL=`config -g $ROOTNODE.$LASTFIELDTEXT$TOTAL`

if [ -z "$CHECKTOTAL" ]

Opengear User Manual. Page 298.

then

echo "WARNING: "$TOTALNODE" greater than number of items"

COUNTER=1

while [ $COUNTER != $((TOTAL-NUMBER+1)) ]

config -g $ROOTNODE.$LASTFIELDTEXT$((NUMBER+COUNTER)) \

| while read LINE

config -s \

"`echo "$LINE" | sed -e "s/$LASTFIELDTEXT$((NUMBER+ \

COUNTER))/$LASTFIELDTEXT$((NUMBER+COUNTER-1))/" \

-e 's / /=/'`"

done

let COUNTER++

done

# deleting last user

config -d $ROOTNODE.$LASTFIELDTEXT$TOTAL

# Modifying item total.

config -s "$TOTALNODE=$NEWTOTAL"

echo Done

exit 0

else

echo "error: item being deleted has an index greater than total

items. Increase the total count variable."

exit 0

14.1.6. Power cycle any device upon a ping request failure

The ping-detect script is designed to run speciﬁed commands when a monitored host

stops responding to ping requests.

The ﬁrst parameter taken by the ping-detect script is the hostname or IP address of the

device to ping. Any other parameters are then regarded as a command to run whenever the

ping to the host fails. ping-detect can run any number of commands.

Below is an example using ping-detect to power cycle an RPC (PDU) outlet whenever a

speciﬁc host fails to respond to a ping request. ping-detect is run from /etc/config/

rc.local to make sure that the monitoring starts whenever the system boots.

We assume we have a serially controlled RPC connected to port01 on a console server and

have a router powered by outlet 3 on the RPC and the router has an internal IP address of

192.168.22.2. The following instruc!ons will show you how to con!nuously ping the router

and, when the router fails, to respond to a series of pings, the console server will send a

command to RPC outlet 3 to power cycle the router, and write the current date/!me to a ﬁle.

• Copy the ping-detect script to /etc/config/scripts/ on the console server.

Opengear User Manual. Page 299.

• Open /etc/config/rc.local using vi (or another text editor).

• Add the following line to rc.local:

/etc/config/scripts/ping-detect 192.168.22.2 /bin/bash -c \

"pmpower -l port01 -o 3 cycle && date" > /tmp/output.log &

The above command will cause the ping-detect script to con!nuously ping the host at

192.168.22.2, which is the router. If the router crashes it will no longer respond to ping

requests. If this happens, the two commands pmpower and date will run. The output from

these commands is sent to the ﬁle /tmp/output.log so that we have some kind of record.

The ping-detect is also run in the background using the &.

The rc.local script is only run by default when the system boots. You can manually run the

rc.local script or the ping-detect script if desired.

The above is just one example of using the ping-detect script. The idea of the script is to

run any number of commands when a speciﬁc host stops responding to ping requests. Here

are details of the ping-detect script itself.

The ping-detect script

# !/bin/sh

# Usage: ping-detect HOST [COMMANDS...]

# This script takes 2 types of arguments: hostname/IPaddress

# to ping, and the commands to run if the ping fails 5 times

# in a row. This script can only take one host/IPaddress per

# instance. Multiple independent commands can be sent to the

# script. The commands will be run one after the other.

# PINGREP is the entire reply from the ping command

# LOSS is the percentage loss from the ping command

# $1 must be the hostname/IPaddress of device to ping

# $2... must be the commands to run when the pings fail.

COUNTER=0

TARGET="$1"

shift

# loop indefinitely:

while true

# ping the device 10 times

PINGREP=`ping -c 10 -i 1 "$TARGET" `

# get the packet loss percentage

LOSS=`echo "$PINGREP" | grep "%" | \

sed -e 's/.* $[0-9]*$% .*/\1/'`

if [ "$LOSS" -eq "100" ]

then

COUNTER=`expr $COUNTER + 1`

else

COUNTER=0

sleep 30s

if [ "$COUNTER" -eq 5 ]

Opengear User Manual. Page 300.

then

COUNTER=0

"$@"

sleep 2s

done

14.1.7. Running custom scripts when a conﬁgurator is invoked

A conﬁgurator is responsible for reading the values in /etc/config/config.xml and

making the appropriate changes live. Some changes made by the conﬁgurators are part of the

Linux conﬁgura!on itself such as user passwords or ipconfig.

Currently there are nineteen conﬁgurators, each one responsible for a speciﬁc group of

conﬁg. For example, the users conﬁgurator makes the user conﬁgura!ons in the config.xml

ﬁle live. To see all the available conﬁgurators type the following from a command line prompt:

# config

When a change is made using the Management Console web GUI the appropriate

conﬁgurator is automa!cally run. This can be problema!c. If another user or administrator

makes a change using the Management Console the conﬁgurator could possibly overwrite any

custom CLI/linux conﬁgura!ons you may have set.

The solu!on is to create a custom script that runs a&er each conﬁgurator has run. So a&er

each conﬁgurator runs it will check whether that appropriate custom script exists. You can

then add any commands to the custom script and they will be invoked a&er the conﬁgurator

runs.

The custom scripts must be in the correct loca!on:

/etc/config/scripts/config-post-

To create an alerts custom script:

# cd /etc/config/scripts

# touch config-post-alerts

# vi config-post-alerts

This script could be used to recover a speciﬁc backup conﬁg or overwrite a conﬁg or make

copies of conﬁg ﬁles etc.

14.1.8. Backing-up the conﬁgura"on and restoring using a local USB s"ck

The /etc/scripts/backup-usb script has been wri%en to save and load custom

conﬁgura!on using a USB ﬂash disk. Before saving a conﬁgura!on locally, you must prepare

the USB storage device for use. To do this, disconnect all USB storage devices except for the

storage device you wish to use.

Usage:

/etc/scripts/backup-usb COMMAND [FILE]

Opengear User Manual. Page 301.

The ﬁrst thing to do is to check if the USB disk has a label:

# /etc/scripts/backup-usb check-magic

If this command returns Magic volume not found, then run the following command:

# /etc/scripts/backup-usb set-magic

To save the conﬁgura!on:

# /etc/scripts/backup-usb save config-20May

To check if the backup was saved correctly:

# /etc/scripts/backup-usb list

If this command does not display * conﬁg-20May then there was an error saving the

conﬁgura!on.

The set-default command takes an input ﬁle as an argument and renames it to

default.opg. This default conﬁgura!on remains stored on the USB disk. The next !me you

want to load the default conﬁg, it will be sourced from the new default.opg ﬁle. To set a

conﬁg ﬁle as the default:

# /etc/scripts/backup-usb set-default config-20May

To load this default:

# /etc/scripts/backup-usb load-default

To load any other conﬁg ﬁle:

# /etc/scripts/backup-usb load {filename}

The /etc/scripts/backup-usb script can be executed directly with various commands or

called from other custom scripts you may create. However it is recommended that you do not

customize the /etc/scripts/backup-usb script itself.

14.1.9. Backing-up the conﬁgura"on oﬀ-box

If you do not have a USB port on your console server you can back up the conﬁgura!on to an

oﬀ-box ﬁle. Before backing up you need to arrange a way to transfer the backup oﬀ-box. This

could be via an NFS share, a Samba (Windows) share to USB storage or copied oﬀ-box via the

network. If backing up directly to oﬀ-box storage, make sure it is mounted.

command

check-magic

set-magic

save ﬁle

delete ﬁle

list

load ﬁle

load-default

set-default ﬁle

notes

Check volume label.

Set volume label.

Save conﬁgura!on to USB.

Delete a conﬁgura!on tarball from USB.

List available conﬁg backups on USB

Load a speciﬁc conﬁg from USB.

Load the default conﬁgura!on.

Set which ﬁle becomes the default.

Opengear User Manual. Page 302.

/tmp is not a good loca!on for the backup except as a temporary loca!on before transferring

it oﬀ-box. The /tmp directory will not survive a reboot. The /etc/config directory is not a

good place either: it will not survive a restore.

Backup and restore should be done by the root user to ensure correct ﬁle permissions are set.

The config command is used to create a backup tarball:

# config -e <Output File>

The tarball will be saved to the indicated loca!on. It will contain the contents of the /etc/

config/ directory in an uncompressed and unencrypted form.

Example nfs storage:

# mount -t nfs 192.168.0.2:/backups /mnt # config -e /mnt/ \

cm7116.config

# umount/mnt/

Example transfer oﬀ-box via scp:

# config -e /tmp/cm7116.config

# scp /tmp/cm7116.config username@192.168.0.2:/backups

The conﬁg command is also used to restore a backup:

# config -i <Input File>

This will extract the contents of the previously created backup to /tmp, and then synchronize

the /etc/config directory with the copy in /tmp.

One problem that can crop up here is that there is not enough room in /tmp to extract ﬁles

to. The following command will temporarily increase the size of /tmp:

# mount -t tmpfs -o remount,size=2048k tmpfs /var

If restoring to either a new unit or one that has been factory defaulted, it is important to make

sure that the process genera!ng SSH keys is either stopped or completed before restoring

conﬁgura!on. If this is not done, then a mix of old and new keys may be put in place.

SSH uses these keys to avoid man-in-the-middle a%acks, logging in may be disrupted.

14.2. Advanced PortManager

Opengear’s portmanager manages console server serial ports. It routes network connec!ons

to serial ports, checks permissions, and monitors and logs all data ﬂowing to and from ports.

14.2.1. PortManager commands

pmshell

The pmshell command behaves similarly to standard tip or cu commands, but all serial

port access is directed via the portmanager.

For example, to connect to port 8 via the portmanager:

# pmshell -l port08

Opengear User Manual. Page 303.

pmshell commands

Once connected, the pmshell command supports a subset of the ~ escape commands that

tip and cu support. For SSH you must preﬁx the escape with an addi!onal ~ character. That

is, over SSH use the ~~ escape sequence.

Firmware v3.5.2 and later includes the pmshell chooser escape command. You can now use

~m (or ~~m over SSH) from connected serial port to drop back to pmshell.

For console servers running ﬁrmware v3.11.0 and later, pmshell has a set of key sequences

built in to access things like the power menu, return to the serial port selec!on menu and so

on.

Extra controls (key sequences) can be added to the built in set of key sequences and can be

conﬁgured per serial port. You can have all ports behave the same or selec!vely add control

sequences to ports. The controls can be diﬀerent from port to port for the same func!on.

For example, you could conﬁgure pmshell such that when you are using serial port 2,

pressing Ctrl+p would take you straight to the power menu for that port.

The pmshell control commands are conﬁgurable only via the command line.

Note: The pmshell help message is not updated with informa#on about any custom control

command keys that are conﬁgured.

There is a helper script which will conﬁgure a control command on a range of serial ports to

eliminate the cumbersome task of entering the conﬁgura!on command for every port. You

will s!ll need to use this script once per control func!on (see below) but there are only six of

these.

As an example, to conﬁgure Ctrl+p to open the power menu when using serial port 3, enter

command

~rts=[x]

-signals

-getline

over ssh

~~b

~~h

~~p

~~m

~~?

~~rts=[x]

-signals

-getline

notes

Generates a BREAK on the connected-to serial port.

Generates a history on the connected-to serial port. Depends on port

logging being enabled.

Opens the power menu for the connected-to serial port. Said port must

be conﬁgured for an RPC.

Connect to the port menu. Goes back to the serial port selec!on menu.

Shows the pmshell help message.

Quits pmshell.

Sets RTS to [x].

Shows all signals: 3DSR=1, DTR=1, CTS=1, RTS=1, DCD=0.

Reads a line of text from the serial port.

per port control command conﬁg parameters

conﬁg.ports.portX.ctrlcode.break

conﬁg.ports.portX.ctrlcode.portlog

conﬁg.ports.portX.ctrlcode.power

conﬁg.ports.portX.ctrlcode.chooser

conﬁg.ports.portX.ctrlcode.quit

conﬁg.ports.portX.ctrlcode.help

notes

Generates a BREAK.

View history

open power menu

connect to port menu

exit pmshell

show help message

Opengear User Manual. Page 304.

the following in the console server's command shell:

config -s config.ports.port3.ctrlcode.power=16

killall -HUP portmanager

The ﬁrst command sets the power menu command to listen for Ctrl+p. Decimal 16 is the

character code sent when you press Ctrl+p in the serial port session (see the control codes

table immediately below).

The second command — killall -HUP portmanager — tells portmanager to reload the

conﬁgura!on so that the new control code will take eﬀect. Reboo!ng the device would also

work.

There is a script to set serial control codes on a range of ports so that bulk port conﬁgura!on

can be performed more easily. For example to set the power menu control code to CTRL-P

(keycode 16) on ports 4 to 10 inclusive, enter the following at the command line:

/etc/scripts/set-serial-control-codes 4 10 power 16

This sets the power menu control key to Ctrl+p.

Note: If you've not conﬁgured anything on a par#cular serial port in the included range,

conﬁgura#on for that port will be skipped.

pmchat

The pmchat command is similar to the standard chat command, but all serial port access is

directed via the portmanager.

For example, to run a chat script via the portmanager:

# pmchat -v -f /etc/config/scripts/port08.chat < /dev/port08

For more informa!on on using chat and pmchat you should consult the u!lity’s manual

page, via the man chat command on any Linux or UNIX (including macOS) system, or via the

web, including at h%ps://linux.die.net/man/8/chat.

pmusers

The pmusers command is used to query the portmanager for ac!ve user sessions.

For example, to detect which users are currently ac!ve on which serial ports:

# pmusers

control code

ctrl+a

ctrl+b

ctrl+c

ctrl+d

ctrl+e

ctrl+f

ctrl+g

ctrl+h

ctrl+i

decimal

control code

ctrl+j

ctrl+k

ctrl+l

ctrl+m

ctrl+n

ctrl+o

ctrl+p

ctrl+q

ctrl+r

decimal

control code

ctrl+s

ctrl+t

ctrl+u

ctrl+v

ctrl+w

ctrl+x

ctrl+y

ctrl+z

decimal

Opengear User Manual. Page 305.

This will output nothing if there are no ac!ve users currently connected to any ports. If users

are connected it will respond with a sorted list of usernames per ac!ve port. For example:

Port 1:

user1

user2

Port 2:

user1

Port 8:

user2

The above output indicates that a user named user1 is ac!vely connected to ports 1 and 2,

while user2 is connected to both ports 1 and 8.

With ﬁrmware v3.11 and later the pmusers command is extended with the --disconnect

op!on. This allows an administrator or root to disconnect console server sessions from the

command line. The following connec!on types can be disconnected:

telnet

SSH

Raw TCP

Unauthorized Telnet

The --disconnect op!on cannot disconnect an RFC2217 session.

If the --disconnect op!on is speciﬁed, the pmusers command goes into disconnect mode

where you can specify users with -u and ports with -l (by label) or -n (by name).

By default the command will prompt the user before actually disconnec!ng the matching

sessions. This can be overriden with the --no-prompt argument.

Some example pmuser sessions:

# pmusers --disconnect

Disconnect all users from all ports? (y/n)

5 sessions were disconnected

# pmusers --disconnect -u robertw

Disconnect user robertw from all ports? (y/n)

1 session was disconnected

# pmusers --disconnect -u robertw -n 5

Disconnect user robertw from port 5 (BranchRouter01)? (y/n)

No sessions were disconnected

# pmusers --disconnect -n 5

Disconnect all users from port 5 (BranchRouter01)? (y/n)

2 sessions were disconnected

# pmusers --disconnect -u robertw -u pchunt -n 4 -n 6

Disconnect users robertw, pchunt from ports 4, 6? (y/n)

Opengear User Manual. Page 306.

10 sessions were disconnected

# pmusers --disconnect -u tester --no-prompt

No sessions were disconnected

portmanager dæmon

There is normally no need to stop and restart the dæmon. To restart the dæmon normally, just

run the command:

# portmanager

Supported command line op!ons are:

signals

Sending a SIGHUP signal to the portmanager will cause it to re-read its conﬁgura!on ﬁle.

14.2.2. External scripts & alerts

The portmanager has the ability to execute external scripts on certain events.

When a port is opened by the portmanager

When portmanager opens a port, it a%empts to execute /etc/config/scripts/

portXX.init (where XX is the number of the port, for example 08). The script is run with

STDIN and STDOUT both connected to the serial port.

If the script cannot be executed, portmanager executes /etc/config/scripts/

portXX.chat via the chat command on the serial port.

When an alert occurs on a port

When an alert occurs on a port, portmanager a%empts to execute /etc/config/

scripts/portXX.alert (where XX is the port number, for example 08).

The script is run with STDIN containing the data which triggered the alert, and STDOUT

redirected to /dev/null, not to the serial port.

If you wish to communicate with the port, use pmshell or pmchat from within the script.

If the script cannot be executed, the alert will be mailed to the address conﬁgured in the

system administra!on sec!on.

When a user connects to any port

If a ﬁle called /etc/config/pmshell-start.sh exists it is run when a user connects to a

port. It is provided 2 arguments, the Port number and the Username. Here is a simple example:

</etc/config/pmshell-start.sh>

#!/bin/sh

op"on

-nodaemon

--loglevel={debug | info |warn | error | alert}

-c /etc/conﬁg/portmanager.conf

purpose

Force portmanager to run in the foreground

Set the level of debug logging

Change which conﬁgura!on ﬁle it uses

Opengear User Manual. Page 307.

PORT="$1"

USER="$2"

echo "Welcome to port $PORT $USER"

</etc/config/pmshell-start.sh>

The return value from the script controls whether the user is accepted or not, if 0 is returned

(or nothing is done on exit as in the above script) the user is permi%ed, otherwise the user is

denied access.

Here is a more complex script which reads from conﬁgura!on to display the port label if

available and denies access to the root user:

</etc/config/pmshell-start.sh>

#!/bin/sh

PORT="$1"

USER="$2"

LABEL=$(config -g config.ports.port$PORT.label | cut -f2- -d' ')

if [ "$USER" == "root" ]; then

echo "Permission denied for Super User"

exit 1

if [ -z "$LABEL" ]; then

echo "Welcome $USER, you are connected to Port $PORT"

else

echo "Welcome $USER, you are connected to Port $PORT ($LABEL)"

</etc/config/pmshell-start.sh>

14.3. Raw access to serial ports

14.3.1. Access to serial ports

You can use tip and stty to completely bypass the portmanager and have raw access to

the serial ports.

When you run tip on a portmanager-controlled port, portmanager closes that port, and

stops monitoring it un!l tip releases control of it.

With stty, the changes made to the port only persist un!l that port is closed and opened

again. Using stty for more than ini!al debugging of a serial connec!on is not recommended.

If you want to use stty to conﬁgure a port, you can put stty commands in /etc/config/

scripts/portXX.init which gets run whenever portmanager opens the port

Otherwise, any setup you do with stty will be lost when portmanager opens the port.

Note: portmanager sets things back to its conﬁg rather than using whatever is on the port, so the

port is in a known good state, and will work, no ma"er what things are done to the serial

port outside of portmanager.

14.3.2. Accessing the console modem port

Console dial-in is handled by mgetty, with automa!c PPP login extensions. mgetty is a

smart getty replacement, designed for Hayes-compa!ble data and data/fax modems.

Opengear User Manual. Page 308.

mgetty knows about modem ini!aliza!on, manual modem answering (so your modem

doesn’t answer if the machine isn’t ready), and UUCP locking (so you can use the same device

for dial-in and dial-out). mgetty provides extensive logging facili!es. All standard mgetty

op!ons are supported.

Modem ini"aliza"on strings

To override the standard modem ini!aliza!on string either use the Management Console (see

chapter 4) or the command line config tool (see chapter 14).

Enabling boot messages on the console

If you are not using a modem on the DB9 console port and instead wish to connect to it

directly via a Null Modem cable you may want to enable verbose mode allowing you to see

the standard linux start-up messages. This can be achieved with the following commands:

# /bin/config --set=config.console.debug=on # /bin/config \

--run=console # reboot

If at some point in the future you chose to connect a modem for dial-in out-of-band access

the procedure can be reversed with the following commands:

# /bin/config --del=config.console.debug

# /bin/config --run=console # reboot

14.4. IP ﬁltering

The console server uses the iptables u!lity to provide a stateful ﬁrewall of LAN traﬃc.

By default, rules are automa!cally inserted to allow access to enabled services, and serial port

access via enabled protocols. The commands which add these rules are in conﬁgura!on ﬁles:

/etc/config/fw.rules

This is an executable shell script which is run whenever the LAN interface is brought up and

whenever modiﬁca!ons are made to the iptables conﬁgura!on as a result of CGI ac!ons or

the conﬁg command line tool.

The basic steps performed are as follows:

• the running iptables conﬁgura!on is erased, per-interface.

• other standard system chains are installed.

• fall-through Block rules (default deny) are installed.

• Serial & Network > Services policies are installed in per-interface chains.

• Custom Serial & Network > Firewall rules are inserted at the top of the rule sets, taking

priority over any other conﬁgura!on

For further ﬁrewall customiza!on, extra rules can be persisted by crea!ng a ﬁle at /etc/

config/scripts/firewall-post containing iptables commands to amend the

ﬁrewall policy.

Thorough documenta!on regarding iptables is available at the Linux netﬁlter website, at

h%ps://netﬁlter.org/documenta!on/.

Opengear User Manual. Page 309.

14.5. SNMP status repor"ng

Console servers contain an SNMP Service — snmpd — which can provide status informa!on on

demand. snmpd is an SNMP agent which binds to a port and awaits requests from SNMP

management so&ware. Upon receiving a request, it processes the request(s), collects the

requested informa!on and/or performs the requested opera!on(s) and returns the

informa!on to the sender.

Note: ini#ally only advanced console server models were equipped with an SNMP Service. With

ﬁrmware v3.0 and later this support was extended to all console servers. Also the MIBS were

extended (and renamed for compliance) with this ﬁrmware release.

Console servers can also be conﬁgured to send SNMP traps or messages to mul!ple remote

SNMP Network Managers on deﬁned trigger events. See chapter 6 for conﬁgura!on details.

14.5.1. Retrieving status informa"on using SNMP

Console servers can provide serial and device status informa!on through SNMP. This includes

• Serial port status

•Ac!ve users

• Remote Power Control (RPC) and Power Distribu!on Unit (PDU) status

• Environmental Monitoring Device (EMD) status

• Signal alert status

• Environmental alert status and

• UPS alert status

The MIBs in your console server are located in /etc/snmp/mibs. They include:

14.5.2. Check ﬁrewall rules

• Navigate to System > Services.

• Check the SNMP dæmon checkbox for the required interface.

This allows SNMP requests through the speciﬁed interface’s ﬁrewall.

14.5.3. Enable SNMP service

Console servers support diﬀerent SNMP versions including SNMPv1, SNMPv2c and SNMPv3.

MIB

OG-STATUS-MIB

OG-STATUSv2-MIB

OG-SMI-MIB

OGTRAP-MIB

OGTRAPv2-MIB

notes

Contains serial and connected device status informa!on for

snmpstatusd and snmpalertd.

This MIB contains extended status and alerts.

Enterprise structure of management informa!on.

SMIv1 traps from old MIBS as smilint will not let SMIv1 structures

coexist with SMIv2.

Updated traps.

Opengear User Manual. Page 310.

Although an industry standard, SNMP brings with it a variety of security concerns. For

example, SNMPv1 and SNMPv2c oﬀer no inherent privacy, while SNMPv3 is suscep!ble to

man-in-the-middle a%acks. Recent IETF developments suggest tunnelling SNMP over widely

accepted technologies such as SSH (Secure Shell) or TLS (Transport Layer Security) rather

than relying on a less mature security systems such as SNMPv3's USM (User-based Security

Model).

Addi!onal informa!on regarding SNMP security issues and SNMPv3 can be found at h%p://

net-snmp.sourceforge.net/wiki/index.php/TUT:Security.

• Navigate to Alerts & Logging > SNMP.

The SNMP Service Details tab shows by default. This tab controls aspects of the SNMP

service including security level. It also manages requests from external agents for

Opengear status informa!on.

• Check the Enable the SNMP Service to start the SNMP service.

SNMP is disabled by default.

• Select either UDP or TCP for the TCP/IP Protocol.

UDP is the recommended protocol and is selected by default. TCP should only be used in

special cases, such as when Port Forwarding SNMP requests/responses to or from the

Opengear device is required.

• Complete the Loca"on and Contact ﬁelds.

The Loca!on ﬁeld should describe the physical loca!on of the Opengear and will be used

in response to requests for the SNMPv2-MIB::sysLoca!on.0 of the device.

The Contact ﬁeld refers to the person responsible for the Opengear such as the System

Administrator and will be used in response to requests as follows: SNMPv2-

MIB::sysContact.0.

• Enter the Read-Only Community and Read-Write Community.

This is required for SNMP v1 & v2c only. The Read-Only Community ﬁeld is used to specify

the SNMPv1 or SNMPv2c community that will be allowed read-only (GET and GETNEXT)

access. This must be speciﬁed in order for both versions to become enabled. The Read-

Write Community ﬁeld is used to specify the SNMPv1 or SNMPv2c community that will be

allowed read-write (GET, GETNEXT and SET) access.

Opengear User Manual. Page 311.

• Conﬁgure SNMPv3, if required.

SNMPv3 provides secure SNMP opera!ons through the use of USM (User-based Security

Model). It oﬀers various levels of security including user-based authen!ca!on and basic

encryp!on.

•Enter an Engine ID if required.

Engine ID is used to localize the SNMPv3 user. It will be automa!cally generated from a

Network Interface (eth0) hardware address, if le& blank, or must be entered as a hex value

(for example, 0x01020304).

• Specify the Security Level.

• Enter the Read Only Username.

This ﬁeld is mandatory when conﬁguring the console server for SNMPv3.

• For a Security Level of auth, set the Auth Protocol (SHA or MD5) and the Auth Password.

A password of at least 8 characters is required.

security level

noauth

auth

priv

notes

No authen!ca!on or encryp!on required. This is the minimum security level.

Authen!ca!on will be required but encryp!on is not enforced. An

authen!ca!on protocol (SHA or MD5) and password will be required.

Enforces encryp!on use. This is the highest level of security and requires an

encryp!on protocol (DES or AES) and password in addi!on to the

authen!ca!on protocol and password.

Opengear User Manual. Page 312.

• For a Security Level of priv, set the Privacy Protocol (DES or AES) and the Privacy Password.

AES is recommended. A password of at least 8 characters is required.

• Click Apply.

• Setup serial ports and devices as per requirements such as UPS, RPC/PDU and EMD.

• Copy the mibs from /etc/snmp/mibs on the console server to a local directory using scp

or Winscp. For example:

scp root@im4004:/etc/snmp/mibs/*

• Using the snmpwalk and snmpget commands, status informa!on can be retrieved from

any console server. For example:

snmpwalk -Oa -v1 -M .:/usr/share/snmp/mibs -c public im4004 OG-

STATUS-MIB::ogStatus

Opengear User Manual. Page 313.

snmpget -Oa -v1 -M .:/usr/share/snmp/mibs -c public im4004 OG-

STATUSMIB::ogSerialPortStatusSpeed.2

noauth

snmpwalk -Oa –v3 –l noAuthNoPriv –u readonlyusername -M .:/usr/

share/snmp/mibs im4004 OG-STATUS-MIB::ogStatus

auth

snmpwalk -Oa –v3 –l authNoPriv –u readonlyusername –a SHA –A

“authpassword” -M .:/usr/share/snmp/mibs im4004 OG-STATUS-

MIB::ogStatus

priv

snmpwalk -Oa –v3 –l authNoPriv –u readonlyusername –a SHA –A

“authpassword” –x DES –X “privpassword” -M .:/usr/share/snmp/mibs

im4004 OG-STATUS-MIB::ogStatus

A mib browser can explore the Opengear enterprise MIB structure. For example, the ogStatus

tree is shown below:

snmp argument

-l

-u

-a

-A

-x

-X

purpose

security level.

security name or read-only username.

authen!ca!on protocol: SHA or MD5.

authen!ca!on password.

privacy protocol: DES or AES.

privacy password.

Opengear User Manual. Page 314.

14.5.4. Adding mul"ple remote SNMP managers

You can add mul!ple SNMP servers for alert traps. Add the ﬁrst and second SNMP servers

using the Management Console (see chapter 6) or the command line config tool. Further

SNMP servers must be added manually using config.

• Set the SNMP Manager Address ﬁeld:

config –set="config.system.snmp.address3=w.x.y.z"

replacing w.x.y.z with the IP address or hostname.

• Set the Manager Trap Port ﬁeld:

config --set=”config.system.snmp.trapport3=162”

replacing 162 with the TCP/UDP port number

• Set the SNMP Manager Protocol ﬁeld:

config --set="config.system.snmp.protocol3=UDP"

config --set="config.system.snmp.protocol3=TCP"

• Set the SNMP Manager Version ﬁeld:

config --set="config.system.snmp.version3=3"

• Set the SNMP Manager v1 & v2c community ﬁeld:

config --set="config.system.snmp.community3=public"

• Set the SNMP Manager v3 Engine ID ﬁeld:

config –set="config.system.snmp.engineid3=0x8000000001020304"

replacing 0x8000000001020304 with the hex Engine-ID.

• Set the SNMP Manager v3 Security Level ﬁeld:

config --set="config.system.snmp.seclevel3=noAuthNoPriv"

config --set="config.system.snmp.seclevel3=authNoPriv"

config --set="config.system.snmp.seclevel3=authPriv"

• Set the SNMP Manager v3 Username ﬁeld:

config --set="config.system.snmp.username3=username"

• Set the SNMP Manager v3 Auth. Protocol and password ﬁelds:

conﬁg –set="conﬁg.system.snmp.authprotocol3=SHA"

Opengear User Manual. Page 315.

config --set="config.system.snmp.authprotocol3=MD5"

config --set="config.system.snmp.authpassword3=password 1"

• To set the SNMP Manager v3 Privacy Protocol and password ﬁelds:

config –set="config.system.snmp.privprotocol3=AES"

config –set="config.system.snmp.privprotocol3=DES"

config --set="config.system.snmp.privpassword3=password 2"

• Once the ﬁelds are set, apply the conﬁgura!on with the following command:

config --run snmp

You can add a third or more SNMP servers by incremen!ng the 2 in the above commands. For

example, config.system.snmp.protocol3, config.system.snmp.address3, etc.

14.6. Secure shell (SSH) public key authen"ca"on

This sec!on covers the genera!on of public and private keys in a Linux and Windows

environment and conﬁguring SSH for public key authen!ca!on. The steps to use in a

Clustering environment are:

• generate a new public and private key pair.

• upload the keys to the master and to each slave console server.

•ﬁngerprint each connec!on to validate.

14.6.1. SSH overview

Popular TCP/IP applica!ons such as telnet, rlogin, ftp, and others transmit their

passwords unencrypted. Doing this across pubic networks like the Internet can have

catastrophic consequences. It leaves the door open for eavesdropping, connec!on hijacking,

and other network-level a%acks.

Secure Shell (SSH) is a program to log into another computer over a network, to execute

commands in a remote machine, and to move ﬁles from one machine to another. It provides

strong authen!ca!on and secure communica!ons over insecure channels.

OpenSSH, the de facto open source SSH applica!on, encrypts all traﬃc (including passwords)

to eﬀec!vely eliminate these risks. Addi!onally, OpenSSH provides a myriad of secure

tunneling capabili!es, as well as a variety of authen!ca!on methods.

OpenSSH is the port of OpenBSD's excellent OpenSSH[0] to Linux and other versions of

Unix. OpenSSH is based on the last free version of Tatu Ylonen’s sample implementa!on with

all patent-encumbered algorithms removed (to external libraries), all known security bugs

ﬁxed, new features reintroduced and many other clean-ups.

The only changes in the Opengear SSH implementa!on are:

• PAM support.

Opengear User Manual. Page 316.

• EGD[1]/PRNGD[2] support and replacements for OpenBSD library func!ons that are

absent from other versions of UNIX.

• The conﬁg ﬁles are now in /etc/config/. For example:

/etc/config/sshd_config not /etc/sshd_config

/etc/config/ssh_config not /etc/ssh_config

/etc/config/users/<username>/.ssh / not /home/<username>/.ssh/

14.6.2. Genera"ng public keys (Linux)

To generate new SSH key pairs use the Linux ssh-keygen command.

This produces an RSA or DSA public/private key pair. You will be prompted for a path to store

the two key ﬁles: id_dsa.pub (the public key) and id_dsa (the private key). For example:

$ ssh-keygen -t [rsa|dsa]

Generating public/private [rsa|dsa] key pair.

Enter file in which to save the key (/home/user/.ssh/id_[r|dsa]):

Enter passphrase (empty for no passphrase):

Enter same passphrase again:

Your identification has been saved in /home/user/.ssh/id_[r|dsa].

Your public key has been saved in /home/user/.ssh/id_[r|dsa].pub.

The key fingerprint is:

28:aa:29:38:ba:40:f4:11:5e:3f:d4:fa:e5:36:14:d6 user@server

It is advisable to create a new directory to store your generated keys. It is also possible to

name the ﬁles a&er the device they will be used for. For example:

$ mkdir keys

$ ssh-keygen -t rsa

Generating public/private rsa key pair.

Enter file in which to save the key: ~/keys/control_room

Enter passphrase (empty for no passphrase):

Enter same passphrase again:

Your identification has been saved in ~/keys/control_room

Your public key has been saved in ~/keys/control_room.pub.

The key fingerprint is:

28:aa:29:38:ba:40:f4:11:5e:3f:d4:fa:e5:36:14:d6 user@server

There must be no password associated with the keys. If there is a password, Opengear

devices will have no way to supply it at run!me.

Full documenta!on for the ssh-keygen command can be found at h%p://man.openbsd.org/

OpenBSD-current/man1/ssh-keygen.1.

14.6.3. Installing the SSH public & private keys (clustering)

For console servers the keys can be uploaded through the web interface, on the System >

Administra"on page.

Opengear User Manual. Page 317.

This enables you to upload stored RSA or DSA Public Key pairs to the master and apply the

authorized key to the slave as documented in chapter 3. Once complete you then proceed to

Fingerprin!ng as documented below.

14.6.4. Installing SSH public key authen"ca"on (Linux)

Alternately the public key can be installed on the unit remotely from the linux host with the

scp u!lity as follows.

Assump!ons:

• the Management Console username is fred.

• the console server IP address is 192.168.0.1 (a console server’s default private IP address).

• the public key is stored on the Linux- or UNIX-based system in ~/.ssh/id_dsa.pub.

Given this, run the following command from the Linux- or UNIX-based system:

scp ~/.ssh/id_dsa.pub \

root@192.168.0.1:/etc/config/users/fred/.ssh/authorized_keys

Opengear User Manual. Page 318.

This copies the ﬁle to the console server but doesn’t set ownership as required. The

authorized_keys ﬁle on the console server needs to be owned by fred. To aﬀect this, login to

the Management Console as root and run the following command:

chown fred /etc/config/users/fred/.ssh/authorized_keys

If the console server selected to be the server has only one client device, the

authorized_keys ﬁle is simply a copy of the public key for that device.

If one or more devices will be clients of the console server, the authorized_keys ﬁle will contain

copies of all of the public keys.

RSA and DSA keys may be freely mixed in the authorized_keys ﬁle. For example, assume we

already have one server, called bridge_server, and two sets of keys, for the

control_room and the plant_entrance. The following commands 1) show the stored

keys and 2) combine two of them into a single ﬁle, authorized_keys_bridge_server.

$ ls /home/user/keys

control_room

control_room.pub

plant_entrance

plant_entrance.pub

$ cat ~/keys/control_room.pub ~/keys/plant_entrance.pub > ~/keys/

authorized_keys_bridge_server

More OpenSSH documenta!on can be found at h%ps://openssh.com/manual.html and h%p://

man.openbsd.org/OpenBSD-current/man1/ssh.1.

Opengear User Manual. Page 319.

14.6.5. Genera"ng public & private keys for SSH (Windows)

This sec!on describes how to generate and conﬁgure SSH keys using Windows.

The OpenSSH project does not produce a Windows binary. The OpenSSH project’s

development is en!rely focussed on producing ‘a very small, secure, and easy to maintain

version for the OpenBSD project’.

The versions of OpenSSH that ship on other Unix- and Unix-like opera!ng systems are

managed and produced by the OpenSSH Portability Team.

As of 2016-10, and despite Microso& announcing ‘the PowerShell team will support and

contribute to the OpenSSH community… to deliver the PowerShell and Windows SSH

solu!on’, there is no Windows version of the current OpenSSH release.

Consequently, Simon Tatham’s long-standing SSH client for Windows, PuTTY, which includes

the key generator, PuTTYgen.exe, is used in the following procedure.

Before beginning, make sure you have the most recent PuTTYgen release installed.

PuTTYgen is available for download from h%p://www.chiark.greenend.org.uk/~sgtatham/

pu%y/download.html.

This procedure also requires the current version of WinSCP — a Windows-equivalent to the

scp utlil!y — be installed. WinSCP is available for download from h%ps://winscp.net/.

• Create a new user from the Opengear Management Console.

The following example uses a user called testuser. This user must be a member of the

users group.

• If you do not already have a public/private key pair generate them now using PuTTYgen.

• Launch PuTTYgen.exe.

• Select the desired key type — SSH2 DSA — in the Parameters sec!on.

You may use RSA or DSA.

• Leave the passphrase ﬁeld blank.

• Click Generate.

• As instructed, move the mouse pointer over the blank area of the program in order to

create random data used by PUTTYGEN to generate secure keys.

Key genera!on occurs once PUTTYGEN has collected suﬃcient random data.

• Copy the public key data from the Public key for pas"ng into OpenSSH authorized_keys ﬁle

sec!on of the PuTTY Key Generator window.

• Launch Notepad (not Microso& Word or any other word processor).

• paste the key data into the Notepad window.

Make sure there is only one line of text in this ﬁle.

• Save the Notepad ﬁle as authorized_keys.

• Launch WinSCP.

Opengear User Manual. Page 320.

• Copy authorized_keys to the user’s home directory on the console server which will be

the SSH server.

For example, if the user’s username is testuser, copy the ﬁle to

/etc/config/users/testuser/.ssh/authorized_keys

• From the console server’s command line run the following commands to give the ﬁle the

correct text-format and the correct permissions:

# dos2unix /etc/config/users/testuser/.ssh/authorized_keys

# chown testuser /etc/config/users/testuser/.ssh/authorized_keys

•Using WinSCP, copy the local sshd_config ﬁle over /etc/config/sshd_config on

the console server.

This ensures public key authen!ca!on is enabled.

•Test the public key by logging in to the console server as testuser.

• At the console server’s command line type the following:

# ssh -o StrictHostKeyChecking=no <server-ip>

To automate connec!on of the SSH tunnel from the client on every power-up you need to

make the client’s /etc/config/rc.local look like the following:

#!/bin/sh

ssh -L9001:127.0.0.1:4001 -N -o \

StrictHostKeyChecking=no testuser@<server-ip> &

This will run the tunnel redirec!ng local port 9001 to the server port 4001.

14.6.6. Fingerprin"ng

Fingerprints are used to ensure you are establishing an SSH session to who you think you are.

On the ﬁrst connec!on to a remote server you will receive a ﬁngerprint which you can use on

future connec!ons.

This ﬁngerprint is related to the host key of the remote server. Fingerprints are stored in

~/.ssh/known_hosts.

• To receive the ﬁngerprint from the remote server, log in to the client as the required user

(usually root) and establish a connec!on to the remote host:

# ssh rh

The authenticity of host 'rh (192.168.0.1)' can't be established.

RSA key fingerprint is 8d:11:e0:7e:8a:6f:ad:f1:94:0f:93:fc:

7c:e6:ef:56.

Are you sure you want to continue connecting (yes/no)?

• Answer yes to accept the key.

• The following message will be returned:

Warning: Permanently added 'rh,192.168.0.1' (RSA) to the list of

known hosts.

Opengear User Manual. Page 321.

• You may be prompted for a password.

There is no need to log in, however: you have received the ﬁngerprint.

• Press Ctrl-C to cancel the connec!on.

If the host key changes you will receive the following warning, and not be allowed to connect

to the remote host:

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @

@ IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY! @

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Someone could be eavesdropping on you right now using a man-in-the-middle a%ack.

It is also possible that the RSA host key has just been changed:

The fingerprint for the RSA key sent by the remote host is

ab:7e:33:bd:85:50:5a:43:0b:e0:bd:43:3f:1c:a5:f8.

Please contact your system administrator.

Add correct host key in /.ssh/known_hosts to get rid of this

message.

Offending key in /.ssh/known_hosts:1

RSA host key for remhost has changed and you have requested strict

checking.

Host key verification failed.

If the host key has legi!mately changed, it can be removed from the ~/.ssh/known_hosts

ﬁle and the new ﬁngerprint added. If it has not changed legi!mately, this indicates a serious

problem that should be inves!gated immediately.

14.6.7. SSH tunnelled serial bridging

You can apply SSH tunneling when two Black Box console servers are conﬁgured for serial

bridging.

As detailed in chapter 3, the Server console server is setup in Console Server mode with either

RAW or RFC2217 enabled and the Client console server is set up in Serial Bridging Mode

with the Server Address, and Server TCP Port (4000 + port for RAW or 5000 + port # for

RFC2217) speciﬁed:

• Select SSH Tunnel when conﬁguring the Serial Bridging Se!ng.

Opengear User Manual. Page 322.

• set up SSH keys for each end of the tunnel and upload these keys to the Server and Client

console servers.

Client keys

The ﬁrst step in se$ng up ssh tunnels is to generate keys. Ideally, you will use a separate,

secure, machine to generate and store all keys to be used on the console servers. However, if

this is not ideal to your situa!on, keys may be generated on the console servers themselves.

It is possible to generate only one set of keys, and reuse them for every SSH session. While

this is not recommended, each organiza!on will need to balance the security of separate keys

against the addi!onal administra!on they bring.

Generated keys may be one of two types — RSA or DSA — and it is beyond the scope of this

document to recommend one over the other. RSA keys will go into the ﬁles id_rsa and

id_rsa.pub. DSA keys will be stored in the ﬁles id_dsa and id_dsa.pub.

For simplicity going forward the term private key will be used to refer to either id_rsa or

id_dsa and public key to refer to either id_rsa.pub or id_dsa.pub.

To generate the keys use the ssh-keygen program (part of the OpenSSH suite):

$ ssh-keygen -t [rsa|dsa]

Opengear User Manual. Page 323.

Generating public/private [rsa|dsa] key pair.

Enter file in which to save the key (/home/user/.ssh/id_[r|

dsa]):

Enter passphrase (empty for no passphrase):

Enter same passphrase again:

Your identification has been saved in /home/user/.ssh/id_[r|

dsa].

Your public key has been saved in /home/user/.ssh/id_[r|

dsa].pub.

The key fingerprint is:

28:aa:29:38:ba:40:f4:11:5e:3f:d4:fa:e5:36:14:d6 user@server

It is advisable to create a new directory to store your generated keys. It is also possible to

name the ﬁles a&er the device they will be used for. For example:

$ mkdir keys

$ ssh-keygen -t rsa

Generating public/private rsa key pair.

Enter file in which to save the key: ~/keys/control_room

Enter passphrase (empty for no passphrase):

Enter same passphrase again:

Your identification has been saved in ~/keys/control_room

Your public key has been saved in ~/keys/control_room.pub.

The key fingerprint is:

28:aa:29:38:ba:40:f4:11:5e:3f:d4:fa:e5:36:14:d6 user@server

There must be no password associated with the keys. If there is a password, Opengear

devices will have no way to supply it at run!me.

Authorized keys

If the console server selected to be the server has only one client device, the

authorized_keys ﬁle is simply a copy of the public key for that device.

If one or more devices will be clients of the console server, the authorized_keys ﬁle will contain

copies of all of the public keys.

RSA and DSA keys may be freely mixed in the authorized_keys ﬁle. For example, assume we

already have one server, called bridge_server, and two sets of keys, for the

control_room and the plant_entrance. The following commands 1) show the stored

keys and 2) combine two of them into a single ﬁle, authorized_keys_bridge_server.

$ ls /home/user/keys

control_room

control_room.pub

plant_entrance

plant_entrance.pub

$ cat ~/keys/control_room.pub ~/keys/plant_entrance.pub > ~/

keys/authorized_keys_bridge_server

Uploading keys

Opengear User Manual. Page 324.

The keys for the server can be uploaded through the web interface, on the System >

Administra"on page as detailed earlier. If only one client will be connec!ng, then simply

upload the appropriate public key as the authorized keys ﬁle. Otherwise, upload the

authorized keys ﬁle constructed in the previous step.

Each client will then need its own set of keys uploaded through the same page. Take care to

ensure that the correct type of keys (DSA or RSA) goes in the correct spots, and that the

public and private keys are in the correct spot.

14.6.8. SDT connector public key authen"ca"on

SDT Connector can authen!cate against a console server using your SSH key pair rather than

requiring your to enter your password (that is public key authen!ca!on).

To use public key authen!ca!on with SDT Connector, ﬁrst create an RSA or DSA key pair

(using ssh-keygen, PuTTYgen or a similar tool) and add the public part of your SSH key pair

to the console server.

Next, add the private part of your SSH key pair (this ﬁle is typically named id_rsa or

id_dsa) to the SDT Connector client:

• Navigate to Edit > Preferences > Private Keys > Add.

• Locate the private key ﬁle.

• Click OK.

You do not have to add the public part of your SSH key pair, it is calculated using the private

key.

SDT Connector will now use public key authen!ca!on when SSH-connec!ng through the

console server. You may have to restart SDT Connector to shut down any exis!ng tunnels that

were established using password authen!ca!on.

If you have a host behind the console server that you connect to by clicking the SSH bu%on in

SDT Connector, you can also conﬁgure it for public key authen!ca!on.

Essen!ally what you are using is SSH over SSH. The two SSH connec!ons are en!rely

separate, and the host conﬁgura!on is en!rely independent of SDT Connector and the console

server. You must conﬁgure the SSH client that SDT Connector launches (for example Pu%y or

OpenSSH) and the host’s SSH server for public key authen!ca!on.

14.7. Secure sockets layer (SSL) support

Secure Sockets Layer (SSL) is a protocol developed by Netscape for transmi$ng private

documents via the Internet. SSL works by using a private key to encrypt data that’s

transferred over the SSL connec!on.

The console server includes OpenSSL. The OpenSSL Project is a collabora!ve eﬀort to develop

a robust, commercial-grade, full-featured, and Open Source toolkit implemen!ng the Secure

Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1) protocols as well as a full-

strength general purpose cryptography library. The project is managed by a worldwide

community of volunteers that use the Internet to communicate, plan, and develop the

OpenSSL toolkit and its related documenta!on.

Opengear User Manual. Page 325.

OpenSSL is based on the Slay library developed by Eric A Young and Tim J Hudson. The

OpenSSL toolkit is licensed under an Apache-style license, which basically means that you are

free to get and use it for commercial and non-commercial purposes subject to some simple

license condi!ons. In the console server OpenSSL is used primarily in conjunc!on with https

in order to have secure browser access to the GUI management console across insecure

networks.

OpenSSL documenta!on is available at h%ps://openssl.org/docs/manmaster/apps/

openssl.html.

The OpenSSL project itself ‘highly recommends’ Ivan Ris!ć’s OpenSSL Cookbook, available as a

free download from h%ps://feistyduck.com/books/openssl-cookbook/.

14.8. HTTPS

The Management Console UI is served using HTTPS by the built in cherokee webserver.

If your default network address is changed or the unit is to be accessed via a known Domain

Name you can use the following steps to replace the default SSL Cer!ﬁcate and Private Key

with ones tailored for your new address.

14.8.1. Genera"ng an encryp"on key

To create a 1024 bit RSA key with a password issue the following command on the command

line of a linux host with the openssl u!lity installed:

# openssl genrsa -des3 -out ssl_key.pem 1024

14.8.2. Genera"ng a self-signed cer"ﬁcate with OpenSSL

This example shows how to use OpenSSL to create a self-signed cer!ﬁcate on a Linux- or

Unix-based system. OpenSSL ships as part of macOS and is available for most Linux

distribu!ons via the default package management mechanism.

The OpenSSL project ‘does not distribute any code in binary form, and does not oﬃcially

recommend any speciﬁc binary distribu!ons.’ The project does, however, maintain a page on

its community wiki: h%ps://wiki.openssl.org/index.php/Binaries.

This page lists 3rd-party binaries that are ‘stable and can provide con!nued support for

OpenSSL’. Windows users should check here for a suitable binary.

To create a 1024-bit RSA key and a self-signed cer!ﬁcate, issue the following command from

the host you have openssl installed on:

# openssl req -x509 -nodes -days 1000 -newkey rsa:1024 -keyout \

ssl_key.pem -out ssl_cert.pem

You will be prompted to enter a lot of informa!on. Most of it doesn't ma%er, but the Common

Name should be the domain name of your computer (for example, test.opengear.com).

When you have entered everything, the cer!ﬁcate will be created in a ﬁle called

ssl_cert.pem.

14.8.3. Installing the key & cer"ﬁcate

Opengear User Manual. Page 326.

The recommended method for copying ﬁles securely to the console server unit is with a

Secure Copying Protocol client (for example, the shell-based tool: scp).

The scp u!lity ships with macOS and ships with OpenSSH for most Linux distribu!ons.

Windows users can use something like the PSCP command line u!lity available with PuTTY.

The ﬁles created in the steps above can be installed remotely with the scp u!lity as follows:

# scp ssl_key.pem root@<address of unit>:/etc/config/

# scp ssl_cert.pem root@<address of unit>:/etc/config/

or, using PSCP:

pscp -scp ssl_key.pem root@<address of unit>:/etc/config/

pscp -scp ssl_cert.pem root@<address of unit>:/etc/config/

PuTTY and the PSCP u!lity can be downloaded from h%p://www.chiark.greenend.org.uk/

~sgtatham/pu%y/download.html.

Detailed documenta!on on PSCP can be found at h%ps://the.earth.li/~sgtatham/pu%y/0.67/

htmldoc/Chapter5.html.

14.8.4. Launching the HTTPS server

The easiest way to enable the HTTPS server is from the web Management Console.

• click the appropriate checkbox in Network > Services > HTTPS Server.

The HTTPS server will now be ac!vated (assuming ssl_key.pem and ssl_cert.pem

exist in the /etc/config/).

Alterna!vely, inetd can be conﬁgured to launch the secure fnord server from the

command line of the unit as follows.

• Edit the inetd conﬁgura!on ﬁle. From the unit command line:

# vi /etc/config/inetd.conf

• Append a line:

443 stream tcp nowait root sslwrap -cert /etc/config/ssl_cert.pem

-key /etc/config/ssl_key.pem -exec /bin/httpd /home/httpd"

• Save the ﬁle.

• Signal inetd of the conﬁgura!on change:

# kill -HUP `cat /var/run/inetd.pid`

The HTTPS server should now be accessible from a web client at a URL similar to this:

https://common-name-of-unit/.

14.9. Power strip control

The console server supports a growing list of remote power-control devices (RPCs) which can

be conﬁgured using the Management Console as described in chapter 7. These RPCs are

controlled using the open source PowerMan and Network UPS Tools and with Opengear’s

Opengear User Manual. Page 327.

pmpower u!lity.

14.9.1. the PowerMan tool

PowerMan provides power management in a data center or compute cluster environment. It

performs opera!ons such as power on, power oﬀ, and power cycle via remote power

controller (RPC) devices.

The powerman man page is not shipped with Opengear hardware. It is reproduced below.

Synopsis

powerman | pm [-options][targets]

For more details see h%p://linux.die.net/man/1/powerman.

op"ons

-1 --on

-0 --oﬀ

-c --cycle

-r --reset

-f --ﬂash

-u --unﬂash

-l --list

-q --query

-n --node

-b --beacon

-t --temp

-h --help

-L --license

-d --des!na!on

-V --version

-D --device

-T --telemetry

-x --exprange

notes regarding targets

power on targets.

power oﬀ targets.

Power cycle targets.

Assert hardware reset for targets (if implemented by RPC).

Turn beacon on for targets (if implemented by RPC).

Turn beacon oﬀ for targets (if implemented by RPC).

List available targets. If possible, output will be compressed into a host

range (see target speciﬁca"on below).

Query plug status of targets. If none speciﬁed, query all targets. Status is not

cached; each !me this op!on is used, powerman queries the appropriate

RPC's. Targets connected to RPC's that could not be contacted (e.g. due to

network failure) are reported as status "unknown". If possible, output will be

compressed into host ranges.

Query node power status of targets (if implemented by RPC). If no targets

speciﬁed, query all targets. In this context, a node in the oﬀ state could be

on at the plug but opera!ng in standby power mode.

Query beacon status (if implemented by RPC). If no targets are speciﬁed,

query all targets.

Query node temperature (if implemented by RPC). If no targets are

speciﬁed, query all targets. Temperature informa!on is not interpreted by

powerman and is reported as received from the RPC on one line per target,

preﬁxed by target name.

Display op!on summary.

Show powerman license informa!on.

host[:port]. Connect to a powerman daemon on non-default host and

op!onally port.

Display the powerman version number and exit.

Displays RPC status informa!on. If targets are speciﬁed, only RPC's

matching the target list is displayed.

Causes RPC telemetry informa!on to be displayed as commands are

processed. Useful for debugging device scripts.

Expand host ranges in query responses.

Opengear User Manual. Page 328.

Target speciﬁca"on

powerman target hostnames may be speciﬁed as comma separated or space separated

hostnames or host ranges.

Host ranges are of the general form:

prefix[n-m,l-k,...]

where n < m and l < k, etc.

This form should not be confused with regular expression character classes, which are also

denoted by []. For example, foo[19] does not represent foo1 or foo9, but rather

represents a degenerate range: foo19.

This range syntax is meant only as a convenience on clusters with a preﬁx NN naming

conven!on and speciﬁca!on of ranges should not be considered necessary -- the list

foo1,foo9 could be speciﬁed as such, or by the range foo[1,9].

Some examples of powerman targets follow.

Power on hosts bar,baz,foo01,foo02,...,foo05: powerman --on bar baz foo[01-05]

Power on hosts bar,foo7,foo9,foo10: powerman --on bar,foo[7,9-10]

Power on foo0,foo4,foo5: powerman --on foo[0,4-5]

As a reminder to the reader, some shells will interpret brackets — [ and ] — for pa%ern

matching. Depending on your shell, it may be necessary to enclose ranged lists within quotes.

For example, in tcsh, the last example above should be executed as:

powerman --on "foo[0,4-5]"

14.9.2. The pmpower tool

The pmpower u!lity is a high level tool for manipula!ng remote preconﬁgured power devices

connected to the console server either via a serial or network connec!on. The PDU UPS and

IPMI power devices are variously controlled using the open source PowerMan, IPMItool or

Network UPS Tools and Opengear’s pmpower u!lity arches over these tools so the devices

can be controlled through the one command line:

Synopsis

pmpower [-?h] [-l device | -r host] [-o outlet] [-u username]\

[-p password] action

op"ons

-? -h

-o

-r

-u

-p

oﬀ

notes

This help message.

The serial port to use.

The outlet on the power target to apply to.

The remote host address for the power target

Override the conﬁgured username.

Override the conﬁgured password.

This ac"on switches the speciﬁed device or outlet(s) on.

This ac"on switches the speciﬁed device or outlet(s) oﬀ.

Opengear User Manual. Page 329.

Examples:

To turn outlet 4 of the power device connected to serial port 2 on:

# pmpower -l port02 -o 4 on

To turn an IPMI device oﬀ located at IP address 192.168.1.100 where the username is root

and the password is calvin:

# pmpower -r 192.168.1.100 -u root -p calvin off

Default system Power Device ac!ons are speciﬁed in /etc/powerstrips.xml.

Custom Power Devices can be added in /etc/config/powerstrips.xml. If an ac!on is

a%empted which has not been conﬁgured for a speciﬁc Power Device pmpower will exit with

an error.

14.9.3. Adding new RPC devices

There are a number of simple paths to adding support for new RPC devices.

The ﬁrst is to have scripts to support the par!cular RPC included in either the open source

PowerMan project — h%ps://code.google.com/archive/p/powerman/ — or the open source

NUT UPS Tools project — h%p://networkupstools.org/.

The PowerMan device speciﬁca!ons are rather weird and it is suggested that you leave the

actual wri!ng of these scripts to the PowerMan authors. However documenta!on on how

they work can be found at h%p://linux.die.net/man/5/powerman.dev. The Network UPS Tools

(NUT) project has moved on from its UPS management origins to also cover SNMP PDUs (and

embrace PowerMan). Opengear progressively includes the updated PowerMan and NUT build

into the console server ﬁrmware releases.

The second path is to directly add support for the new RPC devices (or to customize the

exis!ng RPC device support) on your par!cular console server. The Manage > Power page

uses informa!on contained in /etc/powerstrips.xml to conﬁgure and control devices

a%ached to a serial port. The conﬁgura!on also looks for (and loads) /etc/config/

powerstrips.xml if it exists.

You can add support for more devices by pu$ng deﬁni!ons for them into /etc/config/

powerstrips.xml. This ﬁle can be created on a host system and copied to the

Management Console device using scp. Alterna!vely, login to the Management Console and

use ftp or wget to transfer ﬁles.

Here is a brief descrip!on of the elements of the XML entries in /etc/config/

powerstrips.xml.

<id>Name or ID of the device support</id>

<outlet port="port-id-1">Display Port 1 in menu</outlet>

<outlet port="port-id-2">Display Port 2 in menu</outlet>

...

<on>script to turn power on</on>

cycle

status

This ac"on switches the speciﬁed device or outlet(s) oﬀ and on again.

This ac"on retrieves the current status of the device or outlet.

Opengear User Manual. Page 330.

<off>script to power off</off>

<cycle>script to cycle power</cycle>

<status>script to write power status to

/var/run/power-status</status>

<charsize>character size</charsize>

<parity>parity setting</parity>

</powerstrip>

The id appears on the web page in the list of available devices types to conﬁgure.

The outlets describe targets that the scripts can control. For example a power control board

may control several diﬀerent outlets. The port-id is the na!ve name for iden!fying the

outlet. This value will be passed to the scripts in the environment variable outlet, allowing the

script to address the correct outlet.

There are four possible scripts: on, off, cycle and status.

When a script is run, it’s standard input and output is redirected to the appropriate serial port.

The script receives the outlet and port in the outlet and port environment variables

respec!vely.

The script can be anything that can be executed within the shell.

All of the exis!ng scripts in /etc/powerstrips.xml use the pmchat u!lity.

pmchat works just like the standard unix chat program, only it ensures interopera!on with

the port manager.

The ﬁnal op!ons, speed, charsize, stop and parity deﬁne the recommended or default

se$ngs for the a%ached device.

14.10. IPMItool

The console server includes the ipmitool u!lity for managing and conﬁguring devices that

support the Intelligent Pla*orm Management Interface (IPMI) versions 1.5 and 2.0.

IPMI is an open standard for monitoring, logging, recovery, inventory, and control of hardware

that is implemented independent of the main CPU, BIOS, and OS. The service processor (or

Baseboard Management Controller, BMC) is the brain behind pla*orm management and its

primary purpose is to handle the autonomous sensor monitoring and event logging features.

The ipmitool program provides a simple command-line interface to this BMC. It features

the ability to read sensor data repository (SDR) and print sensor values, display the contents

of the System Event Log (SEL), print Field Replaceable Unit (FRU) inventory informa!on, read

and set LAN conﬁgura!on parameters, and perform remote chassis power control.

The ipmitools man page is not shipped with Opengear hardware. It is reproduced below.

Synopsis

ipmitool [-c|-h|-v|-V] -I open <command>

ipmitool [-c|-h|-v|-V] -I lan -H <hostname>

[-p <port>]

Opengear User Manual. Page 331.

[-U <username>]

[-A <authtype>]

[-L <privlvl>]

[-a|-E|-P|-f <password>]

[-o <oemtype>]

ipmitool [-c|-h|-v|-V] -I lanplus -H <hostname>

[-p <port>]

[-U <username>]

[-L <privlvl>]

[-a|-E|-P|-f <password>]

[-o <oemtype>]

[-C <ciphersuite>]

Descrip"on

This program lets you manage Intelligent Pla*orm Management Interface (IPMI) func!ons of

either the local system, via a kernel device driver, or a remote system, using IPMI V1.5 and

IPMI v2.0. These func!ons include prin!ng FRU informa!on, LAN conﬁgura!on, sensor

readings, and remote chassis power control.

IPMI management of a local system interface requires a compa!ble IPMI kernel driver to be

installed and conﬁgured. On Linux this driver is called OpenIPMI and it is included in standard

distribu!ons. On Solaris this driver is called BMC and is included in Solaris 10. Management

of a remote sta!on requires the IPMI-over-LAN interface to be enabled and conﬁgured.

Depending on the par!cular requirements of each system it may be possible to enable the

LAN interface using ipmitool over the system interface.

Op"ons

op"on

-a

-A

-c

-C

-E

-f

-h

-H

variable

<password_ﬁle>

notes

Prompt for the remote server password.

Present output in CSV (comma separated variable) format. This is

not available with all commands.

The remote server authen!ca!on, integrity, and encryp!on

algorithms to use for IPMIv2 lanplus connec!ons. See table 22-19

in the IPMIv2 speciﬁca!on. The default is 3 which speciﬁes RAKP-

HMAC-SHA1 authen!ca!on, HMAC-SHA1-96 integrity, and AES-

CBC-128 encryp!on algorithms.

The remote server password is speciﬁed by the environment

variable IPMI_PASSWORD.

Speciﬁes a ﬁle containing the remote server password. If this

op!on is absent, or if password_ﬁle is empty, the password will

default to NULL.

Get basic usage help from the command line.

Remote server address, can be IP address or hostname. This op!on

is required for lan and lanplus interfaces.

Opengear User Manual. Page 332.

If no password method is speciﬁed then ipmitool will prompt the user for a password. If no

password is entered at the prompt, the remote server password will default to NULL.

Security

The ipmitool documenta!on highlights that there are several security issues to be

considered before enabling the IPMI LAN interface. A remote sta!on has the ability to control

a system's power state as well as being able to gather certain pla*orm informa!on. To reduce

vulnerability it is strongly advised that the IPMI LAN interface only be enabled in 'trusted'

environments where system security is not an issue or where there is a dedicated secure

'management network' or access has been provided through an console server.

Further it is strongly advised that not enable IPMI for remote access without se$ng a

password. That that password should not be the same as any other password on that system.

When an IPMI password is changed on a remote machine with the IPMIv1.5 lan interface the

new password is sent across the network as clear text. This could be observed and then used

to a%ack the remote system. It is thus recommended that IPMI password management only

be done over IPMIv2.0 lanplus interface or the system interface on the local sta!on.

For IPMI v1.5, the maximum password length is 16 characters. Longer passwords are

truncated. For IPMI v2.0, the maximum password length is 20 characters. Longer passwords

are truncated.

Commands

-I

-L

-m

-o

-p

-P

-t

-U

-v

-V

<local_address>

<port>

<target_address>

Selects IPMI interface to use. Supported interfaces that are

compiled in are visible in the usage help output.

Force session privilege level. Can be CALLBACK, USER,

OPERATOR, and ADMIN. Default is ADMIN.

Set the local IPMB address. The default is 0x20 and there should

be no need to change it for normal opera!on.

Select OEM type to support. This usually involves minor hacks in

place in the code to work around quirks in various BMCs from

various manufacturers. Use -o list to see a list of current supported

OEM types.

Remote server UDP port to connect to. Default is 623.

Remote server password is speciﬁed on the command line. If

supported it will be obscured in the process list. Note! Specifying

the password as a command line op!on is not recommended.

Bridge IPMI requests to the remote target address.

Remote server username, default is NULL user.

Increase verbose output level. This op!on may be speciﬁed

mul!ple !mes to increase the level of debug output. If given three

!mes you will get hexdumps of all incoming and outgoing packets.

Display version informa!on.

command

help

raw

notes

This can be used to get command-line help on ipmitool commands. It may also be

placed at the end of commands to get op!on usage help.

Send a RAW IPMI request and print response

Opengear User Manual. Page 333.

*chassis commands: status, power, iden!fy, policy, restart_cause, poh, bootdev.

chassis power commands: status, on, oﬀ, cycle, reset, diag, so&.

More details on ipmitools are availalbe at the project site, h%ps://sourceforge.net/projects/

ipmitool/.

14.11. Custom development kit (CDK)

As detailed in this manual, customers can copy scripts, binaries and conﬁgura!on ﬁles directly

to the console server.

Opengear also freely provides a development kit which allows changes to be made to the

so&ware in console server ﬁrmware image. The customer can use the CDK to:

• generate a ﬁrmware image without certain programs, such as telnet, which may be

banned by company policy.

• generate an image with new programs, such as custom Nagios plug-in binaries or company

speciﬁc binary u!li!es.

• generate an image with custom defaults e.g. it may be required that the console server be

conﬁgured to have a speciﬁc default serial port proﬁle which is reverted to even in event of

a factory reset

• place conﬁgura!on ﬁles into the ﬁrmware image, which cannot then be modiﬁed.

For example

# /bin/config –-set= tools

updates the conﬁgura!on ﬁles in /etc/config which are read/write, whereas the ﬁles

in /etc are read only and cannot be modiﬁed.

The CDK essen!ally provides a snapshot of the Opengear build process (taken a&er the

programs have been compiled and copied to a temporary directory, romfs) just before the

lan

chassis*

event

sdr

sensor

fru

sel

pef

sol

isol

user

channel

session

exec

set

Conﬁgure LAN Channels

Get chassis status and set power state

Send pre-deﬁned events to MC

Management Controller status and global enables

Print Sensor Data Repository entries and readings

Print detailed sensor informa!on

Print built-in FRU and scan SDR for FRU locators

Print System Event Log (SEL)

Conﬁgure Pla*orm Event Filtering (PEF)

Conﬁgure IPMIv2.0 Serial-over-LAN

Conﬁgure IPMIv1.5 Serial-over-LAN

Conﬁgure Management Controller users

Conﬁgure Management Controller channels

Print session informa!on

Run list of commands from ﬁle

Set run!me variable for shell and exec

Opengear User Manual. Page 334.

compressed ﬁle systems are generated.

You can obtain a copy of the Opengear CDK for the par!cular appliance you are working with

from &p://&p.opengear.com/cdk. Further informa!on is avalable at h%p://opengear.com/

faq284.html.

Note: the CDK is free, however Opengear does not provide free technical support for systems

modiﬁed using the CDK and any changes are the responsibility of the user.

14.12. Scripts for managing slaves

When the console servers are cascaded the Master is in control of the serial ports on the

Slaves, and the Master’s Management Console provides a consolidated view of the se$ngs

for its own and all the Slave’s serial ports.

However the Master does not provide a fully consolidated view. Status > Ac"ve Users only

displays those users ac!ve on the Master’s ports. You will need to write a custom bash script

that parses the port logs if you want to ﬁnd out who’s logged in to cascaded serial ports from

the master.

You will probably also want to enable remote or USB logging, as local logs only buﬀer 8K of

data and don’t persist between reboots.

This script would, for example, parse each port log ﬁle line by line

Each !me it sees LOGIN: username, it adds username to the list of connected users for

that port. Each !me it sees LOGOUT: username, it removes it from the list.

The list can then be nicely forma%ed and displayed. It’s also possible to run this as a CGI

script on the remote log server.

To enable log storage and connec!on logging:

• select Alerts & Logging > Port Log.

• conﬁgure log storage.

• select Serial & Network > Serial Port.

• Edit the serial port(s).

• Under Console Server, select Logging Level 1.

• click Apply.

Note: a useful tutorial on crea#ng a bash script CGI is at h"p://yolinux.com/TUTORIALS/

LinuxTutorialCgiShellScript.html.

Similarly the Master maintains a view of the status of the slaves:

• select Status > Support Report.

• scroll down to Processes.

• look for /bin/ssh -MN -o ControlPath=/var/run/cascade/%h slavename.

These are the slaves that are connected

Note: the end of the Slaves’ names will be truncated, so the ﬁrst 5 characters must be unique

Opengear User Manual. Page 335.

Alterna!vely, you can write a custom CGI script as described above. The currently connected

Slaves can be determined by running ls /var/run/cascade and the conﬁgured slaves can

be displayed by running config -g config.cascade.slaves.

14.13. SMS server tools

Firmware releases v3.1 and later include the SMS Server Tools so&ware which provides an

SMS Gateway which can send and receive short messages through GSM modems and mobile

phones.

You can send short messages by simply storing text ﬁles into a special spool directory. The

program monitors this directory and sends new ﬁles automa!cally. It also stores received

short messages into another directory as text ﬁles. Binary messages (including Unicode text)

are also supported, for example ring tone messages. It's also possible to send a WAP Push

message to a WAP- or MMS-capable mobile phone.

The program can be run as an SMS daemon which can be started automa!cally when the

opera!ng system starts. High availability can be ensured by using mul!ple GSM devices

(currently up to 64).

The program can run other external programs or scripts a&er events like recep!on of a new

message, successful sending and also when the program detects a problem. These programs

can inspect the related text ﬁles and perform automa!c ac!ons

The SMS Server Tools so&ware needs a GSM modem (or mobile phone) with SMS command

set according to the European speciﬁca!ons

GSM 07.05 (=ETSI TS 300 585) and GSM 03.38 (=ETSI TS 100 900).

The AT command set is supported. Devices can be connected with serial port, infrared or

USB.

For more informa!on see h%p://smstools3.kekekasvi.com/ or the online Opengear FAQ.

14.14. Mul"cast

By default, all Opengear console servers come with Mul!cas!ng enabled. Mul!cas!ng

provides Opengear products with the ability to simultaneously transmit informa!on from a

single device to a select group of hosts.

With ﬁrmware releases v3.1 and later, mul!cas!ng can be disabled and re-enabled from the

command line. To disable mul!cas!ng type:

ifconfig eth0 -multicast

To re-enable mul!cas!ng from the command line type:

ifconfig eth0 multicast

IPv6 may need to be restarted when toggling between mul!cast states.

14.15. Bulk provisioning

Opengear appliances include wizard scripts to facilitate conﬁgura!on and deployment en

masse. These wizards operate at the command line level, so knowledge of the Linux command

Opengear User Manual. Page 336.

line and shell scrip!ng is useful, but not necessary – they aim to be user-friendly enough for

remote hands to manage. This bulk provisioning feature is supported by ﬁrmware version

3.9.1 or later, and Lighthouse version 4.4.0 and later (op!onal).

Both the bulk provisioning of Opengear appliances and bulk enrollment of these appliances

into Lighthouse central management system(s) is supported. These features may be used

separately or in conjunc!on.

Using this method, an Opengear appliance can be fully conﬁgured and enrolled into

Lighthouse with minimal interac!on, in under 5 minutes. The basic steps are:

• Conﬁgure an individual golden master appliance with the baseline conﬁgura!on shared by

all Opengear appliances. This may be a minimal conﬁgura!on if the installs are quite

diverse, or a complete conﬁgura!on when dealing with replicated installs.

• Use make-template to turn the golden master’s ac!ve conﬁgura!on into a template

conﬁgura!on that may be applied to other appliances.

• Create an OPG backup of the templated golden master appliance.

• Restore this conﬁgura!on to each target devices via the CLI, web UI or using a USB thumb

drive.

• Login via the CLI to complete conﬁgura!on using setup-wizard.

•(Op!onal) On Lighthouse, use enrollment-wizard to automa!cally place appliances under

management. This may be local/routable appliances, or remote appliances that have

automa!cally Call Home using callhome-wizard.

Steps 5 and 6 may be reversed for remote setup via Lighthouse.

Full details for the above steps can be found in the Knowledge Base

14.16. Zero touch provisioning

Zero Touch Provisioning (ZTP) was introduced with ﬁrmware release 3.15.1 to allow

Opengear appliances to be provisioned during their ini!al boot from a DHCP server.

14.16.1.Prepara"on

These are typical steps for conﬁgura!on over a trusted network:

• Conﬁgure a same-model Opengear device.

•Op!onally use the Bulk Provisioning wizard scripts to remove any appliance-speciﬁc se$ngs

(that is, create a template conﬁgura!on) and/or prepare the conﬁgura!on for automated

Lighthouse enrollment. See chapter 14.15.

• Save the conﬁgura!on as an Opengear backup (.opg) ﬁle under System > Conﬁgura"on

Backup in the web UI, or via config -e in the CLI.

Alterna!vely, you can save the XML conﬁgura!on as a ﬁle ending in .xml.

• Publish the .opg or .xml ﬁle on a ﬁleserver that understands one of the HTTPS, HTTP,

FTP or TFTP protocols.

• Conﬁgure your DHCP server to include a vendor speciﬁc op!on for Opengear devices. The

Opengear User Manual. Page 337.

op!on text should be a URL to the loca!on of the .opg or .xml ﬁle. The op!on text

should not exceed 250 characters in length. It must end in either .opg or .xml.

• Connect a new Opengear device (either at defaults from the factory, or conﬁg erased) to

the network and apply power.

Note: it may take up to 5 minutes for the device to ﬁnd the .opg or .xml ﬁle via DHCP, download,

install the ﬁle and reboot itself.

14.16.2.Example ISC DHCP server conﬁgura"on

The following is an example ISC DHCP server conﬁgura!on fragment for serving an .opg

conﬁgura!on image:

option space opengear code width 1 length width 1;

option opengear.config-url code 1 = text;

class "opengear-ztp" {

match if option vendor-class-identifier ~~ "^Opengear/";

vendor-option-space opengear;

option opengear.config-url "https://example.com/opg/$

{class}.opg";

}

For other DHCP servers, please consult their documenta!on on specifying vendor speciﬁc

op!on ﬁelds.

We use sub-op!on 1 to hold the URL text.

14.16.3.Setup for an untrusted LAN

If network security is a concern, and you can have remote hands insert a trusted USB ﬂash

drive into the Opengear device during provisioning, then follows are a summary of the steps

required for deploying conﬁgura!on in an untrusted network:

• Generate an X.509 cer!ﬁcate for the client. Place it and its private key ﬁle onto a USB ﬂash

drive (concatenated as a single ﬁle, client.pem).

• Set up a HTTPS server that restricts access to the .opg or .xml ﬁle for HTTPS onnec!ons

providing the client cer!ﬁcate.

• Put a copy of the CA cert (that signed the HTTP server's cer!ﬁcate) onto the USB ﬂash

drive as well (ca-bundle.crt).

• Insert the USB ﬂash drive into the Opengear device before a$aching power or network.

• Con!nue with the steps above, but using only an h%ps URL.

14.16.4.How it works

This sec!on explains in detail how the Opengear device uses DHCP to obtain its ini!al

conﬁgura!on.

First, an Opengear console manager is either conﬁgured or unconﬁgured. ZTP needs it to be

in an unconﬁgured state, which is only obtained in the following ways:

Opengear User Manual. Page 338.

• Firmware programming at factory.

• Pressing the Conﬁg Erase bu%on twice during opera!on.

• Selec!ng Conﬁg Erase under System > Administra"on in the web UI, and reboo!ng.

• Crea!ng the ﬁle /etc/config/.init and then reboo!ng.

When an unconﬁgured Opengear device boots, it performs these steps to ﬁnd a

conﬁgura!on:

• the Opengear device transmits a DHCP DISCOVER request onto its primary Network

Interface (WAN).

This DHCP request carries a Vendor Class Iden!ﬁer of the form Opengear/model-name

(for example, Opengear/ACM5003-M) and its parameter request list will include op!on 43

(Vendor-Speciﬁc Informa!on).

• On receipt of a DHCP OFFER, the device will use the informa!on in the oﬀer to assign an

IPv4 address to its primary Network Interface, add a default route, and prepare its DNS

resolver.

• If the oﬀer also contained an op!on 43 with sub-op!on 1, the device interprets the sub-

op!on as a whitespace-separated list of URLs to conﬁgura!on ﬁles to try to restore.

• If an NTP server op!on was provided in the DHCP oﬀer, the system clock is synchronized

with the NTP server.

• The system now searches all a%ached USB storage devices for two op!onal cer!ﬁcate

ﬁles. The ﬁrst ﬁle is named ca-bundle.crt and the second one is whichever one of the

following ﬁlenames is found ﬁrst:

• If both ﬁles — ca-bundle.crt and client*.pem — are found, then secure mode is

enabled for the next sec!on.

Each URL in the list obtained from op!on 43 sub-op!on 1 is tried in sequence un!l one

succeeds:

• the URL undergoes substring replacement from the following table:

• the resul!ng URL must end in .opg or .xml (an op!onal ?query-string is permi%ed).

If is doesn’t, it is skipped and the next URL is tried.

ﬁle-name

client-aabbccddeeﬀ.pem

client-model.pem

client.pem

notes

aabbccddeeﬀ is the MAC address of the primary network

interface.

model is the (vendor class) model name in lowercase.

sub-string

${mac}

${model}

${class}

${version}

replaced by

the 12-digit MAC address of the device.

the full model name, in lowercase.

the ﬁrmware hardware class.

the ﬁrmware version number.

example

0013b600b669

acm5504-5-g-w-i

ACM550x

3.15.1

Opengear User Manual. Page 339.

• in secure mode, the URL must use the h%ps scheme or it is skipped.

• otherwise the available schemes are: h%p, h%ps, *tp, &p, and &ps.

• The curl program is used to download the URL.

• In secure mode, the server’s cer!ﬁcate must validate against the ca-bundle.crt.

The (required) client.pem ﬁle is provided to authen!cate the client to the server. See

the curl documenta!on for the format of these ﬁles.

• The URL is downloaded.

For .opg ﬁles, its header is checked to see if it is compa!ble with the current device.

For .xml ﬁles, a parse check is made. If the check fails, the downloaded ﬁle is abandoned

and the next URL is tried.

• The ﬁle is imported into the current conﬁgura!on.

• The system checks to see if a hostname has been set in the conﬁg. If not, it is set to $

{model}-${mac}.

• The system checks to see if it is s!ll in an unconﬁgured state. If it is, then the network

interface mode is set to DHCP. This eﬀec!vely forces the system into a conﬁgured state,

preven!ng a future reboot loop.

• The system reboots.

Note: If all the URLs were skipped or failed, the system will wait for 30 seconds before retrying

again. It will retry all the URLs up to 10 #mes. A(er the 10th retry, the system reboots. If the

system has been manually conﬁgured in the mean#me, the retries stop and ZTP is disabled.

Note: Note: If no op#on 43 is received over DHCP, no URLs are downloaded and no reboots occur:

the system must be manually conﬁgured. Once conﬁgured (manually or by ZTP), an

Opengear will no longer request op#on 43 from the DHCP server, and it will ignore any

op#on 43 conﬁgura#on URLs presented to it.

14.17. Internal storage

Some models have an internal USB ﬂash drive, a non-vola!le NAND ﬂash par!!on, or both,

which can be used by portmanager for log storage and the TFTP/FTP server for ﬁle storage.

These storage devices are automa!cally mounted as subdirectories of /var/mnt/. The default

directory served by FTP or TFTP is set to the preferred internal storage (if any), otherwise the

ﬁrst detected a%ached USB storage. The loca!on of portmanager logs must be manually

conﬁgured.

14.17.1.Filesystem loca"on of FTP & TFTP directory

product

ACM7000

CM7100

IM7200

ACM5500

preferred storage

internal ﬂash

internal USB ﬂash

Table of Contents

Opengear IM7200 User Manual

Related Manuals