---
title: "New-VBRScriptProcessingOptions"
description: "Creates pre-freeze and post-thaw scripts settings for Veeam Agent backup jobs. Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet creates the VBRScriptProcessingOptions object."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrscriptprocessingoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Agent Management > Working with Veeam Agent Backup Jobs and Policies > Veeam Agent Job Guest Processing Options > New-VBRScriptProcessingOptions"
dateModified: "2026-08-19"
---

# New-VBRScriptProcessingOptions

## Short Description
Creates pre-freeze and post-thaw scripts settings for Veeam Agent backup jobs.

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

## Syntax
```
New-VBRScriptProcessingOptions [-Credentials <CCredentials>] -ProcessingAction <VBRGeneralProcessingAction>
 [-ScriptPrefreezeCommand <String>] [-ScriptPostthawCommand <String>] [-ScriptPreJobCommand <String>]
 [-ScriptPostJobCommand <String>] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates the `VBRScriptProcessingOptions` object. This object contains pre-freeze and post-thaw scripts settings for the protected computer OS quiescence. You can use these scripts to create consistent backups of the protected computers that do not support Microsoft VSS.

For more information about custom scripts, see the [Pre-Freeze and Post-Thaw Scripts](https://helpcenter.veeam.com/docs/vbr/userguide/agent_job_vss_scripts.html?ver=13) section of the Veeam Agent Management Guide.

## 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">Credentials</span></p>
        </td>
        <td>
          <p>Specifies the user account credentials with local administrator privileges on the VM guest OS. Veeam Backup & Replication will use these credentials to run pre-freeze and post-thaw scripts.</p><p>By default, Veeam Agent for Microsoft Windows will use the credentials that you specified for the protection group.</p><p><strong>Note</strong>: this option works for Veeam Agent jobs that back up Windows computers only.</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">ProcessingAction</span></p>
        </td>
        <td>
          <p>Specifies script processing settings:</p><ul><li><code>IgnoreFailures</code>: use this option if you want to continue the backup process even if script errors occur.</li><li><code>RequireSuccess</code>: use this option if you want Veeam Backup & Replication to stop the backup process if the scripts fail.</li><li><code>DisableCompletely</code>: use this option if you do not want to run scripts.</li></ul><p><strong>Note</strong>: The <code>IgnoreFailures</code> option does not work for Veeam Agent jobs that back up Linux computers. Use the <code>RequireSuccess</code> option to enable script execution for these types of jobs.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRGeneralProcessingAction</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">ScriptPostJobCommand</span></p>
        </td>
        <td>
          <p>Specifies a post-freeze script.</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">ScriptPostthawCommand</span></p>
        </td>
        <td>
          <p>Specifies the path on your backup server to a local folder with the post-thaw script.</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">ScriptPrefreezeCommand</span></p>
        </td>
        <td>
          <p>Specifies the path on your backup server to a local folder with the pre-freeze script.</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">ScriptPreJobCommand</span></p>
        </td>
        <td>
          <p>Specifies a post-thaw script.</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>
    </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
This cmdlet returns the `VBRScriptProcessingOptions` object that contains pre-freeze and post-thaw scripts settings for Veeam Agent backup jobs.

## Examples

::: example
### Example 1. Creating Script Processing Settings for Veeam Agent Backup Job (Linux)

This command creates script processing settings for a Veeam Agent job that backs up Linux computers. The job will run with the following options:

- Veeam Backup & Replication will run the pre-freeze script before the job starts to quiesce the protected computer OS.
- Veeam Backup & Replication will run the post-thaw script after the snapshot is created to bring the protected computer back to the initial state.

```
New-VBRScriptProcessingOptions -ProcessingAction RequireSuccess -ScriptPrefreezeCommand "C:\scripts\pre-script.bat" -ScriptPostthawCommand "C:\scripts\post-script.bat"
```

:::

::: example
### Example 2. Creating Script Processing Settings for Veeam Agent Backup Job (Windows)

This example shows how to create script processing settings for a Veeam Agent job that backs up Windows computers. The job will run with the following options:

- Veeam Backup & Replication will use the user account credentials to run pre-freeze and post-thaw scripts.
- Veeam Backup & Replication will continue to run the job even if scripts fail.

```
$creds = Get-VBRCredentials
New-VBRScriptProcessingOptions -ProcessingAction IgnoreFailures -ScriptPrefreezeCommand "C:\script\pre-script.bat" -ScriptPostthawCommand "C:\script\post-script.bat" -Credentials $creds
```

Perform the following steps:

1. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Save the result to the `$creds` variable.
2. Run the `New-VBRScriptProcessingOptions` cmdlet. Specify the following settings:

   - Set the `IgnoreFailures` option for the `ProcessingAction` parameter.
   - Specify the `ScriptPrefreezeCommand` parameter value.
   - Specify the `ScriptPostthawCommand` parameter value.
   - Set the `$creds` variable as the `Credentials` parameter value.

:::

## Related Commands

[`Get-VBRCredentials`](get-vbrcredentials.md)