THEMA
about_CommonParameters
KURZBESCHREIBUNG
Beschreibt die Parameter, die mit jedem Cmdlet verwendet werden
können.
DETAILBESCHREIBUNG
Die allgemeinen Parameter bilden einen Satz von Cmdlet-Parametern,
den Sie mit jedem Cmdlet verwenden können. Diese werden von
Windows PowerShell, nicht vom Cmdlet-Entwickler, implementiert,
und sie sind für jedes Cmdlet automatisch verfügbar.
Die allgemeinen Parameter können Sie mit jedem Cmdlet verwenden,
doch haben diese nicht in jedem Fall Auswirkungen auf alle
Cmdlets. Wenn z. B. von einem Cmdlet keine ausführliche Ausgabe
generiert wird, hat der allgemeine Verbose-Parameter keine
Auswirkungen.
Mehrere allgemeine Parameter überschreiben Systemstandards oder
Einstellungen, die Sie mit den Windows PowerShell-Einstellungs-
variablen festgelegt haben. Im Gegensatz zu den Einstellungsvariablen
wirken sich die allgemeinen Parameter auf nur die Befehle aus, in
denen sie verwendet werden.
Zusätzlich zu den allgemeinen Parametern bieten viele Cmdlets den
WhatIf-Risikominderungsparameter und den -Risikominderungsparameter.
Solche Parameter werden meist von Cmdlets geboten, die Risiken
für das System für oder Benutzerdaten darstellen.
Die gängigsten Parameter sind folgende:
-Verbose
-Debug
-WarningAction
-WarningVariable
-ErrorAction
-ErrorVariable
-OutVariable
-OutBuffer
Folgende Risikominderungsparameter sind verfügbar:
-WhatIf
-Confirm
Weitere Informationen zu Einstellungsvariablen finden Sie, indem
Sie Folgendes eingeben:
help about_preference_variables
Beschreibungen allgemeiner Parameter
-Verbose[:{$true | $false}]
Zeigt ausführliche Informationen zu dem Vorgang an, der mit
dem Befehl ausgeführt wird. Diese Informationen ähneln den
Informationen in einem Ablaufverfolgungs- oder Transaktions-
protokoll. Dieser Parameter kann nur verwendet werden, wenn vom
Befehl eine ausführliche Meldung generiert wird.
Beispielsweise kann dieser Parameter verwendet werden, wenn
ein Befehl das Cmdlet "Write-Verbose" enthält.
Der Verbose-Parameter überschreibt den Wert der Variablen
"$VerbosePreference" für den aktuellen Befehl. Da der Standardwert
der Variablen "$VerbosePreference" "SilentlyContinue" lautet, werden
ausführliche Meldungen standardmäßig nicht angezeigt.
Gültige Werte:
$true (-Verbose:$true) hat die gleichen Auswirkungen wie
-Verbose.
$false (-Verbose:$false) unterdrückt die Anzeige
ausführlicher Meldungen. Verwenden Sie diesen Parameter,
wenn der Wert von $VerbosePreference nicht
"SilentlyContinue" (Standard) ist.
-Debug[:{$true | $false}]
Zeigt Details auf Programmierebene zu dem Vorgang an, der vom
Befehl ausgeführt wird. Dieser Parameter kann nur verwendet
werden, wenn vom Befehl eine Debugmeldung generiert wird.
Beispielsweise kann dieser Parameter verwendet werden, wenn
ein Befehl das Cmdlet "Write-Debug" enthält.
Der Debug-Parameter überschreibt den Wert der Variablen
"$DebugPreference" für den aktuellen Befehl. Da der
Standardwert der Variablen "$DebugPreference" "SilentlyContinue"
lautet, werden Debugmeldungen standardmäßig nicht angezeigt.
Gültige Werte:
$true (-Debug:$true). Hat die gleichen Auswirkungen wie
-Debug.
$false (-Debug:$false). Unterdrückt die Anzeige von
Debugmeldungen, wenn der Wert vom $DebugPreference nicht
"SilentlyContinue" (Standard) ist.
-WarningAction[:{SilentlyContinue | Continue | Inquire | Stop}]
Bestimmt, wie das Cmdlet auf eine Warnung im Befehl reagiert.
Der Standardwert ist "Continue". Dieser Parameter kann nur
verwendet werden, wenn vom Befehl eine Warnmeldung generiert
wird. Beispielsweise kann dieser Parameter verwendet werden,
wenn ein Befehl das Cmdlet "Write-Warning" enthält.
Der WarningAction-Parameter überschreibt den Wert der Variablen
"$WarningPreference" für den aktuellen Befehl. Da der Standardwert
der Variablen "$WarningPreference" "Continue" ist, werden Warnungen
angezeigt, und die Ausführung wird fortgesetzt, sofern Sie nicht den
WarningAction-Parameter verwenden.
Gültige Werte:
SilentlyContinue. Unterdrückt die Warnmeldung und setzt
die Ausführung des Befehls fort.
Continue. Zeigt die Warnmeldung an und setzt die
Ausführung des Befehls fort. Der Standardwert ist "Continue".
Inquire. Zeigt die Warnmeldung an und fordert Sie vor dem
Fortsetzen der Ausführung zum Bestätigen auf. Dieser Wert
wird selten verwendet.
Stop. Zeigt die Warnmeldung an und beendet die Ausführung
des Befehls.
-WarningVariable [+]<Variablenname>
Speichert Warnungen zum Befehl in der angegebenen Variable.
Wenn Sie die Warnungen an den Variableninhalt anfügen
möchten, anstatt bereits dort gespeicherte Warnungen zu
ersetzen, geben Sie vor dem Variablennamen ein Pluszeichen
(+) ein.
Beispielsweise wird mit dem folgenden Befehl die Variable
"$a" erstellt, und sämtliche Warnungen werden darin gespeichert:
get-process -id 6 -WarningVariable a
Mit dem folgenden Befehl werden alle Warnungen der Variablen
"$a" hinzugefügt:
get-process -id 2 -WarningVariable +a
Mit dem folgenden Befehl wird der Inhalt von $a angezeigt:
$a
Mit diesem Parameter können Sie eine Variable erstellen, die nur
Warnungen aus bestimmten Befehlen enthält. Für Verweise auf bestimmte
in der Variablen gespeicherte Warnungen können Sie die Arraynotation
verwenden, z. B. "$a[0]" oder "$warning[1,2]".
-ErrorAction[:{SilentlyContinue | Continue | Inquire | Stop)]
Bestimmt, wie das Cmdlet auf einen Fehler ohne Abbruch im
Befehl reagiert. Dieser Parameter kann nur verwendet werden,
wenn vom Befehl eine Debugmeldung generiert wird.
Beispielsweise kann dieser Parameter verwendet werden, wenn
ein Befehl das Cmdlet "Write-Error" enthält.
Der ErrorAction-Parameter überschreibt den Wert der Variablen
"$ErrorActionPreference" für den aktuellen Befehl. Da der
Standardwert der Variablen "$ErrorActionPreference" "Continue" ist,
werden Fehlermeldungen angezeigt, und die Ausführung wird
fortgesetzt, sofern Sie nicht den ErrorAction-Parameter verwenden.
Der ErrorAction-Parameter hat keine Auswirkungen auf Fehler
mit Abbruch (z. B. fehlende Daten, ungültige Parameter oder
ungenügende Berechtigungen), die den erfolgreichen Abschluss
eines Befehls verhindern.
Gültige Werte:
SilentlyContinue. Unterdrückt die Fehlermeldung und setzt
die Ausführung des Befehls fort.
Continue. Zeigt die Fehlermeldung an und setzt die
Ausführung des Befehls fort. Der Standardwert ist "Continue".
Inquire. Zeigt die Fehlermeldung an und fordert Sie vor dem
Fortsetzen der Ausführung zum Bestätigen auf. Dieser Wert
wird selten verwendet.
Stop. Zeigt die Fehlermeldung an und beendet die
Ausführung des Befehls.
-ErrorVariable [+]<Variablenname>
Speichert Fehlermeldungen zum Befehl in der angegebenen
Variable und in der automatischen Variablen "$Error". Geben
Sie den folgenden Befehl ein, um weitere Informationen zu
erhalten:
get-help about_automatic_variables
Standardmäßig überschreiben neue Fehlermeldungen andere
Fehlermeldungen, die bereits in der Variable gespeichert
sind. Wenn Sie die Fehlermeldung an den Variableninhalt
anfügen möchten, geben Sie vor dem Variablennamen ein
Pluszeichen (+) ein.
Beispielsweise wird mit dem folgenden Befehl die Variable
"$a" erstellt, und sämtliche Fehler werden darin gespeichert:
get-process -id 6 -ErrorVariable a
Mit dem folgenden Befehl werden sämtliche Fehlermeldungen der
Variablen "$a" hinzugefügt:
get-process -id 2 -ErrorVariable +a
Mit dem folgenden Befehl wird der Inhalt von $a angezeigt:
$a
Mit diesem Parameter können Sie eine Variable erstellen, die nur
Fehlermeldungen aus bestimmten Befehlen enthält. Die automatische
Variable "$Error" enthält Fehlermeldungen aus allen Befehlen in der
Sitzung.
Für Verweise auf bestimmte in den Variablen gespeicherte
Fehler können Sie die Arraynotation verwenden, z. B. "$a[0]" oder
"$error[1,2]".
-OutVariable [+]<Variablenname>
Speichert Ausgabeobjekte des Befehls in der angegebenen
Variablen und zeigt diese in der Befehlszeile an.
Wenn Sie die Ausgabe der Variablen hinzufügen möchten,
anstatt bereits dort gespeicherte Ausgaben zu ersetzen, geben
Sie vor dem Variablennamen ein Pluszeichen (+) ein.
Beispielsweise wird mit dem folgenden Befehl die Variable "$out"
erstellt, und das Prozessobjekt wird darin gespeichert:
get-process powershell -OutVariable out
Mit dem folgenden Befehl wird das Prozessobjekt der Variablen
"$out" hinzugefügt:
get-process iexplore -OutVariable +out
Mit dem folgenden Befehl wird der Inhalt der Variablen "$out"
angezeigt:
$out
-OutBuffer <Int32>
Bestimmt die Anzahl der Objekte, die in einem Puffer
akkumuliert werden, bevor Objekte über die Pipeline übergeben
werden. Wenn Sie diesen Parameter weglassen, werden Objekte
gesendet, sobald sie generiert wurden.
Dieser Ressourcenverwaltungsparameter ist für fortgeschrittene
Benutzer vorgesehen.
Wenn Sie diesen Parameter verwenden, ruft Windows PowerShell
das nächste Cmdlet in der Pipeline erst auf, wenn die Anzahl
der generierten Objekte gleich OutBuffer+1 ist. Danach werden
sämtliche Objekte gesendet, sobald sie generiert wurden.
Beschreibungen von Risikoverwaltungsparametern
-WhatIf[:{$true | $false}]
Zeigt eine Meldung an, in der die Auswirkungen des Befehls
beschrieben werden, statt den Befehl auszuführen.
Der WhatIf-Parameter überschreibt den Wert der Variablen
"$WhatIfPreference" für den aktuellen Befehl. Da der
Standardwert der Variablen "$WhatIfPreference" 0
(deaktiviert) ist, wird das WhatIf-Verhalten nicht ohne den
WhatIf-Parameter ausgeführt. Geben Sie den folgenden Befehl
ein, um weitere Informationen zu erhalten:
get-help about_preference_variables
Gültige Werte:
$true (-WhatIf:$true). Hat die gleichen Auswirkungen wie
-WhatIf.
$false (-WhatIf:$false). Unterdrückt das automatische
Verhalten von WhatIf, das ausgeführt wird, wenn der Wert
der Variablen "$WhatIfPreference" 1 ist.
Beispielsweise verwendet der folgende Befehl den
WhatIf-Parameter im Befehl "Remove-Item":
PS> remove-item date.csv -whatif
Statt das Element zu entfernen, führt Windows PowerShell die
potenziell auszuführenden Vorgänge sowie die dann betroffenen
Elemente auf. Dieser Befehl erzeugt die folgende Ausgabe:
WhatIf: Ausführen des Vorgangs "Datei entfernen" für das
Ziel "C:\ps-test\date.csv".
-Confirm[:{$true | $false}]
Fordert Sie vor der Ausführung des Befehls zum Bestätigen auf.
Der Confirm-Parameter überschreibt den Wert der Variablen
"$ConfirmPreference" für den aktuellen Befehl. Der
Standardwert lautet "High". Geben Sie den folgenden Befehl
ein, um weitere Informationen zu erhalten:
get-help about_preference_variables
Gültige Werte:
$true (-WhatIf:$true). Hat die gleichen Auswirkungen wie
-Confirm.
$false(-Confirm:$false). Unterdrückt die automatische
Bestätigung, die erfolgt, wenn der Wert der Variablen
"$ConfirmPreference" kleiner oder gleich dem geschätzten
Risiko des Cmdlet ist.
Beispielsweise verwendet der folgende Befehl den
Confirm-Parameter mit dem Befehl "Remove-Item". Vor dem
Entfernen des Elements führt Windows PowerShell die potenziell
auszuführenden Vorgänge sowie die dann betroffenen Elemente
auf und fordert Sie zum Bestätigen auf.
PS C:\ps-test> remove-item tmp*.txt -confirm
Dieser Befehl erzeugt die folgende Ausgabe:
Bestätigung
Möchten Sie diese Aktion wirklich ausführen?
Ausführen des Vorgangs "Datei entfernen" für das Ziel "C:\ps-test\tmp1.txt
[Y] Ja [A] Ja, alle [N] Nein [L] Nein, keine [S] Anhalten
[?] Hilfe (Standard ist "Y"):
SIEHE AUCH
about_Preference_Variables
Write-Debug
Write-Warning
Write-Error
Write-Verbose