Opengear Lighthouse User Manual

Lighthouse

User Guide

Revision 2020.Q4.0

2021-1-8

Lighthouse User Guide

TABLE OF CONTENTS

1. About this User Guide 7

GLOSSARY 7

2. Lighthouse overview 10

2.1 Lighthouse VM host requirements 10

2.2 Lighthouse architecture 10

2.2.1 Lighthouse to Node interactions 11

2.2.2 User to Lighthouse interactions 11

2.2.3 Node organization and filtering 12

2.2.4 Multiple Instance Feature 12

3. Lighthouse VM installation 13

3.1 Lighthouse VM components 13

3.2 VMware vSphere 6.0 via the VMware vSphere 6.0 client on Windows 13

3.2.1 Launch the vSphere Client and connect to a vSphere instance. 14

3.2.2 Import the Lighthouse VM Open Volume Format (.ovf) image 14

3.2.3 Launch the Opengear Lighthouse virtual machine 15

3.2.4 Access the console of a running but headless Opengear Lighthouse instance 16

3.3 VMware Workstation Player on Windows as host 16

3.4 VMware Workstation Pro on Windows as host 17

3.5 VMware Workstation Player or Pro on Fedora Workstation as host 18

3.6 Local deployment on Hyper-V running on Windows 10/Windows Server 2016 18

3.7 Remote Hyper-V deployment with pre-authenticated user 18

3.8 Remote Hyper-V deployment with different user 19

3.9 VirtualBox on Windows as host 19

3.10 VirtualBox on macOS as host 20

3.11 VirtualBox on Ubuntu as host 21

3.12 VirtualBox on Fedora Workstation as host 22

3.13 Virtual Machine Manager (KVM) on Ubuntu as host 23

3.14 Boxes on Fedora Workstation as host 23

3.15 Boxes on CentOS as host 24

3.16 Azure environment 24

3.17 Amazon Web Services (AWS) environment 25

4. First boot of the Lighthouse VM 28

5. Initial system configuration 30

5.1 Lighthouse IP addressing 30

5.2 Loading Lighthouse 30

5.3 Login to Lighthouse 31

Lighthouse User Guide

5.4 Network connections 33

5.5 Setting the Lighthouse hostname 34

5.6 Adding external IP addresses manually 34

5.7 Setting the Lighthouse internal clock 35

5.8 Examine or modify the Lighthouse SSL certificate 36

5.9 Examine or modify Lighthouse Session Settings 37

5.10 Examine or change the MTU of the Lighthouse VPN tunnel 38

5.11 Enable or modify SNMP Service 38

5.12 Cellular Health Settings 39

5.13 Lighthouse MIBs 39

6. Shut Down or Restart Lighthouse 50

6.1 Shut down a running Lighthouse instance 50

6.2 Restarting a running Lighthouse instance 50

7. Using Lighthouse 50

7.1 Licensing third-party nodes before enrollment 51

7.1.1 Adding a license using the Lighthouse UI 51

7.1.2 Showing installed licenses in the Lighthouse UI 51

7.1.3 Showing installed licenses via the Local Terminal 52

7.2 Enrolling nodes 53

7.2.1 Enrollment overview 53

7.2.2 Enrollment bundles 53

7.2.3 Creating an enrollment bundle 54

7.2.4 Structure of an enrollment bundle 55

7.2.5 Enrollment via Lighthouse Web UI 56

7.2.6 Enrollment via Node Web UI 58

7.2.7 Lighthouse Enrollment via OM, ACM, CM, and IM Web UI 58

7.2.8 Mass Enrollment using ZTP 58

7.2.9 Enrollment via USB drive 59

7.3 The Enrolled Nodes page 60

7.4 Filtering pages displaying nodes 61

7.4.1 Filtering using the Free Text Search field 62

7.4.2 Filtering using the Smart Group Filtering drop-down menu 62

7.4.3 Filtering using the Managed Device Filtering drop-down menu 63

7.5 Creating Smart Groups 64

7.6 Editing an existing Smart Group 65

7.7 Creating Managed Device Filters 66

7.8 Editing an existing Managed Device Filter 66

7.9 Connecting to a node’s web-management interface 67

7.10 Connecting to a node’s serial ports via Console Gateway 68

7.10.1 Access via HTML5 Web Terminal 69

7.10.2 Access via SSH 69

7.10.3 Example Console Gateway session 71

Lighthouse User Guide

8. Lighthouse user management 72

8.1 Password fields in Lighthouse 72

8.2 Creating new groups and roles 72

8.3 Modifying existing groups 78

8.4 Use an existing group as a template for a new group 79

8.5 Creating new local users 80

8.6 Modifying existing users 81

8.7 Expire user password 82

8.8 Setting password policy 83

8.9 Deleting users 84

8.10 Disabling a Lighthouse root user 84

8.11 Configuring AAA 84

8.11.1 LDAP Configuration 85

8.11.2 RADIUS configuration 86

8.11.3 TACACS+ configuration 87

8.12 Setting login restrictions 88

9. Notifications 90

10. Lighthouse central configuration 93

10.1 Creating new users and groups templates 93

10.2 Modifying existing users and groups templates 95

10.3 Deleting users or groups from a template 96

10.4 Deleting users and groups templates 96

10.5 Creating new authentication templates 96

10.6 Modifying existing authentication templates 97

10.7 Deleting authentication templates 98

10.8 Creating new script templates 98

10.9 Modifying existing script templates 99

10.10 Deleting script templates 100

10.11 Apply Templates 100

10.12 Manually Activate Secure Provisioning or Software Defined Infrastructure via Template 102

11. Multiple Instance 104

11.1 Licensing 104

11.2 Setting up a multiple instance 104

11.3 Multiple instance configuration 106

11.4 Disconnecting a secondary instance 108

11.5 Promoting a secondary instance 108

Lighthouse User Guide

11.6 Upgrading a multiple instance Lighthouse 109

12. Command line tools 110

12.1 node-info 110

12.2 node-upgrade 111

12.3 ogadduser 112

12.4 ogconfig-cli 113

12.4.1 Commands to try from within the ogconfig-cli tool 113

12.4.2 Config searches using ogconfig-cli 113

12.4.3 Changing a configuration from within ogconfig-cli 113

12.4.4 Configuration validation from within ogconfig-cli 114

12.4.5 Modify LHVPN keepalive timeout for different sized deployments with ogconfig-cli 114

12.4.6 Support for mounting the hard disks with ogconfig-cli 114

12.4.7 Support for multiple instance Lighthouse with ogconfig-cli 115

12.5 oglicdump 115

12.6 cron 116

12.7 sysflash 117

12.8 Selecting nodes using shell-based tools 117

12.8.1 Select all nodes 117

12.8.2 Running commands on selected nodes 117

12.9 Add a custom 2nd NIC to a Lighthouse instance 118

13. Lighthouse CLI and REST API logging 121

13.1 Logging overview and limitations 121

13.2 Using ogconfig-cli to enable logging 121

13.3 Example logs 122

13.4 Checking if logging is enabled 122

13.5 Enable logging 123

13.6 Disable logging 123

14. System upgrades 124

14.1 Upgrading the system from within Lighthouse 125

14.2 Upgrading the Lighthouse system via the Local Terminal 126

15. Adding Extra Disk Space to Lighthouse 127

15.1 Adding a New Disk 127

15.2 Using the new disk to increase the lh_data logical volume 129

16. Troubleshooting 130

16.1 Finding the current Lighthouse instance version 130

16.1.1 Using the web UI 130

16.1.2 Via the local Lighthouse shell 130

16.1.3 Other information sources related to a Lighthouse instance’s version 131

16.2 Technical support reports 131

Lighthouse User Guide

16.2.1 Generate a support report via the Lighthouse interface 131

16.2.2 Generate a support report via the local terminal 132

16.3 Configuration Backup 133

16.4 Configuration Restore 134

16.5 Returning a Lighthouse instance to factory settings 135

18. Changing Docker IP Ranges 136

18. EULA and GPL 138

TERM

DEFINITION

AUTHDOWNLOCAL (RADIUS/LDAP/AAA)

When this authentication option is selected, if remote authentication fails because the user does not exist on the remote AAA server, the user is denied access.

AUTHLOCAL (RADIUS/LDAP/AAA)

When this authentication option is selected, if remote authentication fails because the user does not exist on the remote AAA server, Lighthouse tries to authenticate the user using a local account.

CELLULAR HEALTH

Status of the cellular connection of a node.

DARK MODE

Changes the user interface to display mostly dark colors, reducing the light emitted by device screens.

DOCKER

An open platform for developing, shipping, and running applications. Docker enables you to separate your applications from your infrastructure so you can deliver software quickly.

Docker powers the NetOps platform within the Lighthouse product.

ENROLLMENT

Connecting a node to Lighthouse

ENROLLMENT BUNDLE

Used to assign a number of tags to a set of nodes when they are enrolled. During enrollment, the bundle is specified using its name, and a bundle-specific enrollment token.

ENROLLED NODE

Node that has been connected to Lighthouse and is ready for use.

ENROLLMENT TOKEN

A password that authorizes the node with Lighthouse. Used when performing Node-based, or ZTP enrollment.

INSTANCE

A single running Lighthouse.

LIGHT MODE

Changes the user interface to display mostly light colors. This is the default UI setting.

LIGHTHOUSE

System for accessing, managing and monitoring Opengear console servers.

Lighthouse User Guide

1. About this User Guide

This manual covers Lighthouse and is current as of 2020.Q4.0. When using a minor release, there may or may not be a specific version of the user guide for that release. The current Lighthouse user guide can always be found here.

NOTE: OPERATIONS MANAGER support is partial for this release. Mass node enrollment using ZTP, enrollment via USB drive, and SNMP information are not currently supported for OPERATIONS MANAGER nodes. All template types are supported.

GLOSSARY

Terms used in this guide to define Lighthouse elements and concepts are listed below.

LIGHTHOUSE ENTERPRISE

Offers an elevated centralized management solution with additional functionality. It supports growing trends such as edge computing and SDWAN with High Availability and Remote IP Access.

LIGHTHOUSE VPN

The OpenVPN based connections that the Lighthouse instance has with the nodes it is managing

LOCALAUTH (RADIUS/LDAP/AAA)

When this authentication option is selected, if local authentication fails, Lighthouse tries to authenticate the user using a remote AAA server.

MANAGED DEVICE

A device that is managed via a node through a serial, USB, or network connection.

MULTIPLE INSTANCE

Access nodes through multiple Lighthouse instances at the same time.

NODE

A device that can be enrolled with Lighthouse, allowing it to be accessed, managed, and monitored. Currently, Opengear console servers are supported on a standard license, with support for other vendors Console Servers available as an add-on.

PASSWORD POLICY

Administrative users can define rules for Lighthouse user passwords including length, types of characters, reuse, and expiration period.

PENDING NODE

A node that has been connected to Lighthouse and has been configured with a VPN Tunnel, but which has not yet been approved for access, monitoring, or management. The approval operation can be automated by configuring Lighthouse to auto- approve nodes.

PRIMARY INSTANCE

The main instance of Lighthouse used for updating configuration and node enrollment.

REMOTE LOGGING/REMOTE SYSLOG

The ability to send logs to a remote server, for the offsite storage and review of logs.

REPLICATION

Automatic copying of the primary Lighthouse database to any connected dependent instances. Replication ensures that these instances mirror the same information and maintains connections to the same nodes.

ROLE

A set of access rights for a particular group. Three roles are defined within Lighthouse: Lighthouse Administrator, Node Administrator, and Node User.

SECONDARY/DEPENDENT INSTANCES

Redundant instances of Lighthouse that are used to access Lighthouse information and connected nodes.

SMART GROUP

Dynamic filter used to search for particular nodes, or for defining the access rights of a

Lighthouse User Guide

group of users. Smart Groups use node properties, as well as tags defined by users.

TAG

User-defined attribute and value that is assigned to one or more nodes. Tags are used when creating Smart Groups for filtering views or access to nodes.

Lighthouse User Guide

2. Lighthouse overview

2.1 Lighthouse VM host requirements

To host Lighthouse, the VM needs to be configured to support a 20GB SCSI disk. As of Lighthouse 20.Q4.0, a second NetOps disk is no longer required, and is included as a part of the normal Lighthouse disk. Modules will need to be synchronized with the latest version from Dockerhub, or updated using the offline installer

•

Lighthouse deploys as an application running in a Linux-based virtual machine (VM). The

Lighthouse binary is available in open (for VM managers such as Boxes, KVM, and VirtualBox), VMware and Hyper-V specific Virtual Machine formats, image format. Lighthouse can also be run through cloud hosting services including Amazon’s AWS, and Microsoft Azure.

•

To run a Lighthouse VM, the host computer must be able to run a VM manager and at least one full

64-bit Linux-based virtual machine.

•

To host Lighthouse, the VM needs to be configured to support:

o 20GB SCSI disk. (This can be expanded or reduced after installation and first run)

o 1 x network interface card, preferably paravirtualised (virtio, vmxnet3), Realtek rtl8139, or

Intel e1000 are also supported, bridged.

o VGA console for initial setup.

To dimension CPU and RAM resources, follow these guidelines:

CPU and RAM utilization increase with the number of enrolled nodes.

For small deployments (Up to 500 nodes), allocate:

• 2 x 64-bit CPU cores.

• 8GB RAM.

For medium deployments (between 500 and 1000 nodes), allocate:

•

4 x 64-bit CPU cores.

•

18GB RAM.

For large deployments (more than 1000), allocate:

•

4 x 64-bit CPU cores.

•

32GB RAM.

For large deployments, please contact us for guidance on the deployment options, including low and zerotouch enrollment. The performance and limitations are dependent on network deployment.

Additionally, Lighthouse VPN keepalive timeout needs to be modified according to the size of deployment.

2.2 Lighthouse architecture

Lighthouse provides a platform for centrally accessing, managing, and monitoring Opengear console servers.

Console servers connect to a central Lighthouse instance over an OpenVPN tunnel, and are accessed, managed, and monitored via services transported over the VPN tunnel. In Lighthouse terminology, the console server is referred to as the node.

Lighthouse User Guide

NOTE: This diagram depicts High Availability. Without a secondary Lighthouse set up, the

diagram remains the same but without the secondary elements.

2.2.1 Lighthouse to Node interactions

For management and monitoring operations, Lighthouse queries and pushes data to and from a REST API on the node.

When a node is enrolled in Lighthouse, Lighthouse generates an X.509 certificate. This certificate authenticates the OpenVPN tunnel and provides the node access to the Lighthouse REST API. The node also imports a Certificate Authority from Lighthouse and uses that to allow Lighthouse access to the node’s REST API. Lighthouse also provides a public SSH key to the node, which allows Lighthouse to access the node’s serial ports via SSH.

For serial access, a node’s serial port subsystem is connected to via SSH. Users can also access the node's Web UI, which is reverse-proxied through the VPN tunnel.

2.2.2 User to Lighthouse interactions

Users interact with Lighthouse via an Ember.js JavaScript application, which communicates with Lighthouse via a REST API. This REST API can integrate Lighthouse into other systems. Documentation for this API is available for direct customer use.

While Lighthouse supports REST API versions v1, v1.1, v2, v3, v3.1 and v3.2, some of the endpoints in v1, v1.1, and v2 have been deprecated, meaning the functionality and expected request body may be different. We advise using the v3.2 to ensure the latest available functionality.

Lighthouse User Guide

2.2.3 Node organization and filtering

To help search, organize, and filter access to nodes, Lighthouse uses Smart Groups which allow node properties and user-supplied tags, consisting of a name and value, to be compiled into a search expression. These search expressions can be saved and used to filter the various lists of nodes in the Web UI, for example when selecting a serial port to connect to or to connect to the node’s Web UI. They can also be used for selecting the nodes that a particular group of users can access.

To help locate managed devices, Lighthouse includes Managed Device Filtering which allows users to search for port labels on a node. This search can be saved and applied on the MANAGE > MANAGED DEVICES > Console Gateway page.

2.2.4 Multiple Instance Feature

Starting with version 5.3, Lighthouse offers a Multiple Instance feature that allows you to set up a secondary or dependent instance of Lighthouse that automatically receives updates from a primary Lighthouse instance and maintains connections to all of its remote nodes.

Secondary instances are read-only. They may be used to view Lighthouse information specific to that instance, and to connect to its nodes via pmshell. Configuration changes must be performed on the primary instance, which will then update the information displayed on the secondary instance.

The multiple instance feature has the following limitations:

• Up to ten secondary instances can be enrolled.

• Multiple instance support is available starting with Lighthouse 5.3.

• Secondary Lighthouse instances are read-only. We recommended that you preconfigure instance

specific settings such as hostname, external endpoints, and time zone on a secondary instance before adding it to the primary in a normal way through UI.

• Dependent Lighthouse instances must have zero nodes enrolled before being enrolled to the primary Lighthouse.

• Removing a dependent Lighthouse instance will initiate a factory reset.

• If external endpoints on the primary or secondary Lighthouses are updated after a secondary

Lighthouse has been enrolled, it may break replication.

• Only Opengear nodes with a version that supports multiple instance will connect to the secondary instance, which means CS 4.4.1, or later and NGCS 19.Q2.0 or later. Nodes that don't support multiple instance will behave normally on the primary.

• The secondary instance UI offers a limited display.

See Chapter 10 for specific information on using the multiple instance feature.

Lighthouse User Guide

3. Lighthouse VM installation

To host Lighthouse, the VM needs to be configured to support a 20GB SCSI disk.

3.1 Lighthouse VM components

Lighthouse VM is available in several formats:

•

An Open Volume Format file — lighthouse-20.Q4.0-ovf.zip — inside a PKZip archive. This

is for use with virtual machine managers such as KVM and Virtual Box.

•

A VMware configuration file — lighthouse-20.Q4.0-vmx.zip —inside a PKZip archive. This is

for use with virtual machine managers from VMware.

•

A raw (.hdd) file, lighthouse-20.Q4.0-raw.hdd.tar. This file has been compressed with tar

and is for use with hosting services such as ElasticHosts.

•

An Open Virtual Appliance file — lighthouse-20.Q4.0.ova. This is for use with virtual

machine managers such as VM and Virtual Box as well as for use with virtual machine managers from VMware.

•

A Hyper-V configuration file with Powershell script — lighthouse-20.Q4.0-hyperv.zip —

inside a PKZip archive. This is for use in Microsoft Hyper-V deployment.

•

A Microsoft Azure file, lighthouse-azure.zip for deploying on Azure.

•

An Amazon Web Services bootstrap shell scripts aws_bootstrap.sh and lighthouse-aws-

bootstrap.sh, and the lighthouse-20.Q4.0.aws.raw.tar image for deploying on AWS.

•

An upgrade file, lh_upg.

NOTE: Due to disk restructuring, there are no lh_upg files for 20Q3.0.

•

The optional lighthouse-nom.vhd file for NetOps.

NOTE: The NetOps disk is only required to run NetOps modules (including Secure Provisioning, and IP Access) or to run a Docker container on Lighthouse. To install:

1. Upload the lighthouse-nom.vhd file for netops.

2. Go to images.

3. Create a new image.

4. Choose the boot disk by navigating to the storage explorer and selecting the

lighthouse.vhd disk image. Optionally add the netops disk under managed disks.

3.2 VMware vSphere 6.0 via the VMware vSphere 6.0 client on Windows

This procedure assumes VMware vSphere 6.0 is installed and running on available hardware. User must have access to a Windows computer on which the VMware vSphere 6.0 client is installed and that this installed client application can connect to and manage the VMware Sphere 6.0 instance. Finally, a copy of the Lighthouse binary in Open Volume Format is required, the .ovf file, either copied to the Windows computer running the VMware vSphere 6.0 client or available via a URL.

This procedure was tested using the VMware Sphere Client 6.0 running on Windows 7 Enterprise SP 1.

Lighthouse User Guide

3.2.1 Launch the vSphere Client and connect to a vSphere instance.

1. Launch the VMware vSphere Client. The simplest way is to use the Start Menu shortcut added during

installation.

Start > All Programs > VMware > VMware vSphere Client

The VMware vSphere Client opens a login window.

2. Select the IP address or name of the VMware vSphere instance where Lighthouse will be installed from

the IP address/Name drop-down list.

