Citrix Virtual Apps and Desktops SDK

Repair-ProvScheme

Introduced in: Citrix Virtual Apps and Desktop 7 2511

Repairs a provisioning scheme

Syntax

Repair-ProvScheme
      [-ProvisioningSchemeName] <String>
      [-WBCDisks]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Repair-ProvScheme
      -ProvisioningSchemeUid <Guid>
      [-WBCDisks]
      [-RunAsynchronously]
      [-PurgeJobOnSuccess]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to repair a provisioning Scheme. The additional flags passed to this cmdlet determine what type of repair is run

Examples

EXAMPLE 1

Repairs the WBC disks of the provisioning scheme named ‘myProvScheme’.

Repair-ProvScheme -ProvisioningSchemeName myProvScheme -WBCDisks

TaskId                 : 5852d1b6-7138-449f-92ca-36978a6a9d4d
Active                 : False
Host                   : R77778-28-1
DateStarted            : 4/29/2025 2:51:11 PM
Metadata               : {}
ProvisioningSchemeUid  : dd9e43ab-e83d-48a9-aa98-13d82a2daad4
ProvisioningSchemeName : TestCatalog
RepairWBCDisks         : True
WBCDisksToRepair       : {DiskId template:/subscriptions/8de0ea51-de7a-4a19-8603-4a6dd163024b/resourceGroups/my-rg/providers/Microsoft.Compute/snapshots/TestCatalog-wbcDisk-d8igc : StorageId }
RepairedWBCDisks       : {DiskId template:/subscriptions/8de0ea51-de7a-4a19-8603-4a6dd163024b/resourceGroups/my-rg/providers/Microsoft.Compute/snapshots/TestCatalog-wbcDisk-d8igc : StorageId }
TaskState              : Finished
TaskType               : RepairProvScheme
LastUpdateTime         : 4/29/2025 2:51:49 PM
CurrentOperation       :
TerminatingError       :
TaskProgress           : 100
WorkFlowStatus         : Completed
DateFinished           : 4/29/2025 2:51:49 PM
TaskExpectedCompletion : 4/29/2025 2:51:49 PM
ActiveElapsedTime      : 37
Status                 : Finished
TaskStateInformation   : Completed
Type                   : RepairProvScheme
<!--NeedCopy-->

EXAMPLE 2

Repairs the WBC disks of the provisioning scheme with UID ‘dd9e43ab-e83d-48a9-aa98-13d82a2daad4’.

Repair-ProvScheme -ProvisioningSchemeUid 'dd9e43ab-e83d-48a9-aa98-13d82a2daad4' -WBCDisks

TaskId                 : 5852d1b6-7138-449f-92ca-36978a6a9d4d
Active                 : False
Host                   : R77778-28-1
DateStarted            : 4/29/2025 2:51:11 PM
Metadata               : {}
ProvisioningSchemeUid  : dd9e43ab-e83d-48a9-aa98-13d82a2daad4
ProvisioningSchemeName : TestCatalog
RepairWBCDisks         : True
WBCDisksToRepair       : {DiskId template:/subscriptions/8de0ea51-de7a-4a19-8603-4a6dd163024b/resourceGroups/my-rg/providers/Microsoft.Compute/snapshots/TestCatalog-wbcDisk-d8igc : StorageId }
RepairedWBCDisks       : {DiskId template:/subscriptions/8de0ea51-de7a-4a19-8603-4a6dd163024b/resourceGroups/my-rg/providers/Microsoft.Compute/snapshots/TestCatalog-wbcDisk-d8igc : StorageId }
TaskState              : Finished
TaskType               : RepairProvScheme
LastUpdateTime         : 4/29/2025 2:51:49 PM
CurrentOperation       :
TerminatingError       :
TaskProgress           : 100
WorkFlowStatus         : Completed
DateFinished           : 4/29/2025 2:51:49 PM
TaskExpectedCompletion : 4/29/2025 2:51:49 PM
ActiveElapsedTime      : 37
Status                 : Finished
TaskStateInformation   : Completed
Type                   : RepairProvScheme
<!--NeedCopy-->

Parameters

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme to be repaired.

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

-ProvisioningSchemeName

The name of the provisioning scheme to be repaired.

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

-WBCDisks

If specified, repairs the base WBC disks for the provisioning scheme if they were deleted by mistake. There is one base WBC per WBC disk size used by machines in the provisioning scheme

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, -SkipCertificateValidation, -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 Repair-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.

Repair-ProvScheme