Get-ADGroup
Synopsis
Description
The Identity parameter specifies the Active Directory group to get. You can identify a group by its distinguished name (DN), GUID, security identifier (SID), Security Accounts Manager (SAM) account name, or canonical name. You can also specify group object variable, such as $.
To search for and retrieve more than one group, use the Filter or LDAPFilter parameters. The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. For more information about the Filter parameter syntax, see about_ActiveDirectory_Filter. If you have existing LDAP query strings, you can use the LDAPFilter parameter.
This cmdlet gets a default set of group object properties. To get additional properties use the Properties parameter. For more information about the how to determine the properties for group objects, see the Properties parameter description.
Parameters
-AuthType
Specifies the authentication method to use. Possible values for this parameter include:
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <String>
Specifies a query string that retrieves Active Directory objects. This string uses the PowerShell Expression Language syntax. The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. For more information about the Filter parameter, see about_ActiveDirectory_Filter.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADGroup>
Specifies an Active Directory group object by providing one of the following values. The identifier in parentheses is the LDAP display name for the attribute.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LDAPFilter <String>
Specifies an LDAP query string that is used to filter Active Directory objects. You can use this parameter to run your existing LDAP queries. The Filter parameter syntax supports the same functionality as the LDAP syntax. For more information, see the Filter parameter description and the about_ActiveDirectory_Filter.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Partition <String>
Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the Identity parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Properties <String[]>
Specifies the properties of the output object to retrieve from the server. Use this parameter to retrieve properties that are not included in the default set.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResultPageSize <Int32>
Specifies the number of objects to include in one page for an Active Directory Domain Services query.
Required? false
Position? named
Default value 256
Accept pipeline input? false
Accept wildcard characters? false
-ResultSetSize <Int32>
Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want to receive all of the objects, set this parameter to $null (null value). You can use Ctrl+c to stop the query and return of objects.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SearchBase <String>
Specifies an Active Directory path to search under.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SearchScope <ADSearchScope>
Specifies the scope of an Active Directory search. Possible values for this parameter are:
Required? false
Position? named
Default value Subtree
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSyntax
Get-ADGroup [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Filter <String> [-Properties <String[]>] [-ResultPageSize <Int32>] [-ResultSetSize <Int32>] [-SearchBase <String>] [-SearchScope <ADSearchScope>] [-Server <String>] [<CommonParameters>]
Get-ADGroup [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Identity] <ADGroup> [-Partition <String>] [-Properties <String[]>] [-Server <String>] [<CommonParameters>]
Get-ADGroup [-AuthType <ADAuthType>] [-Credential <PSCredential>] -LDAPFilter <String> [-Properties <String[]>] [-ResultPageSize <Int32>] [-ResultSetSize <Int32>] [-SearchBase <String>] [-SearchScope <ADSearchScope>] [-Server <String>] [<CommonParameters>]
C:\PS>Get-ADGroup administrators
DistinguishedName : CN=Administrators,CN=Builtin,DC=TOSSolution,DC=com
GroupCategory : Security
GroupScope : DomainLocal
Name : Administrators
ObjectClass : group
ObjectGUID : 02ce3874-hj34-41ba-sade-013f34019978
SamAccountName : Administrators
SID : S-1-4-31-765
C:\PS>get-adgroup -Identity S-1-4-31-765 -Properties member
DistinguishedName : CN=Administrators,CN=Builtin,DC=TOSSolution,DC=com
GroupCategory : Security
GroupScope : DomainLocal
member : {CN=Domain Admins,CN=Users,DC=TOSSolution,DC=com, CN=Enterprise Admins,CN=Users,DC=TOSSolution,DC=com, CN=LabAdmin,CN=Users,DC=TOSSolution,DC=com, C
N=Administrator,CN=Users,DC=TOSSolution,DC=com}
Name : Administrators
ObjectClass : group
ObjectGUID : 02ce3874-hj34-41ba-sade-013f34019978
SamAccountName : Administrators
SID : S-1-4-31-765
C:\PS>get-adgroup -Filter ‘GroupCategory -eq “Security” -and GroupScope -ne “DomainLocal”‘
Get all groups that have a GroupCategory of Security but do not have a GroupScope of DomainLocal.
C:\PS>get-adgroup -server localhost:60000 -filter {GroupScope -eq “DomainLocal”} -SearchBase “DC=AppNC”
DistinguishedName : CN=AlphaGroup,OU=AccountDeptOU,DC=AppNC
GroupCategory : Security
GroupScope : DomainLocal
Name : AlphaGroup
ObjectClass : group
ObjectGUID : 02ce3874-hj34-41ba-ewsa-013f34019978
SID : S-1-32423546-124657213438-12345342
DistinguishedName : CN=BranchOffice1,OU=AccountDeptOU,DC=AppNC
GroupCategory : Security
GroupScope : DomainLocal
Name : BranchOffice1
ObjectClass : group
ObjectGUID : 34er5678-hj34-41ba-ewsa-013f34019978
SID : S-1-345243-24355678-245-8767863
DistinguishedName : CN=AccountLeads,OU=AccountDeptOU,DC=AppNC
GroupCategory : Distribution
GroupScope : DomainLocal
Name : AccountLeads
ObjectClass : group
ObjectGUID : d32i3545c-2de9-401a-b48c-341854a37254
SID : S-1-5763875345-5735-452345-5464-4567876-7868678Get-Command Get-ADGroup
. New-ADGroup
. Remove-ADGroup
. Set-ADGroup
