Citrix Virtual Apps and Desktops SDK

Stop-HypVM

March 11, 2024

Contributed by:

Stops a VM by issuing a Shutdown request

Syntax

Stop-HypVM [-LiteralPath] <String> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

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
AdminClientIP	Specifies the client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	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.

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

<!--NeedCopy-->

Description

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Stop-HypVM

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Stop-HypVM

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

Return Values

System.Void

Notes

Examples

Example 1

Description

In this article