TEMA
about_CommonParameters
DESCRIPCIÓN BREVE
Describe los parámetros que se pueden utilizar con cualquier cmdlet.
DESCRIPCIÓN DETALLADA
Los parámetros comunes son un conjunto de parámetros de cmdlet
que se pueden utilizar con cualquier cmdlet. Los implementa Windows
PowerShell y no el programador del cmdlet. Están disponibles
automáticamente para cualquier cmdlet.
Los parámetros comunes se pueden utilizar con cualquier cmdlet,
pero puede que no surtan efecto en todos ellos. Por ejemplo,
si un cmdlet no genera ninguna salida detallada, utilizar el
parámetro común Verbose no tendrá ningún efecto.
Varios parámetros comunes invalidan valores predeterminados del
sistema o preferencias establecidas mediante las variables de
preferencia de Windows PowerShell. A diferencia de las variables de
preferencia, los parámetros comunes afectan solamente a los comandos
en los que se utilizan.
Además de los parámetros comunes, muchos cmdlets proporcionan los
parámetros de mitigación de riesgos WhatIf y Confirm. Los cmdlets que
implican riesgos para el sistema o los datos del usuario suelen
proporcionar estos parámetros.
Los parámetros comunes son:
-Verbose
-Debug
-WarningAction
-WarningVariable
-ErrorAction
-ErrorVariable
-OutVariable
-OutBuffer
Los parámetros de mitigación de riesgos son:
-WhatIf
-Confirm
Para obtener más información sobre las variables de preferencia,
escriba:
help about_preference_variables
Descripciones de los parámetros comunes
-Verbose[:{$true | $false}]
Muestra información detallada sobre la operación realizada por el
comando. Esta información se parece a la información de un registro de
seguimiento o de transacciones. Este parámetro funciona solamente
cuando el comando genera un mensaje detallado. Por ejemplo, este parámetro
funciona cuando un comando contiene el cmdlet Write-Verbose.
El parámetro Verbose invalida el valor de la variable
$VerbosePreference para el comando actual. Dado que el valor
predeterminado de la variable $VerbosePreference es SilentlyContinue,
de forma predeterminada no se muestran los mensajes detallados.
Valores válidos:
$true (-Verbose:$true) tiene el mismo efecto que -Verbose.
$false (-Verbose:$false) suprime la presentación de los
mensajes detallados. Este parámetro se utiliza cuando el
valor de $VerbosePreference no es SilentlyContinue (el valor
predeterminado).
-Debug[:{$true | $false}]
Muestra detalles de nivel de programación sobre la operación
realizada por el comando. Este parámetro funciona únicamente
cuando el comando genera un mensaje de depuración. Por
ejemplo, este parámetro funciona cuando un comando contiene
el cmdlet Write-Debug.
El parámetro Debug invalida el valor de la variable
$DebugPreference para el comando actual. Dado que el valor
predeterminado de la variable $DebugPreference es SilentlyContinue,
de forma predeterminada no se muestran los mensajes de depuración.
Valores válidos:
$true (-Debug:$true). Tiene el mismo efecto que -Debug.
$false (-Debug:$false). Suprime la presentación de los
mensajes de depuración cuando el valor de $DebugPreference
no es SilentlyContinue (el valor predeterminado).
-WarningAction[:{SilentlyContinue | Continue | Inquire | Stop}]
Determina cómo responde el cmdlet a una advertencia procedente del comando.
El valor predeterminado es "Continue". Este parámetro funciona
únicamente cuando el comando genera un mensaje de advertencia. Por
ejemplo, este parámetro funciona cuando un comando contiene el cmdlet
Write-Warning.
El parámetro WarningAction invalida el valor de la variable
$WarningPreference para el comando actual. Puesto que el valor
predeterminado de la variable $WarningPreference es Continue, se
muestran las advertencias y la ejecución continúa a menos que se
utilice el parámetro WarningAction.
Valores válidos:
SilentlyContinue. Suprime el mensaje de advertencia y sigue
ejecutando el comando.
Continue. Muestra el mensaje de advertencia y sigue
ejecutando el comando. El valor predeterminado es "Continue".
Inquire. Muestra el mensaje de advertencia y pide
confirmación antes de continuar la ejecución. Casi nunca
se utiliza este valor.
Stop. Muestra el mensaje de advertencia y detiene la
ejecución del comando.
-WarningVariable [+]<nombre-de-variable>
Almacena las advertencias sobre el comando en la variable especificada.
Para anexar las advertencias al contenido de la variable, en
lugar de reemplazar las que puedan estar almacenadas en ella,
se escribe un signo más (+) antes del nombre de la variable.
Por ejemplo, el comando siguiente crea la variable $a y, a
continuación, almacena todas las advertencias en ella:
get-process -id 6 -WarningVariable a
El comando siguiente agrega todas las advertencias a la variable $a:
get-process -id 2 -WarningVariable +a
El comando siguiente muestra el contenido de $a:
$a
Puede utilizar este parámetro para crear una variable que contenga
únicamente las advertencias correspondientes a comandos concretos.
Puede utilizar la notación de matriz, como $a[0] o $warning[1,2] para
hacer referencia a las advertencias concretas que están almacenadas en
la variable.
-ErrorAction[:{SilentlyContinue | Continue | Inquire | Stop)]
Determina cómo responde el cmdlet cuando se produce un error
que no es de terminación. Este parámetro funciona únicamente
cuando el comando genera un mensaje de depuración. Por
ejemplo, este parámetro funciona cuando un comando contiene
el cmdlet Write-Error.
El parámetro ErrorAction invalida el valor de la variable
$ErrorActionPreference para el comando actual. Dado que el valor
predeterminado de la variable $ErrorActionPreference es Continue, se
muestran los mensajes de error y la ejecución continúa a menos que se
utilice el parámetro ErrorAction.
El parámetro ErrorAction no tiene ningún efecto en los errores de
terminación (tales como datos que faltan, parámetros no válidos o
permisos insuficientes) que impiden que un comando se complete
correctamente.
Valores válidos:
SilentlyContinue. Suprime el mensaje de error y sigue
ejecutando el comando.
Continue. Muestra el mensaje de error y sigue ejecutando
el comando. El valor predeterminado es "Continue".
Inquire. Muestra el mensaje de error y pide confirmación
antes de continuar la ejecución. Casi nunca se utiliza
este valor.
Stop. Muestra el mensaje de error y detiene la ejecución
del comando.
-ErrorVariable [+]<nombre-de-variable>
Almacena los mensajes de error del comando en la variable
especificada y en la variable automática $Error. Para obtener más
información, escriba el comando siguiente:
get-help about_automatic_variables
De forma predeterminada, los mensajes de error nuevos
sobrescriben los que ya están almacenados en la variable.
Para anexar el mensaje de error al contenido de la variable,
se escribe un signo más (+) antes del nombre de la variable.
Por ejemplo, el comando siguiente crea la variable $a y, a
continuación, almacena todos los errores en ella:
get-process -id 6 -ErrorVariable a
El comando siguiente agrega todos los mensajes de error a la
variable $a:
get-process -id 2 -ErrorVariable +a
El comando siguiente muestra el contenido de $a:
$a
Este parámetro se puede utilizar para crear una variable que
contenga solamente mensajes de error de comandos concretos.
La variable automática $Error contiene los mensajes de error
de todos los comandos de la sesión.
Se puede utilizar la notación de matriz, como $a[0] o
$error[1,2] para hacer referencia a errores concretos
almacenados en las variables.
-OutVariable [+]<nombre-de-variable>
Almacena objetos de salida del comando en la variable
especificada y los muestra en la línea de comandos.
Para agregar la salida a la variable en lugar de reemplazar
lo que ya está almacenado en ella, se escribe un signo más
(+) antes del nombre de la variable.
Por ejemplo, el comando siguiente crea la variable $out y
almacena el objeto de proceso en ella:
get-process powershell -OutVariable out
El comando siguiente agrega el objeto de proceso a la
variable $out:
get-process iexplore -OutVariable +out
El comando siguiente muestra el contenido de la variable $out:
$out
-OutBuffer <Int32>
Determina el número de objetos para que se acumularán en un búfer
antes de enviarlos a través de la canalización. Si se omite este
parámetro, los objetos se envían a medida que se generan.
Este parámetro de administración de recursos está diseñado
para usuarios expertos.
Cuando se utiliza este parámetro, Windows PowerShell no llama
al próximo cmdlet de la canalización hasta que el número de
objetos generados sea igual al valor de OutBuffer + 1. A partir de
entonces, envía todos los objetos a medida que se generan.
Descripciones de los parámetros de administración de riesgos
-WhatIf[:{$true | $false}]
Muestra un mensaje en el que se describe el efecto del
comando en lugar de ejecutar el comando.
El parámetro WhatIf invalida el valor de la variable
$WhatIfPreference para el comando actual. Dado que el valor
predeterminado de la variable $WhatIfPreference es 0 (deshabilitado), el
comportamiento de WhatIf no se lleva a cabo si no está presente el
parámetro WhatIf. Para obtener más información, escriba el comando
siguiente:
get-help about_preference_variables
Valores válidos:
$true (-WhatIf:$true). Tiene el mismo efecto que -WhatIf.
$false (-WhatIf:$false). Suprime el comportamiento
automático de WhatIf que se produce cuando el valor de la
variable $WhatIfPreference es 1.
Por ejemplo, el comando siguiente utiliza el parámetro WhatIf
en un comando Remove-Item:
PS> remove-item date.csv -whatif
En lugar de quitar el elemento, Windows PowerShell hace una
lista de las operaciones que realizaría y de los elementos
que se verían afectados. Este comando genera la salida siguiente:
Whatif: Realizando la operación "Quitar archivo" en el destino
"C:\ps-test\date.csv".
-Confirm[:{$true | $false}]
Solicita confirmación antes de ejecutar el comando.
El parámetro Confirm invalida el valor de la variable
$ConfirmPreference para el comando actual. El valor
predeterminado es High. Para obtener más información, escriba
el comando siguiente:
get-help about_preference_variables
Valores válidos:
$true (-WhatIf:$true). Tiene el mismo efecto que -Confirm.
$false(-Confirm:$false). Suprime la confirmación
automática que se produce cuando el valor de $ConfirmPreference
es menor o igual que el riesgo estimado del cmdlet.
Por ejemplo, el comando siguiente utiliza el parámetro
Confirm con un comando Remove-Item. Antes de quitar el
elemento, Windows PowerShell muestra una lista de las
operaciones que realizaría y de los elementos que se verían
afectados, y pide autorización para ello.
PS C:\ps-test> remove-item tmp*.txt -confirm
Este comando genera la salida siguiente:
Confirmar
¿Está seguro de que desea realizar esta acción?
Realizando operación "Quitar archivo" en el destino " C:\ps-
test\tmp1.txt [S] Sí [O] Sí a todo [N] No [T] No a todo [S]
Suspender
[?] Ayuda (el valor predeterminado es "S"):
VEA TAMBIÉN
about_Preference_Variables
Write-Debug
Write-Warning
Write-Error
Write-Verbose