Get-AdmGroup

Gets one or more groups.

Description

The Get-AdmGroup cmdlet gets a group or performs a search to retrieve multiple groups.

The Identity parameter specifies the group to get. You can identify a group by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. You can also specify a group object variable, such as $<localGroupObject> or pass a group object through the pipeline to the Identity parameter.

To search for and retrieve more than one group, use the Filter or LDAPFilter parameter. The Filter parameter uses the PowerShell Expression Language syntax or the criteria-based syntax, depending on whether AdaxesService parameter is specified.

This cmdlet gets a default set of group object properties. To get additional properties, use the Properties parameter.

Examples

Example 1 – Get a group by sAMAccountName 

Get-AdmGroup -Identity Administrators

DistinguishedName : CN=Administrators,CN=Builtin,DC=Fabrikam,DC=com
ObjectClass       : group
Name              : Administrators
ObjectGUID        : 02ce3874-dd86-41ba-bddc-013f34019978
SamAccountName    : Administrators
SID               : S-1-5-32-544
GroupCategory     : Security
GroupScope        : DomainLocal

This command gets the group with SAM account name Administrators.

Example 2 – Get a group by SID 

Get-AdmGroup -Identity S-1-5-32-544 -Properties member

DistinguishedName : CN=Administrators,CN=Builtin,DC=Fabrikam,DC=com
ObjectClass       : group
Name              : Administrators
ObjectGUID        : 02ce3874-dd86-41ba-bddc-013f34019978
SamAccountName    : Administrators
SID               : S-1-5-32-544
GroupCategory     : Security
GroupScope        : DomainLocal
member            : {CN=Domain Admins,CN=Users,DC=Fabrikam,DC=com, CN=Enterprise Admins,CN=Users,DC=Fabrikam,DC=com}

This command gets the group with SID S-1-5-32-544 and the property member.

Example 3 – Get groups and filter the results 

Get-AdmGroup -Filter 'GroupCategory -eq "Security" -and GroupScope -ne "DomainLocal"'

This command gets all groups that have the Security GroupCategory but do not have the DomainLocal GroupScope.

Parameters

-AdaxesService

Specifies the DNS name of an Adaxes service that will be used to execute this cmdlet. If this parameter is not specified, and the cmdlet is running from an Adaxes Active Directory provider drive, the value for this parameter can be determined from the current path. For example, if the current path is Adaxes:/example.com, the Adaxes service on example.com will be used. If the parameter is not specified and the service DNS name can't be determined from the current path, the cmdlet will access Active Directory directly. To perform an operation in a Microsoft Entra managed domain, you must specify this parameter.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Credential

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 Adaxes Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default one.

To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.

You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.

If the acting credentials do not have permission to perform the task, the cmdlet returns a terminating error.

  • Type:

  • PSCredential

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Filter

Specifies a query string that retrieves group objects. If the cmdlet is executed without the AdaxesService parameter, the filter must follow the PowerShell Expression Language syntax. If the AdaxesService parameter is specified, a criteria expression can also be used. For details on how to build criteria, see How to build criteria.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • True

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Identity

Specifies a group object by providing one of the following property values. The identifier in parentheses is the schema name of the attribute.

Possible values for this parameter are:

  • Distinguished name (distinguishedName)
  • GUID (objectGUID)
  • Security identifier (objectSid)
  • SAM account name (sAMAccountName)

The cmdlet searches the default naming context or partition to find the object.

This parameter can also get an object through the pipeline or you can set the parameter to an object instance.

  • Type:

  • ADGroup

  • Position:

  • 1

  • Required:

  • True

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByValue)

  • Accept wildcard characters:

  • False

-LDAPFilter

Specifies an LDAP query string that is used to filter Active Directory objects.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • True

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Partition

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.

In many cases, a default value will be used for the Partition parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first, and once a default value can be determined, no further rules will be evaluated.

  • If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name.
  • If running cmdlets from an Adaxes Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive.
  • If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Properties

Specifies the properties of the output object to retrieve from the server. Use this parameter to retrieve properties that are not included into the default set.

Specify properties for this parameter as a comma-separated list of names. To display all of the attributes that are set on the object, specify * (asterisk).

To specify an individual extended property, use the name of the property. For properties that are not default or extended properties, you must specify the name exactly as it is defined in your directory schema.

To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet.

  • Type:

  • string[]

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-ResultPageSize

Specifies the number of objects to include in one page of this query.

The default is 256 objects per page.

  • Type:

  • int

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-ResultSetSize

Specifies the maximum number of objects to return for this 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.

The default is $null.

  • Type:

  • int

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-SearchBase

Specifies a directory path to search under.

When you run a cmdlet from an Adaxes Active Directory provider drive, the default value of this parameter is the current path of the drive.

When you run a cmdlet outside of an Adaxes Active Directory provider drive, the default value of this parameter is the default naming context of the target domain.

The following example shows how to set this parameter to search under an OU.

-SearchBase "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com"

When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-SearchScope

Specifies the scope of the search.

Possible values for this parameter are:

  • Base or 0
  • OneLevel or 1
  • Subtree or 2

A Base query searches only the current path or object. A OneLevel query searches the immediate children of that path or object. A Subtree query searches the current path or object and all children of that path or object.

  • Type:

  • ADSearchScope

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Server

Specifies the directory to connect to by providing one of the following values for a corresponding domain name or directory server. Specify the AD DS instance or the Microsoft Entra domain name in one of the following ways:

Domain name values:

  • Fully qualified domain name
  • NetBIOS name

Directory server values:

  • Fully qualified directory server name
  • NetBIOS name
  • Fully qualified directory server name and port

The default value for the Server parameter is determined by one of the following methods in the order that they are listed:

  • By using Server value from objects passed through the pipeline.
  • By using the server information associated with the Adaxes Active Directory PowerShell provider drive, when running under that drive.
  • By using the domain of the computer running PowerShell.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

Inputs

None or Softerra.Adaxes.PowerShellModule.Directory.ADGroup

A group object is received by the Identity parameter.

Outputs

Softerra.Adaxes.PowerShellModule.Directory.ADGroup

Returns one or more group objects.

This cmdlet returns a default set of ADGroup property values. To retrieve additional properties, use the Properties parameter.

See also

© Softerra 2022. All rights reserved.
Send feedback