Start-Fsrm File Management Job

Module:
fileserverresourcemanager
Starts a file management job.

Syntax 

Start-FsrmFileManagementJob
     [-Name] <String[]>
     [-Queue]
     [-RunDuration <Int32>]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-FsrmFileManagementJob
     -InputObject <CimInstance[]>
     [-Queue]
     [-RunDuration <Int32>]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

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.

Examples

Example 1: Start a file management job 

PS C:\> Start-FsrmFileManagementJob -Name "Expire stale Data"

This command starts the file management job named Expire stale Data immediately.

Example 2: Queue a file management job and set the run duration 

PS C:\> Start-FsrmFileManagementJob -Name "Expire stale Data" -Queue -RunDuration 4

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.

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name

Specifies an array of names of file management jobs.

Type: String[]
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs .

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RunDuration

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob