Skip to content

Commit c3f8e7b

Browse files
authored
Merge branch 'main' into New-DedupSchedule.md#3432
2 parents f2c5f93 + ad03624 commit c3f8e7b

File tree

2 files changed

+71
-36
lines changed

2 files changed

+71
-36
lines changed

docset/winserver2022-ps/deduplication/Deduplication.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,57 +10,75 @@ title: Deduplication
1010
---
1111

1212
# Deduplication Module
13+
1314
## Description
14-
This reference provides cmdlet descriptions and syntax for all Windows Server Data Deduplication-specific cmdlets.
15-
It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.
15+
16+
This reference provides cmdlet descriptions and syntax for all Windows Server Data
17+
Deduplication-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the
18+
beginning of the cmdlet.
1619

1720
## Deduplication Cmdlets
21+
1822
### [Disable-DedupVolume](./Disable-DedupVolume.md)
23+
1924
Disables data deduplication activity on one or more volumes.
2025

2126
### [Enable-DedupVolume](./Enable-DedupVolume.md)
27+
2228
Enables data deduplication on one or more volumes.
2329

2430
### [Expand-DedupFile](./Expand-DedupFile.md)
31+
2532
Expands an optimized file into its original location.
2633

2734
### [Get-DedupJob](./Get-DedupJob.md)
35+
2836
Returns status and information for currently running or queued deduplication jobs.
2937

3038
### [Get-DedupMetadata](./Get-DedupMetadata.md)
39+
3140
Returns metadata for volumes that have data deduplication metadata.
3241

3342
### [Get-DedupSchedule](./Get-DedupSchedule.md)
43+
3444
Returns the deduplication job schedule defined on the computer.
3545

3646
### [Get-DedupStatus](./Get-DedupStatus.md)
47+
3748
Returns deduplication status for volumes that have data deduplication metadata.
3849

3950
### [Get-DedupVolume](./Get-DedupVolume.md)
51+
4052
Returns deduplication volumes that have data deduplication metadata.
4153

4254
### [Measure-DedupFileMetadata](./Measure-DedupFileMetadata.md)
55+
4356
Measures potential disk space on a volume.
4457

4558
### [New-DedupSchedule](./New-DedupSchedule.md)
59+
4660
Creates a data deduplication schedule.
4761

4862
### [Remove-DedupSchedule](./Remove-DedupSchedule.md)
63+
4964
Deletes a deduplication schedule.
5065

5166
### [Set-DedupSchedule](./Set-DedupSchedule.md)
67+
5268
Changes configuration settings for data deduplication schedules.
5369

5470
### [Set-DedupVolume](./Set-DedupVolume.md)
71+
5572
Changes data deduplication settings on one or more volumes.
5673

5774
### [Start-DedupJob](./Start-DedupJob.md)
75+
5876
Starts a data deduplication job.
5977

6078
### [Stop-DedupJob](./Stop-DedupJob.md)
79+
6180
Cancels one or more specified data deduplication jobs.
6281

6382
### [Update-DedupStatus](./Update-DedupStatus.md)
64-
Scans volumes for fresh data deduplication savings.
65-
6683

84+
Scans volumes for fresh data deduplication savings.

docset/winserver2022-ps/deduplication/Expand-DedupFile.md

Lines changed: 49 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -16,42 +16,48 @@ Expands an optimized file into its original location.
1616
## SYNTAX
1717

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

2323
## DESCRIPTION
24-
The **Expand-DedupFile** cmdlet expands an optimized file into its original location.
25-
You may need to expand optimized files because of compatibility with applications or other requirements.
2624

27-
Ensure that there is enough space on the volume to store the expanded file.
28-
If you do not have enough disk space, the cmdlet attempts to expand the file, and then informs you when it is unable to finish the operation.
29-
If you attempt to restore a file that is not optimized, the cmdlet notifies you of the error.
25+
The `Expand-DedupFile` cmdlet expands an optimized file into its original location. You may need to
26+
expand optimized files because of compatibility with applications or other requirements.
27+
28+
Ensure that there is enough space on the volume to store the expanded file. If you do not have
29+
enough disk space, the cmdlet attempts to expand the file, and then informs you when it is unable to
30+
finish the operation. If you attempt to restore a file that is not optimized, the cmdlet notifies
31+
you of the error.
3032

3133
## EXAMPLES
3234

3335
### Example 1: Expand a file
34-
```
35-
PS C:\> Expand-DedupFile -Path "D:\Share\File07.doc"
36+
37+
```powershell
38+
Expand-DedupFile -Path "D:\Share\File07.doc"
3639
```
3740

38-
This command expands a file to its original location, D:\Share\File07.doc.
39-
If the file is not optimized, the cmdlet informs you of the problem.
41+
This command expands a file to its original location, `D:\Share\File07.doc`. If the file is not
42+
optimized, the cmdlet informs you of the problem.
4043

4144
## PARAMETERS
4245

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

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

51-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
51+
The cmdlet immediately returns an object that represents the job and then displays the command
52+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
53+
`*-Job` cmdlets. To get the job results, use the
54+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
55+
56+
For more information about Windows PowerShell background jobs, see
57+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5258

5359
```yaml
54-
Type: SwitchParameter
60+
Type: System.Management.Automation.SwitchParameter
5561
Parameter Sets: (All)
5662
Aliases:
5763

@@ -63,12 +69,14 @@ Accept wildcard characters: False
6369
```
6470
6571
### -CimSession
66-
Runs the cmdlet in a remote session or on a remote computer.
67-
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.
68-
The default is the current session on the local computer.
72+
73+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
74+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
75+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
76+
current session on the local computer.
6977
7078
```yaml
71-
Type: CimSession[]
79+
Type: Microsoft.Management.Infrastructure.CimSession[]
7280
Parameter Sets: (All)
7381
Aliases: Session
7482

@@ -80,11 +88,12 @@ Accept wildcard characters: False
8088
```
8189
8290
### -Path
83-
Specifies an array of file paths.
84-
The cmdlet expands files to the file paths specified by this parameter.
91+
92+
Specifies an array of file paths. The cmdlet expands files to the file paths specified by this
93+
parameter.
8594
8695
```yaml
87-
Type: String[]
96+
Type: System.String[]
8897
Parameter Sets: (All)
8998
Aliases: FullName
9099

@@ -96,12 +105,15 @@ Accept wildcard characters: False
96105
```
97106
98107
### -ThrottleLimit
99-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
100-
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.
101-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
108+
109+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
110+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
111+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
112+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
113+
computer.
102114

103115
```yaml
104-
Type: Int32
116+
Type: System.Int32
105117
Parameter Sets: (All)
106118
Aliases:
107119
@@ -113,15 +125,20 @@ Accept wildcard characters: False
113125
```
114126

115127
### CommonParameters
116-
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).
128+
129+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
130+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
131+
-WarningAction, and -WarningVariable. For more information, see
132+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
117133

118134
## INPUTS
119135

120136
## OUTPUTS
121137

122138
### Uint32
123-
This cmdlet generates an integer that indicates success or failure of the operation.
124-
A value of zero indicates success.
139+
140+
This cmdlet generates an integer that indicates success or failure of the operation. A value of zero
141+
indicates success.
125142

126143
## NOTES
127144

0 commit comments

Comments
 (0)