Skip to content

Commit f4fdfc9

Browse files
RobBiddlemichaeltlombardi
authored andcommitted
Style guide fixes
1 parent 460e9a3 commit f4fdfc9

File tree

1 file changed

+66
-45
lines changed

1 file changed

+66
-45
lines changed

docset/winserver2022-ps/deduplication/Get-DedupMetadata.md

Lines changed: 66 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,68 +16,74 @@ Returns metadata for volumes that have data deduplication metadata.
1616
## SYNTAX
1717

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

2323
## DESCRIPTION
24-
The **Get-DedupMetadata** cmdlet returns a **DeduplicationMetadata** object for every volume that has optimization metadata.
25-
A **DeduplicationMetadata** object includes read-only properties describing the nature of the deduplication data store, such as chunk counts, container counts, average chunk size, and other statistics.
2624

27-
Because this cmdlet must scan the entire file system.
28-
this cmdlet requires some time to run.
25+
The `Get-DedupMetadata` cmdlet returns a **DeduplicationMetadata** object for every volume that has
26+
optimization metadata. A **DeduplicationMetadata** object includes read-only properties describing
27+
the nature of the deduplication data store, such as chunk counts, container counts, average chunk
28+
size, and other statistics.
2929

30-
This cmdlet cannot be part of a schedule; it must be run manually.
31-
If another optimization job is running on the specified volume when you start this cmdlet, then this cmdlet fails.
32-
It also fails if there is not enough memory for the file system scan and cmdlet processing.
33-
If the cmdlet fails, then review the events and log files for more information.
30+
Because this cmdlet must scan the entire file system. this cmdlet requires some time to run.
31+
32+
This cmdlet cannot be part of a schedule; it must be run manually. If another optimization job is
33+
running on the specified volume when you start this cmdlet, then this cmdlet fails. It also fails if
34+
there is not enough memory for the file system scan and cmdlet processing. If the cmdlet fails, then
35+
review the events and log files for more information.
3436

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

37-
This cmdlet returns the following properties:
39+
This cmdlet returns the following properties:
3840

3941
- **DataChunkCount**.
40-
Indicates the number of data chunks in a container.
42+
Indicates the number of data chunks in a container.
4143
- **DataContainerCount**.
42-
Indicates the number of containers in the data store.
43-
- **DataChunkAverageSize**.
44-
Indicates the data store size, not including chunk metadata, divided by the total number of data chunks in the data store.
44+
Indicates the number of containers in the data store.
45+
- **DataChunkAverageSize**. Indicates the data store size, not including chunk metadata, divided by
46+
the total number of data chunks in the data store.
4547
- **StreamMapCount**.
46-
Indicates the number of data streams in a container.
48+
Indicates the number of data streams in a container.
4749
- **StreamMapContainerCount**.
48-
Indicates the number of containers in the stream map store.
50+
Indicates the number of containers in the stream map store.
4951
- **StreamMapAverageChunkCount**.
50-
Indicates the stream map store size divided by the total number of streams in the store.
52+
Indicates the stream map store size divided by the total number of streams in the store.
5153
- **HotspotCount**.
52-
Indicates the number of hotspots in a container.
54+
Indicates the number of hotspots in a container.
5355
- **HotspotContainerCount**.
54-
Indicates the number of hotspots in the stream map store.
56+
Indicates the number of hotspots in the stream map store.
5557
- **CorruptionCount**.
5658
Indicates the number of corruptions found on the volume.
5759

5860
## EXAMPLES
5961

6062
### Example 1: Get metadata for a volume
61-
```
62-
PS C:\> Get-DedupMetadata -Volume "D:"
63+
64+
```powershell
65+
Get-DedupMetadata -Volume "D:"
6366
```
6467

65-
This command gets metadata for the D: volume.
68+
This command gets metadata for the `D:` volume.
6669

6770
## PARAMETERS
6871

6972
### -AsJob
70-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
7173

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

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

7985
```yaml
80-
Type: SwitchParameter
86+
Type: System.Management.Automation.SwitchParameter
8187
Parameter Sets: (All)
8288
Aliases:
8389

@@ -89,12 +95,14 @@ Accept wildcard characters: False
8995
```
9096
9197
### -CimSession
92-
Runs the cmdlet in a remote session or on a remote computer.
93-
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.
94-
The default is the current session on the local computer.
98+
99+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
100+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
101+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
102+
current session on the local computer.
95103
96104
```yaml
97-
Type: CimSession[]
105+
Type: Microsoft.Management.Infrastructure.CimSession[]
98106
Parameter Sets: (All)
99107
Aliases: Session
100108

@@ -106,12 +114,15 @@ Accept wildcard characters: False
106114
```
107115
108116
### -ThrottleLimit
109-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
110-
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.
111-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
117+
118+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
119+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
120+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
121+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
122+
computer.
112123

113124
```yaml
114-
Type: Int32
125+
Type: System.Int32
115126
Parameter Sets: (All)
116127
Aliases:
117128
@@ -123,10 +134,12 @@ Accept wildcard characters: False
123134
```
124135

125136
### -Volume
126-
Specifies one or more file system volumes for which to return a **DeduplicationVolumeMetadata** object.
137+
138+
Specifies one or more file system volumes for which to return a **DeduplicationVolumeMetadata**
139+
object.
127140

128141
```yaml
129-
Type: String[]
142+
Type: System.String[]
130143
Parameter Sets: (All)
131144
Aliases: Path, Name, DeviceId
132145
@@ -138,7 +151,11 @@ Accept wildcard characters: False
138151
```
139152

140153
### CommonParameters
141-
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).
154+
155+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
156+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
157+
-WarningAction, and -WarningVariable. For more information, see
158+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
142159

143160
## INPUTS
144161

@@ -147,12 +164,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
147164
## OUTPUTS
148165

149166
### Microsoft.Management.Infrastructure.CimInstance
150-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
151-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
167+
168+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
169+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
170+
namespace and class name for the underlying WMI object.
152171

153172
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeMetadata
154-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
155-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
173+
174+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
175+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
176+
namespace and class name for the underlying WMI object.
156177

157178
## NOTES
158179

0 commit comments

Comments
 (0)