Product Documentation


Oct 21, 2016

Stops a VM by issuing a Shutdown request


Stop-HypVM [-LiteralPath] <String> [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

This command provides a mechanism change the power state of a VM from running to stopped.

Related topics



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: <drive>:\Connections\<Connection Name>\<Item Path of VM object> or <drive>:\Connections\{<connection Uid>\<Item Path of VM object>} or <drive>:\HostingUnits\<HostingUnit Name>\<Item Path of VM object> or <drive>:\HostingUnits\{<hostingUnit Uid>\<Item Path of VM object>}

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)


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.

Required? false
Default Value LocalHost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

System.string You can pipe a string the contains a path.

Return Values



In the case of failure the following errors can be produced.

Error Codes



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 whilst attempting a database operation.


The operation could not be completed as the database for the service is not configured.


An error occurred whilst communicating with the service.


The user does not have administrative rights to perform this operation.


An unexpected error occurred. To locate more details see the Windows event logs on the controller being used, or examine the XenDesktop logs.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>Stop-HypVM -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm

This command stops a VM called 'MyVm.vm' within a hypervisor connection called 'MyConnection'.