Get-VirtualDisk
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[]>]
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-UniqueId <String[]>]
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Name <String[]>]
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-StorageJob <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-TargetVirtualDisk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-SourceVirtualDisk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-TargetPort <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-InitiatorId <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-MaskingSet <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-InitiatorPort <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-Disk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-StorageTier <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-PhysicalDisk <CimInstance>]
[-PhysicalRangeMin <UInt64>]
[-PhysicalRangeMax <UInt64>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-StoragePool <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-StorageNode <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-VirtualDisk
[-Usage <Usage[]>]
[-OtherUsageDescription <String[]>]
[-IsSnapshot <Boolean[]>]
[-HealthStatus <HealthStatus[]>]
[-StorageSubSystem <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] 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.
Examples
EXAMPLE 1
PS C:\> Get-VirtualDiskThis 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 $stpoolThis 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-VolumeThis 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.
Parameters
-AsJob
ps_cimcommon_asjob
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Disk
Accepts a Disk object as input. The Disk CIM object is exposed by the Get-Diskhttp://technet.microsoft.com/library/3929eb27-1365-42ca-8acf-68b364c3599f cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FriendlyName
Specifies a friendly name for a disk. The friendly name may be defined by a user and is not guaranteed to be unique.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HealthStatus
Specifies the status of an object and indicates if the object is Healthy or Warning Unhealthy.
| Type: | HealthStatus[] |
| Accepted values: | Healthy, Warning, Unhealthy, Unknown |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitiatorId
Accepts an InitiatorId object as input. The Initiator ID CIM object is exposed by the Get-InitiatorIdhttp://technet.microsoft.com/library/56c96b69-33c0-402b-8813-d64a4434011d cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InitiatorPort
Accepts an InitiatorPort object as input. The Initiator Port CIM object is exposed by the Get-InitiatorPorthttp://technet.microsoft.com/library/580a19cf-26d1-45bb-ad34-a6265e2efacf cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsSnapshot
Specifies that the virtual disk is a snapshot of another virtual disk.
| Type: | Boolean[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaskingSet
Accepts a MaskingSet object as input. The Masking Set CIM object is exposed by the Get-MaskingSethttp://technet.microsoft.com/library/a7ef71fd-f7f6-4231-8799-0e96dd9eac84 cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of an object or setting.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OtherUsageDescription
Specifies the usage of this object.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PhysicalDisk
Accepts a PhysicalDisk object as input. The Physical Disk CIM object is exposed by the Get-PhysicalDiskhttp://technet.microsoft.com/library/a204dcde-bfac-43ac-9b79-d81384f255be cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PhysicalRangeMax
This parameter is reserved for future use.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PhysicalRangeMin
This parameter is reserved for future use.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceVirtualDisk
Specifies a virtual disk as a CIMInstance object. The cmdlet gets the snapshot or clone virtual disks that were created from the virtual disk that you specify. To obtain a virtual disk object, use the Get-VirtualDisk cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageJob
Specifies an outstanding storage job as a CIMInstance object. The cmdlet gets the virtual disks associated with the storage jobs that you specify. To obtain a virtual disk object, use the Get-StorageJob cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageNode
Specifies a storage node as a CIMInstance object. The cmdlet gets the virtual disks that belong to the storage node that you specify. The virtual disks that belong to the storage node have read/write permissions on the node. To obtain a virtual disk object, use the Get-StorageNode cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StoragePool
Accepts a StoragePool object as input. The Storage Pool CIM object is exposed by the Get-StoragePoolhttp://technet.microsoft.com/library/288acad9-7678-45c2-b7b4-3a0522fea499 cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageSubSystem
Accepts a StorageSubsystem object as input. The Storage Subsystem CIM object is exposed by the Get-StorageSubsystemhttp://technet.microsoft.com/library/ea364a0b-06d6-4653-b41c-be69b8038b54 cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageTier
Specifies a storage tier as a CIMInstance object. The cmdlet gets the virtual disks included in the storage tier that you specify. To obtain a virtual disk object, use the Get-StorageTier cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetPort
Accepts a TargetPort object as input. The Target Port CIM object is exposed by the Get-TargetPorthttp://technet.microsoft.com/library/4c139739-cda3-4379-b87b-60b1b4db8cd2 cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetVirtualDisk
Specifies a virtual disk as a CIMInstance object. The cmdlet gets the virtual disk from which the snapshot or clone virtual disk that you specify were created. To obtain a virtual disk object, use the Get-VirtualDisk cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UniqueId
Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.
| Type: | String[] |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Usage
Indicates the intended usage of the virtual disk.
| Type: | Usage[] |
| Accepted values: | Unknown, Other, Unrestricted, ReservedForComputerSystem, ReservedForReplicationServices, ReservedForMigrationServices, LocalReplicaSource, RemoteReplicaSource, LocalReplicaTarget, RemoteReplicaTarget, LocalReplicaSourceOrTarget, RemoteReplicaSourceOrTarget, DeltaReplicaTarget, ElementComponent, ReservedAsPoolContributer, CompositeVolumeMember, CompositeVirtualDiskMember, ReservedForSparing |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
You can use the pipeline operator to pass an MSFT_Disk object to the Disk parameter.
You can use the pipeline operator to pass an MSFT_InitiatorId object to the InitiatorId parameter.
You can use the pipeline operator to pass an MSFT_InitiatorPort object to the InitiatorPort parameter.
You can use the pipeline operator to pass an MSFT_MaskingSet object to the MaskingSet parameter.
You can use the pipeline operator to pass an MSFT_PhysicalDisk object to the PhysicalDisk parameter.
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
You can use the pipeline operator to pass an MSFT_StorageSubsystem object to the StorageSubsystem parameter.
You can use the pipeline operator to pass an MSFT_StorageTier object to the StorageTier parameter.
You can use the pipeline operator to pass an MSFT_TargetPort object to the TargetPort parameter.
You can use the pipeline operator to pass an MSFT_TargetVirtualDisk object to the TargetVirtualDisk parameter.
Outputs
This cmdlet outputs an object that represents the specified virtual disk.
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for