Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Start-VBRZip

Short Description

Performs VeeamZIP on the selected VM.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 2 parameter sets.

  • For targeting VeeamZIP files to a backup repository:

Start-VBRZip -Entity <IItem[]> [-BackupRepository <CBackupRepository>] [-Compression <int>] [-DisableQuiesce] [-RunAsync] [-EncryptionKey <PSCryptoKey>] [-AutoDelete <EFreeBackupRetention> {Never | Tonight | TomorrowNight | In3days | In1Week | In2Weeks | In1Month | In3Months | In6Months | In1Year}]  [<CommonParameters>]

  • For targeting VeeamZIP files to a folder or for Veeam Backup Free Edition:

Start-VBRZip -Entity <IItem[]> [-Folder <string>] [-Compression <int>] [-DisableQuiesce] [-RunAsync] [-EncryptionKey <PSCryptoKey>] [-AutoDelete <EFreeBackupRetention> {Never | Tonight | TomorrowNight | In3days | In1Week | In2Weeks | In1Month | In3Months | In6Months | In1Year}] [-NetworkCredentials <CCredentials>] [<CommonParameters>]

Detailed Description

This cmdlet performs VeeamZIP backup of the selected VM.

VeeamZIP is a quick backup procedure always producing a full backup. The VeeamZIP task runs once the time it is created and does not appear in the jobs list. The result backup file is stored in the specified folder and does not appear automatically in the backups list. Run Import-VBRBackup to start managing the backup file with Veeam Backup & Replication.

This cmdlet is available for Veeam Backup Free Edition. You can use it in your scripts. For Veeam Backup Free Edition, use the second parameter set.

Start-VBRZip Note:

You cannot restore a VM from a VeeamZIP backup with Veeam PowerShell. Use the UI for the restore operations.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Backup
Repository

Specifies the backup repository where you want to save the backup file. If none is specified, the default repository will be used.

False

Named

False

False

Entity

Specifies the array of VMs for which you want to create a VeeamZIP file.

True

Named

True (ByValue,
ByProperty
Name)

False

Compression

Specifies then integer number corresponding to the desired compression level:

  • 0 = None. Consider disabling compression to achieve better deduplication ratios on deduplicating storage appliances at the cost of reduced backup performance.
  • 4 = Dedupe-friendly. This is the recommended setting for using with deduplicating storage devices and caching WAN accelerators. This setting is used by default.
  • 5 = Optimal (recommended). Optimal compression provides for the best compression to performance ratio, and lowest backup proxy CPU usage.
  • 6 = High. High compression provides additional 10% compression ratio over Optimal, at the cost of 8x higher CPU usage.
  • 9 = Extreme. Extreme compression provides additional 3% compression ratio over High, at the cost of 2x higher CPU usage.

False

Named

False

False

DisableQuiesce

If set, the VM will be backed up without using the VMware tools quiescence. Otherwise, the applications running on the target VM will be quiesced to provide transactionally consistent backup with use of VMware Tools.

False

Named

False

False

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

False

Named

False

False

Folder

Specifies the full path to the folder on the server where you want to store the created backup file. If omitted, the created backup file will be saved to the C:\backup folder on the Veeam Backup server.

False

Named

False

False

EncryptionKey

Specifies the encryption key you want to use to encrypt the created VeeamZIP file.

False

Named

False

False

AutoDelete

Specifies the retention settings for the created VeeamZIP file:

  • Never
  • Tonight
  • TomorrowNight
  • In3days
  • In1Week
  • In2Weeks
  • In1Month.
  • In3Months.
  • In6Months.
  • In1Year.

False

Named

False

False

Network
Credentials

Specifies the credentials you want to use for authenticating with the shared folder.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to perform VeeamZIP backup to a backup repository.

You will need to perform the following steps:

  1. Run Find-VBRViEntity to get the VM where VeeamZIP will be started. Save the result to the $vm variable.
  2. Run Get-VBRBackupRepository to get the repository where the backups will be stored. Save the result to the $rep variable.
  3. Run Start-VBRZip with the $vm and $rep variables.

PS C:\PS> $vm = Find-VBViEntity -Name "Fileserver01"

PS C:\PS> $rep = Get-VBRBackupRepository -Name "Reports"

PS C:\PS> Start-VBRZip -BackupRepository $rep -Entity $vm -RunAsync

Example 2

This example shows how to perform VeeamZIP backup to a shared folder. The cmdlet starts VeeamZIP with the following parameters:

  • Path to the folder where the backups will be stored is D:\Repository\VeeamZIP.
  • The compression level is set to 4 (Dedupe-friendly).
  • The VMware quiescence is disabled.
  • The cmdlet will use "Shared" credentials for authenticating with the shared folder.
  • The RunAsync parameter is set to bring the process to the background.

You will need to perform the following steps:

  1. Run Find-VBRViEntity to get the VM where VeeamZIP will be started. Save the result to the $vm variable.
  2. Run Get-VBRCredentials to get the credentials for authenticating with the shared folder. Save the result to the $netcreds variable.
  3. Run Start-VBRZip with the $vm and $netcreds variables.

PS C:\PS> $vm = Find-VBViEntity -Name "Tech"

PS C:\PS> $netcreds = Get-VBRCredentials -Name "Shared"

PS C:\PS> Start-VBRZip -Folder "D:\Repository\VeeamZIP" -Entity $vm -Compression 4 -DisableQuiesce -NetworkCredentials &netcreds -RunAsync

Related Commands

Get-VBRBackupRepository

Get-VBRCredentials

Find-VBRViEntity / Find-VBRHvEntity

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation