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

Get-WBJob

Brian Lich|Last Updated: 4/3/2017

SYNOPSIS

Gets the current backup operation.

SYNTAX

Get-WBJob [[-Previous] <UInt32>] [<CommonParameters>]

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.

EXAMPLES

Example 1: Get backup status

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

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 this cmdlet to obtain this information.

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

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

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.

PARAMETERS

-Previous

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

Type: UInt32
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: None
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

Previous

If you use the Previous parameter, this 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

WBJob[]

This cmdlet returns a WBJob object that contains the currently or previously running backup or recovery operation.

NOTES

Start-WBBackup

Stop-WBJob

© 2017 Microsoft