Stop-WBJob

Stop-WBJob

Stops the current backup or recovery job.

Syntax

Parameter Set: Default
Stop-WBJob [[-Force]] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Stop-WBJob cmdlet stops the backup or recovery job that is currently running.

Parameters

-Force

Indicates that the cmdlet stops the backup or recovery job without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

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

  • System.String

Examples

Example 1: Stop the current backup job

This command stops the currently running backup or recovery job.

PS C:\> Stop-WBJob