Restart-VM
Restart-VM
Restarts a virtual machine.
Syntax
Parameter Set: Name
Restart-VM [-Name] <String[]> [-AsJob] [-ComputerName <String[]> ] [-Force] [-Passthru] [ <CommonParameters>]
Parameter Set: VMObject
Restart-VM [-VM] <VirtualMachine[]> [-AsJob] [-Force] [-Passthru] [ <CommonParameters>]
Detailed Description
The Restart-VM cmdlet restarts a virtual machine. Running this cmdlet results in a “hard” restart, like powering the machine down, then back up again. This can result in data loss in the virtual machine.
Parameters
-AsJob
Specifies that the cmdlet is to be run as a background job.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which the virtual machine is to be restarted. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Specifies that no prompt for confirmation is to appear before the virtual machine is restarted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of the virtual machine to be restarted.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-Passthru
Specifies that an object is to be passed through to the pipeline representing the virtual machine to be restarted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine to be restarted.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None by default, Microsoft.HyperV.Powershell.VirtualMachine if –PassThru is specified.
Examples
Example 1
Performs a hard restart of virtual machine Win7. This is equivalent to turning off the power to the virtual machine and then restarting it.
PS C:\> Restart-VM Win7