Start-FsrmFileManagementJob
Start-FsrmFileManagementJob
Starts a file management job.
Syntax
Parameter Set: Query (cdxml)
Start-FsrmFileManagementJob [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Queue] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Start-FsrmFileManagementJob -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Queue] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-FsrmFileManagementJob cmdlet attempts to start a file management job. If you specify the Queue parameter, the start is delayed by approximately 5 minutes to wait for other file management jobs that the server can run at the same time.
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 |
-InputObject<CimInstance[]>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names of file management jobs.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
true |
-Queue
Indicates that the server adds the file management job to a queue and the task should run the next 5 minutes. Any tasks that the server queues during the next 5 minutes are run together. If you do not specify this parameter, the server runs the file management job immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunDuration<Int32>
Specifies the number of hours that the server runs the task before canceling it. The value 0 indicates that the server runs the task to completion.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob
Examples
Example 1: Start a file management job
This command starts the file management job named "Expire stale Data" immediately.
PS C:\> Start-FsrmFileManagementJob -Name "Expire stale Data"
Example 2: Queue a file management job and set the run duration
This command queues the file management job named "Expire stale Data" to start in the next 5 minutes and specifies that the server does not run the job any longer than 4 hours.
PS C:\> Start-FsrmFileManagementJob -Name "Expire stale Data" -Queue -RunDuration 4