Common Parameter Names
The parameters described in this topic are referred to as common parameters. They are added to cmdlets by the Windows PowerShell runtime and cannot be declared by the cmdlet.
Note
These parameters are also added to provider cmdlets and to functions that are decorated with the
CmdletBinding 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 System.Management.Automation.Internal.Commonparameters class.
Confirm (alias: cf)
Data type: SwitchParameter
This parameter specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.
Debug (alias: db)
Data type: SwitchParameter
This parameter specifies whether programmer-level debugging messages that can be displayed at the command line. These messages are intended for troubleshooting the operation of the cmdlet, and are generated by calls to the System.Management.Automation.Cmdlet.WriteDebug method. Debug messages do not 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 for this parameter are defined by the System.Management.Automation.Actionpreference enumeration.
ErrorVariable (alias: ev)
Data type: String
This parameter specifies the variable in which to place objects when an error occurs. 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 are passed 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 command as it flows through the pipeline.
Verbose (alias: vb)
Data type: SwitchParameter
This parameter specifies whether the cmdlet writes explanatory messages that can be displayed at the command line. These messages are intended to provide additional help to the user, and are generated by calls to the System.Management.Automation.Cmdlet.WriteVerbose method.
WarningAction (alias: wa)
Data type: Enumeration
This parameter specifies what action should take place when the cmdlet writes a warning message. The possible values for this parameter are defined by the System.Management.Automation.Actionpreference enumeration.
WarningVariable (alias: wv)
Data type: String
This parameter specifies the variable in which warning messages can be saved. To append to this variable, 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 their action. For more information about confirmation requests, see Requesting Confirmation. These parameters are defined by the System.Management.Automation.Internal.Shouldprocessparameters class.
WhatIf (alias: wi)
Data type: SwitchParameter
This parameter specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.
Transaction Parameters
The following parameter is added to cmdlets that support transactions. These parameters are defined by the System.Management.Automation.Internal.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 will use the current transaction to perform its action.
See Also
System.Management.Automation.Internal.Commonparameters
System.Management.Automation.Internal.Shouldprocessparameters
System.Management.Automation.Internal.Transactionparameters
Feedback
Submit and view feedback for