Start-VM

Start-VM

Starts a virtual machine.

Syntax

Parameter Set: Name
Start-VM [-Name] <String[]> [-AsJob] [-ComputerName <String[]> ] [-Passthru] [ <CommonParameters>]

Parameter Set: VMObject
Start-VM [-VM] <VirtualMachine[]> [-AsJob] [-Passthru] [ <CommonParameters>]

Detailed Description

The Start-VM cmdlet starts a 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 a virtual machine is to be started. 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

-Name<String[]>

Specifies the name of the virtual machine to be started.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

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 started.

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 started.

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.Virtualization.Powershell.VirtualMachine if –PassThru is specified.

Examples

Example 1

Starts virtual machine TestVM.

PS C:\> Start-VM –Name TestVM

Example 2

Starts all virtual machines whose names start with “Test.”

PS C:\> Start-VM –Name Test*