NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | ATTRIBUTES | SEE ALSO
/etc/opt/SUNWconn/ldap/current/ldapsearchprefs.conf
The ldapsearchprefs.conf file contains information used by LDAP when searching the directory. Blank lines and lines that start with a hash ('#') character are treated as comments and ignored. Non-comment lines contain one or more tokens. Tokens are separated by white space, and double quotes can be used to include white space inside a token.
Search preferences are typically used by LDAP-based client programs to specify what a user may search for, which attributes are searched, and which options are available to the user.
The first non-commment line specifies the version of the template information and must contain the token Version followed by an integer version number. For example:
Version 1 |
The remainder of the file consists of one or more search preference configurations. The first line of a search preference is a human-readable name for the type of object being searched for, for example People or Organizations. This name is stored in the so_objtypeprompt member of the ldap_searchobj structure (see ldap_searchprefs(3LDAP)). For example,
People |
The next line specifies a list of options for this search object. The only option currently allowed is "internal" which means that this search object should not be presented directly to a user. Options are placed in the so_options member of the ldap_searchobj structure and can be tested using the LDAP_IS_SEARCHOBJ_OPTION_SET() macro. Use "" if no special options are required.
The next line specifes a label to use for "Fewer Choices" searches. "Fewer Choices" searches are those where the user's input is fed to the ldap_filter routines to determine an appropriate filter to use. This contrasts with explicitly-constructed LDAP filters, or "More Choices" searches, where the user can explicitly construct an LDAP filter.
For example:
"Search For:" |
The next line specifies an LDAP filter prefix to append to all "More Choices" searched. This is typically used to limit the types of entries returned to those containing a specific object class. For example:
"(&(objectClass=person)" |
The next line is an LDAP filter tag which specifies the set of LDAP filters to be applied for "Fewer Choices" searching. The line
"x500-People" |
The next line specifies an LDAP attribute to retrieve to help the user choose when several entries match the search terms specified. For example:
"title" |
"Title:" |
The next line specifies the scope of the LDAP search to be performed. Acceptable values are subtree, onelevel, and base.
The next section is a list of "More Choices" search options, terminated by a line containing only the string END. For example:
"Common Name" cn 11111 "" "" "Surname" sn 11111 "" "" "Business Phone" "telephoneNumber" 11101 "" "" END |
The next section is a list of search match options, terminated by a a line containing only the string END. Example:
"exactly matches" "(%a=%v))" "approximately matches" "(%a~=%v))" "starts with" "(%a=%v*))" "ends with" "(%a=*%v))" "contains" "(%a=*%v*))" END |
# Version number Version 1 # Name for this search object People # Label to place before text box user types in "Search For:" # Filter prefix to append to all "More Choices" searches "(&(objectClass=person)" # Tag to use for "Fewer Choices" searches - from ldapfilter.conf file "x500-People" # If a search results in > 1 match, retrieve this attribute to help # user distinguish between the entries... multilineDescription # ...and label it with this string: "Description" # Search scope to use when searching subtree # Follows a list of "More Choices" search options. Format is: # Label, attribute, select-bitmap, extra attr display name, extra attr ldap name # If last two are null, "Fewer Choices" name/attributes used "Common Name" cn 11111 "" "" "Surname" sn 11111 "" "" "Business Phone" "telephoneNumber" 11101 "" "" "E-Mail Address" "mail" 11111 "" "" "Uniqname" "uid" 11111 "" "" END # Match types "exactly matches" "(%a=%v))" "approximately matches" "(%a~=%v))" "starts with" "(%a=%v*))" "ends with" "(%a=*%v))" "contains" "(%a=*%v*))" END
In this example, the user may search for People. For "fewer choices" searching, the tag for the ldapfilter.conf(4) file is "x500-People".
See attributes(5) for a description of the following attributes:
ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
---|---|
Availability |
SUNWlldap (32-bit) |
|
SUNWldapx (64-bit) |
Stability Level |
Evolving |
NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | ATTRIBUTES | SEE ALSO