Skip to content

DirectorySearcher

The DirectorySearcher class is used to perform LDAP search queries against Active Directory.

The class can only be used in PowerShell scripts executed on the server side. You can use it in scripts executed by Business Rules, Custom Commands, Scheduled Tasks, and Reports.

Inheritance: The DirectorySearcher class implements the IAdmDirectorySearcher interface.

Namespace: Softerra.Adaxes.Adsi.Search

Constructors

Methods

Properties

  • Property

  • Description

  • Pipelined

  • Gets a value indicating whether to apply access control to search results.

  • SearchParameters

  • Gets or sets the parameters for the directory search.

  • BaseObjectPath

  • Gets or sets the path of the directory object from which the search begins.

Details

DirectorySearcher()

Initializes a new instance of the DirectorySearcher class.

DirectorySearcher()

ExecuteSearch()

Performs a directory search and returns an instance of the IAdmSearchResultIterator2 interface that can be used to iterate through search results.

public IAdmSearchResultIterator2 ExecuteSearch()

Exceptions

Examples

The following code sample searches for users whose Department is Sales and exports their names and descriptions to a CSV file. The script can be executed as a part of a Business Rule, Custom Command, or Scheduled Task.

$csvFilePath = "\\SERVER\Share\Report.csv"

# Create an instance of the DirectorySearcher class
$searcher = New-Object "Softerra.Adaxes.Adsi.Search.DirectorySearcher" $NULL, $False

# Specify search parameters

# Limit the search to the OU on which a Business Rule, Scheduled Task or Custom Command is executed
$searcher.SearchParameters.BaseObjectPath = $Context.TargetObject.AdsPath
$searcher.SearchParameters.Filter = "(&(objectCategory=person)(objectClass=user)(department=Sales))"
$searcher.SearchParameters.SearchScope = "ADS_SCOPE_SUBTREE"
$searcher.SetPropertiesToLoad(@("name", "description"))

try
{
    # Execute search
    $searchResultIterator = $searcher.ExecuteSearch()

    # Fetch results
    $searchResults = $searchResultIterator.FetchAll()

    $csv = @()
    foreach ($searchResult in $searchResults)
    {
        $htable = @{
            Name = $searchResult.Properties["name"].Value;
            Description = $searchResult.Properties["description"].Value;
        }
        $userInfo = New-Object PSObject -Property $htable
        $csv += $userInfo
    }

    # Export to CSV
    $csv | Export-Csv $csvFilePath -NoTypeInformation
}
finally
{
    # Release resources used by the search
    $searchResultIterator.Dispose()
}

AppendFilter()

Appends the given LDAP search filter with the AND operator.

public void AppendFilter(String filter)

Parameters

The filter parameter specifies the LDAP filter to append.

Examples

The following code sample creates a filter out of the two given ones.

# Create an instance of the DirectorySearcher class
$searcher = New-Object "Softerra.Adaxes.Adsi.Search.DirectorySearcher" $NULL, $False

# Specify search filter
$searcher.SearchParameters.Filter = "(objectClass=contact)" # Contacts

# Append search filter
$searcher.AppendFilter("(mail=*)") # Contacts with email address

# Add a record into Execution Log
$Context.LogMessage("Search filter: " + $searcher.SearchParameters.Filter, "Information")

# Result: (&(mail=*)(objectClass=contact))

Pipelined

Gets a value indicating whether to apply access control to search results. If TRUE, results will be returned according to the Security Roles assigned to the user on behalf of which the operation is executed. If FALSE, all results will be returned.

  • Type:
  • Boolean
  • Access:
  • Read-only

SearchParameters

Gets or sets the parameters for the directory search.


BaseObjectPath

Gets or sets the path of the directory object from which the search begins. The path must be a valid ADS path string.

  • Type:
  • String
  • Access:
  • Read/Write

Requirements

Minimum required version: 2017.1

See also