Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Wait-FsrmFileManagementJob

Last Updated: 3/28/2017

SYNOPSIS

Waits for file management jobs to finish running.

SYNTAX

Query (cdxml) (Default)

Wait-FsrmFileManagementJob [-Name] <String[]> [-Timeout <Int32>] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject (cdxml)

Wait-FsrmFileManagementJob -InputObject <CimInstance[]> [-Timeout <Int32>] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1: Wait for a file management job to finish

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

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

Example 2: Wait for and stop a file management 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"

This example waits for the file management job named "Expire stale data" to finish running and then stops the 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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

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

Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases: 

Required: True
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[]
Parameter Sets: Query (cdxml)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timeout

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob

NOTES

Get-FsrmFileManagementJob

New-FsrmFileManagementJob

Remove-FsrmFileManagementJob

Set-FsrmFileManagementJob

Start-FsrmFileManagementJob

Stop-FsrmFileManagementJob

© 2017 Microsoft