Get-Volume

Get-Volume [[-DriveLetter] <Char[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-CimSession <CimSession[]>] [-Partition <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-CimSession <CimSession[]>] [-ObjectId <String[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-CimSession <CimSession[]>] [-FilePath <String>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-CimSession <CimSession[]>] [-DiskImage <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-CimSession <CimSession[]>] [-FileSystemLabel <String[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-CimSession <CimSession[]>] [-Path <String[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]

Get-Volume [-FileShare <Microsoft.Management.Infrastructure.CimInstance>] [<CommonParameters>]

Get-Volume [-StorageFileServer <Microsoft.Management.Infrastructure.CimInstance>] [<CommonParameters>]

Get-Volume [-StorageJob <CimInstance>] [<CommonParameters>]

Get-Volume [-StorageNode <Microsoft.Management.Infrastructure.CimInstance>] [<CommonParameters>]

Get-Volume [-StoragePool <Microsoft.Management.Infrastructure.CimInstance>] [<CommonParameters>]

Get-Volume [-StorageSubSystem <Microsoft.Management.Infrastructure.CimInstance>] [<CommonParameters>]

Get-Volume [-UniqueId <System.String[]>] [<CommonParameters>]

The Get-Volume cmdlet will return a Volume object or a set of Volume objects that match the specified criteria.

Note: Dynamic volumes are supported only by the following cmdlets: Repair-Volume (chkdsk), Optimize-Volume (defrag), and Format-Volume (format) on basic disks and storage spaces.

Parameters

-CimSession [<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.

-DiskImage [<CimInstance>]

Accepts pipeline input ByValue

Gets the volume associated with the specified DiskImage object. Enter a DiskImage CIM object, which is returned by the Get-DiskImage cmdlet.

-DriveLetter [<Char[]>]

Accepts pipeline input ByPropertyName

Gets the volume(s) with the specified drive letter(s). Separate multiple drive letters with commas.x

-FilePath [<String>]

Accepts pipeline input ByPropertyName

Specifies the full path of a file. The cmdlet gets the volume for the file path that you specify.

-FileShare [<Microsoft.Management.Infrastructure.CimInstance>]

Accepts pipeline input ByValue

Specifies file shares associated with the volumes to get. To obtain a FileShare object, use the Get-FileShare cmdlet.

-FileSystemLabel [<String[]>]

Accepts pipeline input ByPropertyName

Gets the volume with the specified label.

-ObjectId [<String[]>]

Accepts pipeline input ByPropertyName

Gets the volume with the specified ObjectID.

-Partition [<CimInstance>]

Accepts pipeline input ByValue

Gets the volume associated with the specified Partition object. Enter a Partition CIM object, which is returned by the Get-Partition cmdlet.

-Path [<String[]>]

Accepts pipeline input ByPropertyName

Gets the volume with the specified path.

-StorageFileServer [<Microsoft.Management.Infrastructure.CimInstance>]

Accepts pipeline input ByValue

Specifies a storage file server which hosts volumes to get. To obtain a StorageFileServer, use the Get-StorageFileServer cmdlet.

-StorageJob [<CimInstance>]

Accepts pipeline input ByValue

Specifies a storage job associated with volumes to get. To obtain a StorageJob object, use the Get-StorageJob cmdlet.

-StorageNode [<Microsoft.Management.Infrastructure.CimInstance>]

Accepts pipeline input ByValue

Specifies a storage node object that hosts volumes to get. To obtain a StorageNode object, use the Get-StorageNode cmdlet.

-StoragePool [<Microsoft.Management.Infrastructure.CimInstance>]

Accepts pipeline input ByValue

Specifies a storage pool that contains volumes to get. To obtain StoragePool objects, use the Get-StoragePool cmdlet.

-StorageSubSystem [<Microsoft.Management.Infrastructure.CimInstance>]

Accepts pipeline input ByValue

Specifies the storage subsystem object from which to retrieve volumes. To obtain StorageSubsystem object, the Get-StorageSubSystem cmdlet.

-ThrottleLimit [<Int32>]

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.

-UniqueId [<System.String[]>]

Accepts pipeline input ByPropertyName

Specifies the ID of the volume to get.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_DiskImage

http://msdn.microsoft.com/library/windows/desktop/hh830494.aspx You can use the pipeline operator to pass a DiskImage object to the DiskImage parameter. Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Partition http://msdn.microsoft.com/library/windows/desktop/hh830524.aspx You can use the pipeline operator to pass a Partition object to the Partition parameter. Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume http://msdn.microsoft.com/library/windows/desktop/hh830604.aspx You can use the pipeline operator to pass a Volume object to the ObjectId parameter.

Outputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume

http://msdn.microsoft.com/library/windows/desktop/hh830604.aspx This cmdlet returns one or more objects that represent the specified volume(s).

Examples

Get all volumes:
```
PS C:\> Get-Volume
```
This example returns all volumes on all partitions, on all disks.

Get the volume for a particular drive letter:

PS C:\> Get-Volume -DriveLetter C
DriveLetter         FileSystemLabel     FileSystem          HealthStatus              SizeRemaining 
   Size 
   -----------         ---------------     ----------          ------------              -------------                
   ---- 
   C                                       NTFS                Healthy                        23.61 GB           
   465.42 GB

This example gets the Volume object for drive letter C.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands