Set Up Virtual Appliance - Hyper-V

The PrinterLogic Virtual Appliance is the latest generation of PrinterLogic's private cloud platform. Typical use cases include:

  • It’s a streamlined, self-contained solution for new customers who want the benefits of PrinterLogic’s serverless printing infrastructure but need tighter control over their print environment.
  • For PrinterLogic Web Stack customers, the Virtual Appliance is a path forward to get the latest features PrinterLogic has to offer. Switching over is a track change but provides the newest functionality and ongoing support.

The PrinterLogic Virtual Appliance gets distributed as a fully integrated, standards-based private cloud solution. As a result, it helps customers maximize their investments in virtual infrastructures designed to reduce unnecessary hardware, software, and ongoing maintenance costs.

The PrinterLogic Client deployment, by default, checks for the use of SSL certificates for security considerations. Using SSL Certificates to encrypt data between the Virtual Appliance and other connected systems is highly recommended to ensure the confidentiality and integrity of your communications. Not using SSL Certificates will require additional configuration that may require assistance from PrinterLogic support engineers.

Minimum System Requirements

Depending on the configured features and user count, the minimum requirements for the Virtual Appliance may increase. Use the recommendations below when creating your Virtual Appliance, but continue to monitor the CPU and RAM utilization and allocate additional resources as needed.

  • Four 3.5-4.0 GHz processors. Add two 3.5 GHz processors for each additional 15,000 users.
  • 16GB RAM for up to 15,000 users.
    • Add 2 CPUs / 8GB RAM for each additional 15,000 users.
    • Add a minimum of 2 CPUs and 4GB RAM if using the Internal Service Client.
    • Add 2 CPUs and 4GB RAM per 500 CPA/Simple Badge Release installations.
  • 80GB free hard disk space for the host disk.
  • There should be 50GB of free hard disk space on the persistent storage disk (add 4GB for every 100 printers).
  • There is a requirement for NTLMv2 to connect to the appliance-storage shared folder of the PrinterLogic Virtual Appliance.

If you are migrating from a Web Stack instance please refer to the steps on Web Stack Migration to Virtual Appliance. Only continue if you are setting up a new installation of the Virtual Appliance.

Prerequisites

  1. Download the latest Virtual Appliance vhd.xz file.
  2. After downloading the vhd.xz file, you will need to extract the VHD from the vhd.xz file. The extracted VHD file should then be placed in your Hyper-V server folder.
  3. DNS configured properly.
    1. Identify a FQDN to use for the PrinterLogic Virtual Appliance (i.e., printerlogic.mycompany.com).
    2. Create an A record in DNS (i.e., printerlogic.mycompany.com) that points to the IP address of the Virtual Appliance.
    3. Create a CNAME record in DNS (i.e., *.printerlogic.mycompany.com) that points to the A record above (i.e., printerlogic.mycompany.com)
  4. SSL certificates created and available.
    1. The SubjectAlternativeName extension must list the two DNS entries above (i.e., printerlogic.mycompany.com and *.printerlogic.mycompany.com). In depth information can be found in the Virtual Appliance SSL Certificates document.
  5. Open ports for DB access from your machine:
    1. TCP 3306 - MySQL
    2. TCP 80 - HTTP
    3. TCP 443 - HTTPS
    4. TCP 8000 - Configuration API
    5. TCP 8080 - Configuration UI
    6. TCP 445 - SMB
  6. (Optional) If you are using advanced features requiring a Service Client, you must ensure the Service Client gets appropriately configured. See Set up a service client for more information.

