Skip to content

Remove-ProvImagesPendingDelete¶

Remove pending image to delete.

Syntax¶

Remove-ProvImagesPendingDelete [-Id] <Int32> [-ForceDelete] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description¶

Provides the ability to remove image which are pending to be delete

Get-ProvImagesPendingDeleteCommand

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
Id	Pendig image record ID, in DB	true	true (ByPropertyName)	0
ForceDelete	If this switch is enabled, we force delete the image from hypervisor	false	false	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¶

Return Values¶

Notes¶

In the case of failure, the following errors can result.

Examples¶

Example 1¶

Remove-ProvImagesPendingDelete -Id 1 -ForceDelete

            Remove-ProvImagesPendingDelete : Image is in use.

            At line:1 char:1

            + Remove-ProvImagesPendingDelete -PendingDeleteId 1 -ForceDelete

            + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

            + CategoryInfo          : InvalidOperation: (:) [Remove-ProvImagesPendingDelete], InvalidOperationException

            + FullyQualifiedErrorId : Citrix.XDPowerShell.MachineCreationStatus.DiskIsInUse,Citrix.MachineCreation.Sdk.Commands.RemoveProvImagesPendingDeleteCommand

Description¶

Trying to delete a image which is in use

Example 2¶

Remove-ProvImagesPendingDelete -Id 3 -ForceDelete

            Remove-ProvImagesPendingDelete : There is no pending image to delete.

            At line:1 char:1

            + Remove-ProvImagesPendingDelete -PendingDeleteId 3 -ForceDelete

            + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

            + CategoryInfo          : InvalidOperation: (:) [Remove-ProvImagesPendingDelete], InvalidOperationException

            + FullyQualifiedErrorId : Citrix.XDPowerShell.MachineCreationStatus.NoPendingDiskToDelete,Citrix.MachineCreation.Sdk.Commands.RemoveProvImagesPendingDeleteComman

            d

Description¶

Trying to delete the image which does not exits

Was this article helpful?

Provide Feedback