Resource Type: dsc_xvmhost

Defined in:
lib/puppet/type/dsc_xvmhost.rb
Providers:
powershell

Overview

The DSC xVMHost resource type. Automatically generated from ‘xHyper-V/DSCResources/MSFT_xVMHost/MSFT_xVMHost.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

  • ensure

    The basic property that the resource should be in.

    Supported values:
    • exists?
    • present

Parameters

  • dsc_enableenhancedsessionmode

    EnableEnhancedSessionMode - Indicates whether users can use enhanced mode when they connect to virtual machines on this server by using Virtual Machine Connection.

    Supported values:
    • true
    • false
  • dsc_fibrechannelwwnn

    FibreChannelWwnn - Specifies the default value of the World Wide Node Name on the Hyper-V host.

  • dsc_fibrechannelwwpnmaximum

    FibreChannelWwpnMaximum - Specifies the maximum value that can be used to generate World Wide Port Names on the Hyper-V host.

  • dsc_fibrechannelwwpnminimum

    FibreChannelWwpnMinimum - Specifies the minimum value that can be used to generate the World Wide Port Names on the Hyper-V host.

  • dsc_issingleinstance

    IsSingleInstance - Specifies the resource is a single instance, the value must be ‘Yes’. Valid values are Yes.

  • dsc_macaddressmaximum

    MacAddressMaximum - Specifies the maximum MAC address using a valid hexadecimal value.

  • dsc_macaddressminimum

    MacAddressMinimum - Specifies the minimum MAC address using a valid hexadecimal value.

  • dsc_maximumstoragemigrations

    MaximumStorageMigrations - Specifies the maximum number of storage migrations that can be performed at the same time on the Hyper-V host.

  • dsc_maximumvirtualmachinemigrations

    MaximumVirtualMachineMigrations - Specifies the maximum number of live migrations that can be performed at the same time on the Hyper-V host.

  • dsc_numaspanningenabled

    NumaSpanningEnabled - Specifies whether virtual machines on the Hyper-V host can use resources from more than one NUMA node.

    Supported values:
    • true
    • false
  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_resourcemeteringsaveintervalminute

    ResourceMeteringSaveIntervalMinute - 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 (24 hours).

  • dsc_useanynetworkformigration

    UseAnyNetworkForMigration - Specifies how networks are selected for incoming live migration traffic.

    Supported values:
    • true
    • false
  • dsc_virtualharddiskpath

    VirtualHardDiskPath - Specifies the default folder to store virtual hard disks on the Hyper-V host.

  • dsc_virtualmachinemigrationauthenticationtype

    VirtualMachineMigrationAuthenticationType - Specifies the type of authentication to be used for live migrations. The acceptable values for this parameter are ‘Kerberos’ and ‘CredSSP’. Valid values are CredSSP, Kerberos.

  • dsc_virtualmachinemigrationperformanceoption

    VirtualMachineMigrationPerformanceOption - Specifies the performance option to use for live migration. The acceptable values for this parameter are ‘TCPIP’, ‘Compression’ and ‘SMB’. Valid values are TCPIP, Compression, SMB.

  • dsc_virtualmachinepath

    VirtualMachinePath - Specifies the default folder to store virtual machine configuration files on the Hyper-V host.

  • name (namevar)
  • provider

    The specific backend to use for this ‘dsc_xvmhost` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.