Stop-HypVM¶

Stops a VM by issuing a Shutdown request

Syntax¶

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

Detailed Description¶

Use this command to change the power state of a VM from running to stopped.

Parameters¶

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: :\Connections\\ or :\Connections{\} or :\HostingUnits\\ or :\HostingUnits{\}	true	true (ByValue)
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.

Input Type¶

System.string
You can pipe a string that contains a path.¶

Return Values¶

System.void.¶

## Notes In the case of failure, the following errors can result.
Error Codes
-----------
InputHypervisorItemPathInvalid
The path provided is not to an item in a sub-directory of a connection item or a hosting unit item.
InvalidHypervisorItemPath
No item exists with the specified path.
InvalidHypervisorItem
The item specified by the path exists, but is not a VM Item.
HypervisorInMaintenanceMode
The hypervisor is in maintenance mode.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

Examples¶

EXAMPLE 1¶

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

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