Specifies the scope of the LDAP search. This property defines whether the search applies to the entire subtree (BaseDN and all its descendants), a single level (BaseDN and its direct descendants), or just the base object (BaseDN only).

Syntax

Connect-LDAP -Scope string

Possible Values

Data Type

cstr

Default Value

"WHOLESUBTREE"

Remarks

This property is useful for balancing performance and query results. For broad searches that require retrieving entries across the entire directory hierarchy, use WHOLESUBTREE. For more focused queries, select SINGLELEVEL to limit results to the BaseDN’s direct descendants or BASEOBJECT to retrieve only the BaseDN itself. Narrowing the search scope can help reduce unnecessary overhead and improve query efficiency, especially in large directories.

• WHOLESUBTREE (Default): Searches the BaseDN and all of its descendants.
• SINGLELEVEL: Searches only the BaseDN and its direct descendants.
• BASEOBJECT: Searches only the BaseDN itself, without including any descendants.

This is a required parameter.