Export (0) Print
Expand All
Expand Minimize

Wait-FsrmFileManagementJob

Windows Server 2012 R2 and Windows 8.1

Updated: January 7, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Wait-FsrmFileManagementJob

Waits for file management jobs to finish running.

Syntax

Parameter Set: Query (cdxml)
Wait-FsrmFileManagementJob [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Wait-FsrmFileManagementJob -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Wait-FsrmFileManagementJob cmdlet waits for the specified period of time or until the server finishes running one or more file management job.

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.


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?

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

-Timeout<Int32>

Specifies the number of seconds that the server waits for the file management job to complete. To wait indefinitely, set the value to -1. The value must be in the range from –1 through 2,147,483. If the server is not running the job or the value is set to 0, the cmdlet returns immediately.


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.

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.

Examples

Example 1: Wait for a file management job to finish

This command waits for the file management job named "Expire stale data" to finish running.


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

Example 2: Wait for and stop a file management job

This example waits for the file management job named "Expire stale data" to finish running and then stops the job.


 

The first command starts the file management job named "Expire stale data".


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

 

The second command waits for the file management job to finish running. If the file management job is not completed in 10 minutes, the server ends the file management job and the cmdlet returns.


PS C:\> Wait-FsrmFileManagementJob -Name "Expire stale data" -Timeout 600

 

The third command ensures that the file management job has stopped running.


PS C:\> Stop-FsrmFileManagementJob -Name "Expire stale data"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft