Start-HypVM
Starts a VM.
Syntax
Start-HypVM
[-LiteralPath] <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This command provides a mechanism to start a VM.
Examples
EXAMPLE 1
This command starts a VM called 'MyVm.vm' within a hypervisor connection called 'MyConnection'.
Start-HypVM -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm
Parameters
-LiteralPath
Specifies the path within a hosting unit provider to the virtual machine item to start. 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\>}
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
You can pipe a string that contains a path.
Outputs
None
By default, this cmdlet returns no output.
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.