Clear-Provvmupdatetimewindow¶
Cancels pending property updates on provisioned virtual machines.
Syntax¶
Clear-ProvVMUpdateTimeWindow -ProvisioningSchemeName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Clear-ProvVMUpdateTimeWindow -ProvisioningSchemeName <String> -VMName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Clear-ProvVMUpdateTimeWindow -ProvisioningSchemeUid <Guid> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Clear-ProvVMUpdateTimeWindow -ProvisioningSchemeUid <Guid> -VMName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
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.
Related Commands¶
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 Clear-ProvVMUpdateTimeWindow.
Return Values¶
¶
Examples¶
Example 1¶
c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil<br><br>VMName ProvisioningSchemeVersion ProvisioningSchemeUpdateRequested ProvisioningSchemeUpdateUntil<br><br>------ ------------------------- --------------------------------- -----------------------------<br><br>azu01 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu02 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu03 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu04 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>c:\PS> Clear-ProvVMUpdateTimeWindow -ProvisioningSchemeName azure-catalog<br><br>c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil<br><br>VMName ProvisioningSchemeVersion ProvisioningSchemeUpdateRequested ProvisioningSchemeUpdateUntil<br><br>------ ------------------------- --------------------------------- -----------------------------<br><br>azu01 1<br><br>azu02 1<br><br>azu03 1<br><br>azu04 1
Description¶
Clear the time window for all VMs in azure-catalog, canceling the pending property update for each machine.
Example 2¶
c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil<br><br>VMName ProvisioningSchemeVersion ProvisioningSchemeUpdateRequested ProvisioningSchemeUpdateUntil<br><br>------ ------------------------- --------------------------------- -----------------------------<br><br>azu01 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu02 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu03 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu04 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>c:\PS> Cancel-ProvVMUpdate -ProvisioningSchemeName azure-catalog -VMName azu01,azu02<br><br>c:\PS> Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil<br><br>VMName ProvisioningSchemeVersion ProvisioningSchemeUpdateRequested ProvisioningSchemeUpdateUntil<br><br>------ ------------------------- --------------------------------- -----------------------------<br><br>azu01 1<br><br>azu02 1<br><br>azu03 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM<br><br>azu04 1 3/11/2022 11:00:00 PM 3/12/2022 12:00:00 AM
Description¶
Clear the time window for machines azu01,azu02 in azure-catalog, canceling the pending property update for the two machines. The other machines remain having a property update time window set.