Terraform Provider HyperV

https://github.com/taliesins/terraform-provider-hyperv
Admin
Terraform Provider HyperV is a Terraform plugin that allows users to manage Microsoft Hyper-V...
Tokens:8,774
Snippets:71
Trust Score:9.1
License:MPL-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Clone and navigate to HyperV provider examples

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/examples/README.md

Use these commands to download the repository and enter a specific example directory.

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

--------------------------------

### Manage Hyper-V Machine Instance

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/machine_instance.md

Example configuration for a Hyper-V virtual machine instance, including dependencies for ISO images, network switches, and VHDs.

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

provider "hyperv" {
}

data "archive_file" "bootstrap" {
  type        = "zip"
  source_dir  = "bootstrap"
  output_path = "bootstrap.zip"
}

resource "hyperv_iso_image" "bootstrap" {
  volume_name               = "BOOTSTRAP"
  source_zip_file_path      = data.archive_file.bootstrap.output_path
  source_zip_file_path_hash = data.archive_file.bootstrap.output_sha
  destination_iso_file_path = "c:\\web_server\\bootstrap.iso"
  iso_media_type            = "dvdplusrw_duallayer"
  iso_file_system_type      = "unknown"
}

resource "hyperv_network_switch" "dmz_network_switch" {
  name                                    = "DMZ"
  notes                                   = ""
  allow_management_os                     = true
  enable_embedded_teaming                 = false
  enable_iov                              = false
  enable_packet_direct                    = false
  minimum_bandwidth_mode                  = "None"
  switch_type                             = "Internal"
  net_adapter_names                       = []
  default_flow_minimum_bandwidth_absolute = 0
  default_flow_minimum_bandwidth_weight   = 0
  default_queue_vmmq_enabled              = false
  default_queue_vmmq_queue_pairs          = 16
  default_queue_vrss_enabled              = false
}

resource "hyperv_vhd" "web_server_g2_vhd" {
  path = "c:\\web_server\\web_server_g2.vhdx" #Needs to be absolute path
  size = 10737418240                          #10GB
}

