VMHost

VMHost

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
IsSingleInstance	Key	String	Specifies the resource is a single instance, the value must be 'Yes'.	Yes
EnableEnhancedSessionMode	Write	Boolean	Indicates whether users can use enhanced mode when they connect to virtual machines on this server by using Virtual Machine Connection.
FibreChannelWwnn	Write	String	Specifies the default value of the World Wide Node Name on the Hyper-V host.
FibreChannelWwpnMaximum	Write	String	Specifies the maximum value that can be used to generate the World Wide Port Names on the Hyper-V host. Use with the FibreChannelWwpnMinimum parameter to establish a range of WWPNs that the specified Hyper-V host can assign to virtual Fibre Channel adapters.
FibreChannelWwpnMinimum	Write	String	Specifies the minimum value that can be used to generate the World Wide Port Names on the Hyper-V host. Use with the FibreChannelWwpnMaximum parameter to establish a range of WWPNs that the specified Hyper-V host can assign to virtual Fibre Channel adapters.
MacAddressMaximum	Write	String	Specifies the maximum MAC address using a valid hexadecimal value. Use with the MacAddressMinimum parameter to establish a range of MAC addresses that the specified Hyper-V host can assign to virtual machines configured to receive dynamic MAC addresses.
MacAddressMinimum	Write	String	Specifies the minimum MAC address using a valid hexadecimal value. Use with the MacAddressMaximum parameter to establish a range of MAC addresses that the specified Hyper-V host can assign to virtual machines configured to receive dynamic MAC addresses.
MaximumStorageMigrations	Write	UInt32	Specifies the maximum number of storage migrations that can be performed at the same time on the Hyper-V host.
MaximumVirtualMachineMigrations	Write	UInt32	Specifies the maximum number of live migrations that can be performed at the same time on the Hyper-V host.
NumaSpanningEnabled	Write	Boolean	Specifies whether virtual machines on the Hyper-V host can use resources from more than one NUMA node.
ResourceMeteringSaveIntervalMinute	Write	UInt32	Specifies how often the Hyper-V host saves the data that tracks resource usage. The range is a minimum of 60 minutes to a maximum of 1440 minutes (24 hours).
UseAnyNetworkForMigration	Write	Boolean	Specifies how networks are selected for incoming live migration traffic. If set to $true, any available network on the host can be used for this traffic. If set to $false, incoming live migration traffic is transmitted only on the networks specified in the MigrationNetworks property of the host.
VirtualHardDiskPath	Write	String	Specifies the default folder to store virtual hard disks on the Hyper-V host.
VirtualMachineMigrationAuthenticationType	Write	String	Specifies the type of authentication to be used for live migrations. The acceptable values for this parameter are 'Kerberos' and 'CredSSP'.	CredSSP, Kerberos
VirtualMachineMigrationPerformanceOption	Write	String	Specifies the performance option to use for live migration. The acceptable values for this parameter are 'TCPIP', 'Compression' and 'SMB'.	TCPIP, Compression, SMB
VirtualMachinePath	Write	String	Specifies the default folder to store virtual machine configuration files on the Hyper-V host.
VirtualMachineMigrationEnabled	Write	Boolean	Indicates whether Live Migration should be enabled or disabled on the Hyper-V host.

Description

Manages Hyper-V host settings.

Requirements

• The Hyper-V Role has to be installed on the machine.
• The Hyper-V PowerShell module has to be installed on the machine.

Examples

Example 1

Set paths för the Hyper-V host.

Configuration Example
{
    param
    (
        [Parameter()]
        $VirtualHardDiskPath = 'C:\VMDisks',

        [Parameter()]
        $VirtualMachinePath = 'C:\VMs'
    )

    Import-DscResource -ModuleName 'HyperVDsc'

    VMHost HyperVHostPaths
    {
        IsSingleInstance    = 'Yes'
        VirtualHardDiskPath = $VirtualHardDiskPath
        VirtualMachinePath  = $VirtualMachinePath
    }
}