Skip to content

Commit decb6af

Browse files
Merge pull request MicrosoftDocs#3450 from RobBiddle/Get-DedupSchedule.md#3428
Quality: PowerShell Summit Get dedup schedule.md#3428
2 parents 9dff6b3 + a04c5ab commit decb6af

File tree

1 file changed

+63
-38
lines changed

1 file changed

+63
-38
lines changed

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

Lines changed: 63 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,52 +16,61 @@ Returns the deduplication job schedule defined on the computer.
1616
## SYNTAX
1717

1818
```
19-
Get-DedupSchedule [[-Name] <String[]>] [-Type <Type[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
20-
[-AsJob] [<CommonParameters>]
19+
Get-DedupSchedule [[-Name] <String[]>] [-Type <Type[]>] [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-DedupSchedule** cmdlet returns the **DeduplicationJobSchedule** objects defined on the computer.
24+
25+
The `Get-DedupSchedule` cmdlet returns the **DeduplicationJobSchedule** objects defined on the
26+
computer.
2527

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

2830
## EXAMPLES
2931

3032
### Example 1: Get active schedules
31-
```
32-
PS C:\> Get-DedupSchedule
33+
34+
```powershell
35+
Get-DedupSchedule
3336
```
3437

35-
This command returns the currently active data deduplication schedule objects created using the **New-DedupSchedule** cmdlet.
38+
This command returns the currently active data deduplication schedule objects created using the
39+
`New-DedupSchedule` cmdlet.
3640

3741
### Example 2: Get schedules for optimization jobs
38-
```
39-
PS C:\> Get-DedupSchedule -Type Optimization
42+
43+
```powershell
44+
Get-DedupSchedule -Type Optimization
4045
```
4146

4247
This command returns all data deduplication schedules for optimization jobs.
4348

4449
### Example 3: Get a named schedule
45-
```
46-
PS C:\> Get-DedupSchedule -Name MySchedule
50+
51+
```powershell
52+
Get-DedupSchedule -Name MySchedule
4753
```
4854

4955
This command returns the data deduplication schedule named MySchedule.
5056

5157
## PARAMETERS
5258

5359
### -AsJob
54-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
5560

56-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
57-
You can continue to work in the session while the job completes.
58-
To manage the job, use the `*-Job` cmdlets.
59-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
61+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
62+
complete.
63+
64+
The cmdlet immediately returns an object that represents the job and then displays the command
65+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
66+
`*-Job` cmdlets. To get the job results, use the
67+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
6068

61-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
69+
For more information about Windows PowerShell background jobs, see
70+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
6271

6372
```yaml
64-
Type: SwitchParameter
73+
Type: System.Management.Automation.SwitchParameter
6574
Parameter Sets: (All)
6675
Aliases:
6776

@@ -73,12 +82,14 @@ Accept wildcard characters: False
7382
```
7483
7584
### -CimSession
76-
Runs the cmdlet in a remote session or on a remote computer.
77-
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.
78-
The default is the current session on the local computer.
85+
86+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
87+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
88+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
89+
current session on the local computer.
7990
8091
```yaml
81-
Type: CimSession[]
92+
Type: Microsoft.Management.Infrastructure.CimSession[]
8293
Parameter Sets: (All)
8394
Aliases: Session
8495

@@ -90,10 +101,12 @@ Accept wildcard characters: False
90101
```
91102
92103
### -Name
93-
Specifies the friendly name of one or more data deduplication job schedules for which to return **DeduplicationJobSchedule** objects.
104+
105+
Specifies the friendly name of one or more data deduplication job schedules for which to return
106+
**DeduplicationJobSchedule** objects.
94107
95108
```yaml
96-
Type: String[]
109+
Type: System.String[]
97110
Parameter Sets: (All)
98111
Aliases:
99112

@@ -105,12 +118,15 @@ Accept wildcard characters: False
105118
```
106119
107120
### -ThrottleLimit
108-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
109-
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.
110-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
121+
122+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
123+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
124+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
125+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
126+
computer.
111127

112128
```yaml
113-
Type: Int32
129+
Type: System.Int32
114130
Parameter Sets: (All)
115131
Aliases:
116132
@@ -122,13 +138,14 @@ Accept wildcard characters: False
122138
```
123139

124140
### -Type
125-
Specifies an array of types of data deduplication job schedules for which to return **DeduplicationJobSchedule** objects.
126-
The acceptable values for this parameter are:
127141

128-
- Optimization
129-
- GarbageCollection
130-
- Scrubbing
131-
- Unoptimization
142+
Specifies an array of types of data deduplication job schedules for which to return
143+
**DeduplicationJobSchedule** objects. The acceptable values for this parameter are:
144+
145+
- `Optimization`
146+
- `GarbageCollection`
147+
- `Scrubbing`
148+
- `Unoptimization`
132149

133150
```yaml
134151
Type: Type[]
@@ -144,7 +161,11 @@ Accept wildcard characters: False
144161
```
145162

146163
### CommonParameters
147-
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).
164+
165+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
166+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
167+
-WarningAction, and -WarningVariable. For more information, see
168+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
148169

149170
## INPUTS
150171

@@ -155,12 +176,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
155176
## OUTPUTS
156177

157178
### Microsoft.Management.Infrastructure.CimInstance
158-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
159-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
179+
180+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
181+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
182+
namespace and class name for the underlying WMI object.
160183

161184
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule
162-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
163-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
185+
186+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
187+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
188+
namespace and class name for the underlying WMI object.
164189

165190
## NOTES
166191

0 commit comments

Comments
 (0)