Cancel-ProvVMUpdate
Introduced in: Citrix Virtual Apps and Desktop 7 2212
(DEPRECATED) Cancels pending property updates on provisioned virtual machines.
Syntax
Cancel-ProvVMUpdate
-ProvisioningSchemeName <String>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Cancel-ProvVMUpdate
-ProvisioningSchemeName <String>
-VMName <String[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Cancel-ProvVMUpdate
-ProvisioningSchemeUid <Guid>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Cancel-ProvVMUpdate
-ProvisioningSchemeUid <Guid>
-VMName <String[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet has been deprecated and replaced by Clear-ProvVMUpdateTimeWindow. Clear-ProvVMUpdateTimeWindow is the new name for Cancel-ProvVMUpdate and provides all the same functionality, please use it going foward in place of Cancel-ProvVMUpdate.
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
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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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 Cancel-ProvVMUpdate.
Outputs
None
By default, this cmdlet returns no output.