Skip to content

Instantly share code, notes, and snippets.

@jdhitsolutions
Last active December 13, 2022 23:13
Show Gist options
  • Star 12 You must be signed in to star a gist
  • Fork 3 You must be signed in to fork a gist
  • Save jdhitsolutions/2b3f8761db581726802e to your computer and use it in GitHub Desktop.
Save jdhitsolutions/2b3f8761db581726802e to your computer and use it in GitHub Desktop.
A PowerShell function to list members of a local group such as Administrators.
#requires -version 4.0
Function Get-LocalGroupMember {
<#
.SYNOPSIS
Get local group membership using ADSI.
.DESCRIPTION
This command uses ADSI to connect to a server and enumerate the members of a local group. By default it will retrieve members of the local Administrators group.
The command uses legacy protocols to connect and enumerate group memberships. You may find it more efficient to wrap this function in an Invoke-Command expression. See examples.
.PARAMETER Computername
The name of a computer to query. The parameter has aliases of 'CN' and 'Host'.
.PARAMETER Name
The name of a local group.
.EXAMPLE
PS C:\> Get-LocalGroupMember -computer chi-core01
Computername : CHI-CORE01
Name : Administrator
ADSPath : WinNT://GLOBOMANTICS/chi-core01/Administrator
Class : User
Domain : GLOBOMANTICS
IsLocal : True
Computername : CHI-CORE01
Name : Domain Admins
ADSPath : WinNT://GLOBOMANTICS/Domain Admins
Class : Group
Domain : GLOBOMANTICS
IsLocal : False
Computername : CHI-CORE01
Name : Chicago IT
ADSPath : WinNT://GLOBOMANTICS/Chicago IT
Class : Group
Domain : GLOBOMANTICS
IsLocal : False
Computername : CHI-CORE01
Name : OMAA
ADSPath : WinNT://GLOBOMANTICS/OMAA
Class : User
Domain : GLOBOMANTICS
IsLocal : False
Computername : CHI-CORE01
Name : LocalAdmin
ADSPath : WinNT://GLOBOMANTICS/chi-core01/LocalAdmin
Class : User
Domain : GLOBOMANTICS
IsLocal : True
.EXAMPLE
PS C:\> "chi-hvr1","chi-hvr2","chi-core01","chi-fp02" | get-localgroupmember | where {$_.IsLocal} | Select Computername,Name,ADSPath
Computername Name ADSPath
------------ ---- -------
CHI-HVR1 Administrator WinNT://GLOBOMANTICS/chi-hvr1/Administrator
CHI-HVR2 Administrator WinNT://GLOBOMANTICS/chi-hvr2/Administrator
CHI-HVR2 Jeff WinNT://GLOBOMANTICS/chi-hvr2/Jeff
CHI-CORE01 Administrator WinNT://GLOBOMANTICS/chi-core01/Administrator
CHI-CORE01 LocalAdmin WinNT://GLOBOMANTICS/chi-core01/LocalAdmin
CHI-FP02 Administrator WinNT://GLOBOMANTICS/chi-fp02/Administrator
.EXAMPLE
PS C:\> $s = new-pssession chi-hvr1,chi-fp02,chi-hvr2,chi-core01
Create several PSSessions to remote computers.
PS C:\> $sb = ${function:Get-localGroupMember}
Get the function's scriptblock
PS C:\> Invoke-Command -scriptblock { new-item -path Function:Get-LocalGroupMember -value $using:sb} -session $s
Create a remote version of the function.
PS C:\> Invoke-Command -scriptblock { get-localgroupmember | where {$_.IsLocal} } -session $s | Select Computername,Name,ADSPath
Repeat an example from above but this time execute it in a remote session.
.EXAMPLE
PS C:\> get-localgroupmember -Name "Hyper-V administrators" -Computername chi-hvr1,chi-hvr2
Computername : CHI-HVR1
Name : jeff
ADSPath : WinNT://GLOBOMANTICS/jeff
Class : User
Domain : GLOBOMANTICS
IsLocal : False
Computername : CHI-HVR2
Name : jeff
ADSPath : WinNT://GLOBOMANTICS/jeff
Class : User
Domain : GLOBOMANTICS
IsLocal : False
Check group membership for the Hyper-V Administrators group.
.EXAMPLE
PS C:\> get-localgroupmember -Computername chi-core01 | where class -eq 'group' | select Domain,Name
Domain Name
------ ----
GLOBOMANTICS Domain Admins
GLOBOMANTICS Chicago IT
Get members of the Administrators group on CHI-CORE01 that are groups and select a few properties.
.NOTES
NAME : Get-LocalGroupMember
VERSION : 1.6
LAST UPDATED: 2/18/2016
AUTHOR : Jeff Hicks (@JeffHicks)
Learn more about PowerShell:
http://jdhitsolutions.com/blog/essential-powershell-resources/
****************************************************************
* DO NOT USE IN A PRODUCTION ENVIRONMENT UNTIL YOU HAVE TESTED *
* THOROUGHLY IN A LAB ENVIRONMENT. USE AT YOUR OWN RISK. IF *
* YOU DO NOT UNDERSTAND WHAT THIS SCRIPT DOES OR HOW IT WORKS, *
* DO NOT USE IT OUTSIDE OF A SECURE, TEST SETTING. *
****************************************************************
.INPUTS
[string] for computer names
.OUTPUTS
[object]
#>
[cmdletbinding()]
Param(
[Parameter(Position = 0)]
[ValidateNotNullorEmpty()]
[string]$Name = "Administrators",
[Parameter(ValueFromPipeline,ValueFromPipelineByPropertyName)]
[ValidateNotNullorEmpty()]
[Alias("CN","host")]
[string[]]$Computername = $env:computername
)
Begin {
Write-Verbose "[Starting] $($MyInvocation.Mycommand)"
Write-Verbose "[Begin] Querying members of the $Name group"
} #begin
Process {
foreach ($computer in $computername) {
#define a flag to indicate if there was an error
$script:NotFound = $False
#define a trap to handle errors because we're not using cmdlets that
#could support Try/Catch. Traps must be in same scope.
Trap [System.Runtime.InteropServices.COMException] {
$errMsg = "Failed to enumerate $name on $computer. $($_.exception.message)"
Write-Warning $errMsg
#set a flag
$script:NotFound = $True
Continue
}
#define a Trap for all other errors
Trap {
Write-Warning "Oops. There was some other type of error: $($_.exception.message)"
Continue
}
Write-Verbose "[Process] Connecting to $computer"
#the WinNT moniker is case-sensitive
[ADSI]$group = "WinNT://$computer/$Name,group"
Write-Verbose "[Process] Getting group member details"
$members = $group.invoke("Members")
Write-Verbose "[Process] Counting group members"
if (-Not $script:NotFound) {
$found = ($members | measure).count
Write-Verbose "[Process] Found $found members"
if ($found -gt 0 ) {
$members | foreach {
#define an ordered hashtable which will hold properties
#for a custom object
$Hash = [ordered]@{Computername = $computer.toUpper()}
#Get the name property
$hash.Add("Name",$_[0].GetType().InvokeMember("Name", 'GetProperty', $null, $_, $null))
#get ADS Path of member
$ADSPath = $_[0].GetType().InvokeMember("ADSPath", 'GetProperty', $null, $_, $null)
$hash.Add("ADSPath",$ADSPath)
#get the member class, ie user or group
$hash.Add("Class",$_[0].GetType().InvokeMember("Class", 'GetProperty', $null, $_, $null))
<#
Domain members will have an ADSPath like WinNT://MYDomain/Domain Users.
Local accounts will be like WinNT://MYDomain/Computername/Administrator
#>
$hash.Add("Domain",$ADSPath.Split("/")[2])
#if computer name is found between two /, then assume
#the ADSPath reflects a local object
if ($ADSPath -match "/$computer/") {
$local = $True
}
else {
$local = $False
}
$hash.Add("IsLocal",$local)
#turn the hashtable into an object
New-Object -TypeName PSObject -Property $hash
} #foreach member
}
else {
Write-Warning "No members found in $Name on $Computer."
}
} #if no errors
} #foreach computer
} #process
End {
Write-Verbose "[Ending] $($MyInvocation.Mycommand)"
} #end
} #end function
<#
Copyright (c) 2016 JDH Information Technology Solutions, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
#>
@jdhitsolutions
Copy link
Author

This function is described at http://bit.ly/1U7HTVo

@jdhitsolutions
Copy link
Author

I've posted a version 1.5 which breaks a few steps down into more discreet commands for (hopefully) better error handling. I had reports of an unusual error that I can't replicate. I'm hoping this version will at least handle it more gracefully.

@jdhitsolutions
Copy link
Author

Found the culprit when running on Windows 10. Change has been implemented in v1.6.

@stvflowers
Copy link

Great function! Looks like Microsoft has added this functionality in PS 5.1 but this is a life saver in the mean time.

@jblaine
Copy link

jblaine commented Jul 28, 2017

@toledotown What's the name of the function/functionality in PS 5.1?

@jblaine
Copy link

jblaine commented Jul 28, 2017

Oh. Nevermind. It's Get-LocalGroupMember :)

@raparna10204
Copy link

How can we check local users and group members through powershell version 4

@asavaresi7
Copy link

Hi, you can run the script but for a computer OU specifies an OU where all the computers in my domain are located.
Thank you so much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment