Remove-ProvImageDefinition
Remove an image definition.
Syntax
Remove-ProvImageDefinition
[-ImageDefinitionName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ProvImageDefinition
-ImageDefinitionUid <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
Remove the image definition by name and its image versions.
Remove-ProvImageDefinition -ImageDefinitionName MyImage
Parameters
-ImageDefinitionUid
The unique identifier for the image definition to be removed.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ImageDefinitionName
The name of the image definition to be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
| Disallowed characters: | \/;:#.*?=<>\|[]()"' |
-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.ImageDefinition
You can pipe an object containing a parameter called 'ImageDefinitionName' or 'ImageDefinitionUid' to Remove-ProvImageDefinition.
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.
ImageDefinitionNotFound
The specified image definition could not be located.
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.