Get-QADGroup
From PowerGUI Wiki
Retrieve all groups in a domain or container that match the specified conditions. Supported are both Active Directory Domain Services (AD DS) and Active Directory Lightweight Directory Services (AD LDS).
Contents |
Syntax
Get-QADGroup [-SamAccountName <String>] [-GroupType <GroupType>] [-GroupScope <GroupScope>] [-Dynamic [<Boolean>]] [-Empty [<Boolean>]] [[-Identity] <IdentityParameter>] [-ObjectAttributes <Object>] [-ldapFilter <String>] [-SearchRoot <IdentityParameter>] [-SearchScope <SearchScope>] [-PageSize <Int32>] [-SizeLimit <Int32>] [-WildcardMode <WildcardMode>] [-AttributeScopeQuery <String>] [-IncludeAllProperties] [-DontConvertValuesToFriendlyRepresentation] [-SerializeValues] [-ReturnPropertyNamesOnly] [-DontUseDefaultIncludedProperties] [-UseDefaultExcludedProperties [<Boolean>]] [-ExcludedProperties <String[]>] [-IncludedProperties <String[]>] [-UseDefaultExcludedPropertiesExcept <String[]>] [-SecurityMask <SecurityMasks>] [-Description <String>] [-DisplayName <String>] [-Name <String>] [-Anr <String>] [-Proxy] [-Service <String>] [-ConnectionAccount <String>] [-ConnectionPassword <SecureString>] [-Credential <PSCredential>] [-Connection <ArsConnection>] [-UseGlobalCatalog] [<CommonParameters>]
Detailed Description
Use this cmdlet to search an Active Directory domain or container for groups that meet certain search criteria, or to bind to a certain groups by DN, SID, GUID, or Domain\Name. You can search by group attributes or specify your search criteria by using an LDAP search filter.
The output of the cmdlet is a collection of objects, with each object representing one of the groups found by the cmdlet. You can pipe the output into another cmdlet, such as Set-QADObject, to make changes to the groups returned by this cmdlet.
The cmdlet has optional parameters that determine the server and the security context for the operation. Normally, the connection parameters could be omitted so far as a connection to a server is established prior to using the cmdlet. In this case, the server and the security context are determined by the Connect-QADService cmdlet.
If you do not use Connect-QADService and have no connection established prior to using a cmdlet, then the connection settings, including the server and the security context, are determined by the connection parameters of the first cmdlet you use. Subsequent cmdlets will use those settings by default.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| SamAccountName | Search by the 'sAMAccountName' attribute. | false | false | |
| GroupType | Specify the group type of groups you want to find. Acceptable values are: 'Security'; 'Distribution'. | false | false | |
| GroupScope | Specify the group scope of groups you want to find. Acceptable values are: 'Global'; 'Universal'; 'DomainLocal'. | false | false | |
| Dynamic | Set the value of this parameter to 'true' if you want the cmdlet to retrieve only those groups that are configured as Dynamic Groups in ActiveRoles Server. This parameter requires that the Proxy parameter be supplied, so as to establish a connection the ActiveRoles Server Administration Service. | false | false | |
| Empty | Set the value of this parameter to 'true' if you want the cmdlet to retrieve only those groups that have no members (empty groups).
Note: A group is considered empty if it has the "member" attribute not set. So, this parameter can retrieve a group that has only those members for which the group is set as the primary group. An example is the Domain Users group, which normally is the primary group for any user account while having the "member" attribute not set. | false | false | |
| Identity | Specify the DN, SID, GUID, or Domain\Name of the group you want to find.
The cmdlet attempts to find the group that is identified by the value of this parameter, disregarding the other parameters. If you want other parameters to have effect, do not supply any value of this parameter on the command line. | false | true (ByValue) | |
| ObjectAttributes | Specify an associative array that defines the attributes to search. The array syntax:
@{attr1='val1';attr2='val2';...} In this syntax, each of the key-value pairs is the LDAP display name and the value of an attribute to search. A value may include an asterisk character - a wildcard representing any group of characters. For information about associative arrays, type the following command at the PowerShell command-prompt: help about_associative_array | false | false | |
| ldapFilter | Specify the LDAP search filter that defines your search criteria. Note that the search filter string is case-sensitive.
The cmdlet disregards this parameter if an Identity value is supplied. If you want this parameter to have effect, do not supply any Identity value on the command line. Instead, supply a SearchRoot value. With the LdapFilter parameter, the cmdlet disregards the attribute-specific parameters. If you want to define search criteria based on specific attributes, do not supply LdapFilter on the command line. | false | false | |
| SearchRoot | Specify the DN, GUID or canonical name of the domain or container to search. By default, the cmdlet searches the entire sub-tree of which SearchRoot is the topmost object (sub-tree search). This default behavior can be altered by using the SearchScope parameter.
The search criteria are defined by either the LdapFilter parameter value or the values of attribute-specific parameters. The cmdlet disregards this parameter if an Identity value is supplied. If you want this parameter to have effect, do not supply any Identity value on the command line. | false | false | |
| SearchScope | Specify one of these parameter values:
'Base' Limits the search to the base (SearchRoot) object.
The result contains a maximum of one object.
'OneLevel' Searches the immediate child objects of the base (SearchRoot)
object, excluding the base object.
'Subtree' Searches the whole sub-tree, including the base (SearchRoot)
object and all its child objects.
Normally, if this parameter is not supplied, the cmdlet performs a Subtree search. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | Subtree |
| PageSize | Set the maximum number of items in each page of the search results that will be returned by the cmdlet. After the directory server has found the number of objects that are specified by this parameter, it will stop searching and return the results to the cmdlet. When the cmdlet requests more data, the server will restart the search where it left off. You can use this setting to adjust the number of requests (network calls) to the directory server issued by the cmdlet during a search.
Normally, the default page size is 50. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | 50 |
| SizeLimit | Set the maximum number of items to be returned by the cmdlet. Normally, the default size limit is 1000. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | 1000 |
| WildcardMode | Specify either 'PowerShell' or 'LDAP' as the parameter value. Normally, if this parameter is not supplied, the cmdlet assumes that WildcardMode is set to 'LDAP'. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively.
The 'PowerShell' value causes the cmdlet to use PowerShell wildcards and quoting rules. Wildcards are processed on the client side, which may result in slow search performance. For information about PowerShell wildcards and quoting rules, type the following commands at the PowerShell command-prompt: help about_wildcard help about_quoting_rule The 'LDAP' value causes the cmdlet to use LDAP wildcards (asterisks only) and LDAP quoting rules (backslash as the escape character). Wildcards are processed on the server side, which enables faster search results. | false | false | LDAP |
| AttributeScopeQuery | Specify the LDAP display name of an attribute that has DN syntax (for example, 'member'). The cmdlet enumerates the distinguished name values of the attribute on the group specified by the SearchRoot parameter, and performs the search on the objects represented by the distinguished names. The SearchScope parameter has no effect in this case. The group to search must be specified by using the SearchRoot parameter rather than the Identity parameter.
For instance, with the value of this parameter set to 'member', the cmdlet searches the collection of the objects that are members of the group defined by the SearchRoot parameter. | false | false | |
| IncludeAllProperties | With this parameter, the cmdlet retrieves all attributes of the respective directory object (such as a User object), and stores the attribute values in the memory cache on the local computer. Attribute values can be read from the memory cache by using properties of the object returned by the cmdlet. Thus, when used in conjunction with the SerializeValues parameter, it allows an entire object to be exported from the directory to a text file. For examples of how to use this parameter, see help on the Get-QADUser or Get-QADObject cmdlet. | false | false | |
| DontConvertValuesToFriendlyRepresentation | This parameter causes the cmdlet to represent the Integer8 and OctetString attribute values “as is,” without converting them to a user-friendly, human-readable form. If this parameter is omitted, the cmdlet performs the following data conversions:
- The values of the Integer8 attributes listed in the Integer8AttributesThatContainDateTimes array (see the parameter descriptions for the Get-QADPSSnapinSettings and Set-QADPSSnapinSettings cmdlets) are converted from IADsLargeInteger to DateTime - The values of the Integer8 attributes listed in the Integer8AttributesThatContainNegativeTimeSpans array (see the parameter descriptions for the Get-QADPSSnapinSettings and Set-QADPSSnapinSettings cmdlets) are converted from IADsLargeInteger to TimeSpan - The values of the other Integer8 attributes are converted from IADsLargeInteger to Int64 - The values of the OctetString attributes are converted from byte[] to BinHex strings Note: This parameter has an effect only on the properties of the output object that have the member type of NoteProperty. Such properties are normally added to the output object in order to provide access to the attribute values of the respective directory object that are loaded to the local memory cache but cannot be accessed by using properties of the base object (the object for which the output object serves as a wrapper). | false | false | |
| SerializeValues | This parameter causes the cmdlet to output an object whose properties store the attribute values of the respective directory object that are loaded to the local memory cache. The value returned by each property of the output object is represented as a string (serialized) so as to facilitate the export of the attribute values to a text file. Thus, when used in conjunction with the IncludeAllProperties parameter, it allows an entire object to be exported from the directory to a text file. For examples of how to use this parameter, see help on the Get-QADUser cmdlet. | false | false | |
| ReturnPropertyNamesOnly | This parameter causes the cmdlet to list the names of the object attributes whose values the cmdlet retrieves from the directory and stores in the memory cache on the local computer. Thus, when used in conjunction with the IncludeAllProperties parameter, it lists the names of all attributes of the respective directory object (such as a User object). For examples of how to use this parameter, see help on the Get-QADUser or Get-QADObject cmdlet.
Note: Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by the cmdlet. If a particular attribute is not in the cache, the output object may not have a property that would provide access to the value of the attribute. | false | false | |
| DontUseDefaultIncludedProperties | This parameter causes the cmdlet to load only a small set of attributes from the directory to the local memory cache (normally, this set is limited to objectClass and ADsPath). Other attributes are retrieved from the directory as needed when you use the cmdlet's output objects to read attribute values. Thus, if you want only to count the objects that meet certain conditions (rather than examine values of particular attributes), then you can use this parameter to increase performance of your search. For examples of how to use this parameter, see help on the Get-QADUser cmdlet.
Note: If a cmdlet does not cache a particular attribute, then the output object returned by the cmdlet may not have a property that would provide access to the value of the attribute. | false | false | |
| UseDefaultExcludedProperties | When set to 'true', this parameter causes the cmdlet not to load a certain pre-defined set of attributes from the directory to the local memory cache. This pre-defined set of attributes (referred to as "default excluded properties") can be viewed or modified by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. Normally, this parameter is used in conjunction with IncudeAllProperties to avoid retrieval of unnecessary data from the directory server, thereby increasing performance of the search operation performed by the cmdlet.
Note: If a cmdlet does not cache a particular attribute, then the output object returned by the cmdlet may not have a property that would provide access to the value of the attribute. | false | false | false |
| ExcludedProperties | Use this parameter to specify the attributes that you do not want the cmdlet to retrieve from the directory and store in the memory cache on the local computer. Supply a list of the attribute LDAP display names as the parameter value. By default, the cmdlet caches a certain pre-defined set of attributes, which you can view or modify by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. Using the ExcludedProperties parameter you can change this default behavior on an ad-hoc basis, in order to prevent certain attributes from being loaded. Another scenario involves the use of this parameter in conjunction with IncludeAllProperties in order to restrict the set of the cached attributes.
Note: If a cmdlet does not cache a particular attribute, then the output object returned by the cmdlet may not have a property that would provide access to the value of the attribute. | false | false | |
| IncludedProperties | Use this parameter to specify the attributes that you want the cmdlet to retrieve from the directory and store in the memory cache on the local computer. Supply a list of the attribute LDAP display names as the parameter value. By default, the cmdlet caches a certain pre-defined set of attributes, which you can view or modify by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. Using the IncludedProperty parameter you can direct the cmdlet to cache some attributes in addition to the default set.
Note: Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by the cmdlet. | false | false | |
| UseDefaultExcludedPropertiesExcept | This parameter is deprecated, and has no effect. | false | false | |
| SecurityMask | Specify which elements of the object's security descriptor to retrieve. Valid parameter values are:
'None' - do not retrieve any security data 'Owner' - retrieve the owner data 'Group' - retrieve the primary group data 'Dacl' - retrieve the discretionary access-control list data 'Sacl' - retrieve the system access-control list data You can supply a combination of these values, separating them by commas. For example, you can supply the parameter value of 'Dacl,Sacl' in order to retrieve both the discretionary and system access-control list data. | false | false | |
| Description | Search by the 'description' attribute. | false | false | |
| DisplayName | Search by the 'displayName' attribute. | false | false | |
| Name | Search by the 'name' attribute. | false | false | |
| Anr | Specify a value to be resolved using ambiguous name resolution (ANR). By default, the following attributes are set for ANR:
GivenName Surname displayName LegacyExchangeDN msExchMailNickname RDN physicalDeliveryOfficeName proxyAddress sAMAccountName For instance, when you supply 'ann*' as the value of this parameter, the cmdlet searches for objects that have ann at the beginning of the value of at least one of the attributes listed above. | false | false | |
| Proxy | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Service | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionAccount | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionPassword | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Credential | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Connection | For parameter description, see help on the Connect-QADService cmdlet. | false | true (ByValue) | |
| UseGlobalCatalog | For parameter description, see help on the Connect-QADService cmdlet. | false | false |
Examples
Example 1
(get-QADGroup 'CN=Admins,OU=CompanyOU,DC=company,DC=com').DirectoryEntry.description
Connect to any available domain controller with the credentials of the locally logged on user, bind to a specific group by DN, and display the description of the group.
Example 2
$pw = read-host "Enter password" -AsSecureString C:\PS>connect-QADService -service 'server.company.com' -ConnectionAccount 'company\administrator' -ConnectionPassword $pw C:\PS>(get-QADGroup -identity 'S-1-5-21-1279736177-1630491018-182859109-1305').DirectoryEntry.description C:\PS>disconnect-QADService
Connect to a specific domain controller with the credentials of a specific user, bind to a certain group by SID, display the description of the group, and then disconnect.
Example 3
get-QADGroup -SearchRoot 'company.com/GroupsOU' -LdapFilter '(description=a*)'
Connect to any available domain controller with the credentials of the locally logged on user, search for groups in a specific container by using an LDAP search filter, and display a list of the groups found.
Example 4
get-QADGroup -SearchRoot 'company.com/GroupsOU' -GroupType 'Distribution'
Connect to any available domain controller with the credentials of the locally logged on user, find all distribution groups in a specific container, and display a list of the groups found.
Example 5
$pw = read-host "Enter password" -AsSecureString
C:\PS>connect-QADService -ConnectionAccount 'company\administrator' -ConnectionPassword $pw
C:\PS>get-QADGroup -SearchRoot 'company.com/GroupsOU' –ObjectAttributes @{info=''} | set-QADObject -ObjectAttributes @{info='A note'}
C:\PS>disconnect-QADService
Connect to any available domain controller with the credentials of a specific user, search a certain container to find all groups with the empty Notes field, set a note for each of those groups, and then disconnect.
Example 6
get-QADGroup -Service 'server.domain.local:389' -SearchRoot '<DN of container>'
Connect to the AD LDS instance on 'server.domain.local:389' with the credentials of the locally logged on user, find all AD LDS groups in a specific container, and display a list of the groups found.
