Set-VBRScriptProcessingOptions

In this article

    Short Description

    Modifies pre-freeze and post-thaw scripts settings for Veeam Agent backup jobs.

    Applies to

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

    Syntax

    Set-VBRScriptProcessingOptions -Options <VBRScriptProcessingOptions> [-Credentials <CCredentials>][-ProcessingAction <VBRGeneralProcessingAction> {DisableCompletely | IgnoreFailures | RequireSuccess}][-ScriptPrefreezeCommand <string>] [-ScriptPostthawCommand <string>][<CommonParameters>]

    Detailed Description

    This cmdlet modifies pre-freeze and post-thaw scripts settings for the protected computer OS quiescence. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Options

    Specifies script processing options that you want to modify.

    Accepts the VBRScriptProcessingOptions type.

    True

    Named

    False

     

    ProcessingAction

    Specifies script processing settings.

    • DisableCompletely: use this option if you do not want to run scripts.
    • IgnoreFailures: use this option if you want to continue the backup process even if script errors occur.
    • RequireSuccess: use this option if you want Veeam Backup & Replication to stop the backup process if the script fails.

    NOTE: The IgnoreFailures option does not work for Veeam Agent backup jobs that back up Linux computers. Use the RequireSuccess option to enable script execution for these types of jobs.

    False

    Named

    False

     

    Credentials

    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.

    By default, Veeam Agent for Microsoft Windows will use the credentials that you specified for the protection group.

    NOTE: This option works for Veeam Agent jobs that back up Windows computers only.

    False

    Named

    False

     

    ScriptPrefreezeCommand

    Specifies the path on your backup server to a local folder with the pre-freeze script.

    False

    Named

    False

     

    ScriptPostthawCommand

    Specifies the path on your backup server to a local folder with the post-thaw script.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example

    This example shows how to modify the existing script processing settings for a Veeam Agent job that backs up Windows computers.

    1. Run New-VBRScriptProcessingOptions to specify the script settings. Save the result to the $script variable.
    2. Run Set-VBRScriptProcessingOptions with the $script variable. Specify the RequireSuccess value for the ProcessingAction parameter to stop the job in case the script fails.

    $script = New-VBRScriptProcessingOptions -ProcessingAction IgnoreFailures -ScriptPrefreezeCommand "C:\script\pre-script.bat" -ScriptPostthawCommand "C:\script\post-script.bat"

    Set-VBRScriptProcessingOptions -Options $script -ProcessingAction RequireSuccess

    Related Commands

    New-VBRScriptProcessingOptions