Remove-ProvSchemeMasterVMImageHistory
Removes the history of provisioning scheme master image VMs.
Syntax
Remove-ProvSchemeMasterVMImageHistory
[-ProvisioningSchemeName] <String>
[-VMImageHistoryUid <Guid>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ProvSchemeMasterVMImageHistory
-ProvisioningSchemeUid <Guid>
[-VMImageHistoryUid <Guid>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ProvSchemeMasterVMImageHistory
-VMImageHistoryUid <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove the record of previously used master image VMs or snapshots for provisioning schemes.
Examples
EXAMPLE 1
Removes all history for the provisioning scheme called "MyScheme".
Remove-ProvSchemeMasterVMImageHistory -ProvisioningSchemeName MyScheme
EXAMPLE 2
Removes all history for all provisioning schemes.
Get-ProvScheme | Remove-ProvSchemeMasterVMImageHistory
Parameters
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ProvisioningSchemeName
The name of the provisioning scheme.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Length range: | 1 to 64 |
-VMImageHistoryUid
The unique identifier of the image history item.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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' to Remove-ProvSchemeMasterVMImageHistory.
Outputs
None
By default, this cmdlet returns no output.
Notes
In the case of failure, the following errors can result.
Error Codes
ProvisioningSchemeNotFound
The specified provisioning scheme could not be located.
ProvisioningSchemeNotReady
The specified provisioning scheme is not in Ready state.
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.