Configuring Common Parameters

In this article

    After you create a custom script step, you can set a list of default parameters for script execution. Orchestrator already includes a number of out-of-the-box common default parameters that you can configure as described in section Configuring Parameter Settings:

    Important

    To allow the script to run inside the guest OS of a processed VM, it is required that you have Microsoft PowerShell 3.0 and .Net Framework 4.0 installed on each VM for which you enable this step.

     

    Parameter

    Description

    Default Value

    Critical Step

    Defines whether the step is critical for VM recovery.

    If you mark the step as Critical, its failure for a VM from a critical VM group will halt the plan.

    No

    Execute Location

    Defines whether the script will run on the Veeam Backup & Replication server, on the Orchestrator server or in-guest of the VM.

    Veeam Backup Server

    Windows Credentials

    Credentials required to gain access to the in-guest OS.

    Note: Applies only if the Execute Location parameter value is set to In-Guest OS.

    Timeout

    Maximum amount of time (in seconds) for the step to execute.

    300

    Retries

    Number of retries that will be attempted if the step fails on the first try.

    10

    Failback & Undo Failover Action

    Defines whether the step will be executed during the Failback and Undo Failover operations.

    Skip

    Test Action

    Defines whether the step will be executed during plan testing in a DataLab.

    Skip

    To specify credentials that the script will use to run within the guest OS of a processed VM, follow the instructions provided in section Configuring Windows Credentials Parameter.