Remove-ProvSchemeVersion
Introduced in: Citrix Virtual Apps and Desktop 7 2311
Removes a provisioning scheme configuration version
Syntax
Remove-ProvSchemeVersion
[-ProvisioningSchemeName] <String>
-Version <Int32>
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ProvSchemeVersion
-ProvisioningSchemeUid <Guid>
-Version <Int32>
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove a prior provisioning scheme configuration version.
Examples
EXAMPLE 1
Removes version 3 of provisioning scheme MyScheme.
Remove-ProvSchemeVersion -ProvisioningSchemeName MyScheme -Version 3
EXAMPLE 2
Removes version 1 of provisioning scheme with Uid 5b37b311-fa3f-49dd-b93b-661b9e6fa571 -RunAsynchronously
Remove-ProvSchemeVersion -ProvisioningSchemeUid 5b37b311-fa3f-49dd-b93b-661b9e6fa571 -Version 1 -RunAsynchronously
Parameters
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme with the version to be removed.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Version
The version to remove. Cannot be the current provisioning scheme version in use or a version referenced by any machine in the provisioning scheme.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ProvisioningSchemeName
The name of the provisioning scheme with the version to be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates whether an identifier for the task must be returned before completion of the task. The progress of the task can be monitored using 'get-ProvTask' command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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-ProvSchemeVersion.
Outputs
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 remove prov scheme version task, this is always "RemoveSchemeVersion".
Status \<string\> Where in its lifecycle the task is.
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:
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.
Version \<int\> The provisioning scheme version to be removed
Notes
In the case of failure, the following errors can result.
Error Codes
ProvisioningSchemeNotFound The specified provisioning scheme could not be located.
ProvisioningSchemeVersionNotFound The specified ProvisioningScheme version could not be located.
ProvisioningSchemeVersionRemovalConflict The provisioning scheme version cannot be removed due to it being referenced by other resources.
CannotRemoveCurrentProvisioningSchemeVersion The provisioning scheme version cannot be removed since it is the current version.
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.