Export (0) Print
Expand All

Get-WBJob

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

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

Get-WBJob

Gets the current backup operation.

Syntax

Parameter Set: Default
Get-WBJob [[-Previous] <UInt32> ] [ <CommonParameters>]




Detailed Description

The Get-WBJob cmdlet gets the current backup operation (if one is running) or the previous backup or recovery operation. A WBJob object contains the backup or recovery operation.

To start a backup, use the Start-WBBackup cmdlet.

To use this cmdlet, you must be a member of the Administrators group or Backup Operators group.

Parameters

-Previous<UInt32>

Specifies the number of previous backup operations for which the server queries the event manager.


Aliases

none

Required?

false

Position?

1

Default Value

none

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.

  • Previous

    If you use the Previous parameter, the Get-WBJob cmdlet queries a WBJob object for previously run backups and recoveries. If you do not use this parameter, the cmdlet returns a WBJob object that contains the currently running backup or recovery operation.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • WBJob[]

    The Get-WBJob cmdlet displays a WBJob object that contains the currently or previously running backup or recovery operation.


Examples

Example 1: Get backup status

This example gets the status of the currently running backup or recovery operation.

The first command gets a backup policy object that contains the backup policy for the current computer and stores this policy in the variable named $Policy.

The second command starts the backup job by using the policy in the variable named $Policy. Because the command uses the Async parameter, the backup job does not display status messages as it runs.

The third command gets status information about the backup job and assigns it to the variable named $Job. Because the previous command specified the Async parameter, you can use the Get-WBJob cmdlet to obtain this information.


PS C:\> $Policy = Get-WBPolicy
PS C:\> Start-WBBackup -Policy $Policy -Async
PS C:\> $Job = Get-WBJob

Example 2: Get the status of past backup or recovery jobs

This command gets the status of the last 10 backup or recovery jobs from the backup events in the event manager. It then stores the status in the variable named $Jobs.


PS C:\> $Jobs = Get-WBJob -Previous 10

Related topics

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