DSCResources/DSC_VMHyperV/en-US/about_VMHyperV.help.txt
|
.NAME
VMHyperV .DESCRIPTION Manages VMs in a Hyper-V host. The following properties cannot be changed after VM creation: * VhdPath * Path * Generation ## Requirements * The Hyper-V Role has to be installed on the machine. * The Hyper-V PowerShell module has to be installed on the machine. .PARAMETER Name Key - String The desired name of the VM. .PARAMETER VhdPath Required - String The desired VHD associated with the VM. .PARAMETER SwitchName Write - StringArray Virtual switch(es) associated with the VM. Multiple NICs can now be assigned. .PARAMETER State Write - String Allowed values: Running, Paused, Off State of the VM. .PARAMETER Path Write - String Folder where the VM data will be stored. .PARAMETER Generation Write - UInt32 Virtual machine's generation. Generation 2 virtual machines only support VHDX files. The default value is 1. .PARAMETER StartupMemory Write - UInt64 Startup RAM for the VM. If neither MinimumMemory nor MaximumMemory is specified, dynamic memory will be disabled. .PARAMETER MinimumMemory Write - UInt64 Minimum RAM for the VM. Setting this property enables dynamic memory, with the exception; If MinimumMemory, MaximumMemory and StartupMemory is equal, dynamic memory will be disabled. .PARAMETER MaximumMemory Write - UInt64 Maximum RAM for the VM. Setting this property enables dynamic memory, with the exception; If MinimumMemory, MaximumMemory and StartupMemory is equal, dynamic memory will be disabled. .PARAMETER MACAddress Write - StringArray MAC address(es) of the VM NICs. Multiple MAC addresses can now be assigned. .PARAMETER ProcessorCount Write - UInt32 Processor count for the VM. .PARAMETER WaitForIP Write - Boolean If specified, waits for the VM to get valid IP address. .PARAMETER RestartIfNeeded Write - Boolean If specified, will shutdown and restart the VM as needed for property changes. .PARAMETER Ensure Write - String Allowed values: Present, Absent Specifies if the VM should be Present (created) or Absent (removed). The default value is Present. .PARAMETER Notes Write - String Notes about the VM. .PARAMETER SecureBoot Write - Boolean Specifies if Secure Boot should be enabled for Generation 2 virtual machines. Only supports generation 2 virtual machines. Default value is $true. .PARAMETER EnableGuestService Write - Boolean Enable Guest Service Interface for the VM. The default value is $false. .PARAMETER AutomaticCheckpointsEnabled Write - Boolean Enable AutomaticCheckpoints for the VM. .PARAMETER ID Read - String Returns the unique ID for the VM. .PARAMETER Status Read - String Returns the current status of the VM. .PARAMETER CPUUsage Read - UInt32 Returns the current CPU usage of the VM. .PARAMETER MemoryAssigned Read - UInt64 Returns the current memory assigned to the VM. .PARAMETER Uptime Read - String Returns the uptime of the VM. .PARAMETER CreationTime Read - DateTime Returns the creation time of the VM. .PARAMETER HasDynamicMemory Read - Boolean Returns $true if the VM has dynamic memory enabled. .PARAMETER NetworkAdapters Read - StringArray Returns the IP addresses of the virtual machine's network adapters. |