Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Remove-ProvImageDefinition

March 11, 2024
Contributed by: 
C

Remove an image definition.

Syntax


Remove-ProvImageDefinition -PreparedImageDefinitionName <String> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-ProvImageDefinition -PreparedImageDefinitionUid <Guid> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to remove an image definition and its image versions. The image definition can contain multiple image versions. If it still has image versions used by provisioning scheme, the image scheme can not be removed.

Parameters

Name Description Required? Pipeline Input Default Value
PreparedImageDefinitionName The name of the image definition to be removed. true true (ByPropertyName)  
PreparedImageDefinitionUid The unique identifier for the image definition to be removed. true true (ByPropertyName)  
PurgeDBOnly If this option is specified, this command will only remove the image definition data from the Citrix site database. However, the disk images created by its image versions 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 definition from Citrix site database. This parameter cannot be used with “ForgetVM”. false false  
ForgetVM If this option is specified, this command will remove the image definition data from the Citrix site database and also delete Citrix-assigned identifiers(like tags or custom-attributes) on disk images of its image versions from hypervisor. However, the disk images created in its image version still remain in the hypervisor after removing identifiers(like tags or custom-attributes). The hypervisor administrator can remove the disk images using the tools provided by the hypervisor itself. This parameter cannot be used with “PurgeDBOnly”. false 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. false false 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. 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

Citrix.Machinecreation.Sdk.Imagedefinition

You can pipe an object containing a parameter called ‘PreparedImageDefinitionName’ or ‘PreparedImageDefinitionUid’ to Remove-ProvImageDefinition.

Return Values

System.Guid

When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier.

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. ProvImageDefinitionUid <Guid> The unique identifier of the image definition. ProvImageDefinitionName <string> The name of the image definition. 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> 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. ImageDefinitionNotFound Indicates that the required image definition 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. RemovingImageVersion Indicates that the task is removing image version. RemovingImageDefinition Indicates that the task is removing image definition. 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.

  • IllegalParameter: One or more parameters are illegal or are not specified.

  • ImageDefinitionNotFound: The specified image definition could not be located.

  • UnableToRemoveImageDefinitionDueToAssociatedProvisioningScheme: The image definition still has image versions used by provisioning scheme and can not be removed.

  • 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.

Examples

Example 1 


c:\PS>Remove-ProvImageDefinition -PreparedImageDefinitionName MyImage

<!--NeedCopy-->

Description

Remove the image definition by name and its image versions.

Remove-ProvImageDefinition
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.