Remove-ProvImageScheme¶
Removes an image scheme
Syntax¶
Remove-ProvImageScheme -PreparedImageSchemeName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-ProvImageScheme -PreparedImageSchemeUid <Guid> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Provides the ability to remove an image Scheme. The image scheme may associate with image versions. If associated image versions exist, the image scheme can not be removed.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| PreparedImageSchemeName | The name of the image scheme to be removed. | true | true (ByPropertyName) | |
| PreparedImageSchemeUid | The unique identifier for the image scheme to be removed. | true | true (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 | Specifies the address of a XenDesktop controller that the PowerShell snap-in connects 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.Imagescheme¶
You can pipe an object containing a parameter called 'ImageSchemeName' or 'ImageSchemeUid' to Remove-ImageScheme.
Return Values¶
Notes¶
In the case of failure, the following errors can result.
-
IllegalParameter: One or more parameters are illegal or are not specified.
-
ImageSchemeNotFound: The specified image scheme could not be located.
-
UnableToRemoveImageSchemeDueToAssociatedImageVersion: The image scheme associated with image versions and can not be removed.
-
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. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
Examples¶
Example 1¶
c:\PS>Remove-ProvImageScheme -PreparedImageSchemeName azurescheme
Description¶
Remove the image scheme by name.