- Article
The parameters described in this topic are referred to as common parameters. They're added tocmdlets by the PowerShell runtime and can't be declared by the cmdlet.
Note
These parameters are also added to provider cmdlets and to functions that are decorated with theCmdletBinding attribute.
General Common Parameters
The following parameters are added to all cmdlets and can be accessed whenever the cmdlet is run.These parameters are defined by the CommonParameters class.
Debug (alias: db)
Data type: SwitchParameter
This parameter specifies whether programmer-level debugging messages that can be displayed at thecommand line. These messages are intended for troubleshooting the operation of the cmdlet, and aregenerated by calls to the WriteDebug method. Debug messages don't need to be localized.
ErrorAction (alias: ea)
Data type: Enumeration
This parameter specifies what action should take place when an error occurs. The possible values forthis parameter are defined by the ActionPreference enumeration.
ErrorVariable (alias: ev)
Data type: String
This parameter specifies the variable in which to place objects when an error occurs. To append tothis variable, use +varname rather than clearing and setting the variable.
InformationAction (alias: infa)
Data type: Enumeration
This parameter specifies what action should take place when output is sent to the Informationstream. The possible values for this parameter are defined by the ActionPreferenceenumeration.
InformationVariable (alias: iv)
Data type: String
This parameter specifies the variable in which to save output objects written to the Informationstream. To append to this variable, use +varname rather than clearing and setting the variable.
OutBuffer (alias: ob)
Data type: Int32
This parameter defines the number of objects to store in the output buffer before any objects arepassed down the pipeline. By default, objects are passed immediately down the pipeline.
OutVariable (alias: ov)
Data type: String
This parameter specifies the variable in which to place all output objects generated by the cmdlet.To append to this variable, use +varname rather than clearing and setting the variable.
PipelineVariable (alias: pv)
Data type: String
This parameter stores the value of the current pipeline element as a variable for any named commandas it flows through the pipeline.
ProgressAction (alias: proga)
Data type: Enumeration
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider,such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
Verbose (alias: vb)
Data type: SwitchParameter
This parameter specifies whether the cmdlet writes explanatory messages that can be displayed at thecommand line. These messages are intended to provide additional help to the user, and are generatedby calls to the WriteVerbose method.
WarningAction (alias: wa)
Data type: Enumeration
This parameter specifies what action should take place when the cmdlet writes a warning message. Thepossible values for this parameter are defined by the ActionPreference enumeration.
WarningVariable (alias: wv)
Data type: String
This parameter specifies the variable in which warning messages can be saved. To append to thisvariable, use +varname rather than clearing and setting the variable.
Risk-Mitigation Parameters
The following parameters are added to cmdlets that requests confirmation before they perform theiraction. For more information about confirmation requests, see Requesting Confirmation. Theseparameters are defined by the ShouldProcessParameters class.
Confirm (alias: cf)
Data type: SwitchParameter
This parameter specifies whether the cmdlet displays a prompt that asks if the user is sure thatthey want to continue.
WhatIf (alias: wi)
Data type: SwitchParameter
This parameter specifies whether the cmdlet writes a message that describes the effects of runningthe cmdlet without actually performing any action.
Transaction Parameters
The following parameter is added to cmdlets that support transactions. These parameters are definedby the TransactionParameters class.
Transaction support was introduced in PowerShell 3.0 and discontinued in PowerShell 6.0.
UseTransaction (alias: usetx)
Data type: SwitchParameter
This parameter specifies whether the cmdlet uses the current transaction to perform its action.
