Resource Type: dsc_xvmhyperv

Defined in:

lib/puppet/type/dsc_xvmhyperv.rb

Providers:

powershell

Overview

The DSC xVMHyperV resource type. Automatically generated from ‘xHyper-V/DSCResources/MSFT_xVMHyperV/MSFT_xVMHyperV.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
  • absent

Parameters

• dsc_automaticcheckpointsenabled

  AutomaticCheckpointsEnabled - Enable AutomaticCheckpoints for the VM.

  Supported values:

  • true
  • false
• dsc_cpuusage

  CPUUsage - CPU Usage of the VM

• dsc_creationtime

  CreationTime - Creation time of the VM

• dsc_enableguestservice

  EnableGuestService - Enable Guest Service Interface for the VM.

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - Should the VM be created or deleted Valid values are Present, Absent.

• dsc_generation

  Generation - Virtual machine generation

• dsc_hasdynamicmemory

  HasDynamicMemory - Does VM has dynamic memory enabled

  Supported values:

  • true
  • false
• dsc_id

  ID - VM unique ID

• dsc_macaddress

  MACAddress - MAC address(es) of the VM NICs.

• dsc_maximummemory

  MaximumMemory - Maximum RAM for the VM. This enable dynamic memory.

• dsc_memoryassigned

  MemoryAssigned - Memory assigned to the VM

• dsc_minimummemory

  MinimumMemory - Minimum RAM for the VM. This enables dynamic memory.

• dsc_name

  Name - Name of the VM

• dsc_networkadapters

  NetworkAdapters - Network adapters’ IP addresses of the VM

• dsc_notes

  Notes - Notes about the VM.

• dsc_path

  Path - Folder where the VM data will be stored

• dsc_processorcount

  ProcessorCount - Processor count for the VM

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_restartifneeded

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

  Supported values:

  • true
  • false
• dsc_secureboot

  SecureBoot - Enable secure boot for Generation 2 VMs.

  Supported values:

  • true
  • false
• dsc_startupmemory

  StartupMemory - Startup RAM for the VM.

• dsc_state

  State - State of the VM. Valid values are Running, Paused, Off.

• dsc_status

  Status - Status of the VM

• dsc_switchname

  SwitchName - Virtual switch(es) associated with the VM

• dsc_uptime

  Uptime - Uptime of the VM

• dsc_vhdpath

  VhdPath - VHD associated with the VM

• dsc_waitforip

  WaitForIP - Waits for VM to get valid IP address.

  Supported values:

  • true
  • false
• name (namevar)
• provider

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