Skip to content

Latest commit

 

History

History
154 lines (116 loc) · 4.75 KB

File metadata and controls

154 lines (116 loc) · 4.75 KB
external help file Module Name online version schema
Dedup_Cmdlets.xml
Deduplication
2.0.0

Get-DedupVolume

SYNOPSIS

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

SYNTAX

ByVolumeId (Default)

Get-DedupVolume [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-VolumeId <String[]>]

ByVolume

Get-DedupVolume [[-Volume] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]

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

EXAMPLES

Example 1

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

This example returns the data deduplication settings for volume E.

Example 2

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

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

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CimSession

Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Volume

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.

Type: String[]
Parameter Sets: UNNAMED_PARAMETER_SET_2
Aliases: 

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VolumeId

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

Type: String[]
Parameter Sets: UNNAMED_PARAMETER_SET_1
Aliases: ObjectId,Id,DeviceId

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.String[]

OUTPUTS

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.

NOTES

RELATED LINKS

Disable-DedupVolume

Enable-DedupVolume

Set-DedupVolume