powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Group-Object



NAME
Group-Object

SYNOPSIS
Groups objects that contain the same value for specified properties.

SYNTAX
Group-Object [-AsHashTable] [-AsString] [[-Property] ] [-CaseSensitive] [-Culture ] [-InputObject
] [-NoElement] []


DESCRIPTION
The Group-Object cmdlet displays objects in groups based on the value of a specified property. Group-Object returns
a table with one row for each property value and a column that displays the number of items with that value.

If you specify more than one property, Group-Object first groups them by the values of the first property, and then
, within each property group, it groups by the value of the next property.


PARAMETERS
-AsHashTable []
Returns the group as a hash table. The keys of the hash table are the property values by which the objects are
grouped. The values of the hash table are the objects that have that property value.

By itself, the AsHashTable parameter returns each hash table in which each key is an instance of the grouped ob
ject. When used with the AsString parameter, the keys in the hash table are strings.

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

-AsString []
Converts the hash table keys to strings. By default, the hash table keys are instances of the grouped object. T
his parameter is valid only when used with the AsHashTable parameter.

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

-CaseSensitive []
Makes the grouping case-sensitive. Without this parameter, the property values of objects in a group might have
different cases.

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

-Culture
Specifies the culture to use when comparing strings.

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

-InputObject
Specifies the objects to group. Enter a variable that contains the objects, or type a command or expression tha
t gets the objects.

When you use the InputObject parameter to submit a collection of objects to Group-Object, Group-Object receives
one object that represents the collection. As a result, it creates a single group with that object as its memb
er.

To group the objects in a collection, pipe the objects to Group-Object.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-NoElement []
Omits the members of a group from the results.

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

-Property
Specifies the properties for grouping. The objects are arranged into groups based on the value of the specified
property.

The value of the Property parameter can be a new calculated property. To create a calculated, property, create
a hash table with an Expression key that specifies a string or script block value.

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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.Automation.PSObject
You can pipe any object to Group-Object


OUTPUTS
Microsoft.PowerShell.Commands.GroupInfo or System.Collections.Hashtable
When you use the AsHashTable parameter, Group-Object returns a hash table. Otherwise, it returns a GroupInfo ob
ject.


NOTES


You can also use the GroupBy parameter of the formatting cmdlets (such as Format-Table [m2] and Format-List [m2
]) to group objects. Unlike Group-Object, which creates a single table with a row for each property value, the
GroupBy parameters create a table for each property value with a row for each item that has the property value.

Group-Object does not require that the objects being grouped be of the same Microsoft .NET Framework type. When
grouping objects of different .NET Framework types, Group-Object uses the following rules:

-- Same Property Names and Types: If the objects have a property with the specified name, and the property valu
es have the same .NET Framework type, the property values are grouped by using the same rules that would be use
d for objects of the same type.

-- Same Property Names, Different Types: If the objects have a property with the specified name, but the proper
ty values have a different .NET Framework type in different objects, Group-Object uses the .NET Framework type
of the first occurrence of the property as the .NET Framework type for that property group. When an object has
a property with a different type, the property value is converted to the type for that group. If the type conve
rsion fails, the object is not included in the group.

-- Missing Properties: Objects that do not have a specified property are considered ungroupable. Ungroupable ob
jects appear in the final GroupInfo object output in a group named AutomationNull.Value.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-childitem *.doc | group-object -property length


Description
-----------
This command gets the files in the current location that have a .doc extension and groups them by size.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>get-childitem | sort-object -property extension | group-object -property extension


Description
-----------
This command gets the files in the current location, sorts them by file name extension, and then groups them by fil
e name extension. Note that the files are sorted before they are grouped.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>1..35 | group-object -property {$_ % 2},{$_ % 3}


Description
-----------
This example shows how to use script blocks as the value of the Property parameter.

This command displays the integers from 1 to 35, grouped by the remainder left when they are divided by 2 or 3.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>$events = get-eventlog -logname system -newest 1000

C:\PS> $events | group-object -property eventID

