Parameter

Gilt für: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007

Letztes Änderungsdatum des Themas: 2007-06-20

Die meisten Cmdlets basieren auf Parametern. Parameter sind Elemente, die einem Cmdlet Informationen bereitstellen, die entweder ein Objekt und dessen zugehörigen Attribute identifizieren, für die eine Aktion durchzuführen ist, oder die die Durchführung des Tasks durch das Cmdlet steuern. Parameternamen ist ein Bindestrich (-) vorgestellt, nach dem Namen folgt der Parameterwert. Beispiel:

Verb-Noun -ParameterName <ParameterValue> 

In diesem einfachen Beispiel gibt der Bindestrich vor dem Parameternamen der Exchange-Verwaltungsshell an, dass das unmittelbar auf den Bindestrich folgende Wort ein Parameter ist, der an das Cmdlet übergeben wird und dass das nächste getrennte Wort nach dem Parameter der Parameterwert ist.

Positionsparameter

Bei einem Positionsparameter handelt es sich um einen Parameter, mit dem Sie den Parameterwert ohne Angabe des Parameternamens angeben können. Ein Parameter ist ein Positionsparameter, wenn das Attribut Parameter Position eine ganze Zahl ist. Diese ganze Zahl gibt die Position in der Befehlszeile an, an der das Cmdlet den Parameterwert finden kann.

Die meisten Cmdlets verfügen lediglich über einen Positionsparameter, den Parameter Identity. Identity befindet sich stets an Position 1, wenn er in einem Cmdlet verfügbar ist. Wenn ein Parameter kein Positionsparameter ist, handelt es sich um einen named-Parameter. Für named-Parameter müssen Sie den Parameternamen und -wert angeben.

Die folgenden zwei Befehle führen dieselbe Aufgabe aus: Sie geben Konfigurationsinformationen für einen Empfangsconnector namens "Contoso" zurück.

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

Parameterdetails

Im Parameterabschnitt der Informationen, die vom Cmdlet Get-Help abgerufen werden, sind Details zu den einzelnen Parametern enthalten, auch Metadaten genannt. Das folgende Beispiel stammt aus dem Cmdlet Get-Service.

PARAMETERS
    -ServiceName System.String[]

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

In diesem Beispiel enthält das Cmdlet Get-Service einige sehr spezifische Details über die Werttypen, die für den Parameter ServiceName übergeben werden können. Nicht alle Cmdlets enthalten solche Details. Die meisten Cmdlets jedoch enthalten einige Einstellungen für alle Parameter (siehe Tabelle 1).

Tabelle 1   Parametereinstellungen

Boolesche Parameter

Boolesche Parameter werden in der Exchange-Verwaltungsshell verwendet, um festzustellen, ob eine Funktion oder Option aktiviert ($True) oder deaktiviert ($False) ist. Der einem booleschen Parameter zugewiesene Wert wird in der Konfiguration des Objekts gespeichert, das Sie ändern. Wenn Sie einen Wert für einen booleschen Parameter bereitstellen, müssen Sie die Werte $True oder 1 bzw. $False oder 0 verwenden. Bei $True und $False muss das Dollarzeichen ($) angegeben werden. Bei einigen Befehlen wird ein Doppelpunkt (:) zwischen dem Namen und dem Wert des booleschen Parameters eingefügt. Bei booleschen Parametern ist dieser Doppelpunkt optional. Im folgenden Beispiel wird der Empfangsconnector Contoso.com deaktiviert:

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

Schalterparameter

Schalterparameter werden in der Exchange-Verwaltungsshell verwendet, um einen Status für die unmittelbare Ausführung eines Befehls festzulegen. Dieser Status wird zwischen den Befehlen nicht gespeichert. Schalterparameter ähneln booleschen Parametern, dienen jedoch einem anderen Zweck und erfordern eine andere Syntax. Für Schalterparameter ist kein Wert erforderlich. Geben Sie einen Schalterparameter in einer Befehlszeile ohne Wert ein, wird dieser standardmäßig mit $True ausgewertet. Wie boolesche Parameter akzeptieren Schalterparameter nur die Werte $True oder 1 bzw. $False oder 0. Bei $True und $False muss das Dollarzeichen ($) angegeben werden. Im Gegensatz zu booleschen Parametern müssen Sie einen Doppelpunkt (:) zwischen dem Namen des Schalterparameters und dem Schalterwert einfügen. Im ersten der folgenden Beispiele wird die Exchange-Verwaltungsshell angewiesen, vor dem Starten einer EdgeSync-Synchronisierung eine Bestätigungsaufforderung anzuzeigen. Im zweiten Beispiel wird die Exchange-Verwaltungsshell angewiesen, keine Bestätigungsaufforderung anzuzeigen, bevor der Empfangsconnector Contoso.com gelöscht wird:

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

Allgemeine Parameter

Bei allgemeinen Parametern handelt es sich um Parameter, die von der Exchange-Verwaltungsshell automatischen allen Befehlen hinzugefügt werden. Diese Parameter führen Funktionen aus, die mit oder von den Befehlen verwendet werden können, mit denen sie ausgeführt werden. In Tabelle 2 werden alle allgemeinen Parameter aufgeführt, die in der Exchange-Verwaltungsshell zur Verfügung stehen. Die drei zusätzlichen Parameter WhatIf, Confirm und ValidateOnly können Cmdlets ebenfalls hinzugefügt werden. Weitere Informationen zu diesen zusätzlichen Parametern finden Sie unter Parameter "WhatIf", "Confirm" und "ValidateOnly".

Tabelle 2   Allgemeine Parameter in der Exchange-Verwaltungsshell