Parámetros

Se aplica a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007

Última modificación del tema: 2007-06-20

La mayoría de los cmdlets se basan en parámetros. Los parámetros son elementos que proporcionan información al cmdlet, ya sea mediante la identificación de un objeto y sus atributos sobre el que actuar o mediante el control de la realización de las tareas del cmdlet. El nombre del parámetro va precedido de un guión (-) y seguido por el valor del parámetro del modo siguiente:

Verb-Noun -ParameterName <ParameterValue> 

En este sencillo ejemplo, el guión delante del nombre del parámetro indica al Shell de administración de Exchange que la palabra que sigue inmediatamente al guión es un parámetro que se pasa al cmdlet y que la siguiente palabra independiente después del parámetro es el valor de dicho parámetro.

Parámetros de posición

Un parámetro de posición es un parámetro que permite especificar su valor sin especificar su nombre. Un parámetro es de posición si el atributo Parameter Position es un entero. Este entero indica la posición en la línea de comandos en que el cmdlet puede buscar el valor del parámetro.

La mayoría de los cmdlets sólo tienen el parámetro de posición Identity. Identity siempre se encuentra en la posición 1 si está disponible en un cmdlet. Si el parámetro no es de posición, se considera un parámetro named. Debe especificar el nombre y el valor del parámetro para los parámetros named.

Los dos comandos siguientes realizan la misma tarea: información de configuración de devolución para un conector de recepción llamado "Contoso".

Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"

Detalles de parámetros

En la sección de información de parámetros recuperada mediante el cmdlet Get-Help se incluyen detalles, llamados también metadatos, sobre cada parámetro. El siguiente ejemplo procede del cmdlet Get-Service.

PARAMETERS
    -ServiceName System.String[]

        Parameter required?           false
        Parameter position?           1
        Default value                 *
        Accept pipeline input?       true
        Accept wildcard characters?  True

Este ejemplo del cmdlet Get-Service incluye algunos detalles muy concretos acerca de los tipos de valores que se pueden pasar para el parámetro ServiceName. No todos los cmdlets incluyen estos detalles. No obstante, la mayoría de los cmdlets incluyen algunas configuraciones para cada parámetro según se describe en la tabla 1.

Tabla 1   Configuraciones de parámetros

Parámetros booleanos

Los parámetros booleanos se usan en el Shell de administración Exchange para determinar si una función u opción está habilitada, $True, o deshabilitada, $False. El valor asignado a un parámetro booleano se almacena en la configuración del objeto que va a modificar. Al suministrar un valor para un parámetro booleano, debe usar los valores $True o 1, o $False o 0. El signo de dólar ($) se debe incluir con $True y $False. Puede que observe que algunos comandos incluyen dos puntos (:) entre el nombre del parámetro booleano y el valor booleano. En los parámetros booleanos, los dos puntos son opcionales. En el siguiente ejemplo se deshabilita el conector de recepción "Contoso.com":

Set-ReceiveConnector "Contoso.com" -Enabled $False

Parámetros modificadores

Los parámetros modificadores se usan en el Shell de administración de Exchange para configurar un estado para la ejecución inmediata de un comando. Este estado no se guarda entre comandos. Los parámetros modificadores son similares a los parámetros booleanos, pero se usan con otros fines y requieren una sintaxis distinta. Los parámetros modificadores no requieren ningún valor. De forma predeterminada, si especifica un parámetro modificador en una línea de comandos sin un valor, el parámetro se evalúa como $True. Los parámetros modificadores, al igual que los parámetros booleanos, sólo aceptan $True o 1, o $False o 0. El signo de dólar ($) se debe incluir con $True y $False. A diferencia de los parámetros booleanos, debe incluir dos puntos (:) entre el nombre del parámetro modificador y el valor del modificador. En el primero de los siguientes ejemplos se indica al Shell de administración de Exchange que muestre una petición de confirmación antes de permitir el inicio de la sincronización de EdgeSync.

Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False

Parámetros comunes

Los parámetros comunes son parámetros que se agregan automáticamente a todos los comandos mediante el Shell de administración de Exchange. Estos parámetros realizan funciones que se pueden usar con o ser usadas por los comandos en las que se ejecutan. En la tabla 2 se incluyen todos los parámetros comunes disponibles en el Shell de administración de Exchange. Hay tres parámetros adicionales, WhatIf, Confirm y ValidateOnly, que también se pueden agregar a los cmdlets. Para obtener más información acerca de estos parámetros adicionales, vea Parámetros WhatIf, Confirm y ValidateOnly.

Tabla 2   Parámetros comunes del Shell de administración de Exchange