PowerShell PSDefaultParameterValues

Schauen wir uns genauer an, wie man einen Standardwert festlegt.

$PSDefaulParameterValues.Add("Command:Parameter","Value")

Wie Sie sehen können, fügen wir einfach einen neuen Schlüssel zur Hashtabelle hinzu und geben das Cmdlet und den Parameter an, für den ein Standardwert festgelegt werden soll, getrennt durch ein : .

Der Wert muss natürlich von einem Typ sein, der vom Parameter akzeptiert wird, sonst erhalten Sie Fehler bei der Verwendung des Cmdlets.
Ein konkretes Beispiel wäre die Angabe eines benutzerdefinierten Trennzeichens für Write-Host.

# Default PS> Write-Host "Hello","World" 
Hello World 
# Ergänzen der benutzerdefinierten Vorgabe 
PS> $PSDefaultParameterValues.Add("Write-Host:Separator", "`n") 
# Geänderte Ausgabe 
PS> Write-Host "Hello","World" 
Hello 
World

Wir bleiben beim Verbose-Parameter aus dem vorherigen Beispiel und können ihn mit Platzhaltern für alle Cmdlets festlegen. Dies ist ein nützlicher Trick, den ich häufig zum Debuggen meiner Scripts verwende.

PS> $PSDefaultParameterValues.Add("*:Verbose", $true)

Anstelle eines statischen Werts ist es möglich, einen Scriptblock als Vorgabe für einen Parameter zu verwenden. Dies ermöglicht ein extremes Maß an Anpassung in Abhängigkeit von Systemzuständen wie dem Host, auf dem Sie sich befinden, dem aktuellen Verzeichnis und vielem mehr.

Um bei unserem Verbosität-Beispiel von vorhin zu bleiben, könnten wir das Verhalten von einer Variable $verbose abhängig machen.

PS> $PSDefaultParameterValues.Add("*:Verbose", {$verbose -eq $true})

Jetzt können wir die standardmäßige Verbosität unserer Sitzung durch Setzen und Entfernen einer Variable steuern. Denken Sie daran, dass dieser Scriptblock jedes Mal ausgeführt wird, wenn Sie das Cmdlet verwenden, also halten Sie ihn schnell.

Sie können ihn wie folgt messen:

PS> Measure-Command {$verbose -eq $true} | ft
Days Hours Minutes Seconds Milliseconds
---- ----- ------- ------- ------------
0    0     0       0       0

Alles, was wir bis jetzt gemacht haben, bleibt nicht zwischen Sitzungen bestehen. Damit die Standardwerte dies tun, müssen Sie sie zu Ihrem Profil hinzufügen. Um alle Vorgaben zu finden, die Sie in der aktuellen Sitzung hinzugefügt haben, fragen Sie einfach die Historie wie folgt ab.

Get-History | Where-Object CommandLine -like "`$PSDEfaultParameterValues*"

Sie fragen sich vielleicht, warum das nützlich sein soll, lassen Sie es mich an einem kurzen Beispiel zeigen.

Angenommen, Sie exportieren immer Daten in CSV-Dateien, die jemand in Excel öffnen soll. Wenn er einfach auf Ihre CSV-Datei doppelklickt, wird das Ergebnis nicht besonders gut sein.

Abb. 1: Importierte Daten in Excel, bei denen die Trennzeichen anzeigt werden

Die meisten von uns würden dann einfach eine neue Excel-Datei öffnen und die Daten mit „Daten > Aus Text“ importieren, sich durch die Fülle von Bildschirmfenstern klicken und Excel so konfigurieren, dass es das Trennzeichen tatsächlich erkennt.

Abb. 2: Manuell editierter Daten-Import

Es gibt aber einen besseren Weg! Anstatt nur CSV zu exportieren:

Get-Process -Name Microsoft* | Export-Csv msproc.csv

können Sie ein benutzerdefiniertes Trennzeichen angeben und dabei Typinformationen und Klammern entfernen:

Get-Process -Name Microsoft* | Export-Csv bettermsproc.csv -Delimiter ";"
-NoTypeInformation -NoClobber

Jetzt wird beim Importieren, Exportieren, Konvertieren von und Konvertieren nach CSV das Trennzeichen ; verwendet und keine Typinformationen oder Klammern sind enthalten.

Wenn Sie die resultierende CSV-Datei direkt mit Excel öffnen, sehen Sie ein Ergebnis, das dem des Datenimport-Tanzes ähnelt, den wir vorher gemacht haben.

Abb. 3: Daten-Import nach Konfiguration mit PowerShell

Aber immer diese Parameter abzutippen ist umständlich und hat eine hohe Fehlertoleranz.
An dieser Stelle kommen die Standardwerte ins Spiel

$PSDefaultParams.Add("Export-Csv:Delimiter", ";")
$PSDefaultParams.Add("Export-Csv:NoTypeInformation", $true)
$PSDefaultParams.Add("Export-Csv:NoClobber", $true)

Damit können wir zurückgehen und einfach Export-Csv verwenden und die resultierende Datei wird in Excel genau wie erwartet geöffnet.
Wir könnten sogar noch einen Schritt weiter gehen und diese Parameter für alle Cmdlets in der CSV-Familie mithilfe von Platzhaltern ändern.

$PSDefaultParams.Add("*-Csv:Delimiter", ";")
$PSDefaultParams.Add("*-Csv:NoTypeInformation", $true)
$PSDefaultParams.Add("*-Csv:NoClobber", $true)