Start-OBBackup
Start-OBBackup
Starts a one-time backup operation based on the specified OBPolicy.
Syntax
Parameter Set: PolicyName
Start-OBBackup [-Name] <String> [[-Async]] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: PolicyObject
Start-OBBackup [-Policy] <CBPolicy> [[-Async]] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-OBBackup cmdlet starts a one-time backup operation. Set the Policy parameter to specify the settings for the backup.
This cmdlet supports WhatIf and Confirm parameters with a medium impact. The medium impact signifies that the cmdlet will not prompt 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. Using –Confirm:$FALSE will override the prompt.
Parameters
-Async
Allows the user to indicate that the cmdlet should run asynchronously. This is useful with cmdlets that take a long time to complete. The control returns to the user immediately after the operation.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the policy to be started by name.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Policy<CBPolicy>
Specifies the policy to be backed up.
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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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
This cmdlet displays the status of the currently running backup if the Async parameter is not specified. The Get-OBJob cmdlet can also be used to get the status of the currently running backup operation.
Examples
EXAMPLE 1
This example starts a backup job using a policy.
PS C:\> Get-OBPolicy | Start-OBBackup
EXAMPLE 2
This example starts a backup job by policy name.
PS C:\> Start-OBBackup -Name myPolicy -Async