h3.Definition: LDAP Search Scope
The LDAP search scope indicates the set of entries at or below the [search base DN|Definition -- Search Base DN] that may be considered potential matches for a [search operation|Definition -- LDAP Search Operation].
There are four defined search scope values:
h2.baseObject
This specifies that the search operation should only be performed against the entry specified as the search base DN. No entries below it will be considered.
A sample DIT illustrating the baseObject scope with a search base DN of "dc=example,dc=com" is given below:
!baseObject-scope.png!
h2.singleLevel
This specifies that the search operation should only be performed against entries that are immediate subordinates of the entry specified as the search base DN. The base entry itself is not included, nor are any entries below the immediate subordinates of the search base entry.
A sample DIT illustrating the singleLevel scope with a search base DN of "dc=example,dc=com" is given below:
!singleLevel-scope.png!
h2.wholeSubtree
This specifies that the search operation should be performed against the entry specified as the search base and all of its subordinates to any depth.
A sample DIT illustrating the wholeSubtree scope with a search base DN of "dc=example,dc=com" is given below:
!wholeSubtree-scope.png!
h2.subordinateSubtree
This specifies that the search operation should be performed against all subordinate entries below the search base to any depth, but the search base entry itself should not be included.
A sample DIT illustrating the subordinateSubtree scope with a search base DN of "dc=example,dc=com" is given below:
!subordinateSubtree-scope.png!
The LDAP search scope indicates the set of entries at or below the [search base DN|Definition -- Search Base DN] that may be considered potential matches for a [search operation|Definition -- LDAP Search Operation].
There are four defined search scope values:
h2.baseObject
This specifies that the search operation should only be performed against the entry specified as the search base DN. No entries below it will be considered.
A sample DIT illustrating the baseObject scope with a search base DN of "dc=example,dc=com" is given below:
!baseObject-scope.png!
h2.singleLevel
This specifies that the search operation should only be performed against entries that are immediate subordinates of the entry specified as the search base DN. The base entry itself is not included, nor are any entries below the immediate subordinates of the search base entry.
A sample DIT illustrating the singleLevel scope with a search base DN of "dc=example,dc=com" is given below:
!singleLevel-scope.png!
h2.wholeSubtree
This specifies that the search operation should be performed against the entry specified as the search base and all of its subordinates to any depth.
A sample DIT illustrating the wholeSubtree scope with a search base DN of "dc=example,dc=com" is given below:
!wholeSubtree-scope.png!
h2.subordinateSubtree
This specifies that the search operation should be performed against all subordinate entries below the search base to any depth, but the search base entry itself should not be included.
A sample DIT illustrating the subordinateSubtree scope with a search base DN of "dc=example,dc=com" is given below:
!subordinateSubtree-scope.png!