Remove-ProvSchemeScope¶
Remove the specified provisioning scheme(s) from the given scope(s).
Syntax¶
Remove-ProvSchemeScope [-Scope] <String[]> -InputObject <ProvisioningScheme[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-ProvSchemeScope [-Scope] <String[]> -ProvisioningSchemeUid <Guid[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-ProvSchemeScope [-Scope] <String[]> -ProvisioningSchemeName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
The Remove-ProvSchemeScope command is used to remove one or more provisioning schemes from the given scope(s).
To remove a provisioning scheme from a scope you need permission to change the scopes of the provisioning scheme.
If the provisioning scheme is not in a specified scope, that scope will be silently ignored.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Scope | Specifies the scopes to remove the objects from. | true | false | |
| InputObject | Specifies the ProvisioningScheme objects to be removed. | true | true (ByValue, ByPropertyName) | |
| ProvisioningSchemeUid | Specifies the ProvisioningScheme objects to be removed by the unique identifier of the provisioning scheme(s). | true | true (ByValue, ByPropertyName) | |
| ProvisioningSchemeName | Specifies the ProvisioningScheme objects to be removed by the name of the provisioning scheme(s). | true | true (ByValue, ByPropertyName) | |
| 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. | false | false | |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| AdminClientIP | Specifies the Client IP of the calling user | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing user | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false | |
| AdminAddress | The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Input Type¶
Citrix.Machinecreation.Sdk.Provisioningscheme¶
You can pipe a ProvisioningScheme object or any object containing a parameter called 'ProvisioningSchemeName' or 'ProvisioningSchemeUid' to Remove-ProvScope.
Return Values¶
None¶
Notes¶
If the command fails, the following errors can be returned.
UnknownObject One of the specified objects was not found. ScopeNotFound One of the specified scopes was not found. 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. DataStoreException An error occurred in the service while attempting a database operation - communication with the database failed for various reasons. PermissionDenied You do not have permission to execute this command with the specified objects or scopes. AuthorizationError There was a problem communicating with the Citrix Delegated Administration Service. ConfigurationLoggingError The operation could not be performed because of a configuration logging error. CommunicationError There was a problem communicating with the remote service. ExceptionThrown An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.
Examples¶
Example 1¶
c:\PS>Remove-ProvSchemeScope Finance -ProvisioningSchemeUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
Description¶
Removes a single provisioning scheme from the 'Finance' scope.
Example 2¶
c:\PS>Remove-ProvSchemeScope Finance,Marketing -ProvisioningSchemeUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
Description¶
Removes a single provisioning scheme from multiple scopes.
Example 3¶
c:\PS>Get-ProvScheme | Remove-ProvSchemeScope Finance
Description¶
Removes all visible provisioning schemes from the 'Finance' scope.
Example 4¶
c:\PS>Remove-ProvSchemeScope Finance -ProvisioningSchemeName A\*
Description¶
Removes provisioning schemes whose name starts with an 'A' from the 'Finance' scope.