.png)
Get-Volume
Updated: August 15, 2012
Applies To: Windows Server 2012
Get-Volume
Syntax
Parameter Set: ByDriveLetter Get-Volume [[-DriveLetter] <Char[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByDiskImage Get-Volume [-AsJob] [-CimSession <CimSession[]> ] [-DiskImage <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ById Get-Volume [-AsJob] [-CimSession <CimSession[]> ] [-ObjectId <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByLabel Get-Volume [-AsJob] [-CimSession <CimSession[]> ] [-FileSystemLabel <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByPartition Get-Volume [-AsJob] [-CimSession <CimSession[]> ] [-Partition <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] Parameter Set: ByPaths Get-Volume [-AsJob] [-CimSession <CimSession[]> ] [-Path <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
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
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-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.
|
Aliases |
Session |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-DiskImage<CimInstance>
Gets the volume associated with the specified DiskImage object. Enter a DiskImage CIM object, which is returned by the Get-DiskImage cmdlet.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByValue) |
|
Accept Wildcard Characters? |
false |
-DriveLetter<Char[]>
Gets the volume(s) with the specified drive letter(s). Separate multiple drive letters with commas.x
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-FileSystemLabel<String[]>
Gets the volume with the specified label.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByPropertyName) |
|
Accept Wildcard Characters? |
true |
-ObjectId<String[]>
Gets the volume with the specified ObjectID.
|
Aliases |
Id |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByPropertyName) |
|
Accept Wildcard Characters? |
true |
-Partition<CimInstance>
Gets the volume associated with the specified Partition object. Enter a Partition CIM object, which is returned by the Get-Partition cmdlet.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByValue) |
|
Accept Wildcard Characters? |
false |
-Path<String[]>
Gets the volume with the specified path.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByPropertyName) |
|
Accept Wildcard Characters? |
true |
-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 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.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_DiskImage
You can pipe a DiskImage object to the DiskImage parameter.
-
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Partition
You can pipe a Partition object to the Partition parameter.
-
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume
You can pipe a Volume object to this cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
-
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume
This cmdlet returns one or more objects that represent the specified volume(s).
Notes
-
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.
Examples
Example 1: Get all volumes
This example returns all volumes on all partitions, on all disks.
PS C:\> Get-Volume
Example 2: Get the volume for a particular drive letter
This example gets the Volume object for drive letter C.
PS C:\> Get-Volume -DriveLetter C
DriveLetter FileSystemLabel FileSystem HealthStatus SizeRemaining Size ----------- --------------- ---------- ------------ ------------- ---- C NTFS Healthy 23.61 GB 465.42 GB
Related topics
