Citrix Virtual Apps and Desktops SDK

Remove-ProvScheme

March 11, 2024

Contributed by:

Removes a provisioning scheme

Syntax

Remove-ProvScheme
      [-ProvisioningSchemeName] <String>
      [-PurgeDBOnly]
      [-ForgetVM]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-ProvScheme
      -ProvisioningSchemeUid <Guid>
      [-PurgeDBOnly]
      [-ForgetVM]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to remove a provisioning Scheme. The provisioning scheme must not contain any VMs unless the ‘ForgetVM’ or ‘PurgeDBOnly’ option is specified. Use the Get-ProvTask command to monitor the progress of this task.

Examples

EXAMPLE 1

Remove the empty provisioning scheme by name.

Remove-ProvScheme -ProvisioningSchemeName $provScheme.ProvisioningSchemeName
<!--NeedCopy-->

EXAMPLE 2

Deletes provisioning scheme ‘Catalog-1’ data from the Citrix site database

Get-ProvScheme -ProvisioningSchemeName Catalog-1 | Remove-ProvScheme -PurgeDBOnly

TaskId                 : 02693f9c-8fa0-41c8-ab23-15853537fbb1
Active                 : False
Host                   : E73755-92-1
DateStarted            : 8/19/2022 12:50:34 PM
Metadata               :
ProvisioningSchemeName : Catalog-1
ProvisioningSchemeUid  : 60851748-3476-43c7-b406-c25f1a952185
PurgeDBOnly            : True
ForgetVm               : False
RemovedVirtualMachines : {}
FailedVirtualMachines  : {}
TaskState              : Finished
TaskStateInformation   :
CurrentOperation       :
TaskProgress           : 100
LastUpdateTime         : 8/19/2022 12:50:36 PM
ActiveElapsedTime      : 0
DateFinished           : 8/19/2022 12:50:36 PM
TerminatingError       :
Type                   : RemoveProvScheme
Status                 : Finished
WorkflowStatus         : Completed
TaskExpectedCompletion :
<!--NeedCopy-->

EXAMPLE 3

Removes all the Citrix-assigned identifiers(like tags or custom-attributes) on provisioning scheme, VMs and their related resources from hypervisor and also the deletes provisioning scheme ‘Catalog-1’ data from the Citrix site database.

Get-ProvScheme -ProvisioningSchemeName Catalog-1 | Remove-ProvScheme -ForgetVM

TaskId                 : 02693f9c-8fa0-41c8-ab23-15853537fbb1
Active                 : False
Host                   : E73755-92-1
DateStarted            : 8/19/2022 12:50:34 PM
Metadata               :
ProvisioningSchemeName : Catalog-1
ProvisioningSchemeUid  : 60851748-3476-43c7-b406-c25f1a952185
PurgeDBOnly            : False
ForgetVm               : True
RemovedVirtualMachines : {S-1-5-21-12345678-1234567890-123456789-2345}
FailedVirtualMachines  : {}
TaskState              : Finished
TaskStateInformation   :
CurrentOperation       :
TaskProgress           : 100
LastUpdateTime         : 8/19/2022 12:50:36 PM
ActiveElapsedTime      : 0
DateFinished           : 8/19/2022 12:50:36 PM
TerminatingError       :
Type                   : RemoveProvScheme
Status                 : Finished
WorkflowStatus         : Completed
TaskExpectedCompletion :
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme to be removed.

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

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme 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 provisioning scheme data from the Citrix site database. However, the VMs and related resources created in the provisioning scheme still remain in the hypervisor. The hypervisor administrator can remove the VMs and 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 provisioning scheme 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

-ForgetVM

If this option is specified, this command will remove the provisioning scheme data from the Citrix site database and also delete Citrix-assigned identifiers(like tags or custom-attributes) on provisioning scheme, VMs and their related resources from hypervisor. However, the VMs and related resources created in the provisioning scheme still remain in the hypervisor after removing identifiers(like tags or custom-attributes). The hypervisor administrator can remove the VMs and hard disk images using the tools provided by the hypervisor itself. This parameter is only applied to persistent VMs and cannot be used with “PurgeDBOnly”.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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.ProvisioningScheme

You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ or ‘ProvisioningSchemeUid’ to Remove-ProvScheme.

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 reset disk tasks, this is always “Reset-ProvVMDisk”.

Status <string> ProvisioningSchemeName <string>

The name of the provisioning scheme from which the VM was created.

ProvisioningSchemeUid <Guid>

The unique identifier of the provisioning scheme from which the VM was created.

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

If the hosting unit referenced by the provisioning scheme no longer exists (that is, has been removed using the Hosting Unit PowerShell snap-in), the provisioning scheme data is deleted from the database without errors. However, the hard disks associated with the provisioning scheme cannot be removed and remain in the hypervisor.

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

Error Codes

IllegalParameter

One or more parameters are illegal or are not specified.

ProvisioningSchemeNotFound

The specified provisioning scheme could not be located.

UnableToRemoveProvisioningSchemeDueToAssociatedVM

The provisioning scheme contained VMs and the ‘ForgetVM’ or ‘PurgeDBOnly’ parameter was not specified.

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

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

Running

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-ProvScheme

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Remove-ProvScheme

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

Parameters

-ProvisioningSchemeName

-ProvisioningSchemeUid

-PurgeDBOnly

-ForgetVM

-RunAsynchronously

-PurgeJobOnSuccess

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ProvisioningScheme

Outputs

Guid

System.Management.Automation.PSCustomObject

Notes

Related Links

In this article