Skip to content

Commit 0dfd888

Browse files
RobBiddlemichaeltlombardi
authored andcommitted
Style guide fixes
1 parent affd911 commit 0dfd888

File tree

1 file changed

+86
-66
lines changed

1 file changed

+86
-66
lines changed

docset/winserver2022-ps/deduplication/Update-DedupStatus.md

Lines changed: 86 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -16,77 +16,86 @@ Scans volumes for fresh data deduplication savings.
1616
## SYNTAX
1717

1818
```
19-
Update-DedupStatus [[-Volume] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
Update-DedupStatus [[-Volume] <String[]>] [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Update-DedupStatus** cmdlet scans one or more specified volumes to compute fresh data deduplication savings information.
25-
This cmdlet returns a **DeduplicationStatus** object.
26-
For quick access to cached metadata use **Get-DedupStatus**.
27-
When this cmdlet is run on multiple volumes with one cmdlet call, the analysis for each volume is done serially.
2824

29-
Note: On large volumes this cmdlet can run for several minutes and will always perform a rescan after the initial scan.
30-
The default behavior is to wait for completion, regardless of the length of time required to run the scan and rescan.
25+
The `Update-DedupStatus` cmdlet scans one or more specified volumes to compute fresh data
26+
deduplication savings information. This cmdlet returns a **DeduplicationStatus** object. For quick
27+
access to cached metadata use `Get-DedupStatus`. When this cmdlet is run on multiple volumes with
28+
one cmdlet call, the analysis for each volume is done serially.
29+
30+
Note: On large volumes this cmdlet can run for several minutes and will always perform a rescan
31+
after the initial scan. The default behavior is to wait for completion, regardless of the length of
32+
time required to run the scan and rescan.
3133

3234
To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option.
3335

34-
This cmdlet returns the following metadata:
35-
36-
- DedupSavedSpace.
37-
Saved space is the difference between the logical size of the optimized files and the logical size of the store.
38-
This is the deduplicated user data plus data deduplication metadata.
39-
This number changes continually.
40-
- DedupRate.
41-
Data deduplication rate is the ratio of data deduplication saved space to the logical size of all of the files on the volume and is expressed in percentage.
42-
This number will change continually.
43-
- OptimizedFilesCount.
44-
Optimized files count is the number of optimized files on the specified volume.
45-
This number remains steady, instead of decreasing, as users delete files from, or add files to, the volume, until a garbage collection job is run.
46-
This count is most accurate after a garbage collection job runs.
47-
- OptimizedFilesSize.
48-
Optimized files size is the aggregate size of all optimized files on the specified volume.
49-
This number remains steady, instead of decreasing, as users delete files from, or add new files to, the volume, until a garbage collection job is run.
50-
This number is most accurate after a garbage collection job runs.
51-
- InPolicyFilesCount.
52-
In policy files count is the number of files that currently qualify for optimization.
53-
This number stays relatively constant between optimization jobs.
54-
- InPolicyFilesSize.
55-
In policy files size is the aggregate size of all files that currently qualify for optimization.
56-
This number stays relatively constant between optimization jobs.
57-
- LastOptimizationTime.
58-
Last optimization time specifies the data and time when an optimization job was run last on the specified volume.
59-
This date and time stays constant between optimization jobs.
60-
- LastGarbageCollectionTime.
61-
Last garbage collection time specifies the data and time when a garbage collection job was run last on the specified volume.
62-
This date and time stays constant between optimization jobs.
63-
- LastScrubbingTime.
64-
Last scrubbing time specifies the data and time when a scrubbing job was run last on the specified volume.
65-
This date and time stays constant between optimization jobs.
36+
This cmdlet returns the following metadata:
37+
38+
- `DedupSavedSpace`
39+
- Saved space is the difference between the logical size of the optimized files
40+
and the logical size of the store. This is the deduplicated user data plus data deduplication
41+
metadata. This number changes continually.
42+
- `DedupRate`
43+
- Data deduplication rate is the ratio of data deduplication saved space to the logical
44+
size of all of the files on the volume and is expressed in percentage. This number will change
45+
continually.
46+
- `OptimizedFilesCount`
47+
- Optimized files count is the number of optimized files on the specified volume. This number
48+
remains steady, instead of decreasing, as users delete files from, or add files to, the volume,
49+
until a garbage collection job is run. This count is most accurate after a garbage collection
50+
job runs.
51+
- `OptimizedFilesSize`
52+
- Optimized files size is the aggregate size of all optimized files on the specified volume. This
53+
number remains steady, instead of decreasing, as users delete files from, or add new files to,
54+
the volume, until a garbage collection job is run. This number is most accurate after a garbage
55+
collection job runs.
56+
- `InPolicyFilesCount`
57+
- In policy files count is the number of files that currently qualify for optimization. This
58+
number stays relatively constant between optimization jobs.
59+
- `InPolicyFilesSize`
60+
- In policy files size is the aggregate size of all files that currently qualify for optimization.
61+
This number stays relatively constant between optimization jobs.
62+
- `LastOptimizationTime`
63+
- Last optimization time specifies the data and time when an optimization job was run last on the
64+
specified volume. This date and time stays constant between optimization jobs.
65+
- `LastGarbageCollectionTime`
66+
- Last garbage collection time specifies the data and time when a garbage collection job was run
67+
last on the specified volume. This date and time stays constant between optimization jobs.
68+
- `LastScrubbingTime`
69+
- Last scrubbing time specifies the data and time when a scrubbing job was run last on the
70+
specified volume. This date and time stays constant between optimization jobs.
6671

6772
## EXAMPLES
6873

6974
### Example 1: Scan a volume for savings information
70-
```
71-
PS C:\> Update-DedupStatus -Volume "D:"
75+
76+
```powershell
77+
Update-DedupStatus -Volume "D:"
7278
```
7379

74-
This command scans the D: volume to compute data deduplication savings.
80+
This command scans the `D:` volume to compute data deduplication savings.
7581

7682
## PARAMETERS
7783

7884
### -AsJob
79-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
8085

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

86-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
89+
The cmdlet immediately returns an object that represents the job and then displays the command
90+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
91+
`*-Job` cmdlets. To get the job results, use the
92+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
93+
94+
For more information about Windows PowerShell background jobs, see
95+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
8796

8897
```yaml
89-
Type: SwitchParameter
98+
Type: System.Management.Automation.SwitchParameter
9099
Parameter Sets: (All)
91100
Aliases:
92101

@@ -98,12 +107,14 @@ Accept wildcard characters: False
98107
```
99108
100109
### -CimSession
101-
Runs the cmdlet in a remote session or on a remote computer.
102-
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.
103-
The default is the current session on the local computer.
110+
111+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
112+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
113+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
114+
current session on the local computer.
104115
105116
```yaml
106-
Type: CimSession[]
117+
Type: Microsoft.Management.Infrastructure.CimSession[]
107118
Parameter Sets: (All)
108119
Aliases: Session
109120

@@ -115,12 +126,15 @@ Accept wildcard characters: False
115126
```
116127
117128
### -ThrottleLimit
118-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
119-
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.
120-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
129+
130+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
131+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
132+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
133+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
134+
computer.
121135

122136
```yaml
123-
Type: Int32
137+
Type: System.Int32
124138
Parameter Sets: (All)
125139
Aliases:
126140
@@ -132,14 +146,14 @@ Accept wildcard characters: False
132146
```
133147

134148
### -Volume
135-
Specifies one or more file system volumes for which to scan and compute fresh data deduplication savings information.
136-
Enter one or more volume IDs, drive letters, or volume GUID paths.
137-
For drive letters, use the format D:.
138-
For volume GUID paths, use the format \\\\?\Volume{{GUID}}\.
149+
150+
Specifies one or more file system volumes for which to scan and compute fresh data deduplication
151+
savings information. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive
152+
letters, use the format `D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`.
139153
Separate multiple volumes with a comma.
140154

141155
```yaml
142-
Type: String[]
156+
Type: System.String[]
143157
Parameter Sets: (All)
144158
Aliases: Path, Name, DeviceId
145159
@@ -151,7 +165,11 @@ Accept wildcard characters: False
151165
```
152166

153167
### CommonParameters
154-
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).
168+
169+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
170+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
171+
-WarningAction, and -WarningVariable. For more information, see
172+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
155173

156174
## INPUTS
157175

@@ -160,8 +178,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
160178
## OUTPUTS
161179

162180
### Microsoft.Management.Infrastructure.CimInstance
163-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
164-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
181+
182+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
183+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
184+
namespace and class name for the underlying WMI object.
165185

166186
## NOTES
167187

0 commit comments

Comments
 (0)