PowerShell Logo Small

Get-VirtualDisk



This is the built-in help made by Microsoft for the command 'Get-VirtualDisk', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Returns a list of VirtualDisk objects, across all storage pools, across all providers, or optionally a filtered subset based on provided criteria.

SYNTAX


Get-VirtualDisk [[-FriendlyName] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription
<String[]>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-ThrottleLimit <Int32>]
[-UniqueId <String[]>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-StorageJob
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-TargetVirtualDisk
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-SourceVirtualDisk
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-TargetPort
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-InitiatorId <CimInstance>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription
<String[]>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-MaskingSet <CimInstance>] [-OtherUsageDescription
<String[]>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-InitiatorPort <CimInstance>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription
<String[]>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-Disk <CimInstance>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>]
[-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-StorageTier
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-PhysicalDisk
<CimInstance>] [-PhysicalRangeMax <UInt64>] [-PhysicalRangeMin <UInt64>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-StoragePool
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-StorageNode
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-OtherUsageDescription <String[]>] [-StorageSubSystem
<CimInstance>] [-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]
Get-VirtualDisk [-AsJob] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-IsSnapshot <Boolean[]>] [-Name <String[]>] [-OtherUsageDescription <String[]>]
[-ThrottleLimit <Int32>] [-Usage <Usage[]>] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Get-VirtualDisk cmdlet returns a list of VirtualDisk objects, across all storage pools, across all providers, or optionally a filtered subset based on provided criteria.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=306995
Where-Object
Connect-VirtualDisk
Disconnect-VirtualDisk
Get-Partition
Get-StoragePool
Hide-VirtualDisk
New-VirtualDisk
Remove-VirtualDisk
Repair-VirtualDisk
Resize-VirtualDisk
Set-VirtualDisk
Show-VirtualDisk

REMARKS

<

Examples


EXAMPLE 1

PS C:\> Get-VirtualDisk



This example returns all VirtualDisk objects across all visible StoragePool objects, across all visible StorageProvider objects.




EXAMPLE 2

PS C:\> $stpool = (Get-StoragePool -FriendlyName "SpacesPool")
PS C:\> Get-VirtualDisk -StoragePool $stpool



This example lists only the virtual disks from the StoragePool object named SpacesPool.




EXAMPLE 3

PS C:\> Get-VirtualDisk | Where-Object –FilterScript {$_.HealthStatus -Ne "Healthy"}



This example lists all virtual disks, across all pools, and all providers, which are not currently in a healthy state.




EXAMPLE 4

PS C:\> Get-VirtualDisk –FriendlyName "VDisk01" | Get-Disk | Get-Partition | Get-Volume



This example gets the partition and volume associated with a virtual disk. The command gets the virtual disk named VDisk01 and passes the virtual disk to the Get-Disk cmdlet
by using the pipeline operator. The Get-Disk cmdlet gets the disk associated with the virtual disk and passes the disk to the Get-Partition by using the pipeline operator.
The Get-Partition cmdlet gets the partition associated with the disk, and passes the partition to the Get-Volume cmdlet by using the pipeline operator. The Get-Volume cmdlet
gets the volume associated with the partition.