1- ---
1+ ---
2+ document type : cmdlet
23external help file : Microsoft.PowerShell.Commands.Utility.dll-Help.xml
4+ HelpUri : https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/write-host?view=powershell-5.1&WT.mc_id=ps-gethelp
35Locale : en-US
46Module Name : Microsoft.PowerShell.Utility
5- ms.date : 04/01/2026
6- online version : https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/write-host?view=powershell-5.1&WT.mc_id=ps-gethelp
7- schema : 2.0.0
7+ ms.date : 08/11/2026
8+ PlatyPS schema version : 2024-05-01
89title : Write-Host
910---
1011
1112# Write-Host
1213
1314## SYNOPSIS
15+
1416Writes customized output to a host.
1517
1618## SYNTAX
1719
20+ ### __ AllParameterSets
21+
1822```
19- Write-Host [[-Object] <Object>] [-NoNewline] [-Separator <Object>]
20- [-ForegroundColor <ConsoleColor>] [- BackgroundColor <ConsoleColor>] [<CommonParameters>]
23+ Write-Host [[-Object] <Object>] [-NoNewline] [-Separator <Object>] [-ForegroundColor <ConsoleColor>]
24+ [-BackgroundColor <ConsoleColor>] [<CommonParameters>]
2125```
2226
2327## DESCRIPTION
@@ -140,15 +144,35 @@ Specifies the background color. There is no default. The acceptable values for t
140144
141145``` yaml
142146Type : System.ConsoleColor
143- Parameter Sets : (All)
144- Aliases :
145- Accepted values : Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
146-
147- Required : False
148- Position : Named
149- Default value : None
150- Accept pipeline input : False
151- Accept wildcard characters : False
147+ DefaultValue : None
148+ SupportsWildcards : false
149+ Aliases : []
150+ ParameterSets :
151+ - Name : (All)
152+ Position : Named
153+ IsRequired : false
154+ ValueFromPipeline : false
155+ ValueFromPipelineByPropertyName : false
156+ ValueFromRemainingArguments : false
157+ DontShow : false
158+ AcceptedValues :
159+ - Black
160+ - DarkBlue
161+ - DarkGreen
162+ - DarkCyan
163+ - DarkRed
164+ - DarkMagenta
165+ - DarkYellow
166+ - Gray
167+ - DarkGray
168+ - Blue
169+ - Green
170+ - Cyan
171+ - Red
172+ - Magenta
173+ - Yellow
174+ - White
175+ HelpMessage : ' '
152176` ` `
153177
154178### -ForegroundColor
@@ -174,15 +198,35 @@ Specifies the text color. There is no default. The acceptable values for this pa
174198
175199` ` ` yaml
176200Type: System.ConsoleColor
177- Parameter Sets: (All)
178- Aliases:
179- Accepted values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
180-
181- Required: False
182- Position: Named
183- Default value: None
184- Accept pipeline input: False
185- Accept wildcard characters: False
201+ DefaultValue: None
202+ SupportsWildcards: false
203+ Aliases: []
204+ ParameterSets:
205+ - Name: (All)
206+ Position: Named
207+ IsRequired: false
208+ ValueFromPipeline: false
209+ ValueFromPipelineByPropertyName: false
210+ ValueFromRemainingArguments: false
211+ DontShow: false
212+ AcceptedValues:
213+ - Black
214+ - DarkBlue
215+ - DarkGreen
216+ - DarkCyan
217+ - DarkRed
218+ - DarkMagenta
219+ - DarkYellow
220+ - Gray
221+ - DarkGray
222+ - Blue
223+ - Green
224+ - Cyan
225+ - Red
226+ - Magenta
227+ - Yellow
228+ - White
229+ HelpMessage: ''
186230` ` `
187231
188232# ## -NoNewline
@@ -192,14 +236,19 @@ newlines are inserted between the output strings. No newline is added after the
192236
193237` ` ` yaml
194238Type: System.Management.Automation.SwitchParameter
195- Parameter Sets: (All)
196- Aliases:
197-
198- Required: False
199- Position: Named
200- Default value: None
201- Accept pipeline input: False
202- Accept wildcard characters: False
239+ DefaultValue: None
240+ SupportsWildcards: false
241+ Aliases: []
242+ ParameterSets:
243+ - Name: (All)
244+ Position: Named
245+ IsRequired: false
246+ ValueFromPipeline: false
247+ ValueFromPipelineByPropertyName: false
248+ ValueFromRemainingArguments: false
249+ DontShow: false
250+ AcceptedValues: []
251+ HelpMessage: ''
203252` ` `
204253
205254# ## -Object
@@ -208,14 +257,19 @@ Objects to display in the host.
208257
209258` ` ` yaml
210259Type: System.Object
211- Parameter Sets: (All)
212- Aliases:
213-
214- Required: False
215- Position: 0
216- Default value: None
217- Accept pipeline input: True (ByValue)
218- Accept wildcard characters: False
260+ DefaultValue: None
261+ SupportsWildcards: false
262+ Aliases: []
263+ ParameterSets:
264+ - Name: (All)
265+ Position: 0
266+ IsRequired: false
267+ ValueFromPipeline: true
268+ ValueFromPipelineByPropertyName: false
269+ ValueFromRemainingArguments: true
270+ DontShow: false
271+ AcceptedValues: []
272+ HelpMessage: ''
219273` ` `
220274
221275# ## -Separator
@@ -224,21 +278,26 @@ Specifies a separator string to insert between objects displayed by the host.
224278
225279` ` ` yaml
226280Type: System.Object
227- Parameter Sets: (All)
228- Aliases:
229-
230- Required: False
231- Position: Named
232- Default value: None
233- Accept pipeline input: False
234- Accept wildcard characters: False
281+ DefaultValue: None
282+ SupportsWildcards: false
283+ Aliases: []
284+ ParameterSets:
285+ - Name: (All)
286+ Position: Named
287+ IsRequired: false
288+ ValueFromPipeline: false
289+ ValueFromPipelineByPropertyName: false
290+ ValueFromRemainingArguments: false
291+ DontShow: false
292+ AcceptedValues: []
293+ HelpMessage: ''
235294` ` `
236295
237296# ## CommonParameters
238297
239298This cmdlet supports the common parameters : -Debug, -ErrorAction, -ErrorVariable,
240- -InformationAction, -InformationVariable, -OutVariable, - OutBuffer, -PipelineVariable , -Verbose ,
241- -WarningAction, and -WarningVariable. For more information, see
299+ -InformationAction, -InformationVariable, -OutBuffer, -OutVariable , -PipelineVariable ,
300+ -ProgressAction, -Verbose, - WarningAction, and -WarningVariable. For more information, see
242301[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
243302
244303# # INPUTS
@@ -285,18 +344,11 @@ cmdlet sends to it.
285344
286345# # RELATED LINKS
287346
288- [Clear-Host](../Microsoft.PowerShell.Core/Clear-Host.md)
289-
290- [Out-Host](../Microsoft.PowerShell.Core/Out-Host.md)
291-
292- [Write-Debug](Write-Debug.md)
293-
294- [Write-Error](Write-Error.md)
295-
296- [Write-Output](Write-Output.md)
297-
298- [Write-Progress](Write-Progress.md)
299-
300- [Write-Verbose](Write-Verbose.md)
301-
302- [Write-Warning](Write-Warning.md)
347+ - [Clear-Host](../Microsoft.PowerShell.Core/Clear-Host.md)
348+ - [Out-Host](../Microsoft.PowerShell.Core/Out-Host.md)
349+ - [Write-Debug](Write-Debug.md)
350+ - [Write-Error](Write-Error.md)
351+ - [Write-Output](Write-Output.md)
352+ - [Write-Progress](Write-Progress.md)
353+ - [Write-Verbose](Write-Verbose.md)
354+ - [Write-Warning](Write-Warning.md)
0 commit comments