---
title: "Start-VBRZip"
description: "Performs VeeamZIP on the selected VM. Platform: VMware, Hyper-V Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet performs VeeamZIP backup of the selected VM"
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/start-vbrzip.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > VeeamZIP > Start-VBRZip"
dateModified: "2026-08-19"
---

# Start-VBRZip

## Short Description
Performs VeeamZIP on the selected VM.

**Platform**: VMware, Hyper-V

**Product Edition**: Standard, Enterprise, Enterprise Plus, Veeam Universal License

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>BackupRepository</code></p>

```
Start-VBRZip [-BackupRepository <CBackupRepository>] -Entity <IItem[]> [-Compression <Int32>] [-DisableQuiesce]
 [-RunAsync] [-EncryptionKey <PSCryptoKey>] [-KMSServer <VBRKMSServer>] [-AutoDelete <EFreeBackupRetention>]
 [-RetentionNumber <Int32>] [-RetentionPeriodType <VBRRetentionPeriodType>] [-Force] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Folder</code></p>

```
Start-VBRZip [-Folder <String>] -Entity <IItem[]> [-Compression <Int32>] [-DisableQuiesce] [-RunAsync]
 [-EncryptionKey <PSCryptoKey>] [-KMSServer <VBRKMSServer>] [-AutoDelete <EFreeBackupRetention>]
 [-RetentionNumber <Int32>] [-RetentionPeriodType <VBRRetentionPeriodType>]
 [-NetworkCredentials <CCredentials>] [-Force] [<CommonParameters>]
