Syntax
Gilt für: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Letztes Änderungsdatum des Themas: 2007-02-08
In diesem Thema wird erläutert, wie die Parametersätze der Exchange-Verwaltungsshell und die Beispiele in der Hilfedokumentation von Exchange zu lesen sind und wie ein Befehl formatiert werden muss, damit die Exchange-Verwaltungsshell den Befehl verarbeiten kann. In der Exchange-Verwaltungsshell werden Parametersätze in einem Cmdlet-Hilfethema im Abschnitt zur Verwendung angezeigt. In der Hilfe von Microsoft Exchange Server 2007 werden Parametersätze in dem Cmdlet-Hilfethema im Abschnitt zur Syntax angezeigt.
Weitere Informationen über die Hilfe zu Cmdlets finden Sie unter Zugriff auf die Hilfe.
Befehlskonventionen in der Exchange-Verwaltungsshell
Die Exchange-Verwaltungsshell folgt verschiedenen Befehlskonventionen. Diese helfen Ihnen dabei, zu verstehen, welche Informationen beim Ausführen eines Befehls erforderlich oder optional sind und wie die Parameter und deren Werte angegeben werden müssen. Beispiele für die Darstellung von Parametersätzen in der Hilfe zur Exchange-Verwaltungsshell und in der Hilfe zu Exchange 2007 finden Sie im Abschnitt "Parametersätze" weiter unten in diesem Thema.
Table 1 enthält diese Befehlskonventionen.
Tabelle 1 Befehlskonventionen der Exchange-Verwaltungsshell
Symbol | Beschreibung |
---|---|
- |
Ein Bindestrich gibt an, dass das nächste Wort in der Befehlszeile ein Parameter ist. Der häufigste Parameter lautet Identity. Weitere Informationen zu Parametern finden Sie unter Parameter. |
< > |
Spitze Klammern dienen zum Einschließen von Parameterwerten. Bei diesen Werten kann es sich um Auswahlmöglichkeiten oder Namen handeln. Beispiel: In |
[ ] |
Eckige Klammern dienen zum Einschließen eines optionalen Parameters und dessen Werts. Nicht in eckige Klammern eingeschlossene Parameter und ihre Werte sind erforderlich. |
| |
Wenn das Pipe-Symbol in einer Liste mit Parameterwerten (zum Beispiel |
Diese Befehlskonventionen helfen Ihnen zu verstehen, wie ein Befehl aufgebaut sein sollte. Beim Eingeben von Befehlen in der Befehlszeile geben Sie diese Konventionen nicht mit ein.
Parametersätze
In der Hilfedokumentation von Exchange werden die zugehörigen Parameter aller Cmdlets in Parametersätzen angezeigt. Bei Parametersätzen handelt es sich um Gruppen von Parametern, die zusammen verwendet werden können. Parameter, die nur in einem Parametersatz enthalten sind, schließen sich gegenseitig aus. Sie können nicht zusammen verwendet werden.
Zwar sind für alle Cmdlets Parametersätze vorhanden, viele Cmdlets haben jedoch nur einen einzigen Parametersatz. Diese bedeutet, dass alle Parameter eines solchen Cmdlets miteinander verwendet werden können. Es gibt jedoch auch Cmdlets, die zahlreiche Parametersätze aufweisen. Das folgende Beispiel zeigt die Parametersätze, die für das Cmdlet New-SystemMessage verfügbar sind:
New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false>
-Language <CultureInfo> -Text <String> [-DomainController <String>] [-Templ
ateInstance <MshObject>]
New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailbox
UnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | Warning
PublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSen
dReceiveMailBox> -Text <String> [-DomainController <String>] [-TemplateInst
ance <MshObject>]
Das Cmdlet New-SystemMessage hat zwei Parametersätze. Der erste Parametersatz enthält die Parameter DsnCode und Internal, und der zweite Parametersatz enthält den Parameter QuotaMessageType. Dies bedeutet, dass die Parameter DsnCode und Internal zusammen verwendet werden können. Sie können jedoch nicht zusammen mit dem Parameter QuotaMessageType verwendet werden. Die übrigen Parameter, d. h. Language, Text, DomainController und TemplateInstance sind in beiden Parametersätzen vorhanden. Sie können also zusammen mit den Parametern DsnCode und Internal und auch mit dem Parameter QuotaMessageType verwendet werden.
Parametersätze können darauf hinweisen, dass ein einzelnes Cmdlet mehrere Verwendungsmöglichkeiten hat. Beispielsweise kann das Cmdlet New-SystemMessage verwendet werden, um benutzerdefinierte Benachrichtigungen über den Übermittlungsstatus (Delivery Status Notification, DSN) oder benutzerdefinierte Nachrichten über Grenzwerte für das Postfachkontingent zu konfigurieren. Cmdlets weisen jedoch in der Regel mehrere Parametersätze auf, da unter Umständen ein Parameter eine Funktion ausführt, die mit einem anderen Parameter nicht kompatibel ist. Das folgende Beispiel zeigt die Parametersätze für das Cmdlet New-AddressList:
New-AddressList -Name <String> [-Company <MultiValuedProperty>] [-Container
<AddressListIdParameter>] [-Department <MultiValuedProperty>] [-DisplayNam
e <String>] [-DomainController <String>] [-IncludedRecipients <Nullable>] [
-StateOrProvince <MultiValuedProperty>] [-TemplateInstance <MshObject>]
New-AddressList -Name <String> [-Container <AddressListIdParameter>] [-Disp
layName <String>] [-DomainController <String>] [-RecipientFilter <String>]
[-TemplateInstance <MshObject>]
Im Cmdlet New-AddressList enthält der erste Parametersatz Parameter, mit denen Sie eine neue Adressliste basierend auf der Werten erstellen können, die an die Parameter Company, Department, IncludedRecipients und StateOrProvice übergeben wurden. Eine neue Adressliste kann jedoch auch mithilfe eines benutzerdefinierten Filters erstellt werden, der mit dem Parameter RecipientFilter angegeben wurde. Wenn Sie eine neue Adressliste erstellen, setzt ein mit dem Parameter RecipientFilter angegebener benutzerdefinierter Filter alle Einstellungen außer Kraft, die mit den Parametern aus dem ersten Parametersatz erstellt wurden. Der Parameter RecipientFilter ist daher in einem eigenen Parametersatz enthalten. Exchange 2007 bietet Ihnen nicht die Möglichkeit, beide Parameter in derselben Befehlszeile anzugeben. Ebenso wie bei dem Cmdlet New-SystemMessage können die verbleibenden Parameter, die in beiden Parametersätzen des Cmdlets New-AddressList enthalten sind, in jeder beliebigen Kombination verwendet werden.
Verwenden von Anführungszeichen
Doppelte Anführungszeichen (") werden häufig zum Einschließen eines Werts verwendet, der Leerzeichen enthält, wenn Sie diesen Wert an einen Parameter übergeben. Wenn Sie Contoso Receive Connector
z. B. an den Parameter Name des Cmdlets Set-ReceiveConnector übergeben möchten, müssen Sie Contoso Receive Connector
wie im folgenden Beispiel gezeigt in Anführungszeichen einschließen:
Set-ReceiveConnector -Name "Contoso Receive Connector"
Wenn Sie die Zeichenfolge nicht in Anführungszeichen einschließen, versucht die Exchange-Verwaltungsshell, jedes Wort in dieser Zeichenfolge als neues Argument in der Befehlszeile zu interpretieren und zeigt einen Fehler an.
In der Exchange-Verwaltungsshell besitzen doppelte Anführungszeichen und einfache Anführungszeichen (') eine unterschiedliche Bedeutung. Wenn Sie eine Zeichenfolge in doppelte Anführungszeichen einschließen, ersetzt die Exchange-Verwaltungsshell alle Variablen durch einen passenden Wert. Angenommen, der Wert ServerName
wird z. B. der Variablen $Server
zugewiesen. Dann wird der folgende Befehl in die Befehlszeile eingegeben.
"$Server Example"
Die folgende Ausgabe wird angezeigt:
ServerName Example
Die Variable $Server
wird in der Ausgabe durch den Wert ServerName
ersetzt.
Wenn Sie eine Zeichenfolge in einfache Anführungszeichen einschließen, versucht die Exchange-Verwaltungsshell nicht, Variablen durch passende Werte zu ersetzen. Angenommen, der Wert ServerName
ist noch immer der Variablen $Server
zugewiesen. Dann wird der folgende Befehl in die Befehlszeile eingegeben.
'$Server-Example'
Die folgende Ausgabe wird angezeigt:
$Server-Example
Die Variable $Server
wurde nicht durch einen Wert ersetzt, weil die Exchange-Verwaltungsshell keine Variablen interpretiert, die in Text enthalten sind, der in einfache Anführungszeichen eingeschlossen ist.
Weitere Informationen zu Variablen finden Sie unter Benutzerdefinierte Variablen und Shellvariablen.
Sie möchten ggf. auch Zeichen wie etwa das Dollarzeichen ( $
), doppelte oder einfache Anführungszeichen oder das Graviszeichen ( `
) anzeigen. Diese Zeichen besitzen eine besondere Bedeutung, wenn Sie sie in Exchange-Verwaltungsshell verwenden. Um die Exchange-Verwaltungsshell anzuweisen, diese Zeichen nicht zu interpretieren, sondern anzuzeigen, wenn sie in einer Zeichenfolge enthalten sind, die in doppelte Anführungszeichen eingeschlossen ist, müssen Sie das Graviszeichen als Escapezeichen ( `
) verwenden. Geben Sie z. B. den folgenden Text an der Eingabeaufforderung ein:
"The price is `$23."
Die folgende Ausgabe wird angezeigt:
The price is $23.
Da das Graviszeichen zusammen mit dem Dollarzeichen ( $
) verwendet wurde, interpretiert die Exchange-Verwaltungsshell $
nicht als den Beginn einer Variablen.
Wenn Sie eine Zeichenfolge in einzelne Anführungszeichen einschließen, müssen Sie kein Zeichen durch ein Escapezeichen kennzeichnen. Eine Ausnahme liegt dann vor, wenn ein einzelnes Anführungszeichen in einer Zeichenfolge angezeigt werden soll. Wenn Sie ein einzelnes Anführungszeichen in einer Zeichenfolge anzeigen möchten, die in einzelne Anführungszeichen eingeschlossen ist, müssen Sie zwei einzelne Anführungszeichen ( ''
) verwenden. Geben Sie z. B. Folgendes an der Eingabeaufforderung ein:
'Don''t confuse two single quotation marks with a double quotation mark!'
Die folgende Ausgabe wird angezeigt:
Don't confuse two single quotation marks with a double quotation mark!
Befehlsoperatoren in der Exchange-Verwaltungsshell
Verwenden Sie die Operatoren in Tabelle 2, wenn Sie Befehle in der Exchange-Verwaltungsshell eingeben. Manche Operatoren entsprechen gegebenenfalls einigen der folgenden Befehlskonventionen. Sie haben jedoch nicht dieselbe Bedeutung, wenn sie in die Befehlszeile eingegeben werden. Tabelle 2 enthält die gültigen Operatoren, die in einem Befehl verwendet werden können.
Tabelle 2 Befehlsoperatoren der Exchange-Verwaltungsshell
Operator | Beschreibung |
---|---|
= |
Das Gleichheitszeichen dient als Zuweisungszeichen. Der Wert rechts neben dem Gleichheitszeichen wird der Variablen links neben dem Gleichheitszeichen zugewiesen. Bei den folgenden Zeichen handelt es sich ebenfalls um Zuweisungszeichen:
|
: |
Ein Doppelpunkt kann verwendet werden, um den Namen eines Parameters vom Wert eines Parameters zu trennen. Beispiel: |
! |
Das Ausrufezeichen ist ein logischer NOT-Operator. Wenn es zusammen mit dem Gleichheitszeichen ( = ) verwendet wird, bedeutet diese Kombination "ungleich". |
[ ] |
Eckige Klammern dienen zum Angeben des Indexwerts einer Arrayposition. Beispielsweise verweist Eckige Klammern können auch verwendet werden, um einer Variablen einen Typ zuzuweisen. Beispiel: |
{ } |
Geschweifte Klammern werden verwendet, um einen Ausdruck in einen Befehl einzuschließen. Beispiel: |
| |
Das Pipe-Symbol wird verwendet, wenn ein Cmdlet ein Ergebnis mittels Pipeline an ein anderes Cmdlet übergibt. Beispielsweise übergibt der folgende Befehl die Ergebnisse des Cmdlets Get-Mailbox über eine Pipeline an das Cmdlet Move-Mailbox: |
> |
Die spitze Klammer rechts wird verwendet, um die Ausgabe eines Befehls an eine Datei zu senden. Beispiel: |
>> |
Doppelte spitze Klammern rechts werden verwendet, um die Ausgabe eines Befehls an eine Datei anzufügen, sofern die Datei vorhanden ist. Wenn die Datei nicht vorhanden ist, wird eine neue Datei erstellt. Das folgende Beispiel zeigt, wie doppelte spitze Klammern rechts verwendet werden: |
" " |
Eine Zeichenfolge, die Leerzeichen enthält, wird in Anführungszeichen eingeschlossen. |
$ |
Ein Dollarzeichen gibt eine Variable an. Beispiel: |
@ |
Das @-Symbol verweist auf ein assoziatives Array. Weitere Informationen finden Sie unter Arrays. |
$( ) |
Ein Dollarzeichen ( |
.. |
Doppelte Punkte geben einen Wertebereich an. Wenn beispielsweise ein Array mehrere Indizes enthält, können Sie den folgenden Befehl angeben, um die Werte aller Indizes zwischen dem zweiten und dem fünften Index zurückzugeben. Beispiel: |
+ |
Der Operator + addiert zwei Werte. Beispiel: |
- |
Der Operator - subtrahiert einen Wert von einem anderen Wert. Beispiel: Mit dem Operator - kann auch eine negative Zahl wie beispielsweise |
* |
Ein Platzhalterzeichen hat verschiedene Bedeutungen. Platzhalterzeichen können verwendet werden, um Zeichenfolgen mehreren nummerischen Werten zuzuordnen, oder, wenn Zeichenfolgen und nummerische Werte zusammen verwendet werden, um den Zeichenfolgewert so oft zu wiederholen, wie durch den nummerischen Wert angegeben ist. Beispiel: |
/ |
Der Operator / dividiert einen Wert durch einen anderen. Beispiel: |
% |
Der Operator % gibt den Rest eines Divisionsoperators zurück. Beispiel: |