Stops a VM by issuing a Shutdown request
Stop-HypVM [-LiteralPath] <String> [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
Use this command to change the power state of a VM from running to stopped.
|Name||Description||Required?||Pipeline Input||Default Value|
|LiteralPath||Specifies the path within a hosting unit provider to the virtual machine item to stop. The path specified must be in one of the following formats:
|BearerToken||Specifies the bearer token assigned to the calling user||false||false|
|AdminAddress||Specifies the address of a XenDesktop controller that the PowerShell snap-in will connect to. This can be provided as a host name or an IP address.||false||false||LocalHost. Once a value is provided by any cmdlet, this value will become the default.|
You can pipe a string that contains a path.¶
In the case of failure, the following errors can result.
The path provided is not to an item in a sub-directory of a connection item or a hosting unit item.
No item exists with the specified path.
The item specified by the path exists, but is not a VM Item.
The hypervisor is in maintenance mode.
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred while communicating with the service.
The user does not have administrative rights to perform this operation.
An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
C:\PS>Stop-HypVM -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm
This command stops a VM called 'MyVm.vm' within a hypervisor connection called 'MyConnection'.