Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Stop-SCVirtualMachine

Updated: November 1, 2013

Applies To: System Center 2012 R2 Virtual Machine Manager

Stop-SCVirtualMachine

Stops virtual machines managed by VMM.

Syntax

Parameter Set: SingleVM
Stop-SCVirtualMachine [-VM] <VM> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-Shutdown] [ <CommonParameters>]

Parameter Set: CorrespondsToVMM2008DiscardSavedStateVM
Stop-SCVirtualMachine [-VM] <VM> -DiscardSavedState [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]

Parameter Set: CorrespondsToVMM2008SaveStateVM
Stop-SCVirtualMachine [-VM] <VM> -SaveState [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]

Parameter Set: CorrespondsToVMM2008StopVM
Stop-SCVirtualMachine [-VM] <VM> -Force [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]




Detailed Description

The Stop-SCVirtualMachine cmdlet stops one or more running virtual machines on hosts managed by Virtual Machine Manager (VMM) and returns the virtual machine object in a stopped state.

Stop-SCVirtualMachine stops a virtual machine in the same manner as shutting down the operating system on a computer. Stop-SCVirtualMachine with the Force parameter stops a virtual machine in the same manner as turning off a computer.

To resume running a stopped virtual machine, use the Start-SCVirtualMachine cmdlet.

Parameters

-DiscardSavedState

Deletes the saved state associated with a virtual machine or service.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Forces the operation to complete.

For example:

- Remove-SCSCVMHost -Force

Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force

Stops a virtual machine.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-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

-SaveState

Saves the state of a virtual machine or service.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Shutdown

Indicates that a virtual machine, service, or a source server should be shut down. In the case of a virtual machine or service, the associated cmdlet attempts to use the operating system to shut the virtual machine down gracefully. In the case of a successful physical-to-virtual machine (P2V) conversion, the cmdlet shuts down the source server.


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.

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

1: Stop a specified virtual machine.

The first command gets the virtual machine object named VM01 and stores the object in the $VM variable. This example assumes that only one virtual machine named VM01 exists and that it is currently in a running state.

The second command stops the virtual machine stored in $VM (in this case, VM01) and displays information about the stopped object to the user.


PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"PS C:\> Stop-SCVirtualMachine -VM $VM

2: Stop multiple virtual machines.

The first command gets all virtual machine objects whose name contains the string VMM and whose current status is "Running". The command then stores those objects in the $VMs variable.

The second command passes each virtual machine object stored in $VMs to Stop-VM, which stops each virtual machine and displays information about the stopped virtual machines to the user.


PS C:\> $VMs = Get-SCVirtualMachine | where { $_.Name -match "VM" -and $_.Status -eq "Running" }PS C:\> $VMs | Stop-SCVirtualMachine

Related topics

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.