Skip to content

Commit 7d5f927

Browse files
committed
Description updates
1 parent b053684 commit 7d5f927

13 files changed

+92
-29
lines changed

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ This example clears the scheduled task for volume `D:`.
3737

3838
### -Volume
3939

40-
Specifies the volume or volumes to clear the scheduled optimization task.
40+
Specifies the volume or volumes to clear the scheduled optimization task. Enter one or more volume
41+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
42+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4143

4244
```yaml
4345
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ This example clears the deduplication scrub schedule on the `D:` ReFS volume.
3838

3939
### -Volume
4040

41-
Specifies the volume on which to clear the ReFS deduplication scrub schedule.
41+
Specifies the volume on which to clear the ReFS deduplication scrub schedule. Enter one or more
42+
volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume
43+
GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4244

4345
```yaml
4446
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ This example disables data deduplication on the `D:` ReFS volume.
3838

3939
### -Volume
4040

41-
Specifies the volume or volumes to disable ReFS data deduplication.
41+
Specifies the volume or volumes to disable ReFS data deduplication. Enter one or more volume IDs,
42+
drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
43+
use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4244

4345
```yaml
4446
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,18 @@ specify the type of deduplication to use with the `-Type` parameter.
2929

3030
```powershell
3131
Enable-ReFSDedup -Volume "D:" -Type DedupAndCompress
32-
3332
```
3433

3534
This example enables data deduplication with compression on the `D:` ReFS volume.
3635

36+
### Example 2
37+
38+
```powershell
39+
Enable-ReFSDedup -Volume "E:, F:" -Type DedupAndCompress
40+
```
41+
42+
This example enables data deduplication with compression on both `E:` and `F:` ReFS volumes.
43+
3744
## PARAMETERS
3845

3946
### -Type
@@ -59,7 +66,9 @@ Accept wildcard characters: False
5966
6067
### -Volume
6168
62-
Specifies the volume or volumes to enable ReFS data deduplication.
69+
Specifies the volume or volumes to enable ReFS data deduplication. Enter one or more volume IDs,
70+
drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
71+
use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
6372

6473
```yaml
6574
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Get-ReFSDedupSchedule [-Volume] <String> [<CommonParameters>]
2121
## DESCRIPTION
2222

2323
The `Get-ReFSDedupSchedule` cmdlet retrieves the deduplication schedule for a specified ReFS
24-
volume. The cmdlet returns information about the last time deduplication was run, the next time it
25-
is scheduled to run, and the frequency with which it runs.
24+
volume.
2625

2726
## EXAMPLES
2827

@@ -32,13 +31,21 @@ is scheduled to run, and the frequency with which it runs.
3231
Get-ReFSDedupSchedule -Volume "D:"
3332
```
3433

34+
```output
35+
Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize
36+
------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- --------------------
37+
D: True DedupAndCompress None N/A N/A False LZ4 0 0 B
38+
```
39+
3540
This example retrieves the deduplication schedule for the `D:` ReFS volume.
3641

3742
## PARAMETERS
3843

3944
### -Volume
4045

41-
Specifies the ReFS volume for which to retrieve the deduplication schedule.
46+
Specifies the ReFS volume for which to retrieve the deduplication schedule. Enter one or more volume
47+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
48+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4249

4350
```yaml
4451
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Get-ReFSDedupScrubSchedule [-Volume] <String> [<CommonParameters>]
2121
## DESCRIPTION
2222

2323
The `Get-ReFSDedupScrubSchedule` cmdlet retrieves the deduplication scrub schedule on the specified
24-
ReFS volume. The scrub schedule specifies when and how often scrub jobs are run on the volume to
25-
check for and repair any data corruption.
24+
ReFS volume.
2625

2726
## EXAMPLES
2827

