Remove-ProvImageVersionSpecInstance
Introduced in: Citrix Virtual Apps and Desktop 7 2603
Remove the replica of the prepared image version spec instance.
Syntax
Remove-ProvImageVersionSpecInstance
[-ImageInstanceUid] <Guid>
[-ImageVersionSpecUid] <Guid>
[-PurgeDbOnly]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove the replicas of an image version spec instance.
Examples
EXAMPLE 1
Remove an image version spec instance.
Remove-ProvImageVersionSpecInstance -ImageVersionSpecUid 76232d77-8170-43da-8d4f-f5dc4a0c49dd -ImageInstanceUid "e06f80e2-4c4f-4cbe-9dbb-81f5087cb117" -RunAsynchronously
Parameters
-ImageInstanceUid
The identifier for the image instance.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ImageVersionSpecUid
The identifier for the image version spec.
| Type: | Guid |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-PurgeDbOnly
If this option is specified, this command will only remove the image spec instance data from the Citrix site database. However, the disk images created in the image version still remain in the hypervisor. The hypervisor administrator can remove hard disk images using the tools provided by the hypervisor itself. This option can also be used when you are no longer able to contact the hypervisor and you want to remove the image version spec instance from Citrix site database.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates whether the cmdlet should return before it is complete. If specified, the command returns an identifier for the task that was created. You can monitor this task using the Get-ProvTask cmdlet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PurgeJobOnSuccess
Indicates that the task history will be removed from the database when the task has finished. This cannot be specified for tasks that are run asynchronously.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| 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 |
-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 |
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
None
You can't pipe objects to this cmdlet.
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.
ImageVersionSpecUid \<string\> The unique identifier of the image version spec.
TaskState \<Citrix.DesktopUpdateManager.SDK.ProvisionVMState\> The state of the task. This can be any of the following:
LastUpdateTime \<DateTime\> The date and time of the last task status update.
CurrentOperation \<string\> Operation specific phase of the overall "Running" task state.
TerminatingError \< Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError\> Diagnostic information if the task completely fails.
TaskProgress \<double\> The progress of the task 0-100%.
WorkflowStatus \<System.Workflow.Runtime.WorkflowStatus\> Indicates the status of the workflow that is used to process the task.
DateFinished \<DateTime\> The date and time when the task was completed.
TaskExpectedCompletion \<DateTime\> The date and time at which the task is expected to complete.
ActiveElapsedTime \<int\> Number of seconds the task has taken for active execution.
Status \<string\> Where in its lifecycle the task is.
TaskStateInformation \<string\> Provides more detailed information about the current task state.
Type \<Citrix.XDInterServiceTypes.JobType\> The type of task. For add image version spec instance task, this is always "AddImageVersionSpecInstance".
Notes
In the case of failure, the following errors can result.
Error Codes
ImageVersionSpecInstanceNotFound The specified image version spec instance could not be located.
ImageVersionSpecNotFound The specified image version spec could not be located.
CapabilityNotSupported The operation is not supported by the hypervisor.
NoAvailableStorageForReplication The requested storage IDs for replication are either not found, or already used for existing image instances.
DatabaseError An error occurred in the service while attempting a database operation.
CommunicationError An error occurred while communicating with the service.
PermissionDenied The user does not have administrative rights to perform this operation.