Skip to content

Commit a8b9eb5

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

File tree

2 files changed

+79
-55
lines changed

2 files changed

+79
-55
lines changed

.vscode/cspell/winmodules/dictionaries/winps.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ Cmdletization
33
Dcpromo
44
Dedup
55
DSRM
6+
Hotspot
7+
hotspots
68
krbtgt
79
NTDS
810
reoptimized

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

Lines changed: 77 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -16,68 +16,75 @@ 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:
38-
39-
- **DataChunkCount**.
40-
Indicates the number of data chunks in a container.
41-
- **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.
45-
- **StreamMapCount**.
46-
Indicates the number of data streams in a container.
47-
- **StreamMapContainerCount**.
48-
Indicates the number of containers in the stream map store.
49-
- **StreamMapAverageChunkCount**.
50-
Indicates the stream map store size divided by the total number of streams in the store.
51-
- **HotspotCount**.
52-
Indicates the number of hotspots in a container.
53-
- **HotspotContainerCount**.
54-
Indicates the number of hotspots in the stream map store.
55-
- **CorruptionCount**.
56-
Indicates the number of corruptions found on the volume.
39+
This cmdlet returns the following properties:
40+
41+
- `CorruptionCount`
42+
- Indicates the number of corruptions found on the volume.
43+
- `DataChunkAverageSize`
44+
- Indicates the data store size, not including chunk metadata, divided by the total number of data
45+
chunks in the data store.
46+
- `DataChunkCount`
47+
- Indicates the number of data chunks in a container.
48+
- `DataContainerCount`
49+
- Indicates the number of containers in the data store.
50+
- `HotspotContainerCount`
51+
- Indicates the number of hotspots in the stream map store.
52+
- `HotspotCount`
53+
- Indicates the number of hotspots in a container.
54+
- `StreamMapAverageChunkCount`
55+
- Indicates the stream map store size divided by the total number of streams in the store.
56+
- `StreamMapContainerCount`
57+
- Indicates the number of containers in the stream map store.
58+
- `StreamMapCount`
59+
- Indicates the number of data streams in a container.
5760

5861
## EXAMPLES
5962

6063
### Example 1: Get metadata for a volume
61-
```
62-
PS C:\> Get-DedupMetadata -Volume "D:"
64+
65+
```powershell
66+
Get-DedupMetadata -Volume "D:"
6367
```
6468

65-
This command gets metadata for the D: volume.
69+
This command gets metadata for the `D:` volume.
6670

6771
## PARAMETERS
6872

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

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.
75+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
76+
complete.
7677

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

7986
```yaml
80-
Type: SwitchParameter
87+
Type: System.Management.Automation.SwitchParameter
8188
Parameter Sets: (All)
8289
Aliases:
8390

@@ -89,12 +96,14 @@ Accept wildcard characters: False
8996
```
9097
9198
### -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.
99+
100+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
101+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
102+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
103+
current session on the local computer.
95104
96105
```yaml
97-
Type: CimSession[]
106+
Type: Microsoft.Management.Infrastructure.CimSession[]
98107
Parameter Sets: (All)
99108
Aliases: Session
100109

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

113125
```yaml
114-
Type: Int32
126+
Type: System.Int32
115127
Parameter Sets: (All)
116128
Aliases:
117129
@@ -123,10 +135,12 @@ Accept wildcard characters: False
123135
```
124136

125137
### -Volume
126-
Specifies one or more file system volumes for which to return a **DeduplicationVolumeMetadata** object.
138+
139+
Specifies one or more file system volumes for which to return a **DeduplicationVolumeMetadata**
140+
object.
127141

128142
```yaml
129-
Type: String[]
143+
Type: System.String[]
130144
Parameter Sets: (All)
131145
Aliases: Path, Name, DeviceId
132146
@@ -138,7 +152,11 @@ Accept wildcard characters: False
138152
```
139153

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

143161
## INPUTS
144162

@@ -147,12 +165,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
147165
## OUTPUTS
148166

149167
### 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.
168+
169+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
170+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
171+
namespace and class name for the underlying WMI object.
152172

153173
### 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.
174+
175+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
176+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
177+
namespace and class name for the underlying WMI object.
156178

157179
## NOTES
158180

0 commit comments

Comments
 (0)