Citrix Daas SDK

Remove-ProvImageDefinition

November 28, 2023

Contributed by:

C C

Remove an image definition.

Syntax

Remove-ProvImageDefinition
      -PreparedImageDefinitionName <String>
      [-PurgeDBOnly]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-ProvImageDefinition
      -PreparedImageDefinitionUid <Guid>
      [-PurgeDBOnly]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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 -PreparedImageDefinitionName MyImage
<!--NeedCopy-->

Parameters

-PreparedImageDefinitionName

The name of the image definition to be removed.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-PreparedImageDefinitionUid

The unique identifier for the image definition to be removed.

Type:	Guid
Position:	Named
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 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”.

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

Citrix.MachineCreation.Sdk.ImageDefinition

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

Outputs

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.

Error Codes

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.

UnableToRemoveImageDefinitionWithPreparingImageVersion

The image definition has image version in preparing 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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-ProvImageDefinition

November 28, 2023

Contributed by:

C C

November 28, 2023

Contributed by:

C C

Remove-ProvImageDefinition

Syntax

Description

Examples

EXAMPLE 1

Parameters

-PreparedImageDefinitionName

-PreparedImageDefinitionUid

-PurgeDBOnly

-RunAsynchronously

-PurgeJobOnSuccess

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ImageDefinition

Outputs

Guid

System.Management.Automation.PSCustomObject

Notes

Related Links

In this article