Start-SCVirtualMachine
Start-SCVirtualMachine
Starts a virtual machine managed by VMM.
Syntax
Parameter Set: SingleVM
Start-SCVirtualMachine [-VM] <VM> [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Start-SCVirtualMachine cmdlet starts one or more virtual machines on hosts managed by Virtual Machine Manager (VMM) when the machines are in a stopped state. Starting a stopped virtual machine restores it to a running state and returns its object in a running state. When the virtual machine is running again, you can resume activity on that virtual machine.
If you run Start-SCVirtualMachine on a virtual machine that is already running, the cmdlet returns the object but does not change the state of the virtual machine.
To stop a running virtual machine, use the Stop-SCVirtualMachine cmdlet.
Parameters
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUser<System.String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VM>
Specifies a virtual machine object.
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.
- VirtualMachine
Notes
- Requires a virtual machine object, which can be retrieved by using the Get-SCVirtualMachine cmdlet.
Examples
Example 1: Start a virtual machine that is turned off
The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.
The second command starts the virtual machine stored in $VM, and displays information about the running virtual machine object.
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> Start-SCVirtualMachine -VM $VM
Example 2: Start all virtual machines that are turned off
The first command gets all virtual machine objects on VMMServer01 that are in a stopped state, and then stores the objects in the $VMs object array.
The second command passes each virtual machine object stored in $VMs to the Start-SCVirtualMachine cmdlet, which starts each virtual machine in the array.
PS C:\> $VMs = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.Status -eq "PowerOff" }
PS C:\> $VMs | Start-SCVirtualMachine