Nombres de parámetros comunes

2021-09-27

Los parámetros descritos en este tema se conocen como parámetros comunes. El tiempo de ejecución de Windows PowerShell los agrega a los cmdlets y el cmdlet no los puede declarar.

Nota

Estos parámetros también se agregan a los cmdlets del proveedor y a las funciones que se decoran con el CmdletBinding atributo .

Parámetros comunes generales

Los parámetros siguientes se agregan a todos los cmdlets y se puede acceder a ellos cada vez que se ejecuta el cmdlet. Estos parámetros se definen mediante la clase System.Management.Automation.Internal.Commonparameters.

Confirm (alias: cf)

Tipo de datos: SwitchParameter

Este parámetro especifica si el cmdlet muestra un mensaje que pregunta si el usuario está seguro de que desea continuar.

Depuración (alias: db)

Tipo de datos: SwitchParameter

Este parámetro especifica si los mensajes de depuración de nivel de programador se pueden mostrar en la línea de comandos. Estos mensajes están diseñados para solucionar problemas del funcionamiento del cmdlet y se generan mediante llamadas al método System.Management.Automation.Cmdlet.WriteDebug. No es necesario localizar los mensajes de depuración.

ErrorAction (alias: ea)

Tipo de datos: Enumeración

Este parámetro especifica qué acción debe tener lugar cuando se produce un error. Los valores posibles para este parámetro se definen mediante la enumeración System.Management.Automation.Actionpreference.

ErrorVariable (alias: ev)

Tipo de datos: cadena

Este parámetro especifica la variable en la que se colocarán los objetos cuando se produzca un error. Para anexar a esta variable, use +varname en lugar de borrar y establecer la variable.

OutBuffer (alias: ob)

Tipo de datos: Int32

Este parámetro define el número de objetos que se almacenarán en el búfer de salida antes de que se pasen objetos por la canalización. De forma predeterminada, los objetos se pasan inmediatamente por la canalización.

OutVariable (alias: ov)

Tipo de datos: cadena

Este parámetro especifica la variable en la que se colocarán todos los objetos de salida generados por el cmdlet . Para anexar a esta variable, use +varname en lugar de borrar y establecer la variable.

PipelineVariable (alias: pv)

Tipo de datos: cadena

Este parámetro almacena el valor del elemento de canalización actual como una variable para cualquier comando con nombre a medida que fluye a través de la canalización.

Detallado (alias: vb)

Tipo de datos: SwitchParameter

Este parámetro especifica si el cmdlet escribe mensajes explicativos que se pueden mostrar en la línea de comandos. Estos mensajes están diseñados para proporcionar ayuda adicional al usuario y se generan mediante llamadas al método System.Management.Automation.Cmdlet.WriteVerbose.

WarningAction (alias: wa)

Tipo de datos: Enumeración

Este parámetro especifica qué acción debe tener lugar cuando el cmdlet escribe un mensaje de advertencia. Los valores posibles para este parámetro se definen mediante la enumeración System.Management.Automation.Actionpreference.

WarningVariable (alias: wv)

Tipo de datos: cadena

Este parámetro especifica la variable en la que se pueden guardar los mensajes de advertencia. Para anexar a esta variable, use +varname en lugar de borrar y establecer la variable.

Risk-Mitigation parámetros

Los parámetros siguientes se agregan a los cmdlets que solicitan confirmación antes de realizar su acción. Para obtener más información sobre las solicitudes de confirmación, vea Solicitar confirmación. Estos parámetros se definen mediante la clase System.Management.Automation.Internal.Shouldprocessparameters.

WhatIf (alias: wi)

Tipo de datos: SwitchParameter

Este parámetro especifica si el cmdlet escribe un mensaje que describe los efectos de ejecutar el cmdlet sin realizar realmente ninguna acción.

Parámetros de transacción

El parámetro siguiente se agrega a los cmdlets que admiten transacciones. Estos parámetros se definen mediante la clase System.Management.Automation.Internal.Transactionparameters. La compatibilidad con transacciones se introdujo en PowerShell 3.0 y se descontinuó en PowerShell 6.0.