xref: /illumos-gate/usr/src/man/man8/ldap_cachemgr.8 (revision 8aafd47d0dbabbca4365c9565fbe0e051e7346dd)
te
Copyright (C) 2005, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
LDAP_CACHEMGR 8 "May 13, 2017"
NAME
ldap_cachemgr - LDAP daemon to manage client configuration for LDAP based Network Information Service lookups
SYNOPSIS

/usr/lib/ldap/ldap_cachemgr [-l log-file] [-g]
DESCRIPTION

The ldap_cachemgr daemon is a process that provides an up-to-date configuration cache for LDAP naming services. It is started during multi-user boot.

The ldap_cachemgr utility provides caching for all parameters as specified and used by the LDAP naming service clients. The ldap_cachemgr utility uses the cache files which are originally created by executing the ldapclient(8) utility, as cold start files. Updates to the cache files take place dynamically if profiles are used to configure the client. See the init option to ldapclient(8).

The ldap_cachemgr utility helps improve the performance of the clients that are using LDAP as the Naming service repository. In order for the LDAP naming services to function properly, the ldap_cachemgr daemon must be running. ldap_cachemgr also improves system security by making the configuration files readable by superuser only.

The cache maintained by this daemon is shared by all the processes that access LDAP Naming information. All processes access this cache through a door call. On startup, ldap_cachemgr initializes the cache from the cache files. See ldapclient(8). Thus, the cache survives machine reboots.

The ldap_cachemgr daemon also acts as its own administration tool. If an instance of ldap_cachemgr is already running, commands are passed transparently to the running version.

OPTIONS

The following options are supported: -g

Print current configuration and statistics to standard output. This is the only option executable without superuser privileges.

-l log-file

Cause ldap_cachemgr to use a log file other than the default /var/ldap/cachemgr.log.

EXAMPLES

Example 1 Stopping and Restarting the ldap_cachemgr Daemon

The following example shows how to stop and to restart the ldap_cachemgr daemon.

example# svcadm disable network/ldap/client
example# svcadm enable network/ldap/client

Example 2 Forcing ldap_cachemgr to Reread Configuration Files

The following example shows how to force ldap_cachemgr to reread the /var/ldap/ldap_client_file and /var/ldap/ldap_client_cred files

example# pkill -HUP ldap_cachemgr
FILES
/var/ldap/cachemgr.log

Default log file.

/var/ldap/ldap_client_file

/var/ldap/ldap_client_cred

Files containing the LDAP configuration of the client. These files are not to be modified manually. Their content is not guaranteed to be human readable. Use ldapclient(8) to update these files.

WARNINGS

The ldap_cachemgr utility is included in the current Solaris release on an uncommitted basis only. It is subject to change or removal in a future minor release.

SEE ALSO

ldap (1), ldapadd (1), ldapdelete (1), ldaplist (1), ldapmodify (1), ldapmodrdn (1), ldapsearch (1), pkill (1), svcs (1), signal.h (3HEAD), resolv.conf (5), attributes (7), smf (7), idsconfig (8), ldapaddent (8), ldapclient (8), svcadm (8)

NOTES

The ldap_cachemgr service is managed by the service management facility, smf(7), under the service identifier:

svc:/network/ldap/client

Administrative actions on this service, such as enabling, disabling, or requesting restart, can be performed using svcadm(8). The service's status can be queried using the svcs(1) command.