Remove-ProvImageVersion
Introduced in: Citrix Virtual Apps and Desktop 7 2303
Remove specified image version.
Syntax
Remove-ProvImageVersion
[-ImageDefinitionName] <String>
[-ImageVersionNumber] <Int32>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ProvImageVersion
[-ImageVersionUid] <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove an image version if there are no image version specs in this version.
Examples
EXAMPLE 1
Removes image version with Guid 90e93b9d-a225-4701-ad50-fa1546af35ac.
Remove-ProvImageVersion -ImageVersionUid 90e93b9d-a225-4701-ad50-fa1546af35ac
EXAMPLE 2
Removes image version 1 in image1.
Remove-ProvImageVersion -ImageVersionNumber 1 -ImageDefinitionName image1
Parameters
-ImageDefinitionName
The name of image definition which the image version belongs to.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-ImageVersionUid
The identifier of image version.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-ImageVersionNumber
The version number of image version.
| Type: | Int32 |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-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
Citrix.MachineCreation.Sdk.ImageVersion
Outputs
None
By default, this cmdlet returns no output.
Notes
In the case of failure, the following errors can result.
Error Codes
IllegalParameter
One or more parameters are illegal or are not specified.
ImageVersionNotFound
The specified image version could not be located.
UnableToRemoveImageVersionWithImageVersionSpecs
Unable to remove an image version with image version specs
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.