Resource Type: dsc_xvmprocessor

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

Overview

The DSC xVMProcessor resource type. Automatically generated from ‘xHyper-V/DSCResources/MSFT_xVMProcessor/MSFT_xVMProcessor.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_compatibilityformigrationenabled

    CompatibilityForMigrationEnabled - Specifies whether the virtual processors features are to be limited for compatibility when migrating the virtual machine to another host.

    Supported values:
    • true
    • false
  • dsc_compatibilityforolderoperatingsystemsenabled

    CompatibilityForOlderOperatingSystemsEnabled - Specifies whether the virtual processor’s features are to be limited for compatibility with older operating systems.

    Supported values:
    • true
    • false
  • dsc_enablehostresourceprotection

    EnableHostResourceProtection - Specifies whether to enable host resource protection.

    Supported values:
    • true
    • false
  • dsc_exposevirtualizationextensions

    ExposeVirtualizationExtensions - Specifies whether nested virtualization is enabled.

    Supported values:
    • true
    • false
  • dsc_hwthreadcountpercore

    HwThreadCountPerCore - Specifies the maximum thread core per processor core.

  • dsc_maximum

    Maximum - Specifies the maximum percentage of resources available to the virtual machine processor to be configured. Allowed values range from 0 to 100.

  • dsc_maximumcountpernumanode

    MaximumCountPerNumaNode - Specifies the maximum number of processors per NUMA node to be configured for the virtual machine.

  • dsc_maximumcountpernumasocket

    MaximumCountPerNumaSocket - Specifies the maximum number of sockets per NUMA node to be configured for the virtual machine.

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_relativeweight

    RelativeWeight - Specifies the priority for allocating the physical computer’s processing power to this virtual machine relative to others. Allowed values range from 1 to 10000.

  • dsc_reserve

    Reserve - Specifies the percentage of processor resources to be reserved for this virtual machine. Allowed values range from 0 to 100.

  • dsc_resourcepoolname

    ResourcePoolName - Specifies the name of the processor resource pool to be used.

  • dsc_restartifneeded

    RestartIfNeeded - If specified, shutdowns and restarts the VM if needed for property changes.

    Supported values:
    • true
    • false
  • dsc_vmname

    VMName - Specifies the name of the virtual machine on which the processor is to be configured.

  • name (namevar)
  • provider

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