---
title: "Start-VBRIrisInstanceRestore"
description: "This cmdlet starts restore of an InterSystems IRIS instance from a backup restore point. You can restore the instance to its original location or to another server."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/start-vbririsinstancerestore.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 > Start-VBRIrisInstanceRestore"
dateModified: "2026-08-19"
---

# Start-VBRIrisInstanceRestore

## Short Description
Starts restore of InterSystems IRIS instances.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>OriginalLocation (Default)</code></p>

```
Start-VBRIrisInstanceRestore -RestorePoint <Object> [-PathMapping <VBRIrisInstancePathMappingRule[]>] [-Force]
 [-RunAsync] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>RestoreToAnotherLocation</code></p>

```
Start-VBRIrisInstanceRestore -RestorePoint <Object> -ServerName <String> -ServerCredentials <CCredentials>
 [-PathMapping <VBRIrisInstancePathMappingRule[]>] [-Force] [-RunAsync] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet starts restore of an InterSystems IRIS instance from a backup restore point. You can restore the instance to its original location or to another server.

## 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">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will overwrite the data in non-empty target paths.</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">PathMapping</span></p>
        </td>
        <td>
          <p>Specifies an array of path mapping rules that redirect the InterSystems IRIS instance data to new target paths. If you do not specify this parameter, the cmdlet will restore the data to the original paths.</p><p>Accepts the <a href="vbririsinstancepathmappingrule.md"><code>VBRIrisInstancePathMappingRule[]</code></a> object. To create this object, run the <a href="new-vbririsinstancepathmappingrule.md"><code>New-VBRIrisInstancePathMappingRule</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbririsinstancepathmappingrule.md"><code>VBRIrisInstancePathMappingRule[]</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">RestorePoint</span></p>
        </td>
        <td>
          <p>Specifies the restore point from which you want to restore the InterSystems IRIS instance.</p><p>Accepts the <code>Object</code> object. To get this object, run the <a href="get-vbrsnapshotrestorepoint.md"><code>Get-VBRSnapshotRestorePoint</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>True (ByPropertyName, ByValue)</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>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ServerCredentials</span></p>
        </td>
        <td>
          <p><strong>For the</strong> <code>RestoreToAnotherLocation</code> parameter set. Specifies the credentials to authenticate against the target server.</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>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">ServerName</span></p>
        </td>
        <td>
          <p><strong>For the</strong> <code>RestoreToAnotherLocation</code> parameter set. Specifies the DNS name or IP address of the server to which you want to restore the InterSystems IRIS instance.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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>
    </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 `VBRSession` object that contains the InterSystems IRIS instance restore session.

## Examples

::: example
### Example 1. Restoring an InterSystems IRIS Instance to the Original Location

This example shows how to restore an InterSystems IRIS instance from a storage snapshot to its original location.

```
$rp = Get-VBRSnapshotRestorePoint -ObjectName "IRIS01"
Start-VBRIrisInstanceRestore -RestorePoint $rp[0] -Force
```

Perform the following steps:

1. Run the [`Get-VBRSnapshotRestorePoint`](get-vbrsnapshotrestorepoint.md) cmdlet. Specify the `ObjectName` parameter value. Save the result to the `$rp` variable.
2. Run the `Start-VBRIrisInstanceRestore` cmdlet. Set the `$rp` variable as the `RestorePoint` parameter value. Provide the `Force` parameter.

:::

::: example
### Example 2. Restoring an InterSystems IRIS Instance to Another Server

This example shows how to restore an InterSystems IRIS instance from a storage snapshot to another server and remap its data paths.

```
$rp = Get-VBRSnapshotRestorePoint -ObjectName "IRIS01"
$creds = Get-VBRCredentials -Name "iris\\administrator"
$rule = New-VBRIrisInstancePathMappingRule -OriginalPath "/usr/irissys/mgr" -TargetPath "/mnt/restore/mgr"
Start-VBRIrisInstanceRestore -RestorePoint $rp[0] -ServerName "172.18.21.30" -ServerCredentials $creds -PathMapping $rule -Force
```

Perform the following steps:

1. Run the [`Get-VBRSnapshotRestorePoint`](get-vbrsnapshotrestorepoint.md) cmdlet. Save the result to the `$rp` variable.
2. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Save the result to the `$creds` variable.
3. Run the [`New-VBRIrisInstancePathMappingRule`](new-vbririsinstancepathmappingrule.md) cmdlet. Save the result to the `$rule` variable.
4. Run the `Start-VBRIrisInstanceRestore` cmdlet.

   - Set the `$rp` variable as the `RestorePoint` parameter value.
   - Specify the `ServerName` parameter value.
   - Set the `$creds` variable as the `ServerCredentials` parameter value.
   - Set the `$rule` variable as the `PathMapping` parameter value.
   - Provide the `Force` parameter.

:::

::: example
### Example 3. Restoring an InterSystems IRIS Instance from a NAS Backup to the Original Location

This example shows how to restore an InterSystems IRIS instance from a NAS backup to its original location.

```
$rp = Get-VBRUnstructuredBackupRestorePoint
Start-VBRIrisInstanceRestore -RestorePoint $rp[0]
```

Perform the following steps:

1. Run the [`Get-VBRUnstructuredBackupRestorePoint`](get-vbrunstructuredbackuprestorepoint.md) cmdlet. Save the result to the `$rp` variable.
2. Run the `Start-VBRIrisInstanceRestore` cmdlet. Set the `$rp` variable as the `RestorePoint` parameter value.

:::

::: example
### Example 4. Restoring an InterSystems IRIS Instance from a NAS Backup to Another Server

This example shows how to restore an InterSystems IRIS instance from a NAS backup to another server.

```
$rp = Get-VBRUnstructuredBackupRestorePoint
$creds = Add-VBRCredentials -Type "Linux" -User "root" -Password "Test123!"
Start-VBRIrisInstanceRestore -RestorePoint $rp[0] -ServerName "skorhel1" -ServerCredentials $creds
```

Perform the following steps:

1. Run the [`Get-VBRUnstructuredBackupRestorePoint`](get-vbrunstructuredbackuprestorepoint.md) cmdlet. Save the result to the `$rp` variable.
2. Run the [`Add-VBRCredentials`](add-vbrcredentials.md) cmdlet. Specify the `Type`, `User`, and `Password` parameter values. Save the result to the `$creds` variable.
3. Run the `Start-VBRIrisInstanceRestore` cmdlet.

   - Set the `$rp` variable as the `RestorePoint` parameter value.
   - Specify the `ServerName` parameter value.
   - Set the `$creds` variable as the `ServerCredentials` parameter value.

:::

## Related Commands

- [`Get-VBRSnapshotRestorePoint`](get-vbrsnapshotrestorepoint.md)
- [`Get-VBRCredentials`](get-vbrcredentials.md)
- [`New-VBRIrisInstancePathMappingRule`](new-vbririsinstancepathmappingrule.md)
- [`Get-VBRUnstructuredBackupRestorePoint`](get-vbrunstructuredbackuprestorepoint.md)
- [`Add-VBRCredentials`](add-vbrcredentials.md)