Citrix Virtual Apps and Desktops SDK

Remove-ProvVMSnapshot

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Removes provisioned snapshots created by Machine Creation Services.

Syntax

Remove-ProvVMSnapshot
      [-ProvisioningSchemeName] <String>
      [-VMName <String>]
      [-SnapshotName <String[]>]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-ProvVMSnapshot
      [-ProvisioningSchemeUid] <Guid>
      [-VMName <String>]
      [-SnapshotName <String[]>]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Allows you to remove provisioned snapshots from the Machine Creation Services and hypervisor.

Examples

EXAMPLE 1

Remove all Provisioned Snapshots from provisioning scheme XenPS

,(Get-ProvVMSnapshot -ProvisioningSchemeName XenPS) | Remove-ProvVM XenPS

TaskId                 : cfb506a5-cc7e-4a49-ac7b-dd960029d0d3
Active                 : False
Host                   : DDC
DateStarted            : 10/10/2021 16:39:45
Metadata               : {}
CurrentOperation       :
TaskProgress           : 100
LastUpdatedTime        : 10/10/2021 16:39:50
ActiveElapsedTime      : 5
DateFinished           : 10/10/2021 16:39:50
TerminatingError       :
Type                   : RemoveSnapshot
Status                 : Finished
RemovedSnapshots       : {...}
FailedSnapshots        : {}
ProvisioningSchemeName : XenPS
ProvisioningSchemeUid  : e1afc8fb-3f52-42ea-9a17-305fdb0b6ee4
TaskState              : Finished
TaskStateInformation   :
WorkflowStatus         : Completed
TaskExpectedCompletion : 10/10/2021 16:39:50
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme from which snapshots will be removed.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme from which snapshots will be removed.

Type:	Guid
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

-VMName

The name of the VM from which snapshots will be removed.

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

-SnapshotName

List of snapshot names that will be removed.

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

-RunAsynchronously

Indicates whether the command returns before it completes. If this is specified, the command returns an identifier for the task that was created. This task can be monitored using the Get-ProvTask command.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PurgeJobOnSuccess

Indicates that the task history is removed from the database when the task completes. This cannot be specified for tasks that run asynchronously.

Type:	SwitchParameter
Position:	Named
Default value:	None
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.ProvisionedSnapshot

You can pipe an object containing parameters called ‘VMName’, ‘ProvisioningSchemeName’, and optionally ‘SnapshotName’ to Remove-ProvVMSnapshot.

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.

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 Remove-ProvVMSnapshot tasks, this is always “RemoveProvisionedSnapshot”.

Status <string>

Where in its lifecycle the task is.

StatusAdditionalInformation <string>

Extra information about the Status.

RemovedSnapshots <Citrix.DesktopUpdateManager.SDK.ProvisionedSnapshot[]>

Object array of removed snapshots summary information. The object properties are:

CreationDate <DateTime>

The date and time when the snapshot was created.

Domain <string>

The Domain of the AD computer account that the VM is using.

ProvisioningSchemeName <string>

The name of the provisioning scheme associated with the snapshot.

ProvisioningSchemeUid <Guid>

The unique identifier of the provisioning scheme associated with the snapshot.

ProvisioningSchemeVersion <int>

The version of the provisioning scheme used by the associated VM at the time of snapshot creation.

ProvVMConfigurationVersion <int>

The version of the custom configuration used by the associated VM at the time of snapshot creation.

SnapshotUid <Guid>

The unique identifier of the provisioned snapshot.

HypervisorID<string>

The hypervisor identifier of the provisioned snapshot.

SnapshotName <string>

The name of the provisioned snapshot.

VMId <string>

The identifier for the associated VM in the hypervisor.

VMName <string>

The name of the associated VM in the hypervisor.

HostingUnitUid <Guid>

The unique identifier of the hosting unit that was used to create the associated VM.

HypervisorConnectionUid <Guid>

The unique identifier of the hypervisor connection that was used to create the associated VM.

DeletionProtection <bool>

Flag indicating if snapshot requires explicit deletion.

FailedSnapshots <Citrix.DesktopUpdateManager.SDK.ProvisionedSnapshot[]>

See RemovedVirtualMachines for details of the object parameters.

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.

ProvisioningSchemeNotFound

Indicates that the required provisioning scheme could not be located.

Provisioning

Indicates that the task is at the provisioning stage.

IdentityPoolNotFound

Indicates that the required identity pool could not be located.

TaskAlreadyRunningForProvisioningScheme

Indicates that the provisioning scheme already has another task running.

Finalizing

Indicates that the task is finalizing.

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.

Removing

Indicates that the task is removing virtual machines from the hypervisor.

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

The cmdlet is associated with a task of type RemoveSnapshot, and while active will move through the following operations (CurrentOperation field)

ValidatingInputs

RemovingSnapshots

Only one long-running task for each provisioning scheme can be processed at a time.

This task still operates if the hosting unit or snapshots in the hypervisor are missing. This removes the data from the Citrix Machine Creation Services, but the VMs remain in the hypervisor.

In the case of failure, the following errors can result.

Error Codes

JobCreationFailed The requested task could not be started.

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 various reasons.

WorkflowHostUnavailable The task could not be started because the database connection is inactive.

CommunicationError An error occurred while communicating with the service.

InvalidParameterCombination Both PurgeJobOnSuccess and RunAsynchronously were specified. When running asynchronously, the cmdlet terminates before the job does, so it cannot clean up the completed job.

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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops 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-ProvVMSnapshot

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Remove-ProvVMSnapshot

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ProvisioningSchemeName

-ProvisioningSchemeUid

-VMName

-SnapshotName

-RunAsynchronously

-PurgeJobOnSuccess

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ProvisionedSnapshot

Outputs

Guid

System.Management.Automation.PSCustomObject

Notes

Related Links

In this article