resource "hyperv_machine_instance" "default" {
  name                                    = "WebServer"
  generation                              = 2
  automatic_critical_error_action         = "Pause"
  automatic_critical_error_action_timeout = 30
  automatic_start_action                  = "StartIfRunning"
  automatic_start_delay                   = 0
  automatic_stop_action                   = "Save"
  checkpoint_type                         = "Production"
  guest_controlled_cache_types            = false
  high_memory_mapped_io_space             = 536870912
  lock_on_disconnect                      = "Off"
  low_memory_mapped_io_space              = 134217728
  memory_maximum_bytes                    = 1099511627776
  memory_minimum_bytes                    = 536870912
  memory_startup_bytes                    = 536870912
  notes                                   = ""
  processor_count                         = 1
  smart_paging_file_path                  = "C:\\ProgramData\\Microsoft\\Windows\\Hyper-V"
  snapshot_file_location                  = "C:\\ProgramData\\Microsoft\\Windows\\Hyper-V"
  #dynamic_memory                         = false
  static_memory = true
  state         = "Running"

  # Configure firmware
  vm_firmware {
    enable_secure_boot = "Off"
    #secure_boot_template            = ""
    preferred_network_boot_protocol = "IPv4"
    console_mode                    = "None"
    pause_after_boot_failure        = "Off"
    boot_order {
      boot_type           = "HardDiskDrive"
      controller_number   = "0"
      controller_location = "0"
    }
    boot_order {
      boot_type            = "NetworkAdapter"
      network_adapter_name = "wan"
    }
  }

  # Configure processor
  vm_processor {
    compatibility_for_migration_enabled               = false
    compatibility_for_older_operating_systems_enabled = false
    hw_thread_count_per_core                          = 0
    maximum                                           = 100
    reserve                                           = 0
    relative_weight                                   = 100
    maximum_count_per_numa_node                       = 0
    maximum_count_per_numa_socket                     = 0
    enable_host_resource_protection                   = false
    expose_virtualization_extensions                  = false
  }

  # Configure integration services
  integration_services = {
    "Guest Service Interface" = false
    "Heartbeat"               = true
    "Key-Value Pair Exchange" = true
    "Shutdown"                = true
    "Time Synchronization"    = true
    "VSS"                     = true
  }
```

--------------------------------

### Clone and Build Provider

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Commands to clone the repository and compile the provider binary.

```sh
$ mkdir -p $GOPATH/src/github.com/taliesins; cd $GOPATH/src/github.com/taliesins
$ git clone https://github.com/taliesins/terraform-provider-hyperv.git
```

```sh
$ cd $GOPATH/src/github.com/taliesins/terraform-provider-hyperv
$ make build
```

--------------------------------

### Execute Provider Binary

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Run the locally compiled provider binary after building.

```sh
$ make build
...
$ $GOPATH/bin/terraform-provider-hyperv
...
```

--------------------------------

### Execute Terraform Lifecycle Commands

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/examples/vm-from-scratch/README.md

Standard sequence of commands to initialize, plan, and apply the Terraform configuration.

```bash
terraform init
terraform plan -out=tfplan
terraform apply tfplan
```

--------------------------------

### Run Provider Tests

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Commands to execute standard unit tests or full acceptance tests.

```sh
$ make test
```

```sh
$ make testacc
```

--------------------------------

### Configure WinRM with HTTPS

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Generates a root CA and host certificate, then configures a WinRM HTTPS listener and firewall rule.

```powershell
#Create CA certificate
$rootCaName = "DevRootCA"
$rootCaPassword = ConvertTo-SecureString "P@ssw0rd" -asplaintext -force 
$rootCaCertificate = Get-ChildItem cert:\LocalMachine\Root |?{$_.subject -eq "CN=$rootCaName"}
if (!$rootCaCertificate){
  Get-ChildItem cert:\LocalMachine\My |?{$_.subject -eq "CN=$rootCaName"} | remove-item -force
  if (Test-Path .\$rootCaName.cer) {
    remove-item .\$rootCaName.cer -force
  }
  if (Test-Path .\$rootCaName.pfx) {
    remove-item .\$rootCaName.pfx -force
  }
  $params = @{
    Type = 'Custom'
    DnsName = $rootCaName
    Subject = "CN=$rootCaName"
    KeyExportPolicy = 'Exportable'
    CertStoreLocation = 'Cert:\LocalMachine\My'
    KeyUsageProperty = 'All'
    KeyUsage = 'None'
    Provider = 'Microsoft Strong Cryptographic Provider'
    KeySpec = 'KeyExchange'
    KeyLength = 4096
    HashAlgorithm = 'SHA256'
    KeyAlgorithm = 'RSA'
    NotAfter = (Get-Date).AddYears(5)
  }
  $rootCaCertificate = New-SelfSignedCertificate @params

  Export-Certificate -Cert $rootCaCertificate -FilePath .\$rootCaName.cer -Verbose
  Export-PfxCertificate -Cert $rootCaCertificate -FilePath .\$rootCaName.pfx -Password $rootCaPassword -Verbose
  Get-ChildItem cert:\LocalMachine\My |?{$_.subject -eq "CN=$rootCaName"} | remove-item -force
  Import-PfxCertificate -FilePath .\$rootCaName.pfx -CertStoreLocation Cert:\LocalMachine\Root -password $rootCaPassword -Exportable -Verbose
  Import-PfxCertificate -FilePath .\$rootCaName.pfx -CertStoreLocation Cert:\LocalMachine\My -password $rootCaPassword -Exportable -Verbose
  $rootCaCertificate = Get-ChildItem cert:\LocalMachine\My |?{$_.subject -eq "CN=$rootCaName"}
}

#Create host certificate using CA
$hostName = [System.Net.Dns]::GetHostName()
$hostPassword = ConvertTo-SecureString "P@ssw0rd" -asplaintext -force
$hostCertificate = Get-ChildItem cert:\LocalMachine\My |?{$_.subject -eq "CN=$hostName"}
if (!$hostCertificate){
  if (Test-Path .\$hostName.cer) {
    remove-item .\$hostName.cer -force
  }
  if (Test-Path .\$hostName.pfx) {
    remove-item .\$hostName.pfx -force
  }
  $dnsNames = @($hostName, "localhost", "127.0.0.1") + [System.Net.Dns]::GetHostByName($env:computerName).AddressList.IpAddressToString
  
  $params = @{
    Type = 'Custom'
    DnsName = $dnsNames
    Subject = "CN=$hostName"
    KeyExportPolicy = 'Exportable'
    CertStoreLocation = 'Cert:\LocalMachine\My'
    KeyUsageProperty = 'All'
    KeyUsage = @('KeyEncipherment','DigitalSignature','NonRepudiation')
    TextExtension = @("2.5.29.37={text}1.3.6.1.5.5.7.3.1,1.3.6.1.5.5.7.3.2")
    Signer = $rootCaCertificate
    Provider = 'Microsoft Strong Cryptographic Provider'
    KeySpec = 'KeyExchange'
    KeyLength = 2048
    HashAlgorithm = 'SHA256'
    KeyAlgorithm = 'RSA'
    NotAfter = (Get-date).AddYears(2)
  }
  $hostCertificate = New-SelfSignedCertificate @params
  Export-Certificate -Cert $hostCertificate -FilePath .\$hostName.cer -Verbose
  Export-PfxCertificate -Cert $hostCertificate -FilePath .\$hostName.pfx -Password $hostPassword -Verbose
  Get-ChildItem cert:\LocalMachine\My |?{$_.subject -eq "CN=$hostName"} | remove-item -force
  Import-PfxCertificate -FilePath .\$hostName.pfx -CertStoreLocation Cert:\LocalMachine\My -password $hostPassword -Exportable -Verbose
  $hostCertificate = Get-ChildItem cert:\LocalMachine\My |?{$_.subject -eq "CN=$hostName"}
}

Get-ChildItem wsman:\localhost\Listener\ | Where-Object -Property Keys -eq 'Transport=HTTPS' | Remove-Item -Recurse
New-Item -Path WSMan:\localhost\Listener -Transport HTTPS -Address * -CertificateThumbPrint $($hostCertificate.Thumbprint) -Force -Verbose

Restart-Service WinRM -Verbose

New-NetFirewallRule -DisplayName "Windows Remote Management (HTTPS-In)" -Name "WinRMHTTPSIn" -Profile Any -LocalPort 5986 -Protocol TCP -Verbose
```

--------------------------------

### Manage ISO images with Terraform

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/iso_image.md

Configures the hyperv_iso_image resource to create an ISO from a local zip file.

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

provider "hyperv" {
}

data "archive_file" "bootstrap" {
  type        = "zip"
  source_dir  = "bootstrap"
  output_path = "bootstrap.zip"
}

resource "hyperv_iso_image" "bootstrap" {
  volume_name               = "BOOTSTRAP"
  source_zip_file_path      = data.archive_file.bootstrap.output_path
  source_zip_file_path_hash = data.archive_file.bootstrap.output_sha
  destination_iso_file_path = "$env:TEMP\\bootstrap.iso"
  iso_media_type            = "dvdplusrw_duallayer"
  iso_file_system_type      = "unknown"
}
```

--------------------------------

### Create a Dynamic VHD with Terraform

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/vhd.md

Defines a dynamic virtual hard disk resource with a specified path and size.

```terraform
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"
  #source               = ""
  #source_vm            = ""
  #source_disk          = 0
  vhd_type = "Dynamic"
  #parent_path          = ""
  size = 10737418240 #10GB
  #block_size           = 0
  #logical_sector_size  = 0
  #physical_sector_size = 0
}
```

--------------------------------

### hyperv_iso_image Resource

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/iso_image.md

The hyperv_iso_image resource allows users to manage ISO images. It requires a destination path and supports various optional configurations for source files, file system types, and media types.

```APIDOC
## hyperv_iso_image (Resource)

### Description
This resource allows you to manage ISOs in a Hyper-V environment.

### Required Parameters
- **destination_iso_file_path** (String) - Remote iso file path.

### Optional Parameters
- **destination_boot_file_path** (String) - Remote boot file path. Defaults to $env:temp\{filename(source_boot_file_path)}.
- **destination_zip_file_path** (String) - Remote zip file path. Defaults to $env:temp\{filename(source_zip_file_path)}.
- **iso_file_system_type** (String) - File system type for iso. Valid values: none, iso9660, joliet, iso9660|joliet, udf, joliet|udf, iso9660|joliet|udf, unknown.
- **iso_media_type** (String) - Media type for iso. Valid values: unknown, cdrom, cdr, cdrw, dvdrom, dvdram, dvdplusr, dvdplusrw, dvdplusr_duallayer, dvddashr, dvddashrw, dvddashr_duallayer, disk, dvdplusrw_duallayer, hddvdrom, hddvdr, hddvdram, bdrom, bdr, bdre.
- **source_boot_file_path** (String) - Local boot file path.
- **source_boot_file_path_hash** (String) - Hash of local boot file.
- **source_iso_file_path** (String) - Local iso file path.
- **source_iso_file_path_hash** (String) - Hash of local iso file.
- **source_zip_file_path** (String) - Local zip file path.
- **source_zip_file_path_hash** (String) - Hash of local zip file.
- **volume_name** (String) - Volume name for iso. Must be 15 characters or less (A-Z, 0-9, _).
- **timeouts** (Block) - Configuration for create, delete, read, and update operations.

### Read-Only Attributes
- **id** (String) - The ID of this resource.
- **resolve_destination_boot_file_path** (String) - The remote boot file path that was used.
- **resolve_destination_iso_file_path** (String) - The remote iso file path that was used.
- **resolve_destination_zip_file_path** (String) - The remote zip file path that was used.
```

--------------------------------

### Configure WinRM for HyperV Provider

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Commands to enable PowerShell remoting and configure WinRM settings for remote management.

```powershell
Enable-PSRemoting -SkipNetworkProfileCheck -Force

Set-WSManInstance WinRM/Config/WinRS -ValueSet @{MaxMemoryPerShellMB = 1024}
Set-WSManInstance WinRM/Config -ValueSet @{MaxTimeoutms=1800000}
Set-WSManInstance WinRM/Config/Client -ValueSet @{TrustedHosts="*"}
Set-WSManInstance WinRM/Config/Service/Auth -ValueSet @{Negotiate = $true}
```

--------------------------------

### Configure HyperV Provider and Resources

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/index.md

Defines the provider connection settings and basic resource declarations for HyperV infrastructure.

```terraform
# Configure HyperV
provider "hyperv" {
  user            = "Administator"
  password        = "P@ssw0rd"
  host            = "127.0.0.1"
  port            = 5986
  https           = true
  insecure        = false
  use_ntlm        = true
  tls_server_name = ""
  cacert_path     = ""
  cert_path       = ""
  key_path        = ""
  script_path     = "C:/Temp/terraform_%RAND%.cmd"
  timeout         = "30s"
}

# Create a switch
resource "hyperv_network_switch" "dmz" {
}

# Create a vhd
resource "hyperv_vhd" "webserver" {
}

# Create a machine
resource "hyperv_machine_instance" "webserver" {
}
```

--------------------------------

### data "hyperv_machine_instance"

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/machine_instance.md

Retrieves details for a specific Hyper-V machine instance.

```APIDOC
## data "hyperv_machine_instance"

### Description
Retrieves information about an existing Hyper-V machine instance identified by its name.

### Parameters
#### Required
- **name** (string) - The name of the Hyper-V machine instance to retrieve.

### Usage Example
```hcl
data "hyperv_machine_instance" "default" {
  name = "my-machine-name"
}
```

### Attributes
- **id** (string) - The ID of the machine instance.
- **name** (string) - The name of the machine instance.
```

--------------------------------

### Configure WinRM with HTTP

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Configures a WinRM HTTP listener and firewall rule, temporarily setting network profiles to private if necessary.

```powershell
# Get the public networks
$PubNets = Get-NetConnectionProfile -NetworkCategory Public -ErrorAction SilentlyContinue 

# Set the profile to private
foreach ($PubNet in $PubNets) {
    Set-NetConnectionProfile -InterfaceIndex $PubNet.InterfaceIndex -NetworkCategory Private
}

# Configure winrm
Set-WSManInstance WinRM/Config/Service -ValueSet @{AllowUnencrypted = $true}

# Restore network categories
foreach ($PubNet in $PubNets) {
    Set-NetConnectionProfile -InterfaceIndex $PubNet.InterfaceIndex -NetworkCategory Public
}

Get-ChildItem wsman:\localhost\Listener\ | Where-Object -Property Keys -eq 'Transport=HTTP' | Remove-Item -Recurse
New-Item -Path WSMan:\localhost\Listener -Transport HTTP -Address * -Force -Verbose

Restart-Service WinRM -Verbose

New-NetFirewallRule -DisplayName "Windows Remote Management (HTTP-In)" -Name "WinRMHTTPIn" -Profile Any -LocalPort 5985 -Protocol TCP -Verbose
```

--------------------------------

### Configure DVD Drive

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/machine_instance.md

Defines a DVD drive configuration using an ISO image path.

```hcl
dvd_drives {
    controller_number   = "0"
    controller_location = "1"
    //path = ""
    path               = hyperv_iso_image.bootstrap.destination_file_path
    resource_pool_name = ""
  }
```

--------------------------------

### Retrieve Hyper-V Network Switch Information

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/network_switch.md

Demonstrates defining a network switch resource and subsequently querying its details using the hyperv_network_switch data source.

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

provider "hyperv" {
}

resource "hyperv_network_switch" "default" {
  name                                    = "DMZ"
  notes                                   = ""
  allow_management_os                     = true
  enable_embedded_teaming                 = false
  enable_iov                              = false
  enable_packet_direct                    = false
  minimum_bandwidth_mode                  = "None"
  switch_type                             = "Internal"
  net_adapter_names                       = []
  default_flow_minimum_bandwidth_absolute = 0
  default_flow_minimum_bandwidth_weight   = 0
  default_queue_vmmq_enabled              = false
  default_queue_vmmq_queue_pairs          = 16
  default_queue_vrss_enabled              = false
}

data "hyperv_network_switch" "default" {
  name = hyperv_network_switch.default.name
}

output "hyperv_network_switch" {
  value = data.hyperv_network_switch.default
}
```

--------------------------------

### Configure Network Adaptor

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/machine_instance.md

Defines a network adaptor configuration for a Hyper-V machine instance.

```hcl
network_adaptors {
    name                                       = "wan"
    switch_name                                = hyperv_network_switch.dmz_network_switch.name
    management_os                              = false
    is_legacy                                  = false
    dynamic_mac_address                        = true
    static_mac_address                         = ""
    mac_address_spoofing                       = "Off"
    dhcp_guard                                 = "Off"
    router_guard                               = "Off"
    port_mirroring                             = "None"
    ieee_priority_tag                          = "Off"
    vmq_weight                                 = 100
    iov_queue_pairs_requested                  = 1
    iov_interrupt_moderation                   = "Off"
    iov_weight                                 = 100
    ipsec_offload_maximum_security_association = 512
    maximum_bandwidth                          = 0
    minimum_bandwidth_absolute                 = 0
    minimum_bandwidth_weight                   = 0
    mandatory_feature_id                       = []
    resource_pool_name                         = ""
    test_replica_pool_name                     = ""
    test_replica_switch_name                   = ""
    virtual_subnet_id                          = 0
    allow_teaming                              = "On"
    not_monitored_in_cluster                   = false
    storm_limit                                = 0
    dynamic_ip_address_limit                   = 0
    device_naming                              = "Off"
    fix_speed_10g                              = "Off"
    packet_direct_num_procs                    = 0
    packet_direct_moderation_count             = 0
    packet_direct_moderation_interval          = 0
    vrss_enabled                               = true
    vmmq_enabled                               = false
    vmmq_queue_pairs                           = 16
  }
```

--------------------------------

### Configure DVD Drive

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/machine_instance.md

Defines a DVD drive configuration for a Hyper-V machine instance.

```hcl
dvd_drives {
    controller_number   = "0"
    controller_location = "1"
    path                = ""
    #path                = "c:/iso/windows-server-2016.iso"
    resource_pool_name = ""
  }
```

--------------------------------

### Configure Debugging Logs

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Set environment variables to enable Terraform trace logs and WinRM debug output.

```sh
set TF_LOG=TRACE
```

```sh
set WINRMCP_DEBUG=TRUE
```

--------------------------------

### Retrieve Machine Instance Data

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/machine_instance.md

Retrieves information about an existing Hyper-V machine instance.

```hcl
data "hyperv_machine_instance" "default" {
  name = hyperv_machine_instance.default.name
}

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

--------------------------------

### hyperv_vhd Resource

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/vhd.md

The hyperv_vhd resource allows you to manage VHDs in Hyper-V. It provides parameters to define the disk path, type, size, and source configuration.

```APIDOC
## Resource: hyperv_vhd

### Description
This resource allows you to manage virtual hard disks (VHDs) in Hyper-V. You can create new disks or copy existing ones from various sources.

### Required Parameters
- **path** (String) - Required - Path to the new virtual hard disk file(s) that is being created or being copied to.

### Optional Parameters
- **block_size** (Number) - Optional - Specifies the block size, in bytes, of the virtual hard disk to be created.
- **logical_sector_size** (Number) - Optional - Specifies the logical sector size, in bytes. Valid values: 0, 512, 4096.
- **parent_path** (String) - Optional - Specifies the path to the parent of the differencing disk to be created.
- **physical_sector_size** (Number) - Optional - Specifies the physical sector size, in bytes. Valid values: 0, 512, 4096.
- **size** (Number) - Optional - The maximum size, in bytes, of the virtual hard disk to be created.
- **source** (String) - Optional - A URL or path to a source file (Box, Zip, 7z) to be expanded into the destination.
- **source_disk** (Number) - Optional - Specifies the physical disk to be used as the source.
- **source_vm** (String) - Optional - The name of the VM to copy the VHDs from.
- **vhd_type** (String) - Optional - The type of VHD. Valid values: Unknown, Fixed, Dynamic, Differencing.
- **timeouts** (Block) - Optional - Configuration for create, delete, read, and update operations.

### Read-Only Attributes
- **exists** (Boolean) - Indicates if the virtual disk exists.
- **id** (String) - The unique identifier of the resource.
```

--------------------------------

### Verify WinRM Connectivity

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/README.md

Use this PowerShell script to test WinRM connectivity to the target machine before configuring the provider.

```powershell
$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
```

--------------------------------

### data "hyperv_vhd"

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/vhd.md

Retrieves information about an existing virtual hard disk file.

```APIDOC
## data "hyperv_vhd"

### Description
Retrieves information about an existing virtual hard disk file based on the provided path.

### Required Parameters
- **path** (String) - The path to the existing virtual hard disk file.

### Read-Only Attributes
- **exists** (Boolean) - Indicates if the VHD file exists.
- **id** (String) - The unique identifier of the resource.
```

--------------------------------

### hyperv_network_switch

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/network_switch.md

Resource definition for managing a Hyper-V virtual network switch.

```APIDOC
## Resource: hyperv_network_switch

### Description
Manages a virtual network switch within a Hyper-V environment.

### Configuration
- **name** (string) - The name of the virtual switch.
- **notes** (string) - Optional notes for the switch.
- **allow_management_os** (boolean) - Whether the management OS can access the switch.
- **enable_embedded_teaming** (boolean) - Enables embedded teaming for the switch.
- **enable_iov** (boolean) - Enables SR-IOV for the switch.
- **enable_packet_direct** (boolean) - Enables packet direct for the switch.
- **minimum_bandwidth_mode** (string) - The minimum bandwidth mode (e.g., "None").
- **switch_type** (string) - The type of switch (e.g., "Internal").
- **net_adapter_names** (list) - List of network adapter names to associate.
- **default_flow_minimum_bandwidth_absolute** (number) - Absolute minimum bandwidth for the default flow.
- **default_flow_minimum_bandwidth_weight** (number) - Weight for the default flow minimum bandwidth.
- **default_queue_vmmq_enabled** (boolean) - Enables VMMQ for the default queue.
- **default_queue_vmmq_queue_pairs** (number) - Number of queue pairs for VMMQ.
- **default_queue_vrss_enabled** (boolean) - Enables vRSS for the default queue.
```

--------------------------------

### Configure a Hyper-V Network Switch

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/network_switch.md

Defines a basic internal virtual network switch configuration using the hyperv provider.

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

provider "hyperv" {
}

resource "hyperv_network_switch" "default" {
  name                                    = "DMZ"
  notes                                   = ""
  allow_management_os                     = true
  enable_embedded_teaming                 = false
  enable_iov                              = false
  enable_packet_direct                    = false
  minimum_bandwidth_mode                  = "None"
  switch_type                             = "Internal"
  net_adapter_names                       = []
  default_flow_minimum_bandwidth_absolute = 0
  default_flow_minimum_bandwidth_weight   = 0
  default_queue_vmmq_enabled              = false
  default_queue_vmmq_queue_pairs          = 16
  default_queue_vrss_enabled              = false
}
```

--------------------------------

### Configure Hard Disk Drive

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/resources/machine_instance.md

Defines a SCSI hard disk drive configuration for a Hyper-V machine.

```hcl
hard_disk_drives {
    controller_type                 = "Scsi"
    controller_number               = "0"
    controller_location             = "0"
    path                            = hyperv_vhd.web_server_g2_vhd.path
    disk_number                     = 4294967295
    resource_pool_name              = "Primordial"
    support_persistent_reservations = false
    maximum_iops                    = 0
    minimum_iops                    = 0
    qos_policy_id                   = "00000000-0000-0000-0000-000000000000"
    override_cache_attributes       = "Default"
  }
```

--------------------------------

### Configure Hyper-V Provider

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/examples/vm-from-scratch/README.md

Defines the Hyper-V provider credentials using Terraform variables.

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

--------------------------------

### data "hyperv_network_switch"

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/network_switch.md

Retrieves information about a specific virtual network switch by its name.

```APIDOC
## data "hyperv_network_switch"

### Description
Retrieves information about an existing virtual network switch from the Hyper-V host.

### Parameters
#### Required
- **name** (string) - The name of the virtual network switch to retrieve.

### Example Usage
```hcl
data "hyperv_network_switch" "default" {
  name = "DMZ"
}
```
```

--------------------------------

### Retrieve VHD information with Terraform

Source: https://github.com/taliesins/terraform-provider-hyperv/blob/master/docs/data-sources/vhd.md

Use this configuration to define a VHD resource and retrieve its details using the hyperv_vhd data source.

```terraform
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"
  #source               = ""
  #source_vm            = ""
  #source_disk          = 0
  vhd_type = "Dynamic"
  #parent_path          = ""
  size = 10737418240 #10GB
  #block_size           = 0
  #logical_sector_size  = 0
  #physical_sector_size = 0
}

data "hyperv_vhd" "web_server_vhd" {
  path = hyperv_vhd.web_server_vhd.path
}

output "hyperv_vhd" {
  value = data.hyperv_vhd.web_server_vhd
}
```
Tokens:
Raw