PowerShell Write-Host VS. Write-Output

In PowerShell könnt ihr ja Text mit dem Cmdlet Write-Host ausgeben. Aber es wird teilweise davon abgeraten das zu verwenden. Es gibt zum Beispiel die Alternative Write-Output. In diesem Post erkläre ich euch die Unterschiede.

🎬 Ich habe übrigens auch ein Video zu dem Thema erstellt.

Write-Host

Write-Host gibt Daten auf dem PowerShell Host aus, dem Programm, welches die aktuelle PowerShell Sitzung hostet. Oft ist das der ConsoleHost, aber z.B. die PowerShell ISE oder Visual Studio Code verwenden eigene Hosts, die sich in manchen Aspekten voneinander unterscheiden.

Write-Host kann die Art und Weise beeinflussen, wie die Daten vom PowerShell Host ausgegeben werden. Zum Beispiel kann mit -ForegroundColor die Textfarbe und mit -BackgroundColor die Hintergrundfarbe angepasst werden. Also wenn ihr ein Skript interaktiv in einer Konsole ausführt, dann kann Write-Host durchaus nützlich sein um eine ansprechendere Ausgabe zu ermöglichen. Ein ganz großer Nachteil ist allerdings: Daten die per Write-Host ausgegeben werden, können dann nicht in der Pipeline weiterverarbeitet werden.

Also das Ergebnis kann z.B. nicht in eine Variable gespeichert werden:

1
2
3
4
5

$Variable = Write-Host "Hallo PowerShell"
# Rückgabe: Hallo PowerShell

$Variable
# = keine sichtbare Rückgabe

Und auch nicht an andere Cmdlets gepiped werden:

1
2

Write-Host "C:\temp" | Get-ChildItem
# Rückgabe: C:\temp (und nicht der Inhalt von C:\temp !)

Write-Output

Write-Output hingegen kann weiterverarbeitet werden:

1
2
3
4
5
6

$Variable = Write-Output "Hallo PowerShell"
$Variable
# Rückgabe: Hallo PowerShell

Write-Output "C:\temp" | Get-ChildItem
# Rückgabe: < Inhalt von C:\temp ... >

Dafür fehlen dann aber die Möglichkeiten zur Formatierung, die Write-Host hat.

Wann was verwenden?

Es ist vorteilhaft die Unterschiede zwischen Write-Host und Write-Output zu kennen und zu nutzen. Also z.B. wenn ihr in einem Skript die Rückgabe von einem ScriptBlock wie z.B. aus einer Schleife in eine Variable speichert, dann würden Ausgaben per Write-Output höchstwahrscheinlich euer Ergebnis-Array mit unnötigen Einträgen verunreinigen. Wenn ihr dann aber Write-Host verwendet, dann könnt ihr eine Ausgabe erzeugen, ohne dass diese im Ergebnis-Array landet.

1
2
3
4
5
6

$Ps1Files = Get-ChildItem *.ps1 -Recurse
$Ergebnis = foreach($File in $Ps1Files) {
    $File.FullName # Das wird an die Schleife ausgegeben
    Write-Host "$($File.Name)" -NoNewLine -ForeGroundColor Yellow
    Write-Host " gefunden..."
}

Oder wenn ihr ein Skript in Azure Automation ausführt, dann landen Ausgaben die per Write-Host erzeugt werden nicht in den Logs. Wenn ihr Skripte für Azure Automation erzeugt, dann müsst ihr also Write-Output statt Write-Host verwenden.

1
2
3
4
5

# Azure Automation Beispielcode
Write-Output "Azure Automation verwendet übrigens einen weiteren PowerShell Host"
Get-Host

Write-Host "Ausgaben per Write-Host sind in Azure Automation nicht sichtbar"

Write-Output ist eigentlich optional

Wenn ihr jetzt denkt, dass tendenziell Write-Output zu bevorzugen ist: Ihr müsst eigentlich auch nicht mal Write-Output verwenden. Ihr könnt nämlich auch einfach direkt euer gewünschtes Objekt - sei es aus einer Variable oder einem Cmdlet oder sonst wie - im Code referenzieren und dann wird es ausgegeben. Also vorteilhaft ist dann vielleicht nur, dass ein kleines bisschen einfacher ersichtlich ist “Hey hier wird ganz bewusst eine Ausgabe im Code erzeugt”.

1
2

Write-Output "Hallo :)"
# Rückgabe: Hallo :)

Hinweis zu Output Streams

Abgesehen von Write-Output und Write-Host gibt es auch noch weitere Ausgabe Cmdlets, wie z.B. Write-Information, Write-Error, Write-Warning und so weiter. Ihr könntet damit Ausgaben erzeugen und sie in verschiedene Output Streams leiten. Die Person die das Skript dann am Ende ausführt kann dann selbst entscheiden welche Infos (sprich: welche Streams) sie sehen möchte. Interessanterweise schreibt Write-Host nicht nur direkt in den Konsolenhost, sondern auch in den Information Stream. Wenn ihr mehr zu dem Thema wissen wollt, dann schaut mal dieses Video hier zu PowerShell Output Streams an.

Fazit

Zusammengefasst würde ich sagen: Write-Host gibt Infos vorallem visuell aus für den User in der Konsole. Write-Output ist unabhängig davon und gibt Infos innerhalb der PowerShell Pipeline weiter. Wenn Write-Output der letzte Befehl in einer Pipeline ist, dann wird die Info sichtbar ausgegeben und kann dann durch andere Logging-Funktionalitäten besser aufgefangen werden.