Virtual Appliance Guide

• Deploying the Virtual Appliance
  • Supported environments
  • Downloading the Virtual Appliance
  • Deploying in VMware Player and VMware Workstation
  • Deploying in vCenter or VMware ESXi
• Powering on the Virtual Appliance
• Administering the Virtual Appliance
• Updating the host's operating system
• Logging onto the Security Console
• Frequently Asked Questions
  • How do I set up a static IP?
  • How do I set up DNS?
  • How do I restart networking?
  • How do I set the system time?
  • How do I start, stop, and check the status of the console and engine services?
    • Console
    • Engine
  • What is the OS account lockout policy?

Deploying the Virtual Appliance

Read this section to learn how to deploy the Virtual Appliance in one of the supported environments.

Supported environments

The Virtual Appliance is tested and supported in the following environments:

• VMware Player 6 or later
• VMware Workstation 9 or later
• VMware Fusion 8 or later
• VMware vCenter 5.5, 6.0
• VMware ESXi 5.5, 6.0

Downloading the Virtual Appliance

Rapid7 provides the Virtual Appliance as an Open Virtualization Archive (OVA) file. You can download either a Virtual Appliance Security Console (VA) or the Virtual Appliance Scan Engine (VASE). Download links for both are as follows:

• Virtual Appliance Security Console
• Virtual Appliance Scan Engine

Deploying in VMware Player and VMware Workstation

1. In VMware Player and VMware Workstation, click "File" -> "Open".
2. In the dropdown list, select the group that includes *.ova.
3. Select the Virtual Appliance file, and click "Open".

The "Import Virtual Machine" window will appear.

4. Specify the storage path for the Virtual Appliance.
5. Click "Import".

The import process converts the Virtual Appliance file to a Virtual Machine Disk Format (VMDK) file. When the import process is complete, the Virtual Appliance appears on the list of available virtual machines in VMware Player.

6. Select the Rapid7 Virtual Appliance, and click "Play" or "Power On this Virtual Machine" if using VMware Workstation.

Deploying in vCenter or VMware ESXi

1. In vCenter or VMware ESXi, click File | Deploy OVF Template... The Deploy OVF template window appears.

2. Locate the downloaded Virtual Appliance file, and click Next. The OVF Template Details panel appears for configuring Virtual Appliance set- tings.

3. Enter a name for the Virtual Appliance.
4. Select an inventory location, and click Next.
5. Select a host or cluster for the Virtual Appliance, and click Next.
6. Select a resource pool, and click Next.
7. Select a datastore, and click Next.
8. Select Thin or Thick (recommended) Provision for the disk format, and click Next.
9. Select a network mapping, and click Next.
10. Click Finish.

Powering on the Virtual Appliance

1. When the import process is complete, select the Virtual Appliance from the list of available virtual machines.
2. Click Power on.
3. Click the Console tab to view a terminal window for the Virtual Appliance.

Administering the Virtual Appliance

Log in to the Virtual Appliance after it starts to perform any necessary administrative functions. The operating system for the Virtual Appliance is a CIS hardened, minimal install of Ubuntu Server 16.04 LTS.

When startup is complete, the Virtual Appliance window displays a login prompt. If you are logging in for the first time, you will be asked to change the current UNIX password:

1. Enter the default username: nexpose
2. Enter the default password: nexpose

3. When prompted, enter the default password again.
4. Enter your new password according to the complexity requirements.

5. Enter your new password again to confirm the change.

You need the IP address of the Virtual Appliance in order to login to to the Web interface. Run ifconfig -a to view the IP address.

Updating the host's operating system

As a security best practice, make sure to keep your operating system current with the latest updates. To apply an update, take the following steps:

1. Access the operating system of your Virtual Appliance using SSH or by opening the a virtual console.
2. Run the following command to update all operating system packages to the latest versions:

 
1
sudo apt-get update && sudo apt-get upgrade

Logging onto the Security Console

You perform all Security Console operations through a Web-based interface, which supports the browsers listed at https://www.rapid7.com/products/insightvm/system-requirements/.

To log onto the Security Console take the following steps:

1. Open a web browser.
2. Enter the URL for the Virtual Appliance: https://<Virtual_Appliance_IP>:3780
3. Enter the default username (nxadmin) and password (nxpassword).
4. Click the Logon button.

If you are a first-time user and have not activated your license, the Security Console displays an activation dialog box. Enter your license key. If you do not have a license key, visit https://www.rapid7.com/products/insightvm/ to start your 30-day free trail.

After you receive the license key, login and enter the license key in the activation window.

Frequently Asked Questions

How do I set up a static IP?

There are two different ways to set up a static IP.

1. Option 1 - edit one file only

Open the /etc/network/interfaces file in a text editor with the following command:

 
1
sudo nano /etc/network/interfaces

Edit the /etc/network/interfaces config with the following code. Note that you do not need to do the /etc/resolvconf/resolv.conf.d/tail section if you add the dns-nameservers to the /etc/network/interfaces conf file.

 
1
auto ens32
2
iface ens32 inet static
3
address 192.168.0.16
4
netmask 255.255.255.0
5
gateway 192.168.0.1
6
dns-nameservers 8.8.4.4 8.8.8.8

2. Option 2 - Edit two files

Open the /etc/network/interfaces file in a text editor with the following command:

 
1
sudo nano /etc/network/interfaces

Match the corresponding lines to the following values:

 
1
auto ens32
2
iface ens32 inet static

Add the following address, netmask, and gateway lines and specify the values as desired.

 
1
address 10.0.0.100
2
netmask 255.255.255.0
3
gateway 10.0.0.1

How do I set up DNS?

Create the /etc/resolvconf/resolv.conf.d/tail file with the following command:

 
1
sudo nano /etc/resolvconf/resolv.conf.d/tail

Add the following lines and specify values according to your configuration requirements:

 
1
nameserver 8.8.8.8
2
nameserver 8.8.4.4
3
search local.company.com internal.company.com

How do I restart networking?

In order for the static IP and DNS changes to take effect, the existing IP must be flushed with the following command:

 
1
sudo ip addr flush ens32

To restart the networking service, use the following command:

 
1
sudo systemctl restart networking.service

How do I set the system time?

The virtual appliance comes preinstalled with chrony. To check the current system time, run the chronyc tracking command.

Chrony can be configured by editing the /etc/chrony/chrony.conf file.

To manually sync the time, run the following commands:

 
1
sudo service chrony stop
2
sudo chronyd -q 'pool pool.ntp.org iburst'
3
sudo service chrony start

To change the timezone, run sudo dpkg-reconfigure tzdata and select the desired timezone.

How do I start, stop, and check the status of the console and engine services?

Console

 
1
sudo systemctl status nexposeconsole.service
2
sudo systemctl start nexposeconsole.service
3
sudo systemctl stop nexposeconsole.service

Engine

 
1
sudo systemctl status nexposeengine.service
2
sudo systemctl start nexposeengine.service
3
sudo systemctl stop nexposeengine.service

What is the OS account lockout policy?

Accounts will get locked out after 5 invalid login attempts. Accounts will get automatically unlocked after 15 minutes.