Configure the Virtual Machine

  1. Open up your Hyper-V Manager Console.

    HyperV Manager Console showing the main interface and settings.

  2. Right click on your server, hover your pointer over New, then click on Virtual Machine.

    New Virtual Machine setting seen after right-clicking the server icon in the interface.

  3. Click on Next.

    New virtual machine wizard pop-up with the Next button highlighted.

  4. Specify the new Virtual Machines Name, then click Next.

    VM Wizard with an arrow pointing to the virtual machine name and the Next button is highlighted in the bottom middle.

  5. Select Generation 1 and click Next.

    Virtual machine wizard with an arrow pointing to the Generation 1 option near the top.

  6. Change the memory to 16000 MB and click Next.

    PrinterLogic recommends 16GB RAM for up to 15,000 users (add 4GB for every additional 15,000 users)

    VM wizard showing the Assign Memory tab with an arrow pointing to the Startup memory box adjusted for more RAM.

  7. Select the Virtual Switch you have configured in Hyper-V and click Next.

    VM Wizard showing the Connection drop-down with New Virtual Switch highlighted.

  8. Select the option to Use an existing virtual hard disk, and browse to the downloaded PrinterLogic VHD file. Select the file, and click on Next.

    VM Wizard with an arrow pointing to the Use an existing virtual hard disk option and field to browse for the location path.

  9. Click Finish at the bottom of the summary screen.

    VM Wizard summary page with the Finish button showing in the bottom right.

  10. In the Actions pane to the right, under the virtual machine you just created, click on Settings.

    Actions tab on the right of the VM interface with an arrow pointing to the Settings option in the New Virtual Machine section.

  11. With Add Hardware selected in the left pane and SCSI Controller selected in the right pick list, click on Add.

    Settings pop-up showing the Add Hardware option selected and an arrow pointing to the SCSI Controller option with the Add button to its lower right.

  12. Select Hard Drive, and click Add.

    SCSI Controller tab with Hard Drive option selected and the Add button showing to the lower right.

  13. Select New.

    Hard Drive section with an arrow pointing to the New button to start the hard disk wizard.

  14. Click Next.

  15. Keep the default VHDX selected and click on Next.

    New Hard disk wizard with the VHDX option selected.

  16. Select the appropriate disk type for your environment and click Next.

    Disk type options including Fixed Size, Dynamically expanding, and Differencing.

  17. Name the disk, and click Next.

    Wizard tab where you specify to name of the hard disk and the location of the file.

  18. Select the new hard disk and adjust to the recommended minimum size of 50 GB and click Next.

    PrinterLogic recommends 50GB free persistent hard disk space (add 4GB for every 100 printers).

    Wizard showing the configure disk section and an arrow to the Size field to specify the size of the virtual hard disk.

  19. Review the summary page and then click Finish.

    Hard disk wizard showing the Finish button on the Summary tab.

  20. After the wizard finishes building you will be returned to the Settings dialog.

  21. Select Processor from the left pane and increase to a minimum of 4 processors.

    PrinterLogic recommends four 3.5-4.0 GHz processors. Add two 3.5 GHz processors for each additional 15,000 users.

    Settings tab with Processor selected, and processor count changed to four.

  22. Click on OK.

  23. In the VM's action pane click on Start.

    HyperV main interface with an arrow pointing to the Start button in the Actions menu to the lower right.

  24. After the VM starts, open the VM screen and annotate the provided IP address.

  25. Log in using the displayed login and password to configure the network settings. This allows you to configure a static IP, default gateway, search domain, subnet IP address ranges, and the DNS servers.

    VA Web Console showing the URL to continue setup, and the network settings credentials.

    If you will be using a fully qualified domain name for accessing your Virtual Appliance, you should configure it in DNS and assign it the IP address shown on this console. You would also need to have the license file that PrinterLogic provides to contain the same FQDN for the licensed URL. When you are done with configuration from the above URL, the system will redirect you to the FQDN/URL you have in your license. If you are just testing and don’t need to manage more than 5 printers, you can continue to access the server via IP.

Configure Virtual Appliance Network Settings

