A Hyper-V Canary is a virtual Canary that runs inside Microsoft Hyper-V. It connects back to your Console and appears alongside your existing fleet for management and monitoring. This guide covers the requirements, setup process, and how to confirm your Canary is running.

Overview:

Step 1: Log in to your Console

Step 2: Add a new Canary

Step 3: Choose Hyper-V Canary

Step 4: Download the image package

Step 5: Extract the downloaded files

Step 6: Open Hyper-V Manager

Step 7: Start the import wizard

Step 8: Select the image location

Step 9: Confirm the import settings

Step 10: Register or copy the VM

Step 11: Assign a virtual network

Step 12: Review and complete import

Step 13: Rename your Canary VM

Step 14: Power on your Canary VM

Step 15: Verify your Canary is running

Step 16: Confirm the Canary in Console

Step 17: Connect back to Console

 

Canaries aren't just hardware devices. You can run Canaries inside your Microsoft Hyper-V infrastructure, using the same Console as the rest of your Canary fleet.

Note: Hyper-V Canaries are only supported on our new interface. We will enable the new interface for you when you request Hyper-V Canaries if you have not already got it enabled.

Requirements: All that's needed for a fully functioning bird:

• Disk space larger than 10GB
• 2GB memory
• Single CPU core

Follow the steps below to create your Hyper-V Canary:

Step 1: Log in to your Console

Step 2: Add a new Canary

1. Click the + Add icon.
2. Click Add New Canary.

Step 3: Choose Hyper-V Canary

Select Add Hyper-V Canary.

Step 4: Download the image package

Click on Download Zip to start the download.

Step 5: Extract the downloaded files

Your Hyper-V image will begin to download.

Note: Once the download has been completed, extract the zip file to the storage location where your Canary will live in your Hyper-V environment and then move to Step 6.

Step 6: Open Hyper-V Manager

On the Hyper-V Manager interface, click Import Virtual Machine.

Step 7: Start the import wizard

The wizard window will now appear, click Next.

Step 8: Select the image location

1. Click Browse... and browse to the location where you extracted the Hyper-V image.
2. Click Next.

Step 9: Confirm the import settings

Confirm the Virtual Canary import and click Next.

Step 10: Register or copy the VM

1. We selected Register the virtual machine in-place (use the existing unique ID).
2. Click Next.

Note: If deploying multiple Canaries, please select Copy the virtual machine (create a new unique ID).

Step 11: Assign a virtual network

1. Select your preferred virtual network from the drop-down list under Connection for the network your Canary will live on.
2. Click Next.

Note: we have selected Default Switch.

Step 12: Review and complete import

Review the VM information and click Finish.

Step 13: Rename your Canary VM

Right-click on the new VM and rename the VM to the specified name.

Step 14: Power on your Canary VM

Right-click on the VM and click Start to boot this Canary up.

Step 15: Verify your Canary is running

Your VM Canary is now running in Hyper-V.

Step 16: Confirm the Canary in Console

On your Console, you should see a pop up to confirm your new Canary.

1. If you have multiple Flocks choose one for your new Canary.
2. Click Add Canary.

Step 17: Connect back to Console

Your Virtual Canary will boot and connect back to your Console.

You can set up your Virtual Canary from within your Console using the remote management Guide found here.

You're done!