Clear-ProvVMUpdateTimeWindow
Cancels pending property updates on provisioned virtual machines.
Syntax
Clear-ProvVMUpdateTimeWindow
-ProvisioningSchemeName <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Clear-ProvVMUpdateTimeWindow
-ProvisioningSchemeName <String>
-VMName <String[]>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Clear-ProvVMUpdateTimeWindow
-ProvisioningSchemeUid <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Clear-ProvVMUpdateTimeWindow
-ProvisioningSchemeUid <Guid>
-VMName <String[]>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
Clear the time window for all VMs in azure-catalog, canceling the pending property update for each machine.
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
Clear-ProvVMUpdateTimeWindow -ProvisioningSchemeName azure-catalog
Get-ProvVM -ProvisioningSchemeName azure-catalog | select VMName, ProvisioningSchemeVersion, ProvisioningSchemeUpdateRequested, ProvisioningSchemeUpdateUntil
VMName ProvisioningSchemeVersion ProvisioningSchemeUpdateRequested ProvisioningSchemeUpdateUntil
------ ------------------------- --------------------------------- -----------------------------
azu01 1
azu02 1
azu03 1
azu04 1
EXAMPLE 2
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.
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
Cancel-ProvVMUpdate -ProvisioningSchemeName azure-catalog -VMName azu01,azu02
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
Parameters
-ProvisioningSchemeName
The name of the provisioning scheme.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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
Citrix.MachineCreation.Sdk.ProvisionedVirtualMachine
You can pipe an object containing parameters called 'VMId' and 'ProvisioningSchemeName' to Clear-ProvVMUpdateTimeWindow.
Outputs
None
By default, this cmdlet returns no output.
Notes
In the case of failure, the following errors can result.
Error Codes
ProvisioningSchemeNotFound
The specified provisioning scheme could not be located.
ProvisioningSchemeNotReady
The specified provisioning scheme is not in Ready state.