@@ -32,13 +31,21 @@ check for and repair any data corruption.
3231
Get-ReFSDedupScrubSchedule -Volume "D:"
3332
```
3433

34+
```output
35+
Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended
36+
------ ------- ----- ---- ------------- ------------- ---------
37+
D: True N/A None 0 False False
38+
```
39+
3540
This example gets the deduplication scrub schedule on the `D:` ReFS volume.
3641

3742
## PARAMETERS
3843

3944
### -Volume
4045

41-
Specifies the volume on which to retrieve the ReFS deduplication scrub schedule.
46+
Specifies the volume on which to retrieve the ReFS deduplication scrub schedule. Enter one or more
47+
volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume
48+
GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4249

4350
```yaml
4451
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ Get-ReFSDedupStatus [-Volume] <String> [<CommonParameters>]
2020

2121
## DESCRIPTION
2222

23-
The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS volume.
24-
The cmdlet returns information about the amount of space saved by deduplication, the percentage of
25-
data that is deduplicated, and the status of the deduplication job.
23+
The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS
24+
volume.
2625

2726
## EXAMPLES
2827

@@ -32,13 +31,32 @@ data that is deduplicated, and the status of the deduplication job.
3231
Get-ReFSDedupStatus -Volume "D:"
3332
```
3433

34+
```output
35+
Volume Type Used Deduped Compressed Format Level ChunkSize Status
36+
------ ---- ---- ------- ---------- ------ ----- --------- ------
37+
D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B --
38+
```
39+
3540
This example retrieves the deduplication status for the `D:` ReFS volume.
3641

42+
### Example 2
43+
44+
```powershell
45+
$Volumes = "E:", "F:"
46+
foreach ($Volume in $Volumes) {
47+
Get-ReFSDedupStatus -Volume $Volume
48+
}
49+
```
50+
51+
This example retrieves the deduplication status for both the `E:` and `F:` ReFS volume.
52+
3753
## PARAMETERS
3854

3955
### -Volume
4056

41-
Specifies the ReFS volume for which to retrieve the deduplication status.
57+
Specifies the ReFS volume for which to retrieve the deduplication status. Enter one or more volume
58+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
59+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4260

4361
```yaml
4462
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Resume-ReFSDedupSchedule [-Volume] <String> [<CommonParameters>]
2121
## DESCRIPTION
2222

2323
The `Resume-ReFSDedupSchedule` cmdlet resumes the deduplication schedule on a specified ReFS
24-
volume. This cmdlet is used to resume a deduplication job that has been paused or stopped.
24+
volume that has been paused or stopped.
2525

2626
## EXAMPLES
2727

@@ -37,7 +37,9 @@ This example resumes the deduplication schedule for the `D:` ReFS volume.
3737

3838
### -Volume
3939

40-
Specifies the ReFS volume for which to resume the deduplication schedule.
40+
Specifies the ReFS volume for which to resume the deduplication schedule. Enter one or more volume
41+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
42+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
4143

4244
```yaml
4345
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,9 @@ Accept wildcard characters: False
284284

285285
### -Volume
286286

287-
Specifies the ReFS volume for which to set the deduplication schedule.
287+
Specifies the ReFS volume for which to set the deduplication schedule. Enter one or more volume
288+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
289+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
288290

289291
```yaml
290292
Type: String

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Set-ReFSDedupScrubSchedule [-Volume] <String> -Start <DateTime> -Days <DaysOfWee
2222
## DESCRIPTION
2323

2424
The `Set-ReFSDedupScrubSchedule` cmdlet sets the deduplication scrub schedule on the specified ReFS
25-
volume. The scrub schedule specifies when and how often scrub jobs are run on the volume to check
26-
for and repair any data corruption.
25+
volume. The scrub schedule specifies when and how often scrub jobs are run on the volume.
2726

2827
## EXAMPLES
2928

@@ -105,7 +104,9 @@ Accept wildcard characters: False
105104
106105
### -Volume
107106
108-
Specifies the ReFS volume on which to set the deduplication scrub schedule.
107+
Specifies the ReFS volume on which to set the deduplication scrub schedule. Enter one or more volume
108+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
109+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
109110

110111
```yaml
111112
Type: String

0 commit comments

Comments
 (0)