< Back
Get-Volume
Post
NAME Get-Volume
SYNOPSIS
Gets the specified Volume object, or all Volume objects if no filter is provided.
SYNTAX
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>]
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
-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.
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.
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
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FilePath [<String>]
Specifies the full path of a file. The cmdlet gets the volume for the file path that you specify.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FileShare [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies file shares associated with the volumes to get. To obtain a FileShare object, use the Get-FileShare cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-FileSystemLabel [<String[]>]
Gets the volume with the specified label.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ObjectId [<String[]>]
Gets the volume with the specified ObjectID.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Partition [<CimInstance>]
Gets the volume associated with the specified Partition object. Enter a Partition CIM object, which is returned by the Get-Partition cmdlet.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageFileServer [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies a storage file server which hosts volumes to get. To obtain a StorageFileServer, use the Get-StorageFileServer cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StorageJob [<CimInstance>]
Specifies a storage job associated with volumes to get. To obtain a StorageJob object, use the Get-StorageJob cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StorageNode [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies a storage node object that hosts volumes to get. To obtain a StorageNode object, use the Get-StorageNode cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StoragePool [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies a storage pool that contains volumes to get. To obtain StoragePool objects, use the Get-StoragePool cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StorageSubSystem [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies the storage subsystem object from which to retrieve volumes. To obtain StorageSubsystem object, the Get-StorageSubSystem cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UniqueId [<System.String[]>]
Specifies the ID of the volume to get.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
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_DiskImage
http://msdn.microsoft.com/library/windo ... 30494.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/windo ... 30524.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/windo ... 30604.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/windo ... 30604.aspx
This cmdlet returns one or more objects that represent the specified volume(s).
Example 1: Get all volumes
PS C:\\>Get-Volume
This example returns all volumes on all partitions, on all disks.
Example 2: 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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816423
Get-DiskStorageNodeView
Get-FileShare
Get-Partition
Get-StorageFileServer
Get-StorageJob
Get-StoragePool
Get-StorageSubsystem
Format-Volume
Optimize-Volume
Repair-Volume
Set-Volume
SYNOPSIS
Gets the specified Volume object, or all Volume objects if no filter is provided.
SYNTAX
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>]
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
-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.
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.
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
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FilePath [<String>]
Specifies the full path of a file. The cmdlet gets the volume for the file path that you specify.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FileShare [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies file shares associated with the volumes to get. To obtain a FileShare object, use the Get-FileShare cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-FileSystemLabel [<String[]>]
Gets the volume with the specified label.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ObjectId [<String[]>]
Gets the volume with the specified ObjectID.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Partition [<CimInstance>]
Gets the volume associated with the specified Partition object. Enter a Partition CIM object, which is returned by the Get-Partition cmdlet.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageFileServer [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies a storage file server which hosts volumes to get. To obtain a StorageFileServer, use the Get-StorageFileServer cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StorageJob [<CimInstance>]
Specifies a storage job associated with volumes to get. To obtain a StorageJob object, use the Get-StorageJob cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StorageNode [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies a storage node object that hosts volumes to get. To obtain a StorageNode object, use the Get-StorageNode cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StoragePool [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies a storage pool that contains volumes to get. To obtain StoragePool objects, use the Get-StoragePool cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-StorageSubSystem [<Microsoft.Management.Infrastructure.CimInstance>]
Specifies the storage subsystem object from which to retrieve volumes. To obtain StorageSubsystem object, the Get-StorageSubSystem cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UniqueId [<System.String[]>]
Specifies the ID of the volume to get.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
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_DiskImage
http://msdn.microsoft.com/library/windo ... 30494.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/windo ... 30524.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/windo ... 30604.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/windo ... 30604.aspx
This cmdlet returns one or more objects that represent the specified volume(s).
Example 1: Get all volumes
PS C:\\>Get-Volume
This example returns all volumes on all partitions, on all disks.
Example 2: 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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816423
Get-DiskStorageNodeView
Get-FileShare
Get-Partition
Get-StorageFileServer
Get-StorageJob
Get-StoragePool
Get-StorageSubsystem
Format-Volume
Optimize-Volume
Repair-Volume
Set-Volume