{"id":1346,"date":"2009-04-09T06:00:23","date_gmt":"2009-04-09T14:00:23","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/2009\/04\/09\/get-local-member\/"},"modified":"2009-04-09T06:00:23","modified_gmt":"2009-04-09T14:00:23","slug":"get-local-member","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2009\/04\/09\/get-local-member\/","title":{"rendered":"Get Local Member"},"content":{"rendered":"

I’ve been dealing with the topic of enumerating local group membership in several PowerShell forums from different people. My responses have pretty much been the same. But if these people are asking its a safe bet there are others who are also in need. The bottom line has been to query a local group, typically Administrators, and return a list of group members. If the member is a domain account, then get a little extra information. I put together a script called Get-Localmember.ps1 that I think will get the job done for most of you.<\/p>\n

\n
\n
#Get-Localmember.ps1<\/span><\/pre>\n
Param(  <\/pre>\n
    [string]$computername=$env:Computername,<\/pre>\n
    [string]$group=\"Administrators\"<\/span><\/pre>\n
    )<\/pre>\n
      <\/pre>\n
    Function Get-DomainUser {<\/pre>\n
        Param([string]$sam=\"Administrator\"<\/span>)<\/pre>\n
        <\/pre>\n
        $searcher=New-Object system.DirectoryServices.DirectorySearcher<\/pre>\n
        $searcher.PageSize=100<\/pre>\n
        $searcher.filter<\/span>=\"samaccountname=$sam\"<\/span><\/pre>\n
        $user=$searcher.findone()<\/pre>\n
        write $user<\/pre>\n
    <\/pre>\n
 }<\/pre>\n
 <\/pre>\n
$errorActionPreference=\"SilentlyContinue\"<\/span><\/pre>\n
New-Variable ADS_UF_ACCOUNTDISABLE 0x0002 -Option Constant<\/pre>\n
 <\/pre>\n
trap<\/span> {<\/pre>\n
   Write-Warning (\"Oops.  Something happened trying to return group membership for {0} on {1}.\"<\/span> -f $group,$computername.ToUpper())<\/pre>\n
}<\/pre>\n
 <\/pre>\n
[ADSI]$LocalGroup=\"WinNT:\/\/$computername\/$group,group\"<\/span><\/pre>\n
 <\/pre>\n
$LocalGroup.psbase.invoke(\"Members\"<\/span>) | ForEach-Object {<\/pre>\n
 <\/pre>\n
    #get ADS Path of member<\/span><\/pre>\n
    $ADSPath=$_.GetType().InvokeMember(\"ADSPath\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
    $null, $_, $null)<\/pre>\n
   <\/pre>\n
    #get the member class, ie user or group<\/span><\/pre>\n
    $class=$_.GetType().InvokeMember(\"Class\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
    $null, $_, $null)<\/pre>\n
   <\/pre>\n
    #Get the name property<\/span><\/pre>\n
    $name=$_.GetType().InvokeMember(\"Name\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
    $null, $_, $null)<\/pre>\n
   <\/pre>\n
    #if computer name is found between two \/, then assume<\/span><\/pre>\n
    #the ADSPath reflects a local object<\/span><\/pre>\n
    if<\/span> ($ADSPath -match<\/span> \"$computername\"<\/span>) <\/pre>\n
    {<\/pre>\n
        $local<\/span>=$True<\/pre>\n
        $domain=$computername.ToUpper()<\/pre>\n
        $description=$_.GetType().InvokeMember(\"Description\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
    $null, $_, $null)<\/pre>\n
        $displayname=$_.GetType().InvokeMember(\"FullName\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
    $null, $_, $null)<\/pre>\n
         $account=$ADSPath<\/pre>\n
         $flag=$_.GetType().InvokeMember(\"userflags\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
    $null, $_, $null)<\/pre>\n
          if<\/span> ($flag -band<\/span> $ADS_UF_ACCOUNTDISABLE) <\/pre>\n
          {<\/pre>\n
            $disabled=$True<\/pre>\n
         }<\/pre>\n
         else<\/span> <\/pre>\n
         {<\/pre>\n
            $disabled=$False<\/pre>\n
         }<\/pre>\n
          <\/pre>\n
     } #end if $ADSPath -match $computername<\/span><\/pre>\n
    else<\/span>  #account is a domain member<\/span><\/pre>\n
    {<\/pre>\n
        $local<\/span>=$False<\/pre>\n
        #Domain members will have an ADSPath like<\/span><\/pre>\n
         #WinNT:\/\/MYDomain\/Domain Users.  Local accounts will have<\/span><\/pre>\n
        #be like WinNT:\/\/MYDomain\/Computername\/Administrator<\/span><\/pre>\n
    <\/pre>\n
        #using regular expressions create a named match for the domain name<\/span><\/pre>\n
        $ADSPath -match<\/span> \"(?<domain>\/\/\\w+)\"<\/span> | Out-Null<\/pre>\n
    <\/pre>\n
        #strip off the leading \/\/<\/span><\/pre>\n
        $domain=$matches.domain.Replace(\"\/\/\"<\/span>,\"\"<\/span>)<\/pre>\n
        $domainuser=Get-DomainUser $name<\/pre>\n
        if<\/span> ($domainuser) <\/pre>\n
        {<\/pre>\n
            $description=$domainuser.properties.item(\"description\"<\/span>)[0]<\/pre>\n
            $displayname=$domainuser.properties.item(\"displayname\"<\/span>)[0]<\/pre>\n
            $account=$domainuser.properties.item(\"distinguishedname\"<\/span>)[0]<\/pre>\n
 <\/pre>\n
            if<\/span> ($domainuser.properties.item(\"useraccountcontrol\"<\/span>)[0] -band<\/span> $ADS_UF_ACCOUNTDISABLE ) <\/pre>\n
              {<\/pre>\n
                $disabled=$True<\/pre>\n
             }<\/pre>\n
             else<\/span> <\/pre>\n
             {<\/pre>\n
                $disabled=$False<\/pre>\n
             }<\/pre>\n
        } #end if $domainuser<\/span><\/pre>\n
       else<\/span> <\/pre>\n
       {<\/pre>\n
           $description=\"not found\"<\/span><\/pre>\n
           $displayname=\"not found\"<\/span><\/pre>\n
           $disabled=$null<\/pre>\n
           $account=$ADSPath<\/pre>\n
       }<\/pre>\n
   } #end else domain user<\/span><\/pre>\n
   <\/pre>\n
    #create a custom object<\/span><\/pre>\n
    $obj = New-Object PSObject<\/pre>\n
   <\/pre>\n
    #define custom object properties<\/span><\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Computer\"<\/span> -Value $computername.toUpper()<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Account\"<\/span> -Value $account<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Name\"<\/span> -Value $name<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"DisplayName\"<\/span> -Value $displayname<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Description\"<\/span> -Value $description<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Disabled\"<\/span> -Value $disabled<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Domain\"<\/span> -Value $domain<\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"IsLocal\"<\/span> -Value $local<\/span><\/pre>\n
    $obj | Add-Member -MemberType NoteProperty -Name \"Class\"<\/span> -Value $class<\/pre>\n
   <\/pre>\n
    #write the result to the pipeline<\/span><\/pre>\n
    write $obj<\/pre>\n
   <\/pre>\n
 #end foreach<\/span><\/pre>\n
 <\/pre>\n<\/div>\n<\/div>\n
The script takes computer and group name’s as parameters. The defaults are the local computer and the Administrator’s group. Let me first give you a sample of the script’s output, which is written to the pipeline:\\<\/p>\n
Computer    : XP01
Account     : WinNT:\/\/MYCOMPANY\/XP01\/svcaccount
Name        : svcaccount
DisplayName :
Description : test service acount
Disabled    : False
Domain      : XP01
IsLocal     : True
Class       : User <\/font><\/p>\n
Computer    : XP01
Account     : CN=Domain Admins,CN=Users,DC=MYCOMPANY,DC=LOCAL
Name        : Domain Admins
DisplayName :
Description : Designated administrators of the domain
Disabled    : False
Domain      : MYCOMPANY
IsLocal     : False
Class       : group <\/font><\/p>\n
Computer    : XP01
Account     : CN=Jeffery Hicks,OU=IT,OU=Employees,DC=MYCOMPANY,DC=LOCAL
Name        : jhicks
DisplayName : Jeffery Hicks
Description : Company admin
Disabled    : False
Domain      : MYCOMPANY
IsLocal     : False
Class       : User<\/font> <\/p>\n
A custom object is created for each group member which means you can filter, sort, export or whatever you want with the results. Here’s how this works. First the script defines some variables and a trap to handle any errors.<\/p>\n
\n
\n
$errorActionPreference=\"SilentlyContinue\"<\/span><\/pre>\n
New-Variable ADS_UF_ACCOUNTDISABLE 0x0002 -Option Constant<\/pre>\n
 <\/pre>\n
trap<\/span> {<\/pre>\n
   Write-Warning (\"Oops.  Something happened trying to return group membership for {0} on {1}.\"<\/span> -f $group,$computername.ToUpper())<\/pre>\n
}<\/pre>\n<\/div>\n<\/div>\n
The $ADS_UF_ACCOUNTDISABLE variable will be used later to determine if the account is disabled or not. Using the [ADSI] type adapter, the script connects to the specified group object on the specified computer.<\/p>\n
\n
\n
#connect to the specified group and create an ADSI object<\/span><\/pre>\n
#Remember WinNT is case-sensitive<\/span><\/pre>\n
[ADSI]$LocalGroup=\"WinNT:\/\/$computername\/$group,group\"<\/span><\/pre>\n<\/div>\n<\/div>\n
I now need to process each group member.<\/p>\n
\n
\n
#enumerate group members and for each one get information<\/span><\/pre>\n
#and create a custom object.<\/span><\/pre>\n
$LocalGroup.psbase.invoke(\"Members\"<\/span>) | ForEach-Object {<\/pre>\n<\/div>\n<\/div>\n
Getting properties for local accounts in PowerShell is not as straightforward as you might like due to limitations in the underlying .NET class and how PowerShell adapts the class.  But no matter, here is how I get some of the properties I’m interested in.<\/p>\n
\n
\n
#get ADS Path of member<\/span><\/pre>\n
$ADSPath=$_.GetType().InvokeMember(\"ADSPath\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
$null, $_, $null)<\/pre>\n
 <\/pre>\n
#get the member class, ie user or group<\/span><\/pre>\n
$class=$_.GetType().InvokeMember(\"Class\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
$null, $_, $null)<\/pre>\n
 <\/pre>\n
#Get the name property<\/span><\/pre>\n
$name=$_.GetType().InvokeMember(\"Name\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
$null, $_, $null)<\/pre>\n<\/div>\n<\/div>\n
The ADSPath is used to determine if the account is a domain member or local. Domain members will have an ADSPath like WinNT:\/\/MYDomain\/Domain Users.  Local accounts will have a value like WinNT:\/\/MYDomain\/Computername\/Administrator. With this information if the account is local then I’ll get local properties.<\/p>\n
\n
\n
#if computer name is found between two \/, then assume<\/span><\/pre>\n
#the ADSPath reflects a local object<\/span><\/pre>\n
if<\/span> ($ADSPath -match<\/span> \"$computername\"<\/span>) <\/pre>\n
{<\/pre>\n
  $local<\/span>=$True<\/pre>\n
  $domain=$computername.ToUpper()<\/pre>\n
  $description=$_.GetType().InvokeMember(\"Description\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
$null, $_, $null)<\/pre>\n
  $displayname=$_.GetType().InvokeMember(\"FullName\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
$null, $_, $null)<\/pre>\n
$account=$ADSPath<\/pre>\n
$flag=$_.GetType().InvokeMember(\"userflags\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
$null, $_, $null)<\/pre>\n
 if<\/span> ($flag -band<\/span> $ADS_UF_ACCOUNTDISABLE) <\/pre>\n
 {<\/pre>\n
   $disabled=$True<\/pre>\n
}<\/pre>\n
else<\/span> <\/pre>\n
{<\/pre>\n
   $disabled=$False<\/pre>\n
}<\/pre>\n
 <\/pre>\n
} #end<\/span> if<\/span> $ADSPath -match<\/span> $computername<\/pre>\n<\/div>\n<\/div>\n
I want to point out how I determine if the user account is disabled or not. I have to retrieve the user account control value stored in the userflags property and then perform a binary AND comparison with the $ADS_UF_ACCOUNTDISABLE variable. If the result is true then the account is disabled.<\/p>\n
\n
\n
$flag=$_.GetType().InvokeMember(\"userflags\"<\/span>, 'GetProperty'<\/span>, `<\/pre>\n
, $_, $null)<\/pre>\n
 if<\/span> ($flag -band<\/span> $ADS_UF_ACCOUNTDISABLE) <\/pre>\n
 {<\/pre>\n
   $disabled=$True<\/pre>\n
}<\/pre>\n
else<\/span> <\/pre>\n
{<\/pre>\n
   $disabled=$False<\/pre>\n
}<\/pre>\n<\/div>\n<\/div>\n
If the account is a domain member then the first thing I want to do is parse out the domain name from the ADSPath using a regular expression pattern with a named match, “<domain>”. It’s not the most robust expression because it assumes you don’t have any numbers in your domain name.<\/p>\n
\n
\n
else<\/span>  #account is a domain member<\/span><\/pre>\n
{<\/pre>\n
    $local<\/span>=$False<\/pre>\n
    #Domain members will have an ADSPath like<\/span><\/pre>\n
     #WinNT:\/\/MYDomain\/Domain Users.  Local accounts will <\/span><\/pre>\n
    #be like WinNT:\/\/MYDomain\/Computername\/Administrator<\/span><\/pre>\n
 <\/pre>\n
    #using regular expressions create a named match for the domain name<\/span><\/pre>\n
    $ADSPath -match<\/span> \"(?<domain>\/\/\\w+)\"<\/span> | Out-Null<\/pre>\n
 <\/pre>\n
    #strip off the leading \/\/<\/span><\/pre>\n
    $domain=$matches.domain.Replace(\"\/\/\"<\/span>,\"\"<\/span>)<\/pre>\n<\/div>\n<\/div>\n
In order to get information about the user (or group) such as display name, description or distinguishedname, I need to find the object in Active Directory. I pass the member’s SAMAccountname to a Get-DomainUser function.<\/p>\n
\n
\n
Function Get-DomainUser {<\/pre>\n
    Param([string]$sam=\"Administrator\"<\/span>)<\/pre>\n
        <\/pre>\n
    $searcher=New-Object system.DirectoryServices.DirectorySearcher<\/pre>\n
    $searcher.PageSize=100<\/pre>\n
    $searcher.filter<\/span>=\"samaccountname=$sam\"<\/span><\/pre>\n
    $user=$searcher.findone()<\/pre>\n
    write $user<\/pre>\n
}<\/pre>\n<\/div>\n<\/div>\n
Using a DirectorySearcher, the function finds the first object that matches the SAMaccountname, which should be unique.  I have not tested how this will work in a cross-domain situation. Unless your local group has hundreds of domain members, performance shouldn’t be too bad. Simply remember that Active Directory must be queried for each domain member. The function returns the search result object to the pipeline. Also, be aware that this is not the actual object in Active Directory but a search result object so it won’t have every single property, but it should have enough of the basics to meet your needs. Assuming I get a result back, I’ll grab some Active Directory properties.<\/p>\n
\n
\n
$domainuser=Get-DomainUser $name<\/pre>\n
if<\/span> ($domainuser) <\/pre>\n
{<\/pre>\n
    $description=$domainuser.properties.item(\"description\"<\/span>)[0]<\/pre>\n
    $displayname=$domainuser.properties.item(\"displayname\"<\/span>)[0]<\/pre>\n
    $account=$domainuser.properties.item(\"distinguishedname\"<\/span>)[0]<\/pre>\n<\/div>\n<\/div>\n
Determining if the account is disabled is basically the same process. The location of the user account flag is slightly different.<\/p>\n
\n
\n
if<\/span> ($domainuser.properties.item(\"useraccountcontrol\"<\/span>)[0] -band<\/span> $ADS_UF_ACCOUNTDISABLE ) <\/pre>\n
 {<\/pre>\n
    $disabled=$True<\/pre>\n
 }<\/pre>\n
 else<\/span> <\/pre>\n
 {<\/pre>\n
    $disabled=$False<\/pre>\n
 }<\/pre>\n<\/div>\n<\/div>\n
At this point, all that is left is to build a custom object and add my properties. This is repeated for every group member.<\/p>\n
\n
\n
#create a custom object<\/span><\/pre>\n
$obj = New-Object PSObject<\/pre>\n
 <\/pre>\n
#define custom object properties<\/span><\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Computer\"<\/span> -Value $computername.toUpper()<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Account\"<\/span> -Value $account<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Name\"<\/span> -Value $name<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"DisplayName\"<\/span> -Value $displayname<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Description\"<\/span> -Value $description<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Disabled\"<\/span> -Value $disabled<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Domain\"<\/span> -Value $domain<\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"IsLocal\"<\/span> -Value $local<\/span><\/pre>\n
$obj | Add-Member -MemberType NoteProperty -Name \"Class\"<\/span> -Value $class<\/pre>\n
 <\/pre>\n
#write the result to the pipeline<\/span><\/pre>\n
write $obj<\/pre>\n<\/div>\n<\/div>\n
\n
Download this script file here.<\/a><\/p>\n<\/div>\n
Look for a graphical variation on this script in a future Mr. Roboto column.<\/p>\n","protected":false},"excerpt":{"rendered":"
I’ve been dealing with the topic of enumerating local group membership in several PowerShell forums from different people. My responses have pretty much been the same. But if these people are asking its a safe bet there are others who are also in need. The bottom line has been to query a local group, typically Administrators, and return a list of group members. If the member is a domain account, then get a little extra information. I put together a script called Get-Localmember.ps1 that I think will get the job done for most of you.<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[25],"tags":[90,223,280,82,28,57],"class_list":["post-1346","post","type-post","status-publish","format-standard","hentry","category-windows-powershell","tag-active-directory","tag-add-member","tag-adsi","tag-objects","tag-powershell","tag-scripting"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/1346","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=1346"}],"version-history":[{"count":0,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/1346\/revisions"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=1346"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=1346"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=1346"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}