Get-DedupVolume

Get-DedupVolume

Returns a DeduplicationVolume object for each volume that has data deduplication metadata.

Syntax

Parameter Set: ByVolumeId
Get-DedupVolume [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-VolumeId <String[]> ] [ <CommonParameters>]

Parameter Set: ByVolume
Get-DedupVolume [[-Volume] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-DedupVolume cmdlet returns a DeduplicationVolume object for each volume that has data deduplication metadata (in either the enabled or disabled state). In a cluster, this cmdlet returns a DeduplicationVolume object only for volumes currently mounted by the managed node (whether the volumes are local or clustered volumes).

Parameters

-AsJob

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

-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

-Volume<String[]>

Specifies one or more file system volumes for which to return data deduplication metadata, or in the case of a cluster, volumes with data deduplication metadata currently mounted by the managed node. Enter one or more volume IDs, drive letters (such as D:), or volume GUID pathnames (using the form \\?\Volume{{GUID}}\). Separate multiple volumes with a comma.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VolumeId<String[]>

Specifies a string that uniquely identifies the volume on which to return data deduplication metadata.

Aliases

ObjectId,Id,DeviceId

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

  • System.String[]

Outputs

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

  • Microsoft.Management.Infrastructure.CimInstance

    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.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume

    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

This example returns the data deduplication settings for volume E.

PS C:\> Get-DedupVolume –Volume E:

Example 2

This example returns the data deduplication settings for the volume with the specified GUID.

PS C:\> Get-DedupVolume –Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"

Disable-DedupVolume

Enable-DedupVolume

Set-DedupVolume