Optional PowerShell Parameters

This section describes the common and risk management parameters, which are standard with Windows PowerShell, that you can use with all the Zerto cmdlets.

The common and risk management parameters affect only the commands in which they are used.

The following table lists the common parameters.

Parameter Description Default Value Position
Debug Displays programmer-level detail about the operation performed by the command. This parameter works only when the command generates a debugging message, for example, when a command contains the Write-Debug cmdlet. true named
ErrorAction Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a debugging message, for example, when a command contains the Write-Error cmdlet. Continue named
ErrorVariable Stores error messages about the command in the specified variable and in the $Error automatic variable. named
OutBuffer Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. Objects are sent through the pipeline as they are generated. named
OutVariable Stores output objects from the command in the specified variable and displays it at the command line.   named
Verbose Displays detailed information about the operation performed by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message, for example, when a command contains the Write-Verbose cmdlet. true named
WarningAction Determines how the cmdlet responds to a warning from the command. This parameter works only when the command generates a warning message, for example, when a command contains the Write-Warning cmdlet. Continue named
WarningVariable Stores warnings about the command in the specified variable. named

The following table lists the risk management parameters.

Parameter Description Default Value Position
Confirm Prompts for confirmation before executing the command. true named
WhatIf Displays a message that describes the effect of the command, instead of executing the command. true named

For more details about both the common and risk management parameters, refer to the Windows PowerShell Help.