Skip to content

Commit 2b1da7f

Browse files
Merge pull request MicrosoftDocs#3453 from RobBiddle/Measure-DedupFileMetadata.md#3431
Quality: PowerShell Summit Measure dedup file metadata.md#3431
2 parents db4824d + 31677b4 commit 2b1da7f

File tree

1 file changed

+43
-26
lines changed

1 file changed

+43
-26
lines changed

docset/winserver2022-ps/deduplication/Measure-DedupFileMetadata.md

Lines changed: 43 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,47 @@ Measures potential disk space on a volume.
1616
## SYNTAX
1717

1818
```
19-
Measure-DedupFileMetadata [-Path] <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
Measure-DedupFileMetadata [-Path] <String[]> [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Measure-DedupFileMetadata** cmdlet measures potential disk space on a volume.
25-
The **DedupDistinctSize** value that this cmdlet returns indicates how much disk space you can reclaim on a volume if you delete a group of folders and then run a garbage collection job.
2624

27-
Files often have chunks that are shared across other folders.
28-
The deduplication engine calculates which chunks are unique and would be deleted after the garbage collection job.
25+
The `Measure-DedupFileMetadata` cmdlet measures potential disk space on a volume. The
26+
**DedupDistinctSize** value that this cmdlet returns indicates how much disk space you can reclaim
27+
on a volume if you delete a group of folders and then run a garbage collection job.
28+
29+
Files often have chunks that are shared across other folders. The deduplication engine calculates
30+
which chunks are unique and would be deleted after the garbage collection job.
2931

3032
## EXAMPLES
3133

3234
### Example 1: Measure potential disk space on a volume
33-
```
34-
PS C:\> Measure-DedupFileMetadata -Path "X:\A_Data","X:\Archive1"
35+
36+
```powershell
37+
Measure-DedupFileMetadata -Path "X:\A_Data","X:\Archive1"
3538
```
3639

37-
This command measures potential disk space that you can reclaim on all folders in the paths X:\A_Data and X:\Archive1.
40+
This command measures potential disk space that you can reclaim on all folders in the paths
41+
`X:\A_Data` and `X:\Archive1`.
3842

3943
## PARAMETERS
4044

4145
### -AsJob
42-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4346

44-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
45-
You can continue to work in the session while the job completes.
46-
To manage the job, use the `*-Job` cmdlets.
47-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
47+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
48+
complete.
49+
50+
The cmdlet immediately returns an object that represents the job and then displays the command
51+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
52+
`*-Job` cmdlets. To get the job results, use the
53+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
4854

49-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
55+
For more information about Windows PowerShell background jobs, see
56+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5057

5158
```yaml
52-
Type: SwitchParameter
59+
Type: System.Management.Automation.SwitchParameter
5360
Parameter Sets: (All)
5461
Aliases:
5562

@@ -61,12 +68,14 @@ Accept wildcard characters: False
6168
```
6269
6370
### -CimSession
64-
Runs the cmdlet in a remote session or on a remote computer.
65-
Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
66-
The default is the current session on the local computer.
71+
72+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
73+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
74+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
75+
current session on the local computer.
6776
6877
```yaml
69-
Type: CimSession[]
78+
Type: Microsoft.Management.Infrastructure.CimSession[]
7079
Parameter Sets: (All)
7180
Aliases: Session
7281

@@ -78,10 +87,11 @@ Accept wildcard characters: False
7887
```
7988
8089
### -Path
90+
8191
Specifies an array of paths of folders.
8292
8393
```yaml
84-
Type: String[]
94+
Type: System.String[]
8595
Parameter Sets: (All)
8696
Aliases:
8797

@@ -93,12 +103,15 @@ Accept wildcard characters: False
93103
```
94104
95105
### -ThrottleLimit
96-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
97-
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.
98-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
106+
107+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
108+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
109+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
110+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
111+
computer.
99112

100113
```yaml
101-
Type: Int32
114+
Type: System.Int32
102115
Parameter Sets: (All)
103116
Aliases:
104117
@@ -110,7 +123,11 @@ Accept wildcard characters: False
110123
```
111124

112125
### CommonParameters
113-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
126+
127+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
128+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
129+
-WarningAction, and -WarningVariable. For more information, see
130+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
114131

115132
## INPUTS
116133

0 commit comments

Comments
 (0)