--- external help file: PSAD-help.xml online version: https://github.com/zloeber/PSAD schema: 2.0.0

---

Get-DSDirectorySearcher

SYNOPSIS

Get a diresctory searcher object fro a given domain.

SYNTAX

Get-DSDirectorySearcher [[-ComputerName] <String>] [[-Credential] <PSCredential>] [[-Limit] <Int32>]
 [[-SearchRoot] <String>] [[-Filter] <String>] [[-Properties] <String[]>] [[-PageSize] <Int32>]
 [[-SearchScope] <String>] [[-SecurityMask] <String[]>] [-TombStone]

DESCRIPTION

Get a diresctory searcher object fro a given domain.

EXAMPLES

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

$ADSearcher = Get-DSDirectorySearcher -Filter '(&(objectCategory=computer)(servicePrincipalName=MSSQLSvc*))'

Create a DirectorySearcher object with a filter for searching for all computers with a servicePrincipalName for Microsoft SQL Server.

PARAMETERS

-ComputerName

Domain controller to use.

Type: String
Parameter Sets: (All)
Aliases: Server, ServerName

Required: False
Position: 1
Default value: $Script:CurrentServer
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to use connection.

Type: PSCredential
Parameter Sets: (All)
Aliases: Creds

Required: False
Position: 2
Default value: $Script:CurrentCredential
Accept pipeline input: False
Accept wildcard characters: False

-Limit

Limits items retrieved. If set to 0 then there is no limit.

Type: Int32
Parameter Sets: (All)
Aliases: SizeLimit

Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-SearchRoot

Root of search.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

LDAP filter for searches.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: DistinguishedName=*
Accept pipeline input: False
Accept wildcard characters: False

-Properties

Properties to include in output.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: @('Name','ADSPath')
Accept pipeline input: False
Accept wildcard characters: False

-PageSize

Items returned per page.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: $Script:PageSize
Accept pipeline input: False
Accept wildcard characters: False

-SearchScope

Scope of a search as either a base, one-level, or subtree search, default is subtree.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 8
Default value: Subtree
Accept pipeline input: False
Accept wildcard characters: False

-SecurityMask

Specifies the available options for examining security information of a directory object.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TombStone

Whether the search should also return deleted objects that match the search filter.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

System.DirectoryServices.DirectorySearcher

NOTES

Author: Zachary Loeber

RELATED LINKS

https://github.com/zloeber/PSAD