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