Hyper-V Terraform Provider

The hyperv_machine_instance data source allows you to retrieve information about an existing Hyper-V virtual machine instance. This is useful for inspecting the configuration, state, or properties of a VM that was created outside of the current Terraform workspace or by a different resource.

terraform {
  required_providers {
    hyperv = {
      source  = "taliesins/hyperv"
      version = ">= 1.0.3"
    }
  }
}

provider "hyperv" {}

# Example: Fetching an existing machine named 'WebServer'
data "hyperv_machine_instance" "default" {
  name = "WebServer"
}

output "vm_details" {
  value = data.hyperv_machine_instance.default
}

You can manage memory allocation using either static or dynamic memory modes:

• Static Memory: Set static_memory = true and define the amount of memory in memory_startup_bytes.
• Dynamic Memory: Set dynamic_memory = true. You can then specify:
  • memory_minimum_bytes: The minimum amount of memory allocated.
  • memory_maximum_bytes: The maximum amount of memory allocated.
  • memory_startup_bytes: The amount of memory allocated upon startup.

To explore and run the various HyperV service examples provided in this repository, clone the repository and navigate to the specific example directory. Each example directory contains its own README.md with detailed instructions on its specific functionality and execution steps.

$ git clone https://github.com/taliesins/terraform-provider-hyperv
$ cd terraform-provider-hyperv/examples/vm-from-scratch

To use or build the HyperV Terraform Provider, ensure you meet the following requirements:

• Terraform: version 1.29.x
• Go: version 1.19 (required for building the provider plugin)
• HyperV Host: A Windows machine running Windows 10, Windows Server 2016, or newer, with connectivity and credentials available.

To use the Hyper-V provider, you must provide credentials for the host machine. You can do this in two ways:

1. Environment Variables: Set HYPERV_USER and HYPERV_PASSWORD in your shell.
2. Provider Configuration: Define the user and password properties directly within the hyperv provider block in your Terraform configuration.

provider "hyperv" {
	user     = "${var.username}"
	password = "${var.password}"
}

Before using the provider, verify you can connect to the Windows host using PowerShell. Use the following script to test the connection (replace $winrmPort with 5986 for HTTPS or 5985 for HTTP):

$hostName=[System.Net.Dns]::GetHostName()
$winrmPort = "5986"

# Get the credentials of the machine
$cred = Get-Credential

# Connect to the machine
$soptions = New-PSSessionOption -SkipCACheck -SkipCNCheck
Enter-PSSession -ComputerName $hostName -Port $winrmPort -Credential $cred -SessionOption $soptions -UseSSL

The hyperv_vhd resource allows you to create and manage Virtual Hard Disks (VHD/VHDX) in Hyper-V. You can create new disks from scratch, copy them from a source (URL or local path), or create differencing disks from a parent disk.

terraform {
  required_providers {
    hyperv = {
      source  = "taliesins/hyperv"
      version = ">= 1.0.3"
    }
  }
}

provider "hyperv" {
}

resource "hyperv_vhd" "web_server_vhd" {
  path = "c:\\web_server\\web_server_g2.vhdx"
  vhd_type = "Dynamic"
  size = 10737418240 #10GB
}

Once your credentials are configured, execute the standard Terraform workflow to deploy the switch and the cloned virtual machine:

1. Initialize the working directory: terraform init
2. Generate an execution plan: terraform plan -out=tfplan
3. Apply the plan: terraform apply tfplan

This example demonstrates how to create a Hyper-V switch and attach two virtual machines to it.

To run this example, you must provide credentials for the Hyper-V host. You can do this in two ways:

1. Environment Variables: Set HYPERV_USER and HYPERV_PASSWORD in your shell.
2. Provider Configuration: Define the user and password arguments within the hyperv provider block.

After configuring credentials, execute the standard Terraform workflow:

# Option 1: Provider Configuration
provider "hyperv" {
	user     = "${var.username}"
	password = "${var.password}"
}

# Option 2: Execution commands
terraform init
terraform plan -out=tfplan
terraform apply tfplan