vagrant/website/source/docs/hyperv/configuration.html.md

layout	page_title	sidebar_current	description
docs	Configuration- Hyper-V Provider	providers-hyperv-configuration	The Vagrant Hyper-V provider has some provider-specific configuration options you may set.

Configuration

The Vagrant Hyper-V provider has some provider-specific configuration options you may set. A complete reference is shown below:

• auto_start_action (Nothing, StartIfRunning, Start) - Automatic start action for VM on host startup. Default: Nothing.
• auto_stop_action (ShutDown, TurnOff, Save) - Automatic stop action for VM on host shutdown. Default: ShutDown.
• cpus (integer) - Number of virtual CPUs allocated to VM at startup.
• differencing_disk (boolean) - Deprecated Use differencing disk instead of cloning entire VHD (use linked_clone instead) Default: false.
• enable_virtualization_extensions (boolean) - Enable virtualization extensions for the virtual CPUs. Default: false
• enable_checkpoints (boolean) Enable automatic checkpoints of the VM. Default: false
• ip_address_timeout (integer) - Number of seconds to wait for the VM to report an IP address. Default: 120.
• linked_clone (boolean) - Use differencing disk instead of cloning entire VHD. Default: false
• mac (string) - MAC address for the guest network interface
• maxmemory (integer) - Maximum number of megabytes allowed to be allocated for the VM. When set Dynamic Memory Allocation will be enabled.
• memory (integer) - Number of megabytes allocated to VM at startup. If maxmemory is set, this will be amount of memory allocated at startup.
• vlan_id (integer) - VLAN ID for the guest network interface.
• vmname (string) - Name of virtual machine as shown in Hyper-V manager. Default: Generated name.
• vm_integration_services (Hash) - Hash to set the state of integration services. (Note: Unknown key values will be passed directly.)
  • guest_service_interface (boolean)
  • heartbeat (boolean)
  • key_value_pair_exchange (boolean)
  • shutdown (boolean)
  • time_synchronization (boolean)
  • vss (boolean)
• controller (hash) - Config of disks and controllers.
  • type (:scsi) - Determines type of controller. Only supports SCSI right now. IDE is to be implemented.
  • disks (array) - Disks to be created on the controller. First element is a string specifying name of disk, example d1. Second is size of disk in MB, example 10 * 1024 is 10 GB. Name of disk comes first and size after on every disk.

VM Integration Services

The vm_integration_services configuration option consists of a simple Hash. The key values are the names of VM integration services to enable or disable for the VM. Vagrant includes an internal mapping of known services which allows them to be provided in a "snake case" format. When a provided key is unknown, the key value is used "as-is" without any modifications.

For example, if a new CustomVMSRV VM integration service was added and Vagrant is not aware of this new service name, it can be provided as the key value explicitly:

config.vm.provider "hyperv" do |h|
  h.vm_integration_services = {
    guest_service_interface: true,
    CustomVMSRV: true
  }
end

This example would enable the GuestServiceInterface (which Vagrant is aware) and CustomVMSRV (which Vagrant is not aware) VM integration services.

Attaching extra controllers and disks

The controller configuration option is a simple hash that describes what kind of controller it is. Such as :scsi or :ide. Right now only :scsi is supported. After this the disks that will be created is specified in the disks array. This is an array where several disks to create can be specified. First comes the name of the disk, for example d1, and after that followes the size of the disk specified in MB, for example 10 * 1024 for a 10 GB disk. Repeat this for the number of disks you want to attach on the controller. To attach existing vhd- or vhdx-files is not implemented yet.

config.vm.provider "hyperv" do |h|
  h.controller type: :scsi, disks: [ "d1", 10 * 1024 ]
end

This example would create a SCSI controller and also create a d1.vhdx file and attach it as a dynamic disk that is 10 * 1024 MB big, in other words 10 GB.