---
title: "Add-VBRIrisBackupJob"
description: "This cmdlet creates InterSystems IRIS application backup policies. For application backup policies, you must specify the discovered InterSystems IRIS instances or a protection group that you plan to back up and the target location for storing..."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbririsbackupjob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Plug-Ins for Enterprise Applications, MongoDB Backup and Epic EHR System Protection > Working with Managed Veeam Plug-Ins, MongoDB Backup and Epic EHR System Protection > Application Backup Policy Settings for InterSystems IRIS > Add-VBRIrisBackupJob"
dateModified: "2026-08-19"
---

# Add-VBRIrisBackupJob

## Short Description
Creates InterSystems IRIS application backup policies.

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

## Syntax
```
Add-VBRIrisBackupJob [-Name <String>] [-Description <String>] -BackupObject <Object[]>
 [-ExcludedObject <VBRDiscoveredIris[]>] [-SourceBackup <VBRUnstructuredBackup>]
 [-BackupProxy <VBRNASProxyServer[]>] -BackupRepository <CBackupRepository> [-RetentionPolicy <Int32>]
 [-EnableSnapshotImmutability] [-EnableSnapshotRetention] [-SnapshotRetentionPeriod <Int32>]
 [-SnapshotImmutabilityPeriod <Int32>] [-StorageOptions <VBRStorageOptions>]
 [-ProcessingOptions <VBRIrisProcessingOptions[]>] [-HealthCheckOptions <VBRHealthCheckOptions>]
 [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-EnableSchedule]
 [-ScheduleOptions <VBRServerScheduleOptions>] [-GfsOptions <VBRComputerGFSOptions>] [-EnableGFSRetention] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates InterSystems IRIS application backup policies.

For application backup policies, you must specify the discovered InterSystems IRIS instances or a protection group that you plan to back up and the target location for storing backups. To create application backup policies, do the following:

1. Run one of the following cmdlets:

   1. Run the [`Get-VBRProtectionGroup`](get-vbrprotectiongroup.md) cmdlet to get the protection group.
   2. Run the [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md) cmdlet to get the discovered InterSystems IRIS instance.

2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet to get the repository.
3. Run the `Add-VBRIrisBackupJob` cmdlet to create the application backup policy.

## 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">BackupObject</span></p>
        </td>
        <td>
          <p>Specifies an array of discovered InterSystems IRIS instances and protection groups. The cmdlet will add these entities to the application backup policy.</p><p>Accepts the <code>Object[]</code> object. To get this object, run the <a href="get-vbrdiscoveredapplication.md"><code>Get-VBRDiscoveredApplication</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>Object[]</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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">BackupProxy</span></p>
        </td>
        <td>
          <p>Specifies an array of backup proxies that you want to use with the application backup policy. If you do not specify this parameter, Veeam Backup & Replication will automatically select backup proxies.</p><p>Accepts the <code>VBRNASProxyServer[]</code> object. To get this object, run the <a href="get-vbrnasproxyserver.md"><code>Get-VBRNASProxyServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrnasproxyserver.md"><code>VBRNASProxyServer[]</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">BackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the target backup location for the application backup policy.</p><p><strong>Note</strong>: You can select a storage system as a repository to create a snap-only InterSystems IRIS backup job. Alternatively, you can select a Veeam Backup & Replication backup repository to create an InterSystems IRIS NAS backup job.</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>True</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">Description</span></p>
        </td>
        <td>
          <p>Specifies the description of the application backup policy.</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">EnableGFSRetention</span></p>
        </td>
        <td>
          <p>Enables the GFS (grandfather-father-son) retention policy for the application backup policy. Use the <code>GfsOptions</code> parameter to specify the GFS retention policy.</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">EnableSchedule</span></p>
        </td>
        <td>
          <p>Enables the option to schedule the application backup policy to run on a regular basis.</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">EnableSnapshotImmutability</span></p>
        </td>
        <td>
          <p>Enables immutability for snapshots created by the application backup policy. Use the <code>SnapshotImmutabilityPeriod</code> parameter to specify the immutability period.</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">EnableSnapshotRetention</span></p>
        </td>
        <td>
          <p>Enables a separate retention policy for snapshots created by the application backup policy. Use the <code>SnapshotRetentionPeriod</code> parameter to specify the snapshot retention period.</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">ExcludedObject</span></p>
        </td>
        <td>
          <p>Specifies an array of discovered InterSystems IRIS instances that you want to exclude from the application backup policy.</p><p>Accepts the <code>VBRDiscoveredIris[]</code> object. To get this object, run the <a href="get-vbrdiscoveredapplication.md"><code>Get-VBRDiscoveredApplication</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRDiscoveredIris[]</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">GfsOptions</span></p>
        </td>
        <td>
          <p>Specifies GFS (grandfather-father-son) retention policy settings for the application backup policy.</p><p>Accepts the <code>VBRComputerGFSOptions</code> object. To create this object, run the <a href="new-vbrcomputergfsoptions.md"><code>New-VBRComputerGFSOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSOptions</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">HealthCheckOptions</span></p>
        </td>
        <td>
          <p>Defines the health check schedule options for the application backup policy.</p><p>Accepts the <code>VBRHealthCheckOptions</code> object. To create this object, run the <a href="new-vbrhealthcheckoptions.md"><code>New-VBRHealthCheckOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRHealthCheckOptions</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">Name</span></p>
        </td>
        <td>
          <p>Specifies the name that you want to assign to the application backup policy.</p><p><strong>Note</strong>: If you do not specify this parameter, the cmdlet will assign a default name to the application backup policy.</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">NotificationOptions</span></p>
        </td>
        <td>
          <p>Specifies notification settings for the application backup policy.</p><p>Accepts the <code>VBRNotificationOptions</code> object. To create this object, run the <a href="new-vbrnotificationoptions.md"><code>New-VBRNotificationOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrnotificationoptions.md"><code>VBRNotificationOptions</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">ProcessingOptions</span></p>
        </td>
        <td>
          <p>Specifies processing settings for the discovered InterSystems IRIS instances added to the application backup policy.</p><p>Accepts the <a href="vbririsprocessingoptions.md"><code>VBRIrisProcessingOptions[]</code></a> object. To create this object, run the <a href="new-vbririsprocessingoptions.md"><code>New-VBRIrisProcessingOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbririsprocessingoptions.md"><code>VBRIrisProcessingOptions[]</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">RetentionPolicy</span></p>
        </td>
        <td>
          <p>Specifies the number of restore points that you want to keep on the backup repository.</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">ScheduleOptions</span></p>
        </td>
        <td>
          <p>Specifies the settings for the application backup policy schedule.</p><p>Accepts the <code>VBRServerScheduleOptions</code> object. To create this object, run the <a href="new-vbrserverscheduleoptions.md"><code>New-VBRServerScheduleOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRServerScheduleOptions</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">ScriptOptions</span></p>
        </td>
        <td>
          <p>Specifies pre-job and post-job script options for the application backup policy.</p><p>Accepts the <code>VBRJobScriptOptions</code> object. To create this object, run the <a href="new-vbrjobscriptoptions.md"><code>New-VBRJobScriptOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrjobscriptoptions.md"><code>VBRJobScriptOptions</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">SnapshotImmutabilityPeriod</span></p>
        </td>
        <td>
          <p><strong>For the</strong> <code>EnableSnapshotImmutability</code> parameter. Specifies the number of days during which snapshots remain immutable.</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">SnapshotRetentionPeriod</span></p>
        </td>
        <td>
          <p><strong>For the</strong> <code>EnableSnapshotRetention</code> parameter. Specifies the number of days during which Veeam Backup & Replication retains snapshots.</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">SourceBackup</span></p>
        </td>
        <td>
          <p>Specifies a backup that you want to map to the application backup policy. The cmdlet will use this backup as a seed for the new policy.</p><p>Accepts the <code>VBRUnstructuredBackup</code> object. To get this object, run the <a href="get-vbrunstructuredbackup.md"><code>Get-VBRUnstructuredBackup</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrunstructuredbackup.md"><code>VBRUnstructuredBackup</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">StorageOptions</span></p>
        </td>
        <td>
          <p>Specifies storage optimization settings for the application backup policy.</p><p>Accepts the <code>VBRStorageOptions</code> object. To create this object, run the <a href="new-vbrstorageoptions.md"><code>New-VBRStorageOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRStorageOptions</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).

## Output Object
The cmdlet returns the [`VBRIrisBackupJob`](vbririsbackupjob.md) object that contains the InterSystems IRIS application backup policy.

## Examples

::: example
### Example 1. Creating an InterSystems IRIS Backup Policy for a Discovered Instance

This example shows how to set up an InterSystems IRIS application backup policy for a single discovered instance.

```
$iris = Get-VBRDiscoveredApplication -Iris -IrisEntityType IrisInstance
$backupRepo = Get-VBRBackupRepository -Name 'BackupRepo1'
Add-VBRIrisBackupJob -Name "IRIS Backup Job" -BackupObject $iris[0] -BackupRepository $backupRepo
```

Perform the following steps:

1. Run the [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md) cmdlet. Specify the `Iris` and `IrisEntityType` parameter values. Save the result to the `$iris` variable.

   The [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md) cmdlet will return an array of discovered InterSystems IRIS instances. Mind the ordinal number of the necessary instance. An array starts with 0. In this example, it is the first instance in the array.

2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$backupRepo` variable.
3. Run the `Add-VBRIrisBackupJob` cmdlet.

   - Specify the `Name` parameter with the name of the application backup policy.
   - Specify the `BackupObject` parameter value with the `$iris` variable.
   - Specify the `BackupRepository` parameter value with the `$backupRepo` variable.

:::

::: example
### Example 2. Creating an InterSystems IRIS Backup Policy for a Protection Group

This example shows how to set up an InterSystems IRIS application backup policy for a protection group.

```
$pg = Get-VBRProtectionGroup -Name "IRIS Servers"
$backupRepo = Get-VBRBackupRepository -Name 'BackupRepo1'
Add-VBRIrisBackupJob -Name "IRIS Backup Job" -BackupObject $pg -BackupRepository $backupRepo
```

Perform the following steps:

1. Run the [`Get-VBRProtectionGroup`](get-vbrprotectiongroup.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$pg` variable.
2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$backupRepo` variable.
3. Run the `Add-VBRIrisBackupJob` cmdlet.

   - Specify the `Name` parameter with the name of the application backup policy.
   - Specify the `BackupObject` parameter value with the `$pg` variable.
   - Specify the `BackupRepository` parameter value with the `$backupRepo` variable.

:::

## Related Commands

- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md)
- [`Get-VBRProtectionGroup`](get-vbrprotectiongroup.md)