Contact Info

Crumbtrail » Administration » Powershell » Powershell 3.0 » Receive-Job

Receive-Job - Powershell 3.0 CmdLet

ActiveXperts Network Monitor ships with integrated Powershell scripts to monitor complex network. The scripts run out of the box
Download the ActiveXperts Network Monitor FREE version now »


Short description
Gets the results of the Windows PowerShell background jobs in the current session.

Receive-Job [-Job] <Job[]> [[-Location] <String[]>] [-AutoRemoveJob] [-Force] [-Keep] [-NoRecurse] [-Wait] [-WriteEvent
s] [-WriteJobInResults] [<CommonParameters>]
Receive-Job [-Job] <Job[]> [[-ComputerName] <String[]>] [-AutoRemoveJob] [-Force] [-Keep] [-NoRecurse] [-Wait] [-WriteE
vents] [-WriteJobInResults] [<CommonParameters>]
Receive-Job [-Id] <Int32[]> [-AutoRemoveJob] [-Force] [-Keep] [-NoRecurse] [-Wait] [-WriteEvents] [-WriteJobInResults] 
Receive-Job [-InstanceId] <Guid[]> [-AutoRemoveJob] [-Force] [-Keep] [-NoRecurse] [-Wait] [-WriteEvents] [-WriteJobInRe
sults] [<CommonParameters>]
Receive-Job [-Job] <Job[]> [[-Session] <PSSession[]>] [-AutoRemoveJob] [-Force] [-Keep] [-NoRecurse] [-Wait] [-WriteEve
nts] [-WriteJobInResults] [<CommonParameters>]
Receive-Job [-Name] <String[]> [-AutoRemoveJob] [-Force] [-Keep] [-NoRecurse] [-Wait] [-WriteEvents] [-WriteJobInResult
s] [<CommonParameters>]

The Receive-Job cmdlet gets the results of Windows PowerShell background jobs, such as those started by using the Start
-Job cmdlet or the AsJob parameter of any cmdlet. You can get the results of all jobs or identify jobs by their name, I
D, instance ID, computer name, location, or session, or by submitting a job object.

When you start a Windows PowerShell background job, the job starts, but the results do not appear immediately. Instead,
 the command returns an object that represents the background job. The job object contains useful information about the
 job, but it does not contain the results. This method allows you to continue working in the session while the job runs
.  For more information about background jobs in Windows PowerShell, see about_Jobs.

The Receive-Job cmdlet gets the results that have been generated by the time that the Receive-Job command is submitted.
 If the results are not yet complete, you can run additional Receive-Job commands to get the remaining results.

By default, job results are deleted from the system when you receive them, but you can use the Keep parameter to save t
he results so that you can receive them again. To delete the job results, run the Receive-Job command again (without th
e Keep parameter), close the session, or use the Remove-Job cmdlet to delete the job from the session.

Beginning in Windows PowerShell 3.0, Receive-Job also gets the results of custom job types, such as workflow jobs and i
nstances of scheduled jobs. To enable Receive-Job to get the results a custom job type, import the module that supports
 the custom job type into the session before running a Receive-Job command, either by using the Import-Module cmdlet or
 by using or getting a cmdlet in the module. For information about a particular custom job type, see the documentation 
of the custom job type feature.