usr/src/man/man4/smbautohome.4

   1 '\" te
   2 .\" Copyright (c) 2009, 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 SMBAUTOHOME 4 "Feb 25, 2017"
   7 .SH NAME
   8 smbautohome \- CIFS autohome configuration
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBsmbautohome\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 The Solaris CIFS service can automatically share home directories when a CIFS
  18 client connects. The autohome map file, \fB/etc/smbautohome\fR, uses the search
  19 options and rules to determine whether to share a home directory when a CIFS
  20 client connects to the server.
  21 .sp
  22 .LP
  23 For example, the following entries specify the autohome rules for a particular
  24 environment:
  25 .sp
  26 .in +2
  27 .nf
  28 +nsswitch           dn=ad,dn=sun,dn=com,ou=users
  29 jane    /home/?/&    dn=ad,dn=sun,dn=com,ou=users
  30 .fi
  31 .in -2
  32 .sp
  33
  34 .sp
  35 .LP
  36 The \fBnsswitch\fR autohome entry uses the naming service to match users to
  37 home directories. The second autohome entry specifies that the home directory
  38 for user \fBjane\fR is \fB/home/j/jane\fR.
  39 .SS "autohome Map Entry Format"
  40 .LP
  41 A map entry, which is also referred to as a mapping, uses the following format:
  42 .sp
  43 .in +2
  44 .nf
  45 \fIkey\fR \fIlocation\fR [ \fIoptions\fR ]
  46 .fi
  47 .in -2
  48 .sp
  49
  50 .sp
  51 .LP
  52 \fIkey\fR is a user name, \fIlocation\fR is the fully qualified path for the
  53 user's home directory, and \fIoptions\fR specifies the share options, for
  54 example, an AD container or description. See \fBsharemgr\fR(1M) for information
  55 on share options.
  56 .sp
  57 .LP
  58 If you intend to publish the share in Active Directory (AD), you \fBmust\fR
  59 specify an AD container name, which is specified as a comma-separated list of
  60 attribute name-value pairs. The attributes use the LDAP distinguished name (DN)
  61 or relative distinguished name (RDN) format.
  62 .sp
  63 .LP
  64 The DN or RDN must be specified in LDAP format by using the following attribute
  65 types:
  66 .RS +4
  67 .TP
  68 .ie t \(bu
  69 .el o
  70 \fBcn=\fR represents the common name
  71 .RE
  72 .RS +4
  73 .TP
  74 .ie t \(bu
  75 .el o
  76 \fBou=\fR represents the organizational unit
  77 .RE
  78 .RS +4
  79 .TP
  80 .ie t \(bu
  81 .el o
  82 \fBdc=\fR represents the domain component
  83 .RE
  84 .sp
  85 .LP
  86 The attribute type that is used to describe an object's RDN is called a
  87 \fBnaming attribute\fR. AD uses the naming attributes as follows:
  88 .RS +4
  89 .TP
  90 .ie t \(bu
  91 .el o
  92 \fBcn\fR for the \fBuser\fR object class
  93 .RE
  94 .RS +4
  95 .TP
  96 .ie t \(bu
  97 .el o
  98 \fBou\fR for the \fBOU\fR (organizational unit) object class
  99 .RE
 100 .RS +4
 101 .TP
 102 .ie t \(bu
 103 .el o
 104 \fBdc\fR for the \fBdomainDns\fR object class
 105 .RE
 106 .SS "autohome Map Key Substitution"
 107 .LP
 108 The autohome feature supports the following wildcard substitutions for the
 109 value of the key field:
 110 .RS +4
 111 .TP
 112 .ie t \(bu
 113 .el o
 114 The ampersand character (\fB&\fR) is expanded to the value of the key field for
 115 the entry in which it occurs. In the following example, \fB&\fR expands to
 116 \fBjane\fR:
 117 .sp
 118 .in +2
 119 .nf
 120 jane /home/&
 121 .fi
 122 .in -2
 123
 124 .RE
 125 .RS +4
 126 .TP
 127 .ie t \(bu
 128 .el o
 129 The question mark character (\fB?\fR) is expanded to the value of the first
 130 character in the key field for the entry in which it occurs. In the following
 131 example, \fB?\fR expands to \fBj\fR:
 132 .sp
 133 .in +2
 134 .nf
 135 jane /home/?/&
 136 .fi
 137 .in -2
 138
 139 .RE
 140 .SS "Wildcard Rule"
 141 .LP
 142 When supplied in the key field, the asterisk character (\fB*\fR) is recognized
 143 as the "catch-all" entry. Such an entry matches any key not previously matched.
 144 .sp
 145 .LP
 146 For example, the following entry would map any user to a home directory in
 147 \fB/home\fR in which the home directory name was the same as the user name:
 148 .sp
 149 .in +2
 150 .nf
 151 *    /home/&
 152 .fi
 153 .in -2
 154
 155 .sp
 156 .LP
 157 The wildcard rule is \fBonly\fR applied if an appropriate rule is not matched
 158 by another map entry.
 159 .SS "NSSwitch Map"
 160 .LP
 161 The \fBnsswitch\fR map is used to request that the home directory be obtained
 162 from a password database, such as the local, NIS, or LDAP databases. If
 163 an AD path is appended, it is used to publish shares.
 164 .sp
 165 .in +2
 166 .nf
 167 +nsswitch
 168 .fi
 169 .in -2
 170
 171 .sp
 172 .LP
 173 Like the "catch-all" entry, the \fBnsswitch\fR map is \fBonly\fR searched if an
 174 appropriate rule is not matched by another map entry.
 175 .sp
 176 .LP
 177 The wildcard and \fBnsswitch\fR rules are mutually exclusive. Do not include an
 178 \fBnsswitch\fR rule if a wildcard rule has already been defined.
 179 .SH FILES
 180 .LP
 181 \fB/etc/smbautohome\fR
 182 .SH ATTRIBUTES
 183 .LP
 184 See the \fBattributes\fR(5) man page for descriptions of the following
 185 attributes:
 186 .sp
 187
 188 .sp
 189 .TS
 190 box;
 191 c | c
 192 l | l .
 193 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 194 _
 195 Interface Stability     Uncommitted
 196 .TE
 197
 198 .SH SEE ALSO
 199 .LP
 200 \fBsharectl\fR(1M), \fBsharemgr\fR(1M), \fBsmbadm\fR(1M), \fBsmbd\fR(1M),
 201 \fBsmbstat\fR(1M), \fBsmb\fR(4), \fBattributes\fR(5)