Suspend-VM

Suspends, or pauses, a virtual machine.

Syntax

Suspend-VM
       [-Name] <String[]>
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-ComputerName <String[]>]
       [-Confirm]
       [-Credential <PSCredential[]>]
       [-Passthru]
       [-WhatIf]
       [<CommonParameters>]
Suspend-VM
       [-VM] <VirtualMachine[]>
       [-AsJob]
       [-Confirm]
       [-Passthru]
       [-WhatIf]
       [<CommonParameters>]

Description

The Suspend-VM cmdlet suspends a virtual machine. To return a suspended virtual machine to a running state, use the Resume-VM cmdlet.

Examples

Example 1

PS C:\> Suspend-VM -Name TestVM

This example suspends a virtual machine named TestVM.

Example 2

PS C:\> Suspend-VM -Name Test*

This example suspends all virtual machines whose names starts with Test.

Required Parameters

-Name

Specifies the name of the virtual machine to be suspended.

Type:String[]
Aliases:VMName
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VM

Specifies the virtual machine to be suspended.

Type:VirtualMachine[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies one or more Hyper-V hosts on which a virtual machine is to be suspended. 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.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Specifies that a Microsoft.HyperV.PowerShell.VirtualMachine object is to be passed through to the pipeline representing the virtual machine to be suspended.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None by default; Microsoft.HyperV.PowerShell.VirtualMachine if PassThru is specified.