| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
VirtualDisk.cdxml-help.xml |
Storage |
12/20/2016 |
2.0.0 |
Get-VirtualDisk |
Returns a list of VirtualDisk objects, across all storage pools, across all providers, or optionally a filtered subset based on provided criteria.
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>] [-NoRedundancy] [-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>]
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.
PS C:\> Get-VirtualDisk
This example returns all VirtualDisk objects across all visible StoragePool objects, across all visible StorageProvider objects.
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.
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.
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.
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns 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.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAccepts a Disk object as input. The Disk CIM object is exposed by the Get-Disk cmdlet.
Type: CimInstance
Parameter Sets: ByDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a friendly name for a disk. The friendly name may be defined by a user and is not guaranteed to be unique.
Type: String[]
Parameter Sets: ByFriendlyName
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the status of an object and indicates if the object is Healthy or Warning Unhealthy.
Type: HealthStatus[]
Parameter Sets: (All)
Aliases:
Accepted values: Healthy, Warning, Unhealthy, Unknown
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAccepts an InitiatorId object as input. The Initiator ID CIM object is exposed by the Get-InitiatorId cmdlet.
Type: CimInstance
Parameter Sets: ByInitiatorId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseAccepts an InitiatorPort object as input. The Initiator Port CIM object is exposed by the Get-InitiatorPort cmdlet.
Type: CimInstance
Parameter Sets: ByInitiatorPort
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies that the virtual disk is a snapshot of another virtual disk.
Type: Boolean[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAccepts a MaskingSet object as input. The Masking Set CIM object is exposed by the Get-MaskingSet cmdlet.
Type: CimInstance
Parameter Sets: ByMaskingSet
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of an object or setting.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIndicates that this cmdlet gets virtual disks that have one remaining copy of data stored on the physical disk.
Type: SwitchParameter
Parameter Sets: ByPhysicalDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the usage of this object.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAccepts a PhysicalDisk object as input. The Physical Disk CIM object is exposed by the Get-PhysicalDisk cmdlet.
Type: CimInstance
Parameter Sets: ByPhysicalDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis parameter is reserved for future use.
Type: UInt64
Parameter Sets: ByPhysicalDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter is reserved for future use.
Type: UInt64
Parameter Sets: ByPhysicalDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: BySourceVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: ByStorageJob
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: ByStorageNode
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseAccepts a StoragePool object as input. The Storage Pool CIM object is exposed by the Get-StoragePool cmdlet.
Type: CimInstance
Parameter Sets: ByStoragePool
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseAccepts a StorageSubsystem object as input. The Storage Subsystem CIM object is exposed by the Get-StorageSubsystem cmdlet.
Type: CimInstance
Parameter Sets: ByStorageSubSystem
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: ByStorageTier
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseAccepts a TargetPort object as input. The Target Port CIM object is exposed by the Get-TargetPort cmdlet.
Type: CimInstance
Parameter Sets: ByTargetPort
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: ByTargetVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.
Type: String[]
Parameter Sets: ByUniqueId
Aliases: Id
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIndicates the intended usage of the virtual disk.
Type: Usage[]
Parameter Sets: (All)
Aliases:
Accepted values: Unknown, Other, Unrestricted, ReservedForComputerSystem, ReservedForReplicationServices, ReservedForMigrationServices, LocalReplicaSource, RemoteReplicaSource, LocalReplicaTarget, RemoteReplicaTarget, LocalReplicaSourceOrTarget, RemoteReplicaSourceOrTarget, DeltaReplicaTarget, ElementComponent, ReservedAsPoolContributer, CompositeVolumeMember, CompositeVirtualDiskMember, ReservedForSparing
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem
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.
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.
This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see MSFT_VirtualDisk class.
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).