3. Enter the User name and Password required to gain management privileges to the selected VMware

vSphere instance.

4. Click Login or press Return.

The login window displays progress text in the bottom left corner:

Connecting Loading inventory Loading main form Displaying main form

The vSphere main form window opens.

3.2.2 Import the Lighthouse VM Open Volume Format (.ovf) image

1. From the vSphere Client menu bar, choose File > Deploy OVF Template.

The Deploy OVF Template window appears, with the first stage, Source, pre-selected.

2. If the file Opengear Lighthouse VM.ovf is on a remote computer via a URL, enter this URL in the

Deploy from a file or URL field. Otherwise, click Browse. An Open dialog appears.

Navigate to the directory containing the file Opengear Lighthouse VM.ovf.

Select Opengear Lighthouse VM.ovf and click Open.

Lighthouse User Guide

3. The Deploy OVF Template window opens again, with the Opengear Lighthouse VM.ovf file listed in the Deploy from a file or URL combo-box. Click Next.

4. The OVF Template Details stage appears, showing basic information about the Lighthouse VM encapsulated by the .ovf file. Click Next.

5. The Name and Location screen appears with the Name field pre-populated and pre-selected. The default name is Opengear Lighthouse VM. To change this, enter a new name. Click Next.

6. The Disk Format screen displays which data-store the Lighthouse VM’s virtual disk uses, how much free space the virtual disk has available and which provisioning scheme is being used. Click Next.

7. The Network Mapping screen shows which destination or inventory network the Lighthouse VM’s virtual network is mapped to. Click Next.

8. The Ready to Complete screen appears, listing the basic properties of the about-to-be-deployed virtual machine. To be able to power-up the new virtual machine after deployment, select the Power on after deployment checkbox. Click Finish.

9. The Deploying Opengear Lighthouse VM progress dialog appears.

10. Once deployment has finished the Deployment Completed Successfully alert appears. Click Close. The new virtual machine is now deployed and appears in the inventory list.

3.2.3 Launch the Opengear Lighthouse virtual machine

The vSphere Client provides several ways of launching a Virtual Machine hosted on a vSphere instance. Begin by selecting the Opengear Lighthouse VM from the vSphere Client’s inventory list. The selected VM can then be launched by doing one of the following:

•

Select Inventory > Virtual Machine > Power > Power On.

•

Press Ctrl-B.

Lighthouse User Guide

•

Click the Power on the virtual machine link in the Basic Tasks section of the Getting Started tab.

This option requires the Getting Started tab be front-most. If it is not already the front-most tab, make it active by clicking it.

•

Select Inventory > Virtual Machine > Open Console and then:

o Click Power On in the console tool bar, or o Choose VM > Power > Power On from the console menu bar, or o Press Ctrl-B.

NOTE: Only the fourth option above results in the running virtual machine being accessible from within the vSphere Client. The first three boot the Lighthouse VM and get it running headless.

3.2.4 Access the console of a running but headless Opengear Lighthouse instance

If direct interaction with a running but headless *Opengear Lighthouse VM* is required, open a console window.

Select the running Opengear Lighthouse VM in the vSphere Client’s inventory list, then do one of the following:

•

Select Inventory > Virtual Machine > Open Console or

•

Right-click and select Open Console from the contextual menu that appears.

NOTE: A Lighthouse VM is running a bash shell with no other interactive options. As a result, when the

vSphere Client opens its console window, the Lighthouse VM captures the mouse pointer, making it unavailable for use by any other window. Press CTRL+ALT to release the pointer.

3.3 VMware Workstation Player on Windows as host

Follow these steps when VMware Workstation Player is installed on the host Windows machine. VMwareready virtual machine files are stored in C:\Users\%USERNAME%\Virtual Machines\. This is the location selected by default by VMware Workstation Player. If another location is preferred, adjust this procedure as required.

Prepare the Lighthouse VM file for import into VMware Workstation Player.

1. Move the lighthouse-20.Q4.0-vmx.zip archive to C:\Users\%USERNAME%\Virtual

Machines\.

2. Right-click the archive and select Extract all from the contextual menu.

3. A Select a Destination and Extract Files dialog opens. By default, the location is the same folder

as the archive is in: C:\Users\%USERNAME%\Virtual Machines\. Leave this as the destination folder.

4. Uncheck the Show extracted files when complete checkbox and then click Extract.

5. A folder called lighthouse is created inside C:\Users\%USERNAME%\Virtual

Machines\.

Import the Opengear Lighthouse VM file into VMware Workstation Player.

1. Launch VMware Workstation Player.

Lighthouse User Guide

2. Click Open a Virtual Machine.

3. Navigate to C:\Users\%USERNAME%\Virtual Machines\lighthouse\.

VMware Workstation Player points to Libraries > Documents and includes C:\Users\%USERNAME%\My Documents\.

Assuming this is the case, double-click Virtual Machines and then double-click Lighthouse.

4. If only one file — Lighthouse — is visible, double-click it to add the Lighthouse 2020.Q4.0 virtual

machine to the VMware Workstation 12 Player virtual machines list. If more than one file appears, double-click Lighthouse.vmx.

5. The Lighthouse virtual machine is added to the VMware Workstation 12 Player virtual machines

list.

6. With Opengear Lighthouse VM selected in the VMware Workstation 12 Player virtual machine list,

click Play virtual machine to boot Lighthouse.

3.4 VMware Workstation Pro on Windows as host

This procedure assumes VMware Workstation Pro is already installed on the host Windows machine and that VMware-ready virtual machine files are stored in C:\Users\%USERNAME%\Virtual Machines\. If another location is preferred, adjust the steps as needed.

Prepare the Opengear Lighthouse VM file for import into VMware Workstation Pro.

1. Move the lighthouse-20.Q4.0.zip archive to C:\Users\%USERNAME%\Virtual

Machines\.

2. Right-click the lighthouse-20.Q4.0-vmx.zip archive and select Extract all from the

contextual menu.

3. A Select a Destination and Extract Files dialog opens. The location is the same folder as the

PKZip archive is in: C:\Users\%USERNAME%\Virtual Machines\. Leave this as the destination folder.

4. Uncheck the Show extracted files when complete checkbox and then click Extract.

5. A folder called lighthouse is created inside C:\Users\%USERNAME%\Virtual Machines\.

Import the Opengear Lighthouse VM file into VMware Workstation Pro.

1. Click Open a Virtual Machine.

2. Navigate to C:\Users\%USERNAME%\Virtual Machines\lighthouse\.

3. VMware Workstation Pro points to Libraries > Documents and this library includes

C:\Users\%USERNAME%\My Documents\. Double-click Virtual Machines and then double-click Lighthouse.

4. If only one file — Lighthouse — appears, double-click it to add the Lighthouse 2020.Q4.0 virtual

machine to the VMware Workstation Pro virtual machines list. If more than one file appears, double-click Lighthouse.vmx.

