powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Format-List



NAME
Format-List

SYNOPSIS
Formats the output as a list of properties in which each property appears on a new line.

SYNTAX
Format-List [[-Property] ] [-DisplayError] [-Expand ] [-Force] [-GroupBy ] [-InputObject
] [-ShowError] [-View ] []


DESCRIPTION
The Format-List cmdlet formats the output of a command as a list of properties in which each property is displayed
on a separate line. You can use Format-List to format and display all or selected properties of an object as a list
(format-list *).

Because more space is available for each item in a list than in a table, Windows PowerShell displays more propertie
s of the object in the list, and the property values are less likely to be truncated.


PARAMETERS
-DisplayError []
Displays errors at the command line.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Expand
Formats the collection object, as well as the objects in the collection. This parameter is designed to format o
bjects that support the ICollection (System.Collections) interface. The default value is EnumOnly.

Valid values are:
-- EnumOnly: Displays the properties of the objects in the collection.
-- CoreOnly: Displays the properties of the collection object.
-- Both: Displays the properties of the collection object and the properties of objects in the collection.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force []
Directs the cmdlet to display all of the error information. Use with the DisplayError or ShowError parameters.
By default, when an error object is written to the error or display streams, only some of the error information
is displayed.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-GroupBy
Formats the output in groups based on a shared property or value. Enter an expression or a property of the outp
ut.

The value of the GroupBy parameter can be a new calculated property. To create a calculated, property, use a ha
sh table. Valid keys are:

-- Name (or Label)
-- Expression or