Citrix Virtual Apps and Desktops SDK


Start the PVD Image prepare process in the Broker for the specified machine(s).


Start-BrokerMachinePvdImagePrepare [-InputObject] <Machine[]> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Detailed Description

The Start-BrokerMachinePvdImagePrepare cmdlet instructs the Broker to request the Personal VDisk (PVD) preparation process for the specified machine(s). The process begins when each machine is subsequently powered off, at which point brokering of user desktop sessions is suspended as well as regular machine power operations until the process completes. Only machines in catalogs with a PersistUserChanges value of OnPvd are supported by this cmdlet.


Name Description Required? Pipeline Input Default Value
InputObject The machine(s) to start the PVD Image Preparation process on. true true (ByValue)  
LoggingId Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snapin 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.
BearerToken Specifies the bearer token assigned to the calling user false false  

Input Type


You can pipe in the machines to start the PVD image preparation process on.

Return Values



Example 1

C:\PS> Get-BrokerMachine 'MyMachine' | Start-BrokerMachinePvdImagePrepare


Instruct the Broker that the Personal VDisk preparation process will start the next time the specified machine(s) are powered off.