Remove-ProvImagesPendingDelete
Introduced in: Citrix Virtual Apps and Desktop 7 2212
Remove pending image to delete.
Syntax
Remove-ProvImagesPendingDelete
[-Id] <Int32>
[-ForceDelete]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove image which are pending to be delete
Examples
EXAMPLE 1
Trying to delete a image which is in use
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
EXAMPLE 2
Trying to delete the image which does not exits
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
Parameters
-Id
Pendig image record ID, in DB
| Type: | Int32 |
| Position: | 2 |
| Default value: | 0 |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ForceDelete
If this switch is enabled, we force delete the image from hypervisor
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| 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
None
You can't pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.
Notes
In the case of failure, the following errors can result.