Get-Volume

Get-Volume

Gets the specified Volume object, or all Volume objects if no filter is provided.

Syntax

Parameter Set: ByDriveLetter
Get-Volume [[-DriveLetter] <Char[]> ] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByDiskImage
Get-Volume [-CimSession <CimSession[]> ] [-DiskImage <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFilePath
Get-Volume [-CimSession <CimSession[]> ] [-FilePath <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFileShare
Get-Volume [-FileShare <Microsoft.Management.Infrastructure.CimInstance> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ById
Get-Volume [-CimSession <CimSession[]> ] [-ObjectId <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByLabel
Get-Volume [-CimSession <CimSession[]> ] [-FileSystemLabel <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByPartition
Get-Volume [-CimSession <CimSession[]> ] [-Partition <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByPaths
Get-Volume [-CimSession <CimSession[]> ] [-Path <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByStorageFileServer
Get-Volume [-StorageFileServer <Microsoft.Management.Infrastructure.CimInstance> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByStorageJob
Get-Volume [-StorageJob <CimInstance> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByStorageNode
Get-Volume [-StorageNode <Microsoft.Management.Infrastructure.CimInstance> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByStoragePool
Get-Volume [-StoragePool <Microsoft.Management.Infrastructure.CimInstance> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByStorageSubSystem
Get-Volume [-StorageSubSystem <Microsoft.Management.Infrastructure.CimInstance> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByUniqueId
Get-Volume [-UniqueId <System.String[]> ] [ <CommonParameters>] [ <WorkflowParameters>]




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

-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

-FilePath<String>

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


Aliases

FullName

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.


Aliases

none

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.


Aliases

none

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.


Aliases

Id

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.


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?

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.


Aliases

none

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.


Aliases

none

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.


Aliases

none

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.


Aliases

none

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.


Aliases

none

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.


Aliases

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

  • 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.

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

Related topics

Community Additions

ADD
Show: