Get-DedupSchedule
Get-DedupSchedule
Returns the DeduplicationJobSchedule objects defined on the system.
Syntax
Parameter Set: Query (cdxml)
Get-DedupSchedule [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Type <Type[]> ] [ <CommonParameters>]
Detailed Description
The Get-DedupSchedule cmdlet returns the DeduplicationJobSchedule objects defined on the system.
To run this cmdlet, you must start Windows PowerShell® with the Run as administrator option.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the friendly name of one or more data deduplication job schedules for which to return DeduplicationJobSchedule objects.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Type<Type[]>
Specifies the names of one or more types of data deduplication job schedules for which to return DeduplicationJobSchedule objects. The acceptable values for this parameter are: Optimization, GarbageCollection, Scrubbing, and Unoptimization.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- System.String[]
- Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupSchedule.Type[]
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
Example 1
This example returns the currently active DataDeduplicationSchedule objects created using the New-DedupSchedule cmdlet.
PS C:\> Get-DedupSchedule
Example 2
This example returns all data deduplication schedules for optimization jobs
PS C:\> Get-DedupSchedule -Type Optimization
EXAMPLE 3
This example returns the data deduplication schedule named MySchedule.
PS C:\> Get-DedupSchedule -Name MySchedule