Stop-OBJob
Stop-OBJob
Stops the specified backup or recovery job.
Syntax
Parameter Set: Default
Stop-OBJob [-Job] <CBJob> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Stop-OBJob cmdlet stops currently running job, such as backup or recovery.
This cmdlet supports the WhatIf and the Confirm parameters. The cmdlet prompts the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Specify –Confirm:$FALSE to override the prompt.
Parameters
-Job<CBJob>
Specifies the job to be stopped.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Internal.CloudBackup.Client.Cmdlets.OBJob
Examples
EXAMPLE 1
This example stops a job.
PS C:\> $job = Get-OBJob
PS C:\> Stop-OBJob -Job $job