Count Name Group
----- ---- -----
44 Information {System.Diagnostics.EventLogEntry,
5 Error {System.Diagnostics.EventLogEntry,
1 Warning {System.Diagnostics.EventLogEntry}


Description
-----------
These commands display the 1,000 most recent entries in the System event log, grouped by Event ID.

The first command uses the Get-EventLog cmdlet to retrieve the events and the assignment operator (=) to save them
in the $events variable.

The second command uses a pipeline operator (|) to send the events in the $events variable to the Group-Object cmdl
et. The command uses the Property parameter to specify that the events should be grouped according to the value of
their EventID property.

In the output, the Count column represents the number of entries in each group, the Name column represents the Even
tID values that define a group, and the Group column represents the objects in each group.





-------------------------- EXAMPLE 5 --------------------------

C:\PS>get-process | group-object -property priorityclass

Count Name Group
----- ---- -----
55 Normal {System.Diagnostics.Process (AdtAgent), System.Diagnostics.Process (alg), System.Dia...
1 {System.Diagnostics.Process (Idle)}
3 High {System.Diagnostics.Process (Newproc), System.Diagnostics.Process (winlogon), System.D...

2 BelowNormal {System.Diagnostics.Process (winperf),


C:\PS>get-process | group-object -property company -noelement
Count Name
----- ----
55 Normal
1
3 High
2 BelowNormal


Description
-----------
This example demonstrates the effect of the NoElement parameter. These commands group the processes on the computer
by priority class.

The first command uses the Get-Process cmdlet to get the processes on the computer. It uses a pipeline operator (|)
to send the results to Group-Object, which groups the objects by the value of the PriorityClass property of the pr
ocess.

The second command is identical to the first, except that it uses the NoElement parameter to eliminate the members
of the group from the output. The result is a table with only the count and property value name.

The results are shown in the following sample output.





-------------------------- EXAMPLE 6 --------------------------

C:\PS>get-eventlog -logname system -newest 1000 | group-object -property {$_.TimeWritten - $_.TimeGenerated}


Description
-----------
This command demonstrates how to provide the value of the Property parameter as a script block.

This command displays the most recent 1,000 entries from the system event log, grouped according to the time betwee
n when they were generated and when they were written to the log.

The command uses the Get-EventLog cmdlet to get the event log entries. It uses a pipeline operator (|) to send the
entries to the Group-Object cmdlet. The value of the Property parameter is specified as a script block (an expressi
on in braces). The result of evaluating the script block is the time between when the log entry was generated and w
hen it was written to the log. That value is used to group the 1,000 most recent events.





-------------------------- EXAMPLE 7 --------------------------

C:\PS>get-childitem | group-object extension -noelement

Count Name
----- ----
21
82 .txt
9 .cmd
5 .log
12 .xml
5 .htm
36 .ps1
1 .psc1
3 .exe
6 .csv
1 .psd1
2 .bat


Description
-----------
This command groups the items in the current directory by file name extension. It uses the NoElement parameter to o
mit the members of the group.

The results are shown in the following sample output.





-------------------------- EXAMPLE 8 --------------------------

C:\PS>"a", "b", "c", "c", "d" | get-unique

a
b
c
d

C:\PS> "a", "b", "c", "c", "d" | group-object -noelement | where {$_.Count -gt 1}
Count Name
----- ----
2 c

C:\PS> get-process | group-object -property Name -noelement | where {$_.count -gt 1}
Count Name
----- ----
2 csrss
5 svchost
2 winlogon
2 wmiprvse


Description
-----------
This example shows how to find the unique and non-unique (repeated) property values in a collection.

The first command gets the unique elements of an array by piping the array to the Get-Unique cmdlet.

The second command gets the non-unique elements of an array. It pipes the array to the Group-Object cmdlet, which g
roups the objects by value. The resulting groups are piped to the Where-Object cmdlet, which selects objects with g
roups with more than one member.

The third command shows a practical use for this technique. It uses the same method to find processes on the comput
er that have the same process name.

The results are shown in the following sample output.





-------------------------- EXAMPLE 9 --------------------------

C:\PS>$a = get-command get-*, set-* -type cmdlet | group-object -property verb -ashashtable -asstring

C:\PS> $a

Name Value
---- -----
Get {Get-PSCallStack, Get-PSBreakpoint, Get-PSDrive, Get-PSSession...}
Set {Set-Service, Set-StrictMode, Set-PSDebug, Set-PSSessionConfiguration...}

C:\PS> $a.get

CommandType Name Definition
----------- ---- ----------
Cmdlet Get-PSCallStack Get-PSCallStack [-Verbose] [-Debug] [-ErrorAction Cmdlet Get-PSBreakpoint Get-PSBreakpoint [[-Id] ] [-Verbose] [-Debug] [-ErrorA...
Cmdlet Get-PSDrive Get-PSDrive [[-Name] ] [-Scope ] [-PSProvider...
...


Description
-----------
This example uses the AsHashTable and AsString parameters to return the groups in a hash table, that is, as a colle
ction of key-value pairs.

In the resulting hash table, each property value is a key, and the group elements are the values. Because each key
is a property of the hash table object, you can use dot notation to display the values.

The first command gets the Get and Set cmdlets in the session, groups them by verb, returns the groups as a hash ta
ble, and saves the hash table in the $a variable.

The second command displays the hash table in $a. There are two key-value pairs, one for the Get cmdlets and one fo
r the Set cmdlets.

The third command uses dot notation to display the values of the Get key in $a. The values are CmdletInfo object. T
he AsString parameter does not convert the objects in the groups to strings.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113338