Citrix Virtual Apps and Desktops SDK


(DEPRECATED) Requests a property update on provisioned virtual machines.


Request-ProvVMUpdate -ProvisioningSchemeName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Request-ProvVMUpdate -ProvisioningSchemeName <String> -VMName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Request-ProvVMUpdate -ProvisioningSchemeUid <Guid> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Request-ProvVMUpdate -ProvisioningSchemeUid <Guid> -VMName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]


Detailed Description

This cmdlet has been deprecated and replaced by Set-ProvVMUpdateTimeWindow. Please see the examples on this page that describe how to transition to the new cmdlet.

Provides the ability to synchronize the properties of existing virtual machines with any changes occurred on the provisioning scheme.

This cmdlet updates the ProvisioningSchemeUpdateRequested field on virtual machines to the current time, which indicates that the machines will synchronize to the property updates occurred on the provisioning scheme upon next start.


Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name of the provisioning scheme. true true (ByValue, ByPropertyName)  
VMName List of VM names requesting for update. If not specified, all VMs in the machine catalog associated with the specified provisioning scheme will request for a property update. true true (ByValue, ByPropertyName)  
ProvisioningSchemeUid The unique identifier of the provisioning scheme. true false  
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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  
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 user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type


You can pipe an object containing parameters called ‘VMId’ and ‘ProvisioningSchemeName’ to Request-ProvVMUpdate.

Return Values


Running Set-ProvScheme to update provisioning scheme properties will only affect future provisioned machines. To request existing VMs in a catalog to be brought up to date upon the next power on, use this cmdlet to request certain or all VMs created from the provisioning scheme associated with the catalog to be updated.


Example 1

c:\PS> Request-ProvVMUpdate -ProvisioningSchemeName AzuPS

                is equivalent to

                c:\PS> Set-ProvVMUpdateTimeWindow -ProvisioningSchemeName AzuPS -StartsNow -DurationInMinutes -1



To request all machines in a catalog to apply property updates on next boot, use Set-ProvVMUpdateTimeWindow with parameters -StartsNow and -DurationInMinutes -1.