]
Get-VirtualDisk [-CimSession ] [-HealthStatus ] [-IsSnapshot ] [-Name
] [-OtherUsageDescription ] [-ThrottleLimit ] [-Usage ] []
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.
PARAMETERS
-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-CimSession or Get-CimSession cmdlet. The default is the current session on the local
computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Disk []
Accepts a Disk object as input. The Disk CIM object is exposed by the Get-Disk cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-HealthStatus []
Specifies the status of an object and indicates if the object is Healthy or Warning Unhealthy.
Required? false
Position? named
Default value none
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-InitiatorId cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-InitiatorPort []
Accepts an InitiatorPort object as input. The Initiator Port CIM object is exposed by the Get-InitiatorPort
cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-IsSnapshot []
Specifies that the virtual disk is a snapshot of another virtual disk.
Required? false
Position? named
Default value none
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-MaskingSet cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name []
Specifies the name of an object or setting.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NoRedundancy []
Indicates that this cmdlet gets virtual disks that have one remaining copy of data stored on the physical disk.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-OtherUsageDescription []
Specifies the usage of this object.
Required? false
Position? named
Default value none
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-PhysicalDisk cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PhysicalRangeMax []
This parameter is reserved for future use.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PhysicalRangeMin []
This parameter is reserved for future use.
Required? false
Position? named
Default value none
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.
Required? false
Position? named
Default value none
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-StoragePool []
Accepts a StoragePool object as input. The Storage Pool CIM object is exposed by the Get-StoragePool cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-StorageSubSystem []
Accepts a StorageSubsystem object as input. The Storage Subsystem CIM object is exposed by the
Get-StorageSubsystem cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-TargetPort []
Accepts a TargetPort object as input. The Target Port CIM object is exposed by the Get-TargetPort cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
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 PowerShellr 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.
Required? false
Position? named
Default value none
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Usage []
Indicates the intended usage of the virtual disk.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Disk
http://msdn.microsoft.com/library/windows/desktop/hh830493.aspx
You can use the pipeline operator to pass an MSFT_Disk object to the Disk parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_InitiatorId
http://msdn.microsoft.com/library/windows/desktop/hh830504.aspx
You can use the pipeline operator to pass an MSFT_InitiatorId object to the InitiatorId parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_InitiatorPort
http://msdn.microsoft.com/library/windows/desktop/hh830507.aspx
You can use the pipeline operator to pass an MSFT_InitiatorPort object to the InitiatorPort parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet
http://msdn.microsoft.com/library/windows/desktop/hh830509.aspx
You can use the pipeline operator to pass an MSFT_MaskingSet object to the MaskingSet parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisk
http://msdn.microsoft.com/library/windows/desktop/hh830532.aspx
You can use the pipeline operator to pass an MSFT_PhysicalDisk object to the PhysicalDisk parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StoragePool
http://msdn.microsoft.com/library/windows/desktop/hh830551.aspx
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem
http://msdn.microsoft.com/library/windows/desktop/hh830569.aspx
You can use the pipeline operator to pass an MSFT_StorageSubsystem object to the StorageSubsystem parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageTier
http://msdn.microsoft.com/library/windows/desktop/dn535818(v=vs.85).aspx
You can use the pipeline operator to pass an MSFT_StorageTier object to the StorageTier parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_TargetPort
http://msdn.microsoft.com/library/windows/desktop/hh830582.aspx
You can use the pipeline operator to pass an MSFT_TargetPort object to the TargetPort parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_TargetVirtualDisk
You can use the pipeline operator to pass an MSFT_TargetVirtualDisk object to the TargetVirtualDisk parameter.
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk
http://msdn.microsoft.com/library/windows/desktop/hh830584.aspx
This cmdlet outputs an object that represents the specified virtual disk.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816421
Where-Object
Connect-VirtualDisk
Disconnect-VirtualDisk
Get-Partition
Get-StoragePool
Hide-VirtualDisk
New-VirtualDisk
Remove-VirtualDisk
Repair-VirtualDisk
Resize-VirtualDisk
Set-VirtualDisk
Show-VirtualDisk