Set-VM

Name	Type	Description	Required?	Pipeline Input	Default Value
VM	VirtualMachine[]	Specify the virtual machine you want to configure.	true	true (ByValue)
AlternateGuestName	String	Specify the full name of the guest OS for the virtual machine if the value of the GuestID parameter is set to otherGuest or otherGuest64.	false	false
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	false	$true
Description	String	Provide a description of the virtual machine. The alias of this parameter is Notes.	false	false
DrsAutomationLevel	DrsAutomationLevel	Specify a DRS (Distributed Resource Scheduler) automation level. The valid values are FullyAutomated, Manual, and PartiallyAutomated, AsSpecifiedByCluster, and Disabled. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release. Specifying this parameter is only supported when the virtual machine is inside a cluster. Otherwise, an error is generated.	false	false
GuestId	String	Specify the guest operating system of the virtual machine. The valid values for specific ESX versions are listed in the description of the VirtualMachineGuestOsIdentifier enumeration type in the vSphere API Reference available at http://www.vmware.com/support/developer/vc-sdk/. Depending on the hardware configuration of the host, some of the guest operating systems might be inapplicable.	false	false
HAIsolationResponse	HAIsolationResponse	Indicate whether the virtual machine should be powered off if a host determines that it is isolated from the rest of the compute resource. The valid values are AsSpecifiedByCluster, PowerOff, and DoNothing. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release. Specifying this parameter is only supported when the virtual machine is inside a cluster. Otherwise, an error is generated.	false	false
HARestartPriority	HARestartPriority	Specify the virtual machine HA restart priority. The valid values are Disabled, Low, Medium, High, and ClusterRestartPriority. VMware HA is a feature that detects failed virtual machines and automatically restarts them on alternative ESX hosts. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release. Specifying this parameter is only supported when the virtual machine is inside a cluster. Otherwise, an error is generated.	false	false
MemoryMB	Int64	Specify the memory size in MB.	false	false
Name	String	Specify a new name for the virtual machine.	false	false
NumCpu	Int32	Specify the number of virtual CPUs.	false	false
OSCustomizationSpec	OSCustomizationSpec	Specify a customization specification you want to apply to the virtual machine. This works only in 32-bit mode.	false	false
RunAsync	SwitchParameter	Indicate that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync" in the vSphere PowerCLI console.	false	false
Server	VIServer[]	Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.	false	false
Snapshot	Snapshot	Specify a snapshot whose state you want to apply to the virtual machine.	false	true (ByValue)
ToTemplate	SwitchParameter	Indicate that you want to convert the virtual machine to a template.	false	false
Version	VMVersion	Specify the version to which you want to upgrade the virtual machine. The valid values are v4, v7, and v8. You cannot downgrade to an older version.	false	false
VMSwapFilePolicy	VMSwapfilePolicy	Specify the swapfile placement policy. The following values are valid: InHostDataStore - Store the swapfile in the datastore specified by the VMSwapfileDatastoreID property of the virtual machine host. If the VMSwapfileDatastoreID property is not set or indicates a datastore with insufficient free space, the swapfile is stored in the same directory as the virtual machine. This setting might degrade the VMotion performance. WithVM - Store the swapfile in the same directory as the virtual machine. This parameter is supported only on vCenter Server 2.5 and ESX 3.5 servers, or later versions.	false	false
WhatIf	SwitchParameter	Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

-------------- Example 1 --------------

$template = Get-VM VM | Set-VM -ToTemplate -Name VMTemplate

Converts the VM virtual machine to a template and stores the template in the $template variable.

-------------- Example 2 --------------

Get-VM -Location ResourcePool01 | Set-VM -MemoryMB 2048 -NumCPU 2

Upgrades the memory and CPU count of the virtual machines in ResourcePool01.

-------------- Example 3 --------------

Set-VM -VM VM -Version v7

Upgrades the virtual hardware version of the VM machine.

-------------- Example 4 --------------

$snapshot = Get-Snapshot -VM $vm -Name "Initial state"

Set-VM -VM $vm -Snapshot $snapshot

Revert the VM virtual machine to the "Initial state" snapshot.

-------------- Example 5 --------------

$spec = Get-OSCustomizationSpec -Name FinanceDepartmentSpec;

Set-VM -VM $vm -OSCustomizationSpec $spec

Apply a customization specification on the specified virtual machines.

-------------- Example 6 --------------

Set-VM $vm -Name "Web Server" -GuestID winNetStandardGuest -Description "Company's web server"

Changes the name, description, and guest ID of the specified virtual machine.

vSphere PowerCLI Reference

Synopsis