Suspend-VM

Reference

Module:: Hyper-V

Suspends, or pauses, a virtual machine.

Syntax

Suspend-VM
       [-Name] <String[]>
       [-AsJob]
       [-ComputerName <String[]>]
       [-Passthru]
       [-Confirm]
       [-WhatIf]

Suspend-VM
       [-VM] <VirtualMachine[]>
       [-AsJob]
       [-Passthru]
       [-Confirm]
       [-WhatIf]

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.

Parameters

-AsJob

Specifies that the cmdlet is to be run as a background job.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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:	.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Name

Specifies the name of the virtual machine to be suspended.

Type:	String[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-Passthru

Specifies that a Microsoft.Virtualization.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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VM

Specifies the virtual machine to be suspended.

Type:	VirtualMachine[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

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

Outputs

None

Default

Microsoft.Virtualization.Powershell.VirtualMachine

If -PassThru is specified.