Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Search-ADAccount

Search-ADAccount

microsoft.activedirectory.management.dll

Synopsis

Gets Active Directory user, computer, or service accounts.

Syntax

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-UsersOnly] [-AccountDisabled] [<CommonParameters>]

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-UsersOnly] [-AccountExpired] [<CommonParameters>]

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-DateTime] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-TimeSpan] [-UsersOnly] [-AccountExpiring] [<CommonParameters>]

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-DateTime] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-TimeSpan] [-UsersOnly] [-AccountInactive] [<CommonParameters>]

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-UsersOnly] [-LockedOut] [<CommonParameters>]

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-UsersOnly] [-PasswordExpired] [<CommonParameters>]

Search-ADAccount [-AuthType] [-ComputersOnly] [-Credential] [-ResultPageSize] [-ResultSetSize] [-SearchBase] [-SearchScope] [-Server] [-UsersOnly] [-PasswordNeverExpires] [<CommonParameters>]

Detailed Description

The Search-ADAccount cmdlet retrieves one or more user, computer, or service accounts that meet the criteria specified by the parameters. Search criteria include account and password status. For example, you can search for all accounts that have expired by specifying the AccountExpired parameter. Similarly, you can search for all accounts with an expired password by specifying the PasswordExpired parameter. You can limit the search to user accounts by specifying the UsersOnly parameter. Similarly, when you specify the ComputersOnly parameter, the cmdlet only retrieves computer accounts.

Some search parameters, such as AccountExpiring and AccountInactive use a default time that you can change by specifying the DateTime or TimeSpan parameter. The DateTime parameter specifies a distinct time. The TimeSpan parameter specifies a time range from the current time. For example, to search for all accounts that expire in 10 days, specify the AccountExpiring and TimeSpan parameter and set the value of TimeSpan to 10.00:00:00. To search for all accounts that expire before December 31, 2012, set the DateTime parameter to 12/31/2012.

Parameters

-AccountDisabled <SwitchParameter>

Specifies a search for accounts that are disabled. An account is disabled when the ADAccount Enabled property is set to false.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AccountExpired <SwitchParameter>

Specifies a search for accounts that are expired. An account is expired when the ADAccount AccountExpirationDate property is set to a time in the past. The LDAP Display Name (ldapDisplayName) for the AccountExpirationDate property is accountExpires.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AccountExpiring <SwitchParameter>

Specifies a search for accounts that are expiring in a given time period or by a specified time. To specify a time period, use the AccountExpiring parameter with the TimeSpan parameter. To specify a specific time, use the AccountExpiring parameter with the DateTime parameter.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AccountInactive <SwitchParameter>

Specifies to search for accounts that have not logged in within a given time period or since a specified time. To specify a time period, use the TimeSpan parameter. To specify a specific time, use the DateTime parameter. Note that this attribute is only used when the domain is in Windows Server 2003 Domain Functional Level, so this parameter will only work in that mode.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AuthType <ADAuthType>

Specifies the authentication method to use. The acceptable values for this parameter are:    -- Negotiate or 0   -- Basic or 1

The default authentication method is Negotiate.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputersOnly <SwitchParameter>

Specifies a search of only computer accounts.

Aliases

None

Required?

false

Position

named

Default value

None

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.

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 directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.

Specifies the credentials for the security context under which the task is performed. If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory. If running under the context of an AD PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the currently logged on user security context is used.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DateTime <DateTime>

Specifies a distinct time value for Search-ADAccount parameters such as AccountExpiring, AccountInactive, and PasswordExpiring.

Time is assumed to be local time unless otherwise specified. When a time value is not specified, the time is assumed to midnight local time. When a date is not specified, the date is assumed to be the current date. The following examples show commonly-used syntax to specify a DateTime object. “4/17/2006” “Monday, April 17, 2006” “2:22:45 PM” “Monday, April 17, 2006 2:22:45 PM”

These examples specify the same date and the time without the seconds. "4/17/2006 2:22 PM” "Monday, April 17, 2006 2:22 PM" "2:22 PM”

The following example shows how to specify a date and time by using the RFC1123 standard. This example defines time by using Greenwich Mean Time (GMT). "Mon, 17 Apr 2006 21:22:48 GMT”

The following example shows how to specify a value as Coordinated Universal Time (UTC). This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. "2000-04-17T14:22:48.0000000"

The following example shows how to set the AccountExpiring parameter to a DateTime value of June 18, 2012 at 2:00:00 AM. -AccountExpiring -DateTime “6/18/2012 2:00:00 AM”

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LockedOut <SwitchParameter>

Specifies a search for accounts that are locked out.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PasswordExpired <SwitchParameter>

Specifies a search for accounts that have an expired password.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PasswordNeverExpires <SwitchParameter>

Specifies a search for accounts that have a password that does not expire.

Aliases

None

Required?

true

Position

named

Default value

None

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.

The default is 256 objects per page.

Aliases

None

Required?

false

Position

named

Default value

None

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. The default is $null.

The following example shows how to set this parameter so that you receive all of the returned objects. -ResultSetSize $null

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SearchBase <String>

Specifies an Active Directory path to search under.

When you run a cmdlet from an 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 Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain.

When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value.

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SearchScope <ADSearchScope>

Specifies the scope of an Active Directory search. The acceptable 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.

Aliases

None

Required?

false

Position

named

Default value

None

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.

Specify the Active Directory Domain Services instance 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 this parameter is determined by one of the following methods in the order that they are listed: -- By using the Server value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain ServicesWindows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TimeSpan <TimeSpan>