5. The Lighthouse 2020.Q4.0 virtual machine is added to the VMware Workstation Pro virtual

machines list.

6. With the Opengear Lighthouse VM selected in the My Computer listing and the subsequent

Opengear Lighthouse VM tab open, click Power on this virtual machine to boot Lighthouse.

Lighthouse User Guide

3.5 VMware Workstation Player or Pro on Fedora Workstation as host

VMware Workstation Player 12 cannot be installed on Fedora 25 without substantial reconfiguration of a base Fedora Workstation setup and leaves Fedora Workstation in a state that is unsupported by any external entity.

Opengear does not support this particular combination of host operating system and virtual machine manager.

3.6 Local deployment on Hyper-V running on Windows 10/Windows Server 2016

This procedure assumes Hyper-V is already installed on a Windows 10/Windows Server 2016 host machine and the required Zip archive, ironmam-hyperv.zip is in C:\Users\%USERNAME%$\Downloads.

1. Unzip lighthouse-hyperv.zip.

2. Navigate to the extracted folder. Make sure lighthouse.vhd and

lighthouse_virtual_machine_registration.ps1 are in the folder.

3. Right-click and choose Run with Powershell to execute the Powershell script.

4. Leave the host name empty when prompted to deploy Lighthouse to local machine.

5. Launch Hyper-V Manager. Lighthouse should be registered as a new VM image under Virtual

Machine.

6. Select Lighthouse from the list and click Start in the Action Panel to boot Opengear Lighthouse.

3.7 Remote Hyper-V deployment with pre-authenticated user

In this scenario, the user who performs Lighthouse deployment does not have local access to Hyper-V installed on Windows 2016. However, user has access to a Windows 10 which can manage the Hyper-V server remotely. This procedure assumes Hyper-V is installed on Windows Server 2016 host machine and the required Zip archive lighthouse-hyperv.zip is in C:\Users\%USERNAME%$\Downloads. Windows 10 is already configured to manage Hyper-V on Windows Server 2016. Windows 10 and Windows Server 2016 must have the same user (same password) created. The user who performs the deployment must have permission to both execute the Powershell script and deploy the image on Hyper-V.

1. Login to Windows 10 with the user mentioned above.

2. Unzip lighthouse-hyperv.zip

3. Navigate to the extracted folder. Make sure lighthouse.vhd and

lighthouse_virtual_machine_registration.ps1 are in the folder.

4. Right-click and choose Run with Powershell to execute the Powershell script.

5. Enter the fully qualified domain name for Windows Server 2016 when prompted to deploy

Lighthouse to the remotely-managed Windows Server 2016 machine.

6. Launch Hyper-V Manager. Lighthouse should be registered as a new VM image under Virtual

Machine for Windows Server 2016.

7. Select Lighthouse from the list and click Start in the Action Panel to boot Opengear Lighthouse.

Lighthouse User Guide

3.8 Remote Hyper-V deployment with different user

In this scenario, the user who performs Lighthouse deployment does not have local access to Hyper-V installed on Windows Server 2016. However, user has access to Windows 10 which can manage the Hyper-V server remotely. The user who performs the deployment must have permission to both execute the Powershell script and deploy the image on Hyper-V. This procedure assumes Hyper-V is installed on Windows Server 2016 host machine and the required Zip archive, ironmam-hyperv.zip, is in C:\Users\%USERNAME%$\Downloads. Windows 10 is already configured to manage Hyper-V on Windows Server 2016.

1. Login to windows 10 with a user who does not exist on Windows Server 2016.

2. Unzip lighthouse-hyperv.zip.

3. Navigate to the extracted folder. Make sure lighthouse.vhd and

lighthouse_virtual_machine_registration.ps1 are in the folder.

4. Right-click and choose Run with Powershell to execute the Powershell script.

5. Enter the fully qualified domain name for Windows Server 2016 when prompted to deploy

Lighthouse to remotely managed Windows Server 2016 machine.

6. Enter the user details created on Windows Server 2016 which has permission to deploy Hyper-V.

7. Launch Hyper-V Manager. Lighthouse should be registered as a new VM image under Virtual

Machine for Windows Server 2016.

8. Select Lighthouse from the list and click Start in the Action Panel to boot Opengear Lighthouse.

3.9 VirtualBox on Windows as host

NOTE: when a Skylake processor is available, we do not recommend the use of VirtualBox.

NOTE: We recommend that VirtualBox users customize their instances and change their network cards to

one other than e1000. We also suggest virtio for better performance.

This procedure assumes VirtualBox is already installed on the host machine and the required PKZip archive, lighthouse-20.Q4.0-ovf.zip is in C:\Users\%USERNAME%$\Downloads.

1. Unzip lighthouse-ovf. It may appear as lighthouse-20.Q4.0-ovf.zip depending on the

Windows Explorer preference settings).

2. Right-click the lighthouse-ovf archive and select Extract all from the contextual menu.

3. The Select a Destination and Extract Files dialog opens. The destination is

C:\Users\%USERNAME%\Downloads\Lighthouse-ovf.

4. Uncheck the Show extracted files when complete checkbox and edit the destination by removing

Lighthouse-ovf from the path.

5. Click Extract.

6. A folder called lighthouse-ovf is created inside C:\Users\%USERNAME%\Downloads\.

7. Launch VirtualBox.

8. The Oracle VM VirtualBox Manager window appears.

9. Choose File > Import Appliance.

10. The Appliance to import dialog opens.

11. Click Expert Mode.

12. The Appliance to import dialog changes from Guided Mode to Expert Mode.

13. Click the icon of a folder with an upward pointing arrow superimposed. This icon is to the far right

of the Appliance to import field.

14. The Open File dialog appears with C:\Users\%USERNAME%\Documents as the current folder.

Lighthouse User Guide

15. Navigate to C:\Users\%USERNAME%\Downloads\Lighthouse.ovf\Opengear

Lighthouse VM\.

16. Select the file Opengear Lighthouse VM and click Open.

17. Double-click the text vm in the Name row and Configuration column to make it editable.

18. Type Opengear Lighthouse VM and press Enter.

19. Click Import.

20. A new virtual machine, called Opengear Lighthouse VM is added to the list of virtual machines

available to Virtual Box.

21. Select Opengear Lighthouse VM from the list.

22. Choose Machine > Settings. Or click the Settings icon in the VirtualBox Manager toolbar or press

Control+S.

23. The Opengear Lighthouse VM — Settings dialog appears.

24. Click the System option in the list of options running down the left-hand side of the dialog.

25. The dialog shows the System options available as three tabs: Motherboard, Processor, and

Acceleration. Depending on the underlying hardware platform, Acceleration may be greyed-out and unavailable. The Motherboard tab is preselected.

26. In the Motherboard tab, select the Hardware Clock in UTC Time checkbox.

27. Click OK or press Return.

28. Select Opengear Lighthouse VM from the list and click Start in the Oracle VM VirtualBox

Manager toolbar to boot Lighthouse. Double-clicking Opengear Lighthouse VM in the list also boots Lighthouse.

NOTE: Selecting the Hardware Clock in UTC Time checkbox is necessary because Lighthouse expects the hardware clock to be set to UTC, not local time. Unlike other Virtual Machine Managers, Virtual Box both exposes this option as a user-adjustable setting and does not set it to UTC by default.

3.10 VirtualBox on macOS as host

VirtualBox should already installed on the host macOS machine and the required PKZip archive, lighthouse-20.Q4.0-ovf.zip is in ~/Downloads.

1. Unzip lighthouse-20.Q4.0-ovf.zip.

This creates a folder — Lighthouse-ovf — in ~/Downloads that contains the following files and folders:

Lighthouse-ovf └── Opengear Lighthouse VM ├── Opengear Lighthouse VM.ovf └── Opengear_Lighthouse_VM-disk1.vmdk

2. Launch Virtual Box.

The Oracle VM VirtualBox Manager window appears.

3. Choose File > Import Appliance or press Command+I.

4. The Appliance to import dialog sheet slides down from the Oracle VM VirtualBox Manager

toolbar.

5. Click Expert Mode.

The Appliance to import dialog sheet changes from Guided Mode to Expert Mode.

6. Click the icon of a folder with an upward pointing arrow superimposed. This icon is to the far-right

of the Appliance to import field.

Lighthouse User Guide

7. The Open File dialog sheet slides down from the Oracle VM VirtualBox Manager toolbar. This

sheet opens with ~/Documents as the current folder.

8. Navigate to ~/Downloads/Lighthouse.ovf/Opengear Lighthouse VM/.

9. Select Opengear Lighthouse VM and click Open. (Depending on the Finder Preferences

settings, the file may present as Opengear Lighthouse VM.ovf.)

10. Double-click the text vm in the Name row and Configuration column to make it editable.

11. Type Opengear Lighthouse VM and hit Return.

12. Click Import.

A new virtual machine, called Opengear Lighthouse VM is added to the list of virtual machines.

13. Select Opengear Lighthouse VM from the list.

14. Choose Machine > Settings. Or click the Settings icon in the VirtualBox Manager toolbar. The

Opengear Lighthouse VM — Settings dialog appears.

15. Click the System option in the dialog’s toolbar.

16. The dialog shows the System options available as three tabs: Motherboard, Processor, and

Acceleration. (Depending on the underlying hardware platform, Acceleration may be greyed-out and unavailable). The Motherboard tab is preselected.

17. In the Motherboard tab, select the Hardware Clock in UTC Time checkbox.

18. Click OK or press Return.

19. Select Opengear Lighthouse VM from the list and click Start in the Oracle VM VirtualBox

Manager toolbar to boot Lighthouse. Double-clicking Opengear Lighthouse VM in the list also boots Lighthouse.

NOTE: By default, VirtualBox stores virtual machines in ~/VirtualBox VMs. If this is the first virtual machine setup by VirtualBox, it creates the VirtualBox VMs folder in the current user’s homedirectory and a folder — Opengear Lighthouse VM — inside the VirtualBox VMs folder. The Opengear Lighthouse VM folder contains the files and folders which make up Lighthouse when run under Virtual Box.

3.11 VirtualBox on Ubuntu as host

Before beginning, make certain that VirtualBox and all required support files are installed on the host machine and the PKZip archive, lighthouse-20.Q4.0-ovf.zip is in ~/Downloads.

1. Unzip lighthouse-20.Q4.0-ovf.zip.

This creates a folder — Lighthouse-ovf — in ~/Downloads that contains the following files and folders:

Lighthouse-ovf └── Opengear Lighthouse VM ├── Opengear Lighthouse VM.ovf └── Opengear_Lighthouse_VM-disk1.vmdk

2. Launch Virtual Box.

3. The Oracle VM VirtualBox Manager window appears.

Lighthouse User Guide

4. Choose File > Import Appliance.

5. The Appliance to import dialog opens.

6. Click Expert Mode.

7. The Appliance to import dialog changes from Guided Mode to Expert Mode.

8. Click the icon of a folder with an upward pointing arrow superimposed. This icon is to the far

right of the Appliance to import field.

9. A file-navigation dialog, choose a virtual appliance to import, opens with ~/Documents as

the current folder.

10. Navigate to ~/Downloads/Lighthouse.ovf/Opengear Lighthouse VM/.

11. Select Opengear Lighthouse VM.ovf and click Open.

12. Double-click the text vm in the Name row and Configuration column to make it editable.

13. Type Opengear Lighthouse VM and hit Return.

14. Click Import.

15. A new virtual machine, called Opengear Lighthouse VM is added to the list of virtual

machines available to Virtual Box.

16. Select Opengear Lighthouse VM from the list and click Start in the Oracle VM VirtualBox Manager toolbar to boot Lighthouse. Double-clicking Opengear Lighthouse VM in the list also boots Lighthouse.

NOTE: VirtualBox stores virtual machines in ~/VirtualBox VMs. If this is the first virtual machine setup by VirtualBox it creates the VirtualBox VMs folder in the current user’s home-directory and a folder — Opengear Lighthouse VM — inside the VirtualBox VMs folder. Inside Opengear Lighthouse VM are the files and folders which make up Lighthouse when run under Virtual Box.

3.12 VirtualBox on Fedora Workstation as host

Before beginning, make certain that VirtualBox and all required support files are already installed on the host machine and the PKZip archive, lighthouse-20.Q4.0-ovf.zip is in ~/Downloads.

1. Unzip lighthouse-20.Q4.0-ovf.zip. This creates a folder — Lighthouse.ovf — in

~/Downloads that contains the following files and folders:

Lighthouse.ovf └── Opengear Lighthouse VM ├── Opengear Lighthouse VM.ovf └── Opengear_Lighthouse_VM-disk1.vmdk

2. Launch Virtual Box. The Oracle VM VirtualBox Manager window appears.

3. Choose File > Import Appliance or press Control-I. The Appliance to import dialog opens.

4. Click Expert Mode. The Appliance to import dialog changes from Guided Mode to Expert Mode.

5. Click the icon of a folder with an upward pointing arrow superimposed. This icon is to the far right of the Appliance to import field. The Open File dialog opens with ~/Documents as the current folder.

6. Navigate to ~/Downloads/Lighthouse.ovf/Opengear Lighthouse VM/.

7. Select Opengear Lighthouse VM and click Open.

8. Double-click the text vm in the Name row and Configuration column to make it editable.

9. Type Opengear Lighthouse VM and hit Return.

Lighthouse User Guide

10. Click Import. A new virtual machine, called Opengear Lighthouse VM is added to the list of virtual machines available to Virtual Box.

11. Select Opengear Lighthouse VM from the list and click Start in the Oracle VM VirtualBox Manager toolbar to boot Lighthouse. Double-clicking Opengear Lighthouse VM in the list also boots Lighthouse.

