| 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. |
Volume.cdxml-help.xml |
Storage |
12/20/2016 |
2.0.0 |
Get-Volume |
Gets the specified Volume object, or all Volume objects if no filter is provided.
Get-Volume [[-DriveLetter] <Char[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-ObjectId <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-UniqueId <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-Path <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-FileSystemLabel <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-Partition <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-DiskImage <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-StorageSubSystem <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-StoragePool <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-StorageNode <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-StorageFileServer <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-FileShare <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-StorageJob <CimInstance>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
Get-Volume [-FilePath <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<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.
PS C:\>Get-Volume
This example returns all volumes on all partitions, on all disks.
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.
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: FalseGets the volume associated with the specified DiskImage object. Enter a DiskImage CIM object, which is returned by the Get-DiskImage cmdlet.
Type: CimInstance
Parameter Sets: ByDiskImage
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseGets the volume(s) with the specified drive letter(s). Separate multiple drive letters with commas.x
Type: Char[]
Parameter Sets: ByDriveLetter
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the full path of a file. The cmdlet gets the volume for the file path that you specify.
Type: String
Parameter Sets: ByFilePath
Aliases: FullName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies file shares associated with the volumes to get. To obtain a FileShare object, use the Get-FileShare cmdlet.
Type: CimInstance
Parameter Sets: ByFileShare
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseGets the volume with the specified label.
Type: String[]
Parameter Sets: ByLabel
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseGets the volume with the specified ObjectID.
Type: String[]
Parameter Sets: ById
Aliases: Id
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseGets the volume associated with the specified Partition object. Enter a Partition CIM object, which is returned by the Get-Partition cmdlet.
Type: CimInstance
Parameter Sets: ByPartition
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseGets the volume with the specified path.
Type: String[]
Parameter Sets: ByPaths
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies a storage file server which hosts volumes to get. To obtain a StorageFileServer, use the Get-StorageFileServer cmdlet.
Type: CimInstance
Parameter Sets: ByStorageFileServer
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a storage job associated with volumes to get. To obtain a StorageJob 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 object that hosts volumes to get. To obtain a StorageNode 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: FalseSpecifies a storage pool that contains volumes to get. To obtain StoragePool objects, use 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: FalseSpecifies the storage subsystem object from which to retrieve volumes. To obtain StorageSubsystem object, 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 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 the ID of the volume to get.
Type: String[]
Parameter Sets: ByUniqueId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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 a DiskImage object to the DiskImage parameter.
You can use the pipeline operator to pass a Partition object to the Partition parameter.
You can use the pipeline operator to pass a Volume object to the ObjectId parameter.
This cmdlet returns one or more objects that represent the specified volume(s).
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).