< Back
Wait-RSJob
Post
NAME Wait-RSJob
SYNOPSIS
Waits until all RSJobs are in one of the following states:
SYNTAX
Wait-RSJob [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [[-Job] <RSJob[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [[-Name] <String[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [[-Id] <Int32[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [-InstanceID <String[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [-Batch <String[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
DESCRIPTION
Waits until all RSJobs are in one of the following states:
PARAMETERS
-Job <RSJob[]>
The job object to wait for.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Name <String[]>
The name of the jobs to wait for.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Id <Int32[]>
The ID of the jobs that you want to wait for.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-InstanceID <String[]>
The GUID of the jobs that you want to wait for.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Batch <String[]>
Name of the set of jobs that you want to wait for.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-State <String[]>
The State of the job that you want to wait for. Accepted values are:
NotStarted
Running
Completed
Failed
Stopping
Stopped
Disconnected
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
Timeout after specified number of seconds. This is a global timeout meaning that it is not a per
job timeout.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ShowProgress [<SwitchParameter>]
Displays a progress bar
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Name: Wait-RSJob
Author: Ryan Bushe/Boe Prox/Max Kozlov
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-RSJob | Wait-RSJob
Description
-----------
Waits for jobs which have to be completed.
RELATED LINKS
SYNOPSIS
Waits until all RSJobs are in one of the following states:
SYNTAX
Wait-RSJob [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [[-Job] <RSJob[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [[-Name] <String[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [[-Id] <Int32[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [-InstanceID <String[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
Wait-RSJob [-Batch <String[]>] [-State <String[]>] [-Timeout <Int32>] [-ShowProgress] [<CommonParameters>]
DESCRIPTION
Waits until all RSJobs are in one of the following states:
PARAMETERS
-Job <RSJob[]>
The job object to wait for.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Name <String[]>
The name of the jobs to wait for.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Id <Int32[]>
The ID of the jobs that you want to wait for.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-InstanceID <String[]>
The GUID of the jobs that you want to wait for.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Batch <String[]>
Name of the set of jobs that you want to wait for.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-State <String[]>
The State of the job that you want to wait for. Accepted values are:
NotStarted
Running
Completed
Failed
Stopping
Stopped
Disconnected
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
Timeout after specified number of seconds. This is a global timeout meaning that it is not a per
job timeout.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ShowProgress [<SwitchParameter>]
Displays a progress bar
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Name: Wait-RSJob
Author: Ryan Bushe/Boe Prox/Max Kozlov
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-RSJob | Wait-RSJob
Description
-----------
Waits for jobs which have to be completed.
RELATED LINKS