NOTE: VirtualBox stores virtual machines in ~/VirtualBox VMs. If this is the first virtual machine setup by VirtualBox, it creates the VirtualBox VMs folder in the current user’s home-directory and a folder —

Opengear Lighthouse VM — inside the VirtualBox VMs folder. Inside Opengear Lighthouse VM are the files and folders which make up Lighthouse when run under Virtual Box.

3.13 Virtual Machine Manager (KVM) on Ubuntu as host

Virtual Machine Manager and all required support files should be installed on the host machine and the the .tar archive, lighthouse-20.Q4.0-raw.hdd.tar is in ~/Downloads.

1. Expand lighthouse-20.Q4.0-raw.hdd.tar. This extracts lighthouse-20.Q4.0-

raw.hdd in ~/Downloads.

2. Launch Virtual Machine Manager.

3. Click New at the top left of the Virtual Machine Manager window (or choose File > New Virtual Machine). The Source Selection window opens.

4. Click Select a file. A Select a device or ISO file dialog slides into view.

5. Navigate to ~/Downloads/.

6. Select the file lighthouse-20.Q4.0-raw.hdd and click Open in the top right-hand corner of the dialog. A Review window opens providing basic information about the virtual machine or box, as Boxes calls them, to be created.

7. Click Create in the top right corner of the Review window.

8. A new virtual machine instance, Opengear_Lighthouse_VM-disk1, is created and presented in the Boxes window.

9. To rename the virtual machine instance, right-click on the machine instance and choose Properties from the contextual menu that appears. Click anywhere in the Name field to select and edit the name. Click the close box to save the changes.

3.14 Boxes on Fedora Workstation as host

Boxes and all required support files should be installed on the host machine and lighthouse-

20.Q4.0-ovf.zip is in ~/Downloads.

1. Unzip lighthouse-20.Q4.0-ovf.zip. This creates a folder — Lighthouse.ovf — in ~/Downloads that contains the following files and folders:

Lighthouse.ovf └── Opengear Lighthouse VM ├── Opengear Lighthouse VM.ovf └── Opengear_Lighthouse_VM-disk1.vmdk

2. Launch Boxes.

3. Click New in the Boxes window title bar. The Source Selection window opens.

Lighthouse User Guide

4. Click Select a file. A Select a device or ISO file dialog opens.

5. Navigate to ~/Downloads/Lighthouse.ovf/Opengear Lighthouse VM/.

6. Select the file Opengear_Lighthouse_VM-disk1.vmdk and click Open in the top right-hand corner of the dialog. A Review window opens providing basic information about the virtual machine (or ‘box’, as Boxes calls them) to be created

7. Click Create in the top right corner of the Review window.

8. A new virtual machine instance, Opengear_Lighthouse_VM-disk1 is created and presented in the Boxes window.

3.15 Boxes on CentOS as host

CentOS should be installed, complete with the Gnome desktop environment as the host operating system. CentOS includes the full complement of KVM-centric virtualization tools including the GUI-based virtualization management tools Boxes and virt-manager and the shell-based virtualization management tool virsh.

This procedure assumes Boxes is used to setup and manage the Lighthouse VM and that the required PKZip archive, lighthouse-20.Q4.0-ovf.zip is in ~/Downloads.

1. Unzip lighthouse-20.Q4.0-ovf.zip.

This creates a folder — Lighthouse.ovf — in ~/Downloads that contains the following files and folders:

Lighthouse.ovf └── Opengear Lighthouse VM ├── Opengear Lighthouse VM.ovf └── Opengear_Lighthouse_VM-disk1.vmdk

2. Launch Boxes

3. Click New in the Boxes title bar.

4. Navigate to ~/Downloads/Lighthouse.ovf/Opengear Lighthouse VM/

5. Select Opengear Lighthouse VM and click Open. A new virtual machine, called Opengear LighthouseVM is added to the list of virtual machines available to Boxes.

3.16 Azure environment

To use the Microsoft Azure environment:

1. Login to the Microsoft Azure portal at https://portal.azure.com

2. Under Azure services click the Storage Accounts icon.

3. Create a new storage account.

4. Navigate to the newly created storage account, click storage explorer and create a new blob container.

5. Upload the lighthouse.vhd image provided with the lighthouse-azure.zip file.

6. Go to the newly created image and click Create VM.

7. Ensure the selected image is correct.

Lighthouse User Guide

8. Choose the desired virtual machine instance size.

9. Enter the details for the Microsoft Azure admin user with either password OR SSH key authentication.

10. If SSH key authentication is selected, the user will be created without a password and will be unable to access the UI.

11. To login to the Lighthouse UI, the user must then login via SSH with key authentication and configure their password using the ogpasswd utility (eg. sudo ogpasswd -u 'username' -p 'newpassword').

12. Login via SSH with a password will remain disabled for this user.

13. Select the inbound ports enabled for the Lighthouse instance (SSH, HTTPs, and optionally HTTP).

14. Navigate to the next page of configuration (Disks) and select the desired storage option for the boot disk.

15. Go to the Review page.

16. After validation passes, click Create.

17. Go to the Virtual Machines page, select the virtual machine and open the Serial Console. Lighthouse should now be deploying on Microsoft Azure.

18. To allow nodes to enroll in Lighthouse, you will need to add the following firewall rules in the Microsoft Azure virtual machine control panel:

a. Go to the virtual machine configuration and select Networking. b. Add a rule to allow UDP connections from any source to port 1194 on the instance's internal

network address (10.0.0.x).

c. Add a rule to allow UDP connections from any source to port 1195 on the instance's internal

network address (10.0.0.x).

d. HTTPs and SSH should already be allowed from the initial setup If not, add them.

19. Confirm that the Azure instance public IP address has been added to external endpoints in Settings > Administration.

3.17 Amazon Web Services (AWS) environment

To use Lighthouse with AWS, you will need to create an account, create an AWS EC2 instance, and create an Amazon Machine Image. You will need to spin up a standard AWS EC2 instance with 30 gigs or more of disk space to ensure there is enough room for the necessary operations.

To use the AWS environment, you will need to complete several steps. Visit AWS Help for assistance in completing the following steps:

1. Sign Up for AWS

2. Create an IAM User.

3. Create a Key Pair

4. Connect to your instance using your key pair

5. Create a Virtual Private Cloud (VPC)

6. Create a Security Group

Launch a Linux build-box instance

We do not have a public AMI. You will need to launch a Linux build-box instance in order to create a Lighthouse AMI. This is a one-time procedure, as once Lighthouse is running, you can upgrade it from the Lighthouse Web GUI.

We have a compressed binary image and a script. On the first deployment of Lighthouse you do need to spin up a Linux host in EC2 to use as a “build-box”, upload the Lighthouse AWS-specific aws.raw.tar image, untar it, then run the Lighthouse aws-bootstrap script, which creates a private AMI. You can then use this to launch one or more Lighthouse instances.

