Share via

Start-OBBackup

  • Reference
Module:
MSOnlineBackup

Starts a one-time backup operation based on the specified OBPolicy.

Syntax

Start-OBBackup
     [-Name] <String>
     [-Async]
     [-Confirm]
     [-WhatIf]
     [-Volumes]
Start-OBBackup
     [-Policy] <CBPolicy>
     [-Async]
     [-Confirm]
     [-WhatIf]
     [-Volumes]

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.

To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.

Examples

EXAMPLE 1

Get-OBPolicy | Start-OBBackup

This example starts a backup job using a policy.

EXAMPLE 2

Start-OBBackup -Name myPolicy -Async

This example starts a backup job by policy name.

EXAMPLE 3

Get-OBPolicy | Start-OBBackup -Volumes C,D

This example starts a backup job using the defined policy for C and D drives.

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.

Type:SwitchParameter
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the policy to be started by name.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Policy

Specifies the policy to be backed up.

Type:CBPolicy
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Volumes

Specifies the volumes to be backed up on-demand. If this is not specified, all volumes configured for periodic backup are considered for on-demand backup.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

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.