Citrix Virtual Apps and Desktops SDK

Get-ProvVirtualDisk

August 3, 2023

Contributed by:

Gets any Virtual Disks that are recognised by the Machine Creation Service.

Syntax

Get-ProvVirtualDisk [-VirtualDiskId <Guid>] [-StorageId <Guid>] [-HostingUnitUid <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 Virtual Disks that are known to the Machine Creation Service and their locations on the storage.

Get-ProvVirtualDiskPendingOperation

Parameters

Name	Description	Required?	Pipeline Input	Default Value
VirtualDiskId	The identifier for the virtual disk.	false	true (ByPropertyName)
StorageId	The identifier for the storage location on which the virtual disk is located.	false	false
HostingUnitUid	The identifier for the hosting unit containing the virtual disk.	false	true (ByPropertyName)
ReturnTotalRecordCount	See about_Prov_Filtering for details.	false	false	false
MaxRecordCount	See about_Prov_Filtering for details.	false	false	false
Skip	See about_Prov_Filtering for details.	false	false	0
SortBy	See about_Prov_Filtering for details.	false	false
Filter	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 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

System.Guid

You can pipe the hosting unit identifier to Get-ProvVirtualDisk.

Return Values

Citrix.Machinecreation.Sdk.Virtualdisk

The object has the following properties:

AllowAutomaticReplication <bool> A value indicating whether the virtual disk will be replicated automatically to all storage locations defined within the hosting unit.
HighPriority <bool> A value indicating whether the virtual disk is high priority.
HostingUnitUid <Guid> The unique identifier of the hosting unit.
VirtualDiskId <Guid> The unique identifier of the virtual disk.
VirtualDiskLocations <Citrix.MachineCreation.Sdk.VirtualDiskLocation> An array of objects, each providing the location of the virtual disk on a storage location of the hosting unit.
VirtualDiskType <string> A value indicating the type of the virtual disk (e.g. AppDisk).

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

PS C:\> Get-ProvVirtualDisk

          AllowAutomaticReplication : False

          HighPriority              : False

          HostingUnitUid            : e22036f7-1026-467e-a8af-fad81f8eddf8

          VirtualDiskId             : 51a55b3a-a713-4692-ae57-15aa0c050486

          VirtualDiskLocations      : {a0788335-c0d6-428c-8168-fad6bdb48010}

          VirtualDiskType           : ControlDisk

          AllowAutomaticReplication : True

          HighPriority              : False

          HostingUnitUid            : e22036f7-1026-467e-a8af-fad81f8eddf8

          VirtualDiskId             : 2677e07f-b53d-4b4b-afbb-94af6461b9b1

          VirtualDiskLocations      : {21cd1a35-a5b9-4c86-81f8-f90d0c76b352}

          VirtualDiskType           : AppDisk

          AllowAutomaticReplication : False

          HighPriority              : False

          HostingUnitUid            : 98636b1f-eab8-419f-80ce-8e41740bc251

          VirtualDiskId             : 1b213058-f33c-40bb-85e9-b4a3cc5cb1de

          VirtualDiskLocations      : {Version=2,LsiLogicScsi,-1,,[Shared] AppDisk-VirtualDiskId-1b213058-f33c-40bb-85e9-b4a3cc5cb1de/01 Jan 2016 00-01-02.9567Z.vmdk,resgroup-116,Vmfs}

          VirtualDiskType           : AppDisk

<!--NeedCopy-->

Description

Gets all virtual disks known to MCS.

Example 2

PS C:\> Get-ProvVirtualDisk -HostingUnitUid e22036f7-1026-467e-a8af-fad81f8eddf8

          AllowAutomaticReplication : False

          HighPriority              : False

          HostingUnitUid            : e22036f7-1026-467e-a8af-fad81f8eddf8

          VirtualDiskId             : 51a55b3a-a713-4692-ae57-15aa0c050486

          VirtualDiskLocations      : {a0788335-c0d6-428c-8168-fad6bdb48010}

          VirtualDiskType           : ControlDisk

          AllowAutomaticReplication : True

          HighPriority              : False

          HostingUnitUid            : e22036f7-1026-467e-a8af-fad81f8eddf8

          VirtualDiskId             : 2677e07f-b53d-4b4b-afbb-94af6461b9b1

          VirtualDiskLocations      : {21cd1a35-a5b9-4c86-81f8-f90d0c76b352}

          VirtualDiskType           : AppDisk

<!--NeedCopy-->

Description

Gets all virtual disks associated with the given hosting unit.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvVirtualDisk

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-ProvVirtualDisk

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.Guid

Return Values

Citrix.Machinecreation.Sdk.Virtualdisk

Notes

Examples

Example 1

Description

Example 2

Description

In this article