```
  </li>
</ul>

## 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 the [`Import-VBRBackup`](import-vbrbackup.md) cmdlet 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.

::: note

The cmdlet will not run if the geographic location of the VMs you want to back up and the job target repository location do not match. If you still want to run the cmdlet, use the `Force` parameter.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AutoDelete</span></p>
        </td>
        <td>
          <p>Specifies the retention settings for the created VeeamZIP file:</p><ul><li><code>Never</code></li><li><code>Tonight</code></li><li><code>TomorrowNight</code></li><li><code>In3days</code></li><li><code>In1Week</code></li><li><code>In2Weeks</code></li><li><code>In1Month</code></li><li><code>In3Months</code></li><li><code>In6Months</code></li><li><code>In1Year</code></li><li><code>In2Years</code></li><li><code>In3Years</code></li><li><code>In5Years</code></li><li><code>In7Years</code></li></ul><p><strong>Note</strong>: Use this parameter if the <code>RetentionPeriodType</code> and <code>RetentionNumber</code> parameters are not specified.</p>
        </td>
        <td style="width:10%;">
          <p><code>EFreeBackupRetention</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the backup repository where you want to save the backup file. If none is specified, the default repository will be used.</p><p><strong>Note</strong>: The cmdlet will not run if you do not specify either the <code>BackupRepository</code> or the <code>Folder</code> parameters.</p><p>Accepts the <code>CBackupRepository</code> object. To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Compression</span></p>
        </td>
        <td>
          <p>Specifies then integer number corresponding to the desired compression level:</p><ul><li><code>0</code> = None. Consider disabling compression to achieve better deduplication ratios on deduplicating storage appliances at the cost of reduced backup performance.</li><li><code>4</code> = Dedupe-friendly. This is the recommended setting for using with deduplicating storage devices and caching WAN accelerators. This setting is used by default.</li><li><code>5</code> = Optimal (recommended). Optimal compression provides for the best compression to performance ratio, and lowest backup proxy CPU usage.</li><li><code>6</code> = High. High compression provides additional 10% compression ratio over Optimal, at the cost of 8x higher CPU usage.</li><li><code>9</code> = Extreme. Extreme compression provides additional 3% compression ratio over High, at the cost of 2x higher CPU usage.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">DisableQuiesce</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will back up VM without using the quiescence mechanisms.</p><p>If you provide this parameter, you will be able to create a crash-consistent backup of the target VM. Otherwise, the applications that run on the target VM will be quiesced to provide transactionally consistent backup.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EncryptionKey</span></p>
        </td>
        <td>
          <p>Specifies the encryption key you want to use to encrypt the created VeeamZIP file.</p>
        </td>
        <td style="width:10%;">
          <p><a href="pscryptokey.md"><code>PSCryptoKey</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Entity</span></p>
        </td>
        <td>
          <p>Specifies the array of VMs for which you want to create a VeeamZIP file.</p><p>Accepts the <code>IItem[]</code> object. To get this object, run the <a href="find-vbrvientity.md"><code>Find-VBRViEntity</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>IItem[]</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Folder</span></p>
        </td>
        <td>
          <p>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.</p><p><strong>Note</strong>: The cmdlet will not run if you do not specify either the <code>BackupRepository</code> or the <code>Folder</code> parameters.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will perform backup even if the geographic location of VMs and the target backup repository location do not match.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">KMSServer</span></p>
        </td>
        <td>
          <p>Specifies the KMS server you want to use to encrypt the data.</p><p>Accepts the <code>VBRKMSServer</code> object.</p><p>To get this object, run the <a href="get-vbrkmsserver.md"><code>Get-VBRKMSServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrkmsserver.md"><code>VBRKMSServer</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">NetworkCredentials</span></p>
        </td>
        <td>
          <p>Specifies the credentials you want to use for authenticating with the shared folder.</p><p>Accepts the <code>CCredentials</code> object. To get this object, run the <a href="get-vbrcredentials.md"><code>Get-VBRCredentials</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CCredentials</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">RetentionNumber</span></p>
        </td>
        <td>
          <p>For the <code>RetentionPeriodType</code> option.</p><p>Specifies the period of time to keep the VeeamZIP backups. After this period finishes, Veeam Backup & Replication will remove data.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">RetentionPeriodType</span></p>
        </td>
        <td>
          <p>Specifies the type of the retention policy. You can set the following types:</p><ul><li><code>Days</code>: use this option if you want Veeam Backup & Replication to apply retention policy daily.</li><li><code>Months</code>: use this option if you want Veeam Backup & Replication to apply retention policy monthly.</li><li><code>Years</code>: use this option if you want Veeam Backup & Replication to apply retention policy yearly.</li></ul><p>Use the <code>RetentionNumber</code> to specify the number of days, months or years.</p><p><strong>Note</strong>: Use this parameter if the <code>AutoDelete</code> parameter is not specified.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRRetentionPeriodType</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">RunAsync</span></p>
        </td>
        <td>
          <p>Defines that the command returns immediately without waiting for the task to complete.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Examples

::: example
### Example 1. Performing VeeamZIP Backup to Backup Repository

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

```
$vm = Find-VBRViEntity -Name "Fileserver01"
$rep = Get-VBRBackupRepository -Name "Reports"
Start-VBRZip -BackupRepository $rep -Entity $vm -RunAsync
```

You will need to perform the following steps:

1. Run the [`Find-VBRViEntity`](find-vbrvientity.md) cmdlet to get the VM where VeeamZIP will be started. Specify the `Name` parameter value. Save the result to the `$vm` variable.
2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$rep` variable.
3. Run the `Start-VBRZip` cmdlet. Set the `$vm` variable as the `Entity` parameter value. Set the `$rep` variables as the `BackupRepository` parameter value. Provide the `RunAsync` parameter.

:::

::: example
### Example 2. Performing VeeamZIP Backup to Shared Folder

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.

```
$vm = Find-VBRViEntity -Name "Tech"
$netcreds = Get-VBRCredentials -Name "Shared"
Start-VBRZip -Folder "D:\Repository\VeeamZIP" -Entity $vm -Compression 4 -DisableQuiesce -NetworkCredentials $netcreds -RunAsync
```

You will need to perform the following steps:

1. Run the [`Find-VBRViEntity`](find-vbrvientity.md) cmdlet to get the VM where VeeamZIP will be started. Specify the `Name` parameter value. Save the result to the `$vm` variable.
2. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$netcreds` variable.
3. Run the `Start-VBRZip` cmdlet. Specify the following settings:

   - Specify the `Folder` parameter value. 
   - Set the `$vm` variable as the `Entity` parameter value.
   - Set the `4` value as the `Compression` parameter value.
   - Provide the `DisableQuiesce` parameter.
   - Set the `$netcreds` variable as the `NetworkCredentials` parameter value.
   - Provide the `RunAsync` parameter.

:::

## Related Commands

- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`Get-VBRCredentials`](get-vbrcredentials.md)
- [`Find-VBRViEntity`](find-vbrvientity.md)
- [`Find-VBRHvEntity`](find-vbrhventity.md)