QuickStart Guide
...
Installation and Deployments
ISO Installation on Hypervisor...

Hyper-V

14min

You can install Litmus Edge on a virtual machine using Windows Hyper-V. See the Introduction to Hyper-V on Windows 10 for more information.

A typical Litmus Edge virtual file for Hyper-V deployment adheres to a naming convention as follows: <product-std_3.1.5.0-amd64>.iso.

Video



Before You Begin

  • Adjust the system clock for the host environment prior to installing Litmus Edge. UTC is recommended. The 15-day trial period may be rejected and invalidated by the license server if the system clock is not adjusted. If this happens, contact your Litmus representative.
  • Obtain a valid file in the ISO format (example filename: <litmusedge-std_3.1.2.0-amd64>.iso). You can get the ISO file from Litmus or download it from the Litmus Central portal.

To use Hyper-V to install Litmus Edge, you will need to do the following.

  • Step 1: Turn Hyper-V Feature On
  • Step 2: Start the Hyper-V Service
  • Step 3: Create Virtual Machine
  • Step 4: Configure the Virtual Machine
  • Step 5: Install the Edge Device
  • Step 6: Run the Virtual Machine
  • Step 7: Log in to Litmus Edge

To jump to a specific section, refer to the Table of Contents on the right side and click the corresponding step.

Step 1: Turn Hyper-V Feature On

You must first turn on the Hyper-V feature.

To turn the Hyper-V feature on:

  1. In Windows, navigate to Control Panel > Programs > Programs and Features.
  2. Click Turn Windows features on or off.
  3. Select Hyper-V from the list and click OK.
Document image


Step 2: Start Hyper-V Service

You can now start the Hyper-V Service.

To start the Hyper-V Service:

  1. Open the Hyper-V Manager.
  2. Select the disk to install the virtual machine in and click Start Service. The Hyper-V service is running.
Document image


Step 3: Create Virtual Machine

Once the Hyper-V service is running, you can create the virtual machine. You have two options for creating it. If you don't see the Quick Create option in your version of Windows, you must follow the steps in the Create New Virtual Machine section.

Document image


Create Virtual Machine with Quick Create

Complete the following steps if you see the Quick Create option. If you don't see this option, see the Create New Virtual Machine section below.

To create the virtual machine:

  1. Select the disk to create the virtual machine in and click Quick Create. The Create Virtual Machine dialog box appears.
  2. Click Local installation source. The Change installation source button appears.

    Document image
    
  3. Unselect the checkbox for This virtual machine will run Windows.

    Document image
    
  4. Click Change installation source. The New dialog box appears.
  5. Navigate to the downloaded ISO file, select the file, and click Open. The name of the selected ISO file appears.
  6. Click More options.

    Document image
    
  7. Enter a name for the virtual machine and confirm that the network selection is Default Switch.

    Document image
    
  8. Click Create Virtual Machine.

The new virtual machine is created with the name you added and appears in the Virtual Machines pane.

Create New Virtual Machine

If the Quick Create option is not available, complete the following steps.

Important: To ensure you successfully configure the virtual machine, you must select Generation 2 when configuring the Specify Generation section.

To create a new virtual machine:

  1. Right-click the disk to install the virtual machine in and select New > Virtual Machine. The New Virtual Machine Wizard appears.

    Document image
    
  2. Review the Before You Begin section and click Next.
  3. Configure the parameters for the virtual machine.
    • Specify Name and Location: Enter a name and configure the location for the virtual machine.
    • Specify Generation: You must select Generation 2.
    • Assign Memory: Assign a minimum of 4096 MB.
    • Configure Networking: If you are not using a specific ethernet adapter, select Default Switch.
    • Connect Virtual Hard Disk: Select Attach a virtual hard disk later.
    • Installation Options: Configure the installation options and click Next.
  4. Review the summary and click Finish. The virtual machine will display in the Virtual Machines section.
  5. Select the new virtual machine and click Settings...

    Document image
    
  6. Select SCSI Controller. Then, click DVD Drive and Add.

    Document image
    
  7. For Media, select Image file and select the Litmus Edge ISO file.

    Document image
    
  8. Click Apply and then OK.

Continue with the following steps to further configure the virtual machine.

Step 4: Configure Virtual Machine

To configure the virtual machine:

  1. From the Virtual Machines pane in the Hyper-V Manager, click the virtual machine name. The virtual machine name appears in the Actions pane and includes sub-menus.
  2. From the Actions pane, click Settings under the virtual machine name. The Settings for new VM dialog box appears.
  3. From the Settings for new VM dialog box, configure the following.
    • Firmware: Make sure that DVD drive with Image File is in first place for the Boot order.
    • Security: Select the Enable Trusted Platform Module checkbox and deselect the remaining checkboxes.
    • Memory: Enter at least 4096 MB in the RAM field.
    • Processor: Enter 2 in the Virtual Processors field.
    • Network: Select Default Switch from the Virtual Switch drop-down list.
  4. Click Apply, and then click OK to close the Settings dialog box.
  5. Click the Connect sub-menu. The Starting the new VM dialog box appears. A message appears that the VM is turned off and prompts to you to start.
  6. Click Start.

The installation for the virtual machine begins.

Step 5: Run Operating System Installer

You will run the operating system installer that will install Litmus Edge.

Notes:

  • During the installation, the progress bar may decrease at times due to partitioning.
  • The time to complete the installation is based on the size of the hard disk drive. Large disk drives will cause the installation to take longer to partition the disk and therefore longer to complete setting up the virtual machine.

To install the edge device:

  1. After the device initiates the installer, respond to the questions in the terminal user interface (TUI). Welcome to Operating System Installer. Are you installing over Serial (for advanced users)? Yes/No :
  2. Enter No, and then press ENTER.
  3. Select Install Operating System, and then select OK. Use the arrow keys to navigate to selections.

    Install Operating System option
    Install Operating System option
    
  4. Select the partition to install, and then select OK. This list is device specific. Typically, the installation location is sda. If the device/gateway has embedded MMC (eMMC) components, the partition name may be listed as mmcblk instead of sda. Make sure you select the correct hard drive location.

    Select partition step
    Select partition step
    
  5. Verify the OS installation location by selecting Yes. If you select No, you are returned to the beginning of the installation.
  6. A second verification ensures that you are overwriting the correct device partition during the formatting process. Select Yes to continue formatting the device and installing the operating system.

    Format devices warning message
    Format devices warning message
    
  7. The installer indicates its progress, followed by a success message. Select Yes to power off the device.

    Power off option
    Power off option
    
  8. Close the Virtual Machine dialog box.
  9. From the Actions pane, click the Settings sub-menu again under the new virtual machine name. The Settings for new VM dialog box appears.
  10. From the Settings for new VM dialog box, configure the following.
    • SCSI Controller: Select DVD Drive and click Remove to delete this drive.
    • Firmware: Make sure that Hard Drive with Image File is in first place of the Boot order.
  11. Click Apply, and then click OK to close the Settings dialog box.

The virtual machine is ready to run from the hard drive.

Step 6: Run Virtual Machine

Now that the edge device is installed, you can run the virtual machine.

To run the virtual machine:

  1. From the Actions pane in the Hyper-V Manager, click Connect... under the new virtual machine name.

    Document image
    
  2. From the virtual machine window, click Start, and then select Continue from the pop-up window.

The virtual machine boots up and displays the IP address to access using a web browser.

Document image


Step 7: Log in to Litmus Edge