share/man/man8/nscd.8

   1 '\" te
   2 .\" Copyright (c) 2006 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 NSCD 8 "Mar 6, 2017"
   7 .SH NAME
   8 nscd \- name service cache daemon
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/nscd\fR  [\fB-f\fR \fIconfiguration-file\fR] [\fB-g\fR] [\fB-e\fR \fIcachename\fR, yes
  13  |  no] [\fB-i\fR \fIcachename\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBnscd\fR daemon is a process that provides a cache for most name service
  19 requests. The default \fIconfiguration-file\fR \fB/etc/nscd.conf\fR determines
  20 the behavior of the cache daemon. See \fBnscd.conf\fR(4).
  21 .sp
  22 .LP
  23 \fBnscd\fR provides caching for the \fBpasswd\fR(4), \fBgroup\fR(4),
  24 \fBhosts\fR(4), \fBipnodes\fR(4), \fBexec_attr\fR(4), \fBprof_attr\fR(4),
  25 \fBuser_attr\fR(4), \fBethers\fR(4), \fBrpc\fR(4), \fBprotocols\fR(4),
  26 \fBnetworks\fR(4), \fBbootparams\fR(4),
  27 \fBauth_attr\fR(4), \fBservices\fR(4), \fBnetmasks\fR(4), \fBprinters\fR(4),
  28 \fBproject\fR(4) databases through standard \fBlibc\fR interfaces, such as
  29 \fBgethostbyname\fR(3NSL), \fBgetipnodebyname\fR(3SOCKET),
  30 \fBgethostbyaddr\fR(3NSL), and others. Each cache has a separate time-to-live
  31 for its data; modifying the local database (\fB/etc/hosts\fR,
  32 \fB/etc/resolv.conf\fR, and so forth) causes that cache to become invalidated
  33 upon the next call to \fBnscd\fR. The shadow file is specifically not cached.
  34 \fBgetspnam\fR(3C) calls remain uncached as a result.
  35 .sp
  36 .LP
  37 \fBnscd\fR also acts as its own administration tool. If an instance of
  38 \fBnscd\fR is already running, commands are passed to the running version
  39 transparently.
  40 .sp
  41 .LP
  42 When running with per-user lookups enabled (see \fBnscd.conf\fR(4)), \fBnscd\fR
  43 forks one and only one child process (that is, a per-user \fBnscd\fR) on behalf
  44 of the user making the request. The per-user \fBnscd\fR will use the
  45 credentials of the user to open a per-user connection to the name repository
  46 configured for the per-user style of lookups. The lookup will be performed in
  47 the child process. The results are cached in the process and are available only
  48 to the same user. The caches are managed exactly the same as the main
  49 \fBnscd\fR daemon manages its own caches. Subsequent requests from the user
  50 will be handled by that per-user \fBnscd\fR until it terminates. The per-user
  51 \fBnscd\fR uses a configurable inactivity time-to-live (TTL) value and
  52 terminates itself after the inactivity TTL expires.
  53 .sp
  54 .LP
  55 The maximum number of per-user \fBnscd\fRs that can be created by the main
  56 \fBnscd\fR is configurable (see \fBnscd.conf\fR(4)). After the maximum number
  57 of them are created, the main \fBnscd\fR will use an LRU algorithm to terminate
  58 less active child \fBnscd\fRs as needed.
  59 .sp
  60 .LP
  61 The main \fBnscd\fR daemon creates, monitors, and manages all the child
  62 \fBnscd\fRs. It creates a user's own \fBnscd\fR upon receiving the user's first
  63 per-user lookup. When the \fBnscd\fR daemon is started, if per-user lookups are
  64 enabled, it checks to ensure all conditions are met before getting ready to
  65 create a per-user \fBnscd\fR. When the daemon is stopped, it terminates all the
  66 per-user \fBnscd\fRs under its control.
  67 .sp
  68 .LP
  69 Per-user \fBnscd\fRs use the same configuration as the main \fBnscd\fR. They
  70 read and use the same default configuration file or the one specified with the
  71 \fB-f\fR command line option. Once the configuration is read, the per-user
  72 \fBnscd\fR will use it for its entire lifetime.
  73 .SH OPTIONS
  74 .LP
  75 Several of the options described below require a \fIcachename\fR specification.
  76 Supported values for \fIcachename\fR are: \fBpasswd\fR, \fBgroup\fR,
  77 \fBhosts\fR, \fBipnodes\fR, \fBexec_attr\fR, \fBprof_attr\fR, \fBuser_attr\fR,
  78 \fBethers\fR, \fBrpc\fR, \fBprotocols\fR, \fBnetworks\fR, \fBbootparams\fR,
  79 \fBauth_attr\fR, \fBservices\fR, \fBnetmasks\fR,
  80 \fBprinters\fR, and \fBproject\fR.
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-f\fR \fIconfiguration-file\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 Causes \fBnscd\fR to read its configuration data from the specified file.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-g\fR\fR
  95 .ad
  96 .sp .6
  97 .RS 4n
  98 Prints current configuration and statistics to standard output. This is the
  99 only option executable by non-root users.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB-e\fR \fIcachename\fR\fB, yes\fR|\fBno\fR\fR
 106 .ad
 107 .sp .6
 108 .RS 4n
 109 Enables or disables the specified cache.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB-i\fR \fIcachename\fR\fR
 116 .ad
 117 .sp .6
 118 .RS 4n
 119 Invalidate the specified cache.
 120 .RE
 121
 122 .SH EXAMPLES
 123 .LP
 124 \fBExample 1 \fRStopping and restarting the \fBnscd\fR daemon.
 125 .sp
 126 .in +2
 127 .nf
 128 example# svcadm disable system/name-service-cache
 129
 130 example# svcadm enable system/name-service-cache
 131 .fi
 132 .in -2
 133 .sp
 134
 135 .SH FILES
 136 .ne 2
 137 .na
 138 \fB\fB/etc/nscd.conf\fR\fR
 139 .ad
 140 .RS 18n
 141 Determines athe behavior of the cache daemon
 142 .RE
 143
 144 .SH SEE ALSO
 145 .LP
 146 \fBsvcs\fR(1), \fBsvcadm\fR(8), \fBgetspnam\fR(3C), \fBgethostbyname\fR(3NSL),
 147 \fBgetipnodebyname\fR(3SOCKET), \fBauth_attr\fR(4),
 148 \fBbootparams\fR(4), \fBethers\fR(4), \fBexec_attr\fR(4), \fBgroup\fR(4),
 149 \fBhosts\fR(4), \fBnetmasks\fR(4), \fBnetworks\fR(4), \fBnscd.conf\fR(4),
 150 \fBnsswitch.conf\fR(4), \fBpasswd\fR(4), \fBprinters\fR(4), \fBprof_attr\fR(4),
 151 \fBproject\fR(4), \fBprotocols\fR(4), \fBrpc\fR(4), \fBservices\fR(4),
 152 \fBuser_attr\fR(4), \fBattributes\fR(5)
 153 .SH NOTES
 154 .LP
 155 The output from the \fB-g\fR option to \fBnscd\fR is subject to change. Do not
 156 rely upon it as a programming interface.
 157 .sp
 158 .LP
 159 The \fBnscd\fR service is managed by the service management facility,
 160 \fBsmf\fR(5), under the service identifier:
 161 .sp
 162 .in +2
 163 .nf
 164 svc:/system/name-service-cache
 165 .fi
 166 .in -2
 167 .sp
 168
 169 .sp
 170 .LP
 171 Administrative actions on this service, such as enabling, disabling, or
 172 requesting restart, can be performed using \fBsvcadm\fR(8). The service's
 173 status can be queried using the \fBsvcs\fR(1) command.