Sets a time interval. This parameter is used to specify a time value for Search-ADAccount parameters such as AccountExpiring. Specify the time interval in the following format: [-]D.H:M:S.F where: -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) -- F= Fractions of a second (0 to 9999999)

Note: Time values must be between the following values: -10675199:02:48:05.4775808 and 10675199:02:48:05.4775807.

The following examples show how to set this parameter. Set the time to 2 days -TimeSpan "2" Set the time span to the previous 2 days -TimeSpan "-2" Set the time to 4 hours -TimeSpan "4:00"

For example, to search for all accounts that are expiring in 10 days, specify the AccountExpiring and TimeSpan parameters as follows. -AccountExpiring -TimeSpan "10"

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-UsersOnly <SwitchParameter>

Specifies a search for user accounts only.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.ActiveDirectory.Management.ADAccount

Notes

None

Examples

-------------------------- EXAMPLE 1 --------------------------

This command returns all users, computers and service accounts that are disabled.

PS C:\>Search-ADAccount -AccountDisabled | FT Name,ObjectClass -A
Name            ObjectClass
----            -----------
Guest           user
krbtgt          user
krbtgt_51399    user
AmyAl-LPTOP     computer
DeepakAn-DSKTOP computer

-------------------------- EXAMPLE 2 --------------------------

This command returns all users that are disabled.

PS C:\>Search-ADAccount -AccountDisabled -UsersOnly | FT Name,ObjectClass -A
Name         ObjectClass
----         -----------
Guest        user
krbtgt       user
krbtgt_51399 user

-------------------------- EXAMPLE 3 --------------------------

This command returns all users, computers and service accounts that are expired.

PS C:\>Search-ADAccount -AccountExpired | FT Name,ObjectClass -A



Name            ObjectClass
----            -----------
Greg Chapman    user
Claus Hansen    user
Tomasz Bochenek user



-------------------------- EXAMPLE 4 --------------------------

This command returns all users, computers and service accounts that will expire in the next 6 days.

PS C:\>Search-ADAccount -AccountExpiring -TimeSpan 6.00:00:00 | FT Name,ObjectClass -A
Name           ObjectClass
----           -----------
Iulian Calinov user
John Campbell  user
Garth Fort     user

-------------------------- EXAMPLE 5 --------------------------

This command returns all accounts that have been inactive for the last 90 days.

PS C:\>Search-ADAccount -AccountInactive -TimeSpan 90.00:00:00 | FT Name,ObjectClass -A
Name                        ObjectClass
----                        -----------
FABRIKAM-RODC1              computer
Guest                       user
krbtgt                      user
krbtgt_51399                user
Almudena Benito             user
Aaron Con                   user
Adina Hagege                user
Aaron Nicholls              user
Aaron M. Painter            user
Jeff Phillips               user
Flemming Pedersen           user

-------------------------- EXAMPLE 6 --------------------------

This command returns all accounts where the password has expired.

PS C:\>Search-ADAccount -PasswordExpired | FT Name,ObjectClass -A



Name                        ObjectClass
----                        -----------
Stan Orme                   user
Danni Ortman                user
Matej Potokar               user



-------------------------- EXAMPLE 7 --------------------------

This command returns all accounts with a password that will never expire.

PS C:\>Search-ADAccount -PasswordNeverExpires | FT Name,ObjectClass -A
Name           ObjectClass
----           -----------
Guest          user
Toni Poe       user
Anders Riis    user
Fabien Hernoux user

-------------------------- EXAMPLE 8 --------------------------

This command returns all accounts that have been locked out.

PS C:\>Search-ADAccount -LockedOut | FT Name,ObjectClass -A
Name           ObjectClass
----           -----------
Toni Poe       user

-------------------------- EXAMPLE 9 --------------------------

This command returns all disabled computer accounts.

PS C:\>Search-ADAccount -AccountDisabled -ComputersOnly | FT Name,ObjectClass -A
Name           ObjectClass
----           -----------
TPOE-PC1       computer

-------------------------- EXAMPLE 10 --------------------------

This command returns all accounts which expire on the 18th of March, 2009.

PS C:\>Search-ADAccount -AccountExpiring -DateTime "3/18/2009" | FT Name,ObjectClass -A
Name         ObjectClass
----         -----------
Anders Riis  user

-------------------------- EXAMPLE 11 --------------------------

This command returns all users, computers and service accounts that are disabled in the LDS instance: FABRIKAM-SRV1:60000.

PS C:\>Search-AdAccount -AccountDisabled -SearchBase "DC=AppNC" -Server "FABRIKAM-SRV1:60000"
Enabled               : False
Name                  : SanjayPatel
UserPrincipalName     : 
PasswordNeverExpires  : LockedOut             : False
ObjectGUID            : d671de28-6e40-42a7-b32c-63d336de296d
ObjectClass           : user
SID                   : S-1-510474493-936115905-2231798853-1260534229-4171027843-767619944
PasswordExpired       : False
LastLogonDate         : 
DistinguishedName     : CN=SanjayPatel,OU=AccountDeptOU,DC=AppNC
AccountExpirationDate :  

Online Version
Clear-ADAccountExpiration
Disable-ADAccount
Enable-ADAccount
Get-ADAccountResultantPasswordReplicationPolicy
Set-ADAccountControl
Set-ADAccountExpiration
Set-ADAccountPassword
Unlock-ADAccount