Veeam Backup & Replication 9.0 [Archived]
PowerShell Reference
Related documents
Search
This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRZip

In this article

    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 [-BackupRepository <CBackupRepository>] -Entity <IItem[]> [-Compression <Int32>] [-DisableQuiesce] [-RunAsync] [-EncryptionKey <PSCryptoKey>] [-AutoDelete <EFreeBackupRetention>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

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

    Start-VBRZip [-Folder <String>] -Entity <IItem[]> [-Compression <Int32>] [-DisableQuiesce] [-RunAsync] [-EncryptionKey <PSCryptoKey>] [-AutoDelete <EFreeBackupRetention>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Related Commands

    Get-VBRBackupRepository

    Find-VBRViEntity / Find-VBRHvEntity

    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 VM for which you want to create a VeeamZIP file.

    You can assign multiple VMs to this object.

    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.

    Accepts PSCryptoKey object.

    False

    Named

    False

    False

    AutoDelete

    Specifies the retention settings for the created VeeamZIP file:

    • Never
    • Tonight
    • TomorrowNight
    • In3days
    • In1Week
    • In2Weeks
    • In1Month.

    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 command starts a VeeamZIP for the VM named "Fileserver01". The VM object is obtained with Find-VBRViEntity and piped down. The backup repository to store the result backup file is obtained with Get-VBRBackupRepository and assigned to the $"Repository 01" variable beforehand. The RunAsync parameter is set to bring the process to the background.

    PS C:\PS> Find-VBRViEntity -Server $server -Name "Fileserver01" | Start-VBRZip -BackupRepository $"Repository 01" -RunAsync

    Example 2

    This command starts a VeeamZIP for the VM repersented by the $vm variable. The VM object is obtained with Find-VBRViEntity and assigned to the variable beforehand. The path to the folder where the backup file will be stored is D:\Repository\VeeamZIP. The compression level is set to 4 (Dedupe-friendly). The VMware quiescence is disabled. The RunAsync parameter is set to bring the process to the background.

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

    View all results across Veeam
    Back to document search