elixir_ldap v0.3.0 ElixirLdap.Search
Documentation for ElixirLdap.Search
Link to this section Summary
Functions
search filter equality match
search filter greater number
search filter less number
search filter attribute
this function actually search
search base dn entry. Filter will search for equal
search single level entry. Filter approximation match filter
Search base dn all entry. Search by base dn set in config file
Search base dn all entry. Use the base DN of the argument
search base dn all entry. DN is argument base search and deref aliase is argument
search single level entry. Filter will search for equal
search single level entry. Filter approximation match filter
Search single level all entry. Use the base DN of config file
Search single level all entry. Use the base DN of argument
Search single level all entry. Use the base DN of argument. deref aliases is argument
search sub tree entry. Filter will search for equal
search sub tree entry. Filter will search less number. Use the base DN of the argument
and search filter
not search filter
or search filter
Link to this section Functions
search filter equality match
Exsample
ElixirLdap.Serach.equality_match("cn", "User01")
search filter greater number
Exsample
ElixirLdap.Serach.greater_or_equal("age", "22")
search filter less number
Exsample
ElixirLdap.Serach.less_or_equal("age", "22")
search filter attribute
Exsample
ElixirLdap.Serach.present("telephoneNumber")
this function actually search
search base dn entry. Filter will search for equal.
Exsample
ElixirLdap.Search.search_base(handle, [filter: :equal, field: 'ou', name: 'Server'])
ElixirLdap.Search.search_base(handle, [filter: :present, type: 'ou'])
ElixirLdap.Search.search_base(handle, [filter: :greater, type: 'age', value: "22")
ElixirLdap.Search.search_base(handle, [filter: :less, type: 'age', value: "22")
search single level entry. Filter approximation match filter.
Example
ElixirLdap.Search.search_base(handle, 'ou=People,dc=corporation,dc=home,dc=local', [filter: :approx, type: 'age', value: "22"], :deref_always)
the argument def are:
* never_deref_aliases - Do not refer to alias entries
* deref_in_searching - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always - Always refer to alias entries
Search base dn all entry. Search by base dn set in config file.
Example
ElixirLdap.Search.search_base_all(handle)
Search base dn all entry. Use the base DN of the argument.
Example
ElixirLdap.Search.search_base_all(handle, 'ou=Server,dc=corporation,dc=home,dc=local')
search base dn all entry. DN is argument base search and deref aliase is argument.
Example
ElixirLdap.Search.search_base_all(handle, "ou=Server,dc=corporation,dc=home,dc=local", :deref_always)
the argument def are:
* never_deref_aliases - Do not refer to alias entries
* deref_in_searching - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always - Always refer to alias entries
search single level entry. Filter will search for equal.
Exsample
ElixirLdap.Search.search_single_level(handle, [filter: :equal, field: 'ou', name: 'Server'])
ElixirLdap.Search.search_single_level(handle, [filter: :present, type: 'ou'])
ElixirLdap.Search.search_single_level(handle, [filter: :greater, type: 'age', value: "22")
ElixirLdap.Search.search_single_level(handle, [filter: :less, type: 'age', value: "22")
ElixirLdap.Search.search_single_level(handle, [filter: :approx, type: 'age', value: "22"])
search single level entry. Filter approximation match filter.
Example
ElixirLdap.Search.search_single_level(handle, 'ou=People,dc=corporation,dc=home,dc=local', [filter: :approx, type: 'age', value: "22"], :deref_always)
the argument def are:
* never_deref_aliases - Do not refer to alias entries
* deref_in_searching - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always - Always refer to alias entries
Search single level all entry. Use the base DN of config file.
Example
ElixirLdap.Search.search_single_level_all(handle)
Search single level all entry. Use the base DN of argument.
Example
ElixirLdap.Search.search_single_level_all(handle, "ou=Server,dc=corporation,dc=home,dc=local")
Search single level all entry. Use the base DN of argument. deref aliases is argument
Example
ElixirLdap.Search.search_single_level_all(handle, "ou=Server,dc=corporation,dc=home,dc=local", :deref_always)
the argument def are:
* never_deref_aliases - Do not refer to alias entries
* deref_in_searching - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always - Always refer to alias entries
search sub tree entry. Filter will search for equal.
Exsample
ElixirLdap.Search.search_subtree(handle, [filter: :equal, field: 'ou', name: 'Server'])
ElixirLdap.Search.search_subtree(handle, [filter: :present, type: 'ou'])
ElixirLdap.Search.search_subtree(handle, [filter: :greater, type: 'age', value: "22"])
ElixirLdap.Search.search_subtree(handle, [filter: :less, type: 'age', value: "22"])
search sub tree entry. Filter will search less number. Use the base DN of the argument.
Exsample
ElixirLdap.Search.search_subtree(handle, 'ou=People,dc=corporation,dc=home,dc=local', [filter: :greater, type: 'age', value: "22"], :deref_always)
the argument def are:
* never_deref_aliases - Do not refer to alias entries
* deref_in_searching - If the base DN of the search is an alias entry, it refers to it, ignoring the alias entry under it
* deref_finding_baes_obj - If the base DN of the search is an alias entry no search is performed. If the base DN is not an alias entry, a search is performed, and furthermore, an alias entry under the base DN is referred to
* deref_always - Always refer to alias entries
and search filter
not search filter
or search filter