Citrix Virtual Apps and Desktops SDK

Cancel-ProvVMUpdate

August 3, 2023

Contributed by:

Cancels pending property updates on provisioned virtual machines.

Syntax

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

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

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

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

<!--NeedCopy-->

Detailed Description

Provides the ability to clear pending property updates on existing virtual machines.

This cmdlet clears the ProvisioningSchemeUpdateRequested and ProvisioningSchemeUpdateUntil fields on virtual machines, canceling any pending property updates. If a machine is already powering on with a property update, it cannot be cancelled with this cmdlet.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The name of the provisioning scheme.	true	true (ByValue, ByPropertyName)
VMName	List of VM names. If not specified, all VMs in the machine catalog associated with the specified provisioning scheme will have pending property updates cancelled.	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
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

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

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

Return Values

Examples

Example 1

c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil

VMName       ProvisioningSchemeVersion  ProvisioningSchemeUpdateRequested  ProvisioningSchemeUpdateUntil

------       -------------------------  ---------------------------------  -----------------------------

azu01                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu02                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu03                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu04                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

c:\PS> Cancel-ProvVMUpdate -ProvisioningSchemeName azure-catalog

c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil

VMName       ProvisioningSchemeVersion  ProvisioningSchemeUpdateRequested  ProvisioningSchemeUpdateUntil

------       -------------------------  ---------------------------------  -----------------------------

azu01                              1

azu02                              1

azu03                              1

azu04                              1

<!--NeedCopy-->

Description

Request all VMs in azure-catalog to have their pending property updates canceled.

Example 2

c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil

VMName       ProvisioningSchemeVersion  ProvisioningSchemeUpdateRequested  ProvisioningSchemeUpdateUntil

------       -------------------------  ---------------------------------  -----------------------------

azu01                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu02                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu03                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu04                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

c:\PS> Cancel-ProvVMUpdate -ProvisioningSchemeName azure-catalog -VMName azu01,azu02

c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil

VMName       ProvisioningSchemeVersion  ProvisioningSchemeUpdateRequested  ProvisioningSchemeUpdateUntil

------       -------------------------  ---------------------------------  -----------------------------

azu01                              1

azu02                              1

azu03                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

azu04                              1               3/11/2022  11:00:00 PM         3/12/2022  12:00:00 AM

<!--NeedCopy-->

Description

Request machines azu01 and azu02 to have property updates canceled. The other machines remain having a property update scheduled.

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

Cancel-ProvVMUpdate

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Cancel-ProvVMUpdate

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

Return Values

Examples

Example 1

Description

Example 2

Description

In this article