xVMHyperV

xVMHyperV

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	Name of the VM
VhdPath	Required	String	VHD associated with the VM
SwitchName	Write	StringArray[]	Virtual switch(es) associated with the VM
State	Write	String	State of the VM.	Running, Paused, Off
Path	Write	String	Folder where the VM data will be stored
Generation	Write	UInt32	Virtual machine generation
StartupMemory	Write	UInt64	Startup RAM for the VM.
MinimumMemory	Write	UInt64	Minimum RAM for the VM. This enables dynamic memory.
MaximumMemory	Write	UInt64	Maximum RAM for the VM. This enable dynamic memory.
MACAddress	Write	StringArray[]	MAC address(es) of the VM NICs.
ProcessorCount	Write	UInt32	Processor count for the VM
WaitForIP	Write	Boolean	Waits for VM to get valid IP address.
RestartIfNeeded	Write	Boolean	If specified, shutdowns and restarts the VM as needed for property changes
Ensure	Write	String	Should the VM be created or deleted	Present, Absent
Notes	Write	String	Notes about the VM.
SecureBoot	Write	Boolean	Enable secure boot for Generation 2 VMs.
EnableGuestService	Write	Boolean	Enable Guest Service Interface for the VM.
AutomaticCheckpointsEnabled	Write	Boolean	Enable AutomaticCheckpoints for the VM.
ID	Read	String	VM unique ID
Status	Read	String	Status of the VM
CPUUsage	Read	UInt32	CPU Usage of the VM
MemoryAssigned	Read	UInt64	Memory assigned to the VM
Uptime	Read	String	Uptime of the VM
CreationTime	Read	DateTime	Creation time of the VM
HasDynamicMemory	Read	Boolean	Does VM has dynamic memory enabled
NetworkAdapters	Read	StringArray[]	Network adapters' IP addresses of the VM

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.