The Virtual Appliance starts as a DHCP client. It’s possible to leave it that way and configure the TCP/IP settings via DHCP Reservation. Otherwise, use the steps below to configure a static IP and to optionally change the private IP range that the Virtual Appliance uses by default so that it doesn’t conflict with existing subnets in the environment.

  1. In the hypervisor where the Virtual Appliance runs, open the web console to access the Virtual Appliance Linux terminal interface.
  2. Login with the credentials supplied in the terminal banner for the network user.

    VA web console showing basic settings with the network settings credentials highlighted.

  3. Enter "Y" to change the network settings.
  4. Enter "Y" to change the network mode.

  5. Enter the TCP/IP settings.

    The image below is just an example. Ensure you use the settings specific to your network.

    VA web console, after logging in with network settings credentials, with the adjustable network settings all displayed and highlighted.

  6. If the existing address pool does not conflict with any subnets in the environment, enter “N”. Otherwise, enter “Y” to set a different address range.

    VA web console, Would you like to change the unassigned address pool for your network setting highlighted.

    If needing to adjust IP addresses, be sure to read and understand the network range options you are presented with. Any range used must have a netmask < 20.

    VA web console, with the network range IP requirements highlighted.

  7. If needing to adjust the IP address ranges, configure the address range.

    The image below is just an example. Ensure you use the settings specific to your network.

    VA web console, example highlighted of the unassigned CIDR range.

  8. Press any key to exit.

Launch the Virtual Appliance Wizard

The following steps are ONLY for setting up a new Virtual Appliance. If you are migrating from Web Stack to the Virtual Appliance, continue the migration by selecting Client Cut-over: Step 9 or DNS Cut-over Step 9.

The steps below are for creating new Virtual Appliance instances. If you are upgrading from an older host build, reference Host Upgrade.

  1. Open your preferred, supported browser window, and paste the IP address into the Address Bar, including port 8080. Example: 192.168.10.20:8080.

  2. When the PrinterLogic Virtual Appliance wizard appears, click Let's Do This.

    "Lets do this" button on the Welcome to PrinterLogic VA initialization wizard browser page.

  3. Select the Storage Type drop-down and select VM-Attached Virtual Disk.

    VM-Attached Virtual Disk option in the Storage Type drop-down, selected in the VA wizard.

  4. Click Format Attached Storage.

  5. When the attached disk is ready, click Continue.

    Orange Continue button highlighted in the upper right of the VA wizard Configure Storage window.

  6. If creating a new Virtual Appliance instance, click on Start New Instance.

    VA Wizard showing two button options, Start a New Instance, or Upgrade my Current Instance.

  7. When the General Settings appear add the domain name, then upload your license file, SSL certificate, and SSL key. When finished, click Continue.

    Ensure you document and save the Shared Storage Password so you can access the Data Drive later as needed. You can find more information on accessing the shared storage at the end of this document.

    General settings tab in the wizard showing the domain name, shared storage password, and upload location for the license file, SSL certificate, and SSL Key.

  8. When the Setup Database settings appear, make adjustments on the database type and then click Continue.

    If you want the MySQL database to reside on the VM's data drive, then leave the default settings for Database Type.

    Database type drop-down with two database options. One for using the internal VA database, or an external MySQL8+ database.

  9. Click Finish Setup.

    VA Setup wizard window with an arrow pointing to the Finish Setup button in the lower middle.

    Please do not refresh the page during the installation procedure.

  10. A new "Thank You" browser window will open when the installation is complete. This window can be closed as needed.

  11. The PrinterLogic Virtual Appliance login window appears, where you can Set up Login Credentials

    PrinterLogic root user account set up fields seen when first visiting the VA Admin Console.

  12. Once you are logged in, you will need to accept the License Agreement.

  13. You are now ready to work with your PrinterLogic Virtual Appliance.

    PrinterLogic Admin console shown after first logging in. Tree view to the left, object tabs in the center, and menu drop-downs in the upper right.

Accessing Data Files

If you need to add or update a license file or certificate or access the log files, you will need to map a network drive to the Virtual Appliance folder share. This can be done by using a non-elevated command prompt using a command similar to:

net use V: \\<hostname>\appliance-storage <password> /user:Admin /p:yes.

If the password contains special characters you will need to place "quotes" around the password.

Make sure you use a non-elevated command prompt to map the drive. If you have Windows UAC enabled on your workstation, drives mapped from an elevated command prompt are not visible in Windows Explorer by default. You can find additional information in Microsoft documentation.