Lighthouse User Guide

Using the AWS Management Console:

1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/.

2. From the console dashboard, click Launch Instance.

3. The Choose an Amazon Machine Image (AMI) page displays a list of basic configurations that

serve as templates for your instance.

4. On the Choose an Instance Type page, click the hardware configuration of your instance.

NOTE: You’ll need to choose at least a medium-sized image or larger.

5. Click Review and Launch to let the wizard complete the other configuration settings for you.

6. On the Review Instance Launch page, under Security Groups, the wizard created and selected a

security group for you. You can use this security group, or you can select the security group that you created when getting set up using the following steps:

a. Choose Edit security groups. b. On the Configure Security Group page, ensure that Select an existing security group is

selected.

c. Select your security group from the list of existing security groups, and then click Review

and Launch.

7. On the Review Instance Launch page, choose Launch.

When prompted for a key pair, select Choose an existing key pair, then select your key pair. NOTE: Don't select Proceed without a key pair. If you launch your instance without a key pair, then you can't connect to it.

8. Click View Instances to close the confirmation page and return to the console.

Launch Lighthouse VM Instance

1. Click the acknowledgement check box, and then choose Launch Instances.

2. It can take a few minutes for the instance to be ready so that you can connect to it. Check that

your instance has passed its status checks in the Status Checks column.

Upload Lighthouse software to the build-box and run script to create the AMI

After creating the AWS EC2 instance:

1. Locate the aws_bootstrap.sh script, provided in the current Lighthouse release folder.

2. Connect via SCP and copy aws_bootstrap.sh onto the AWS EC2 instance.

3. While SSHed to your instance on AWS, run the built in aws configure command.

4. Provide an access key with administrative privileges.

NOTE: At a minimum, the access key sufficient permissions to create, attach, delete, and snapshot EBS volumes as well as create an Amazon Machine Image (AMI).

5. Download the Lighthouse image from the Opengear FTP site.

6. Copy the raw_hdd image to the AWS EC2 instance and untar the file. Optionally, you can untar

and then copy the file.

7. From AWS, run the aws_bootstrap.sh script with the appropriate parameters to tell it where to

find the untarred Lighthouse image on the instance.

Lighthouse User Guide

NOTE: aws-bootstrap.sh creates an AMI from a Lighthouse image and has the following options:

-f FILENAME Use the specified local file to create the image

-r URI Download the image file from the specified URI

-d DEVICE Attach temporary disk images to the specified device (eg, xvde)

-n NAME The name to use for generated images (default: Lighthouse)

-h Display help message

8. When complete, you'll have an AMI called Lighthouse you can use to create a Lighthouse

instance with any hardware configuration you require.

9. To set a password for the root user on Lighthouse:

a. Open the Configure instance details page of the AMI launch process. b. Under the Advanced Details section, add a root password using the userdata field in the

format password=Whatever123. If you do not, you will have to log in via SSH to set it.

NOTE: Optionally, you can specify a custom startup script in the Advanced Details section with script_uri=http://my.domain/my_script.sh. This script will be run once on first boot. Different user options should be provided on separate lines.

10. When done, the EC2 instance can be shut down and removed. Future instances can be created

from the AMI.

NOTE: Currently AWS support is limited to:

• All standard Lighthouse operations

• Running on the AWS platform

• Providing aws-cli tools for interaction with AWS

• Loading the provided SSH key for the root user

• Running custom scripts on startup (see above)

• Providing a root password via userdata (see above)

At this time we do not support:

• Using AWS's database services

• Using AWS's redis services

• Using any of AWS's scalability functionality

NOTE: boot up is headless, so most of the information in section 4. First boot of the Lighthouse

VM does not apply. The root password must be specified in the Advanced Details.

Lighthouse User Guide

4. First boot of the Lighthouse VM

NOTE: This section does not apply to Azure or AWS.

During boot, two screens open.

1. The first notes the VM is Booting to latest installed image.

The selected image is Lighthouse Root 1. Two other images are available: Lighthouse Root 1 and Root 2. Do not change the boot image the VM boots from.

2. The second screen prompts to Select Lighthouse boot mode and displays four options:

• Graphics console boot

• Graphics console recovery mode

• Serial console boot

• Serial console recovery mode

Graphics console boot is preselected and should not be changed. After the first boot has completed a message appears:

Welcome to Lighthouse. This is software version:

2020.Q4.0

3. The final step in the initial setup appears:

To complete initial setup, please set a new root password. Press ENTER to continue.

4. After pressing Enter, a prompt appears:

Enter new root password:

5. Enter a password and press Enter. Keep in mind that non-US-English keyboards are not supported

in the graphics console.

NOTE: We recommend you set a temporary password at this point and change it to a very strong highentropy password as soon as possible using the WebUI.

6. The confirm prompt appears:

Confirm given password

7. Re-enter the password and press Enter. Multiple configuration notices appear ending with a login

prompt:

lighthouse login:

Lighthouse User Guide

8. Enter root and press Enter. A password prompt appears:

Password:

Enter the newly-set password and press Enter. A standard bash shell prompt appears with the list of static, DHCP, and IPv6 addresses.

net1 192.168.0.1/24 net1:dhcp 192.168.1.186/24 net1 fe80::a00:27ff:fe39:daa3/64 root@lighthouse:~#

Lighthouse User Guide

5. Initial system configuration

5.1 Lighthouse IP addressing

When the Lighthouse VM is booted and running, it can be reached at:

• The static address, 192.168.0.1, or

• The address it is assigned by any DHCP server it finds. Type ifconfig command to see which IP

address the VM has been allocated by DHCP.

• Static IP address on another subnet, requiring IP address, mask, gateway set using ogconfig-cli

commands.

Only the first two options are available out-of-the-box. The static IP on another subnet has to be configured first.

If there is no DHCP and Lighthouse is not reachable on the default address 192.168.0.1 then the static IP address can be changed from the console using the ogsetnetwork.sh command.

root@lighthouse:~# ogsetnetwork.sh --help

Usage: ogsetnetwork.sh [Use options below to configure a static IP]

-a, --address Static IP address to set

-n, --netmask Netmask for IP address

-g, --gateway Network gateway address

-d, --dns1 Chosen DNS server #1

-D, --dns2 Chosen DNS #2

Example:

ogsetnetwork.sh -a 192.168.1.24 -n 255.255.255.0 -g 192.168.1.1

Tip: Type ogset<tab> and tab completion will give you the full command.

5.2 Loading Lighthouse

Open a new browser window or tab and enter:

1. https://192.168.0.1/ , https://[DHCP-supplied address]/, or an IPv6

address, for example: https://[fe80::a00:27ff:fe39:daa3/64].

2. Press Return. The Lighthouse Login page loads.

+ 108 hidden pages

Opengear Lighthouse User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual