Remove-ProvImageVersionSpec
Introduced in: Citrix Virtual Apps and Desktop 7 2402
Remove specified image version spec.
Syntax
Remove-ProvImageVersionSpec
[-ImageVersionSpecUid] <Guid>
[-PurgeDBOnly]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove an image version spec and its relevant hard disk image that has been prepared.
A background task will be created to remove the old hard disk copies. You can locate and monitor this task using the Get-ProvTask cmdlet.
Examples
EXAMPLE 1
Remove a image version spec with uid "51c92c8d-2213-439b-9fa0-38539fc4a622".
Remove-ProvImageVersionSpec -ImageVersionSpecUid 51c92c8d-2213-439b-9fa0-38539fc4a622 -PurgeDBOnly
TaskId : 021c8997-ac1c-45b8-ab28-25eeb8c3540c
Active : False
Host : E73178-9-1
DateStarted : 10/19/2023 1:10:11 AM
Metadata : {}
ImageVersionSpecUid : 51c92c8d-2213-439b-9fa0-38539fc4a622
PurgeDbOnly : True
TaskStateInformation : Completed
TaskState : Finished
TaskType : RemoveProvImageVersionSpec
LastUpdateTime : 10/19/2023 1:10:11 AM
CurrentOperation :
TerminatingError :
TaskProgress : 100
WorkflowStatus : Completed
DateFinished : 10/19/2023 1:10:11 AM
TaskExpectedCompletion : 10/19/2023 1:10:11 AM
ActiveElapsedTime : 0
Status : Finished
Type : RemoveProvImageVersionSpec
Parameters
-ImageVersionSpecUid
The identifier of the image version spec to be removed.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-PurgeDBOnly
If this option is specified, this command will only remove the image version data from the Citrix site database. However, the disk images created in the image version still remain in the hypervisor. The hypervisor administrator can remove hard disk images using the tools provided by the hypervisor itself. This option can also be used when you are no longer able to contact the hypervisor and you want to remove the image version from Citrix site database. This parameter cannot be used with "ForgetVM".
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates whether or not the cmdlet should return before it is complete. If specified, the command returns an identifier for the task that was created. You can monitor this task using the Get-ProvTask cmdlet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PurgeJobOnSuccess
Indicates that the task history will be removed from the database when the task has finished. This cannot be specified for tasks that are run asynchronously.
| 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
System.Management.Automation.PSCustomObject
This object provides details of the task that was run and contains the following information:
TaskId \<Guid\>
The identifier for the task that was performed.
Active \<bool\>
Indicates whether the task is still processing or is complete.
Host \<string\>
The name of the host on which the task is running or was run.
DateStarted \<DateTime\>
The date and time when the task was started.
Metadata \<Citrix.MachineCreation.Sdk.Metadata\[\]\>
The list of metadata stored for the task. For new tasks, this is empty until metadata is added.
CurrentOperation \<string\>
Operation specific phase of the overall "Running" task state.
TaskProgress \<double\>
The progress of the task 0-100%.
LastUpdateTime \<DateTime\>
The date and time of the last task status update.
ActiveElapsedTime \<int\>
Number of seconds the task has taken for active execution.
DateFinished \<DateTime\>
The date and time when the task was completed.
TerminatingError \< Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError\>
Diagnostic information if the task completely fails.
Type \<Citrix.XDInterServiceTypes.JobType\>
The type of task. For new reset disk tasks, this is always "Reset-ProvVMDisk".
Status \<string\>
Where in its lifecycle the task is.
ImageVersionSpecUid \<Guid\>
The unique identifier of the image version spec that the task was for.
TaskState \<Citrix.DesktopUpdateManager.SDK.ProvisionVMState\>
The state of the task. This can be any of the following: Processing
Indicates that the task is in its initial state.
LocatingResources,
Indicates that the task is locating information from other services.
HostingUnitNotFound
Indicates that the required hosting unit could not be located.
ImageVersionSpecNotFound
Indicates that the required image version spec could not be located.
Finished
Indicates that the task is complete.
FinishedWithErrors
Indicates that the task is complete but there were errors. Specific details of errors are included with each failed virtual machine.
Removing
Indicates that the task is removing virtual machines from the hypervisor.
Failed
Job failed for reasons specified in TaskStateInformation.
Canceled
Indicates that the task was stopped by user intervention (using Stop-ProvTask)
TaskStateInformation \<string\>
Provides more detailed information about the current task state.
WorkflowStatus \<System.Workflow.Runtime.WorkflowStatus\>
Indicates the status of the workflow that is used to process the task.
TaskExpectedCompletion \<DateTime\>
The date and time at which the task is expected to complete.
Notes
In the case of failure, the following errors can result.
Error Codes
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
ServiceStatusInvalidDb
An error occurred in the service while attempting a database operation - communication with the database failed for
for various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
UnsupportedByServer
The requested operation is not supported by this version of the service.
Related Links
-
about_HypHostSnapin