Citrix Virtual Apps and Desktops SDK

Remove-ProvImageDefinition

Remove an image definition.

Syntax


Remove-ProvImageDefinition -PreparedImageDefinitionName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-ProvImageDefinition -PreparedImageDefinitionUid <Guid> [-LoggingId <Guid>] [-BearerToken <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)  
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  
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

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