Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Start-AzureStorSimpleDeviceBackupJob

Start-AzureStorSimpleDeviceBackupJob

microsoft.windowsazure.commands.storsimple.dll

Synopsis

Starts a new job that creates a backup from an existing backup policy.

Syntax

Start-AzureStorSimpleDeviceBackupJob [-DeviceName] [-BackupPolicyId] [-WaitForComplete] [-Profile] [<CommonParameters>]

Start-AzureStorSimpleDeviceBackupJob [-DeviceName] [-BackupPolicyId] [-BackupType] [-WaitForComplete] [-Profile] [<CommonParameters>]

Detailed Description

The Start-AzureStorSimpleDeviceBackupJob cmdlet starts a new job that creates a backup from an existing backup policy on a StorSimple device. By default, this cmdlet creates a local snapshot backup. To create a cloud backup, specify a value of CloudSnapshot for the BackupType parameter.

Parameters

-BackupPolicyId <String>

Specifies the ID of the backup policy to use to create the backup.

Aliases

none

Required?

true

Position

2

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-BackupType <String>

Specifies the backup type. Valid values are: LocalSnapshot and CloudSnapshot.

Aliases

none

Required?

true

Position

3

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-DeviceName <String>

Specifies the name of the StorSimple device on which to start the backup job.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <Microsoft.Azure.Common.Authentication.Models.AzureProfile>

Specifies an Azure profile.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-WaitForComplete <SwitchParameter>

Indicates that this cmdlet waits for the operation to complete before it returns control to the Windows PowerShell® console.

Aliases

none

Required?

false

Position

4

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

TaskStatusInfo, TaskResponse

Notes

None

Examples

Example 1: Create a local snapshot backup

This command creates a local snapshot backup for the specified policy ID. This command starts the job, and then returns a TaskResponse object. To see the status of the job, use the Get-AzureStorSimpleTask cmdlet.

PS C:\>Start-AzureStorSimpleDeviceBackupJob -DeviceName "Contoso63-AppVm" -BackupPolicyId "de088eac-b283-4d92-b501-a759845fdf3f"
JobId                                                                StatusCode RequestId
-----                                                                ---------- ---------
fb9acdca-ed6f-4b69-93f2-5c0bce0a1e08                                 Accepted   456cf6bafd427103b71c07145e26d35c

VERBOSE: Your backup operation has been submitted for processing. Use commandlet "Get-AzureStorSimpleJob -JobId
fb9acdca-ed6f-4b69-93f2-5c0bce0a1e08" to track status. 

Example 2: Create a cloud snapshot backup and wait to finish

This command creates a cloud snapshot backup for the specified policy ID. This command specifies the WaitForComplete parameter, so the command completes the task, and then returns a TaskStatusInfo object for the job.

PS C:\>Start-AzureStorSimpleDeviceBackupJob -DeviceName "Contoso63-AppVm" -BackupPolicyId "de088eac-b283-4d92-b501-a759845fdf3f" -BackupType CloudSnapshot -WaitForComplete
Error      : Microsoft.WindowsAzure.Management.StorSimple.Models.ErrorDetails
JobId      : fb9acdca-ed6f-4b69-93f2-5c0bce0a1e08
JobSteps   : {}
Result     : Succeeded
Status     : Completed
TaskResult : Succeeded
StatusCode : OK
RequestId  : f28ecf6cf75a7f128ca18e6ae14f9003

Get-AzureStorSimpleJob
Start-AzureStorSimpleDeviceBackupRestoreJob