usr/src/man/man1m/ldap_cachemgr.1m

   1 '\" te
   2 .\" Copyright (C) 2005, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LDAP_CACHEMGR 1M "Oct 7, 2008"
   7 .SH NAME
   8 ldap_cachemgr \- LDAP daemon to manage client configuration for LDAP based
   9 Network Information Service lookups
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/lib/ldap/ldap_cachemgr\fR [\fB-l\fR \fIlog-file\fR] [\fB-g\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBldap_cachemgr\fR daemon is a process that provides an up-to-date
  20 configuration cache for LDAP naming services. It is started during multi-user
  21 boot.
  22 .sp
  23 .LP
  24 The \fBldap_cachemgr\fR utility provides caching for all parameters as
  25 specified and used by the LDAP naming service clients. The \fBldap_cachemgr\fR
  26 utility uses the cache files which are originally created by executing the
  27 \fBldapclient\fR(1M) utility, as cold start files. Updates to the cache files
  28 take place dynamically if profiles are used to configure the client. See the
  29 \fBinit\fR option to \fBldapclient\fR(1M).
  30 .sp
  31 .LP
  32 The \fBldap_cachemgr\fR utility helps improve the performance of the clients
  33 that are using LDAP as the Naming service repository. In order for the LDAP
  34 naming services to function properly, the \fBldap_cachemgr\fR daemon must be
  35 running. \fBldap_cachemgr\fR also improves system security by making the
  36 configuration files readable by superuser only.
  37 .sp
  38 .LP
  39 The cache maintained by this daemon is shared by all the processes that access
  40 LDAP Naming information. All processes access this cache through a door call.
  41 On startup, \fBldap_cachemgr\fR initializes the cache from the cache files. See
  42 \fBldapclient\fR(1M). Thus, the cache survives machine reboots.
  43 .sp
  44 .LP
  45 The \fBldap_cachemgr\fR daemon also acts as its own administration tool. If an
  46 instance of \fBldap_cachemgr\fR is already running, commands are passed
  47 transparently to the running version.
  48 .SH OPTIONS
  49 .sp
  50 .LP
  51 The following options are supported:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-g\fR\fR
  56 .ad
  57 .sp .6
  58 .RS 4n
  59 Print current configuration and statistics to standard output. This is the only
  60 option executable without superuser privileges.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fB-l\fR \fIlog-file\fR\fR
  67 .ad
  68 .sp .6
  69 .RS 4n
  70 Cause \fBldap_cachemgr\fR to use a log file other than the default
  71 \fB/var/ldap/cachemgr.log\fR.
  72 .RE
  73
  74 .SH EXAMPLES
  75 .LP
  76 \fBExample 1 \fRStopping and Restarting the \fBldap_cachemgr\fR Daemon
  77 .sp
  78 .LP
  79 The following example shows how to stop and to restart the \fBldap_cachemgr\fR
  80 daemon.
  81
  82 .sp
  83 .in +2
  84 .nf
  85 example# svcadm disable network/ldap/client
  86 example# svcadm enable network/ldap/client
  87 .fi
  88 .in -2
  89 .sp
  90
  91 .LP
  92 \fBExample 2 \fRForcing \fBldap_cachemgr\fR to Reread Configuration Files
  93 .sp
  94 .LP
  95 The following example shows how to force \fBldap_cachemgr\fR to reread the
  96 \fB/var/ldap/ldap_client_file\fR and \fB/var/ldap/ldap_client_cred\fR files
  97
  98 .sp
  99 .in +2
 100 .nf
 101 example# pkill -HUP ldap_cachemgr
 102 .fi
 103 .in -2
 104 .sp
 105
 106 .SH FILES
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB/var/ldap/cachemgr.log\fR\fR
 111 .ad
 112 .sp .6
 113 .RS 4n
 114 Default log file.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB/var/ldap/ldap_client_file\fR\fR
 121 .ad
 122 .br
 123 .na
 124 \fB\fB/var/ldap/ldap_client_cred\fR\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 Files containing the LDAP configuration of the client. These files are not to
 129 be modified manually. Their content is not guaranteed to be human readable. Use
 130 \fBldapclient\fR(1M) to update these files.
 131 .RE
 132
 133 .SH WARNINGS
 134 .sp
 135 .LP
 136 The \fBldap_cachemgr\fR utility is included in the current Solaris release on
 137 an uncommitted basis only. It is subject to change or removal in a future minor
 138 release.
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBldap\fR(1), \fBldapadd\fR(1), \fBldapdelete\fR(1), \fBldaplist\fR(1),
 143 \fBldapmodify\fR(1), \fBldapmodrdn\fR(1), \fBldapsearch\fR(1), \fBpkill\fR(1),
 144 \fBsvcs\fR(1), \fBidsconfig\fR(1M), \fBldapaddent\fR(1M), \fBldapclient\fR(1M),
 145 \fBsuninstall\fR(1M), \fBsvcadm\fR(1M), \fBsignal.h\fR(3HEAD),
 146 \fBresolv.conf\fR(4), \fBattributes\fR(5), \fBsmf\fR(5)
 147 .SH NOTES
 148 .sp
 149 .LP
 150 The \fBldap_cachemgr\fR service is managed by the service management facility,
 151 \fBsmf\fR(5), under the service identifier:
 152 .sp
 153 .in +2
 154 .nf
 155 svc:/network/ldap/client
 156 .fi
 157 .in -2
 158 .sp
 159
 160 .sp
 161 .LP
 162 Administrative actions on this service, such as enabling, disabling, or
 163 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
 164 status can be queried using the \fBsvcs\fR(1) command.