Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-ProvVirtualDiskPendingOperation

August 3, 2023
Contributed by: 
C

Gets the operations queued for Virtual Disks.

Syntax


Get-ProvVirtualDiskPendingOperation [-Id <Guid>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to obtain a list of the operations queued for Virtual Disks.

Parameters

Name Description Required? Pipeline Input Default Value
Id The identifier for the operation false false  
ReturnTotalRecordCount When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
BearerToken Specifies the bearer token assigned to 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

Return Values

Citrix.Machinecreation.Sdk.Pendingvirtualdiskoperation

The object has the following properties:

  • OperationId &lt;Guid&gt; The unique identifier of the operation.

  • VirtualDiskId &lt;Guid&gt; The unique identifier of the virtual disk.

  • StorageId &lt;string&gt; The storage location on the hypervisor where the disk resides.

  • InProgress &lt;bool&gt; Indicates whether the operation is in progress.

  • Progress &lt;int&gt; Percentage progress indication.

  • IsPriority &lt;bool&gt; Indicates whether the operation is high priority.

  • OperationType &lt;string&gt; The kind of operation. Currently the only valid value is “Replicate”. TimeLastQueued <DateTime> The date and time when the operation was last queued for action.

  • LastErrorReported &lt;string&gt; The last reported error if any. Retries <int> The number of times the operation has been retried.

Notes

In the case of failure, the following errors can result.

  • PartialData: Only a subset of the available data was returned.

  • CouldNotQueryDatabase: The query required to get the database was not defined.

  • 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 CommunicationError An error occurred while communicating with the service.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.

  • 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.

Examples

Example 1 


C:\PS>Get-ProvVirtualDiskPendingOperation -Id "33ad07a7-edd7-589b-716a-86cad4739f5e"

          OperationId             : 33ad07a7-edd7-589b-716a-86cad4739f5e

          VirtualDiskId           : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51

          StorageId               : a830de93-ddc5-b763-dc1a-35580a31401c

          InProgress              : False

          Progress                : 100

          IsPriority              : False

          OperationType           : Replicate

          TimeLastQueued          : 08/12/2012 09:35:30

          LastErrorReported       :

          Retries                 : 1

<!--NeedCopy-->

Description

Gets the operation ‘33ad07a7-edd7-589b-716a-86cad4739f5e’.

Get-ProvVirtualDiskPendingOperation
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.