Get-ADUser

Get one or more Active Directory users.

Syntax
      Get-ADUser -Filter string [-ResultPageSize int] [-ResultSetSize int32]
         [-SearchBase string] [-SearchScope {Base | OneLevel | Subtree}]
            [-SearchScope {Base | OneLevel | Subtree}]
               [-AuthType {Negotiate | Basic}]
                  [-Credential PSCredential] [-Partition string]
                     [-Properties string[]] [-Server string] [CommonParameters]

      Get-ADUser [-Identity] ADUser [-AuthType {Negotiate | Basic}]
         [-Credential PSCredential] [-Partition string]
            [-Properties string[]] [-Server string] [CommonParameters]

      Get-ADUser -LDAPFilter string [-ResultPageSize int] [-ResultSetSize int32]
         [-SearchBase string] [-SearchScope {Base | OneLevel | Subtree}]
            [-AuthType {Negotiate | Basic}]
               [-Credential PSCredential] [-Partition string]
                  [-Properties string[]] [-Server string] [CommonParameters]

Key
   -AuthType {Negotiate | Basic}
       The authentication method to use: Negotiate (or 0), Basic (or 1)
       A Secure Sockets Layer (SSL) connection is required for Basic authentication.

   -Credential PSCredential
       The user account credentials to use to perform this task.
       The default credentials are those 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.

       Type a user name, such as "User64" or "Domain64\User64" or specify a
       PSCredential object such as one generated by Get-Credential 

       If a user name is specified, the cmdlet will prompt for a password.

   -Filter string
       A query string that retrieves Active Directory objects.
       This string uses the PowerShell Expression Language syntax:

       filter ::= "{" FilterComponentList"}"
       FilterComponentList ::= FilterComponent | FilterComponent JoinOperator FilterComponent | NotOperator FilterComponent
       FilterComponent ::= attr FilterOperator value | "(" FilterComponent")"
       FilterOperator ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike"
       JoinOperator ::= "-and" | "-or"
       NotOperator ::= "-not"
       attr ::= PropertyName | LDAPDisplayName_of_the_attribute
       value::= <compare this value with an attr by using the specified FilterOperator>

   -Identity ADUser
       An AD account object, specified with one of the following values.
       (The identifier in parentheses is the LDAP display name for the attribute.)

          Distinguished Name 
            Example: CN=JonSmith,CN=Sales,OU=europe,CN=users,DC=corp,DC=SS64,DC=com 
          GUID (objectGUID) 
            Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
          Security Identifier (objectSid) 
            Example: S-1-5-21-3165297888-301567370-576410423-1103
          Security Accounts Manager (SAM) Account Name (sAMAccountName)
            Example: JonSmith

       The cmdlet searches the default naming context or partition to find the object.
       If two or more objects are found, the cmdlet returns a non-terminating error.

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

       This example shows how to set the parameter to a distinguished name.
          -Identity  "CN=JonSmith,CN=Sales,OU=europe,CN=users,DC=corp,DC=SS64,DC=com"

       This example shows how to set this parameter to a group object instance named "accountInstance".
          -Identity $accountInstance

   -LDAPFilter string
       An LDAP query string that is used to filter AD objects.
       Use this parameter to run existing LDAP queries. 
       See also Help about_ActiveDirectory_Filter.

       For example to search an OU for names beginning with "sara".
       -LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=demo,DC=SS64,DC=com"

   -Partition string
       The distinguished name of an AD partition.
       string 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. 
       Examples:
         -Partition "CN=Configuration,DC=Europe,DC=Test,DC=SS64,DC=com"
         -Partition "CN=Schema,CN=Configuration,DC=Europe,DC=Test,DC=SS64,DC=com"
          
       In many cases, a default value will be used for -Partition if no value is specified.
        
   -Properties string[]
       The properties of the output object to retrieve from the server (comma-separated list).
       Use this parameter to retrieve properties that are not included in the default set.

       To display all of the attributes that are set on the object, specify * (asterisk).

       Specify the property Name or,for non default/extended properties, the LDAP Display Name of the attribute.

   -ResultPageSize int
       The number of objects to include in each page for an AD Domain Services query.
       default = 256

   -ResultSetSize Int32
       The maximum number of objects to return for an AD Domain Services query.
       To receive all objects, set this to $null. Ctrl+c will stop the query and return of objects.
       default = $null.

   -SearchBase string
       An Active Directory path to search under.
       e.g.
       -SearchBase "ou=training,dc=demo,dc=ss64,dc=com"

   -SearchScope
       The scope of an AD search.
       Possible values for this parameter are:
       Base or 0        Search only the current path or object.
       OneLevel or 1    Search the immediate children
       Subtree or 2     Search the current path/object and all children

   -Server string
       The AD Domain Services instance to connect to, this may be a Fully qualified domain name,
       NetBIOS name, Fully qualified directory server name (with or without port number)

   CommonParameters:
       -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
       -OutBuffer -OutVariable.

Get-ADUser gets a user object or performs a search to retrieve multiple user objects.

The -Identity parameter specifies the AD user to get. Identify a user with a distinguished name (DN), GUID, security identifier (SID), Security Accounts Manager (SAM) account name or name. Alternatively set the -Identity parameter to a user object variable, or pass a user object through the PowerShell pipeline.

To search for and retrieve more than one user, use -Filter or -LDAPFilter. -Filter uses the PowerShell Expression Language to write query strings for AD. see help about_ActiveDirectory_Filter. If you have existing LDAP query strings, you can use -LDAPFilter.

This cmdlet retrieves a default set of user object properties. To retrieve additional properties use -Properties

Examples

Get all users under the container 'OU=Personnel,DC=SS64,DC=COM':

PS C:\> Get-ADUser -Filter * -SearchBase "OU=Personnel,DC=SS64,DC=COM"

Get all users that have a name that ends with 'SvcAccount':

PS C:\> Get-ADUser -Filter 'Name -like "*SvcAccount"' | FT Name,SamAccountName -A

Get all properties of the user with samAccountName 'StanGetz':

PS C:\> Get-ADUser StanGetz -Properties *

“I rely on my personality for birth control” ~ Liz Winston

Related:

New-adUser - Create a new AD user.
Remove-adUser - Remove an AD user.
Set-adUser - Modify an AD user.


© Copyright SS64.com 1999-2014
Some rights reserved