Debug-VM

Debug-VM

Debugs a virtual machine.

Syntax

Parameter Set: Name
Debug-VM [-Name] <String[]> [-AsJob] [-ComputerName <String[]> ] [-Force] [-InjectNonMaskableInterrupt] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Debug-VM [-VM] <VirtualMachine[]> [-AsJob] [-Force] [-InjectNonMaskableInterrupt] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Debug-VM cmdlet debugs a virtual machine.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ComputerName<String[]>

Specifies an array of Hyper-V hosts. The cmdlet debugs the virtual machines on the hosts you specify.

Aliases	none
Required?	false
Position?	named
Default Value	.
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Forces the command to run without asking for user confirmation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InjectNonMaskableInterrupt

Indicates that the cmdlet sends a nonmaskable interrupt (NMI) to the virtual machine. An interrupt handler must process a nonmaskable interrupt.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies an array of names of virtual machines to be debugged.

Aliases	VMName
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	true

-Passthru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies an array of virtual machine objects that are to be debugged. To obtain virtual machine objects, use the Get-VM cmdlet.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
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.

Examples

Example 1

This example injects a non-maskable interrupt into the virtual machine named “VM to Debug”. A kernel debugger should be connected to the guest operating system before attempting to do this.

PS C:\> debug-vm "VM to Debug" -InjectNonMaskableInterrupt -Force