1NSDB-CREATE-FSL(8) System Manager's Manual NSDB-CREATE-FSL(8)
3
7 nsdb-create-fsl - create a fileset location (FSL) record on an NSDB
8
10 nsdb-create-fsl [-?d] [-D binddn] [-e nce] [-l nsdbname] [-o server‐
11 port] [-r nsdbport] fsn-uuid fsl-uuid servername serverpath
12
14 RFC 5716 introduces the Federated File System (FedFS, for short).
15 FedFS is an extensible standardized mechanism by which system adminis‐
16 trators construct a coherent namespace across multiple file servers
17 using file system referrals. For further details, see fedfs(7).
18 The bulk of FedFS junction information in a FedFS domain is stored on
20 one or more LDAP servers. These servers are known as namespace data‐
21 bases, or NSDBs, for short.
22 FedFS-enabled file servers and clients access the information stored on
24 NSDBs via standard LDAP queries. FedFS-enabled file servers use these
25 queries to resolve FedFS junctions. FedFS administrators use them to
26 manage information about file sets contained in a FedFS domain name
27 space.
28
30 The nsdb-create-fsl(8) command is part of a collection of low-level
31 single-use programs that is intended for testing the NSDB protocol or
32 for use in scripts. This command creates a FedFS fileset location
33 (FSL) record on an NSDB.
34 A fileset location, or FSL, uniquely identifies the location of one
36 replica of a fileset. An FSL record contains two UUIDs and other
37 information, depending on the subtype of the FSL. The meaning of these
38 items is described in more detail in fedfs(7).
39 FSLs are stored in records on an NSDB. FSL records are stored as chil‐
41 dren of FSN records. Replicas of these records can exist on more than
42 one LDAP server.
43 The nsdb-create-fsl(8) command creates an FSL record on the named NSDB.
45 It does not create parent FSN records. To create FSN records, use the
46 nsdb-create-fsn(8) command. It does not create a replica of a fileset.
47 To create a fileset replica, use appropriate file server administrative
48 commands.
49 This command has four positional parameters. The first parameter spec‐
51 ifies the target FSN UUID. If a record for this FSN does not already
52 exist, the nsdb-create-fsn(8) command fails. The second parameter
53 specifies the UUID of the new FSL record. If a record for this FSL
54 already exists, the nsdb-create-fsn(8) command fails.
55 The third parameter specifies the hostname of the fileserver where the
57 fileset replica resides. The fourth parameter specifies the export
58 path of that replica. The nsdb-create-fsn(8) command does not verify
59 that a replica exists at that location.
60
62 -d, --debug
63 Enables debugging messages during operation.
64 -?, --help
66 Displays nsdb-create-fsl(8) version information and a usage mes‐
67 sage on stderr.
68 -D, --binddn=bind-distinguished-name
70 Specifies a distinguished name of an entity used to bind to the
71 LDAP server where the NSDB resides. If the --binddn option is
72 not specified, the value of the FEDFS_NSDB_ADMIN environment
73 variable is consulted. If this variable is not set, the NSDB
74 connection parameter database is searched for this DN. If none
75 of these is specified, or if this entity does not have permis‐
76 sion to modify this area of the server's DIT, the nsdb-create-
77 fsl(8) command fails.
78 -e, --nce=NSDB-container-entry-distinguished-name
80 Specifies the distinguished name of the NSDB Container Entry
81 under which this FSL record is to be created. If the --nce
82 option is not specified, the value of the FEDFS_NSDB_NCE envi‐
83 ronment variable is consulted. If this variable is not set,
84 then the NSDB connection parameter database is searched for this
85 DN. If none of these is specified, the nsdb-create-fsl(8) com‐
86 mand fails.
87 -l, --nsdbname=NSDB-hostname
89 Specifies the hostname of the NSDB where the new FSL record
90 should reside. If the --nsdbname option is not specified, the
91 value of the FEDFS_NSDB_HOST environment variable is consulted.
92 If the variable is not set and the --nsdbname option is not
93 specified, the nsdb-create-fsl(8) command fails.
94 -r, --nsdbport=NSDB-port
96 Specifies the IP port of the NSDB where the new FSL record
97 should reside. If the --nsdbport option is not specified, the
98 value of the FEDFS_NSDB_PORT environment variable is consulted.
99 The default value if the variable is not set is 389.
100 -o, --serverport=file-server-port
102 Specifies the IP port of the file server a client should mount
103 to access this fileset location. The default value if this
104 option is not specified is 2049.
105
107 The NSDB returns a value that reflects the success of the requested
108 operation.
109 FEDFS_OK
111 The LDAP modify request succeeded.
112 FEDFS_ERR_ACCESS
114 The bound entity does not have permission to perform the
115 requested operation.
116 FEDFS_ERR_INVAL
118 One of the arguments was not valid.
119 FEDFS_ERR_SVRFAULT
121 An unanticipated non-protocol error occurred.
122 FEDFS_ERR_NSDB_ROUTE
124 The nsdb-create-fsl(8) command was unable to find a route to the
125 specified NSDB.
126 FEDFS_ERR_NSDB_DOWN
128 The nsdb-create-fsl(8) command determined that the specified
129 NSDB was down.
130 FEDFS_ERR_NSDB_CONN
132 The nsdb-create-fsl(8) command was unable to establish a connec‐
133 tion with the specified NSDB.
134 FEDFS_ERR_NSDB_AUTH
136 The nsdb-create-fsl(8) command was unable to authenticate and
137 establish a secure connection with the specified NSDB.
138 FEDFS_ERR_NSDB_LDAP
140 A non-specific LDAP error occurred on the connection between the
141 nsdb-create-fsl(8) command and specified NSDB.
142 FEDFS_ERR_NSDB_LDAP_VAL
144 An LDAP error occurred on the connection between the nsdb-cre‐
145 ate-fsl(8) command and specified NSDB. The specific error may
146 be displayed on the command line.
147 FEDFS_ERR_NSDB_NONCE
149 The nsdb-create-fsl(8) command was unable to locate the NCE on
150 the specified NSDB.
151 FEDFS_ERR_NSDB_NOFSN
153 The nsdb-create-fsl(8) command was unable to locate the speci‐
154 fied FSN on the specified NSDB.
155 FEDFS_ERR_NSDB_NOFSL
157 The nsdb-create-fsl(8) command was unable to locate the speci‐
158 fied FSL for the specified FSN on the specified NSDB.
159 FEDFS_ERR_NSDB_RESPONSE
161 The nsdb-create-fsl(8) command received a malformed response
162 from the specified NSDB.
163 FEDFS_ERR_NSDB_FAULT
165 An unanticipated error related to the specified NSDB occurred.
166 FEDFS_ERR_NSDB_PARAMS
168 The local NSDB connection parameter database does not have any
169 connection parameters on record for the specified NSDB.
170 FEDFS_ERR_NSDB_LDAP_REFERRAL
172 The nsdb-create-fsl(8) command received an LDAP referral that it
173 was unable to follow.
174 FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL
176 The nsdb-create-fsl(8) command received an LDAP referral that it
177 was unable to follow. A specific error may be displayed on the
178 command line.
179 FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED
181 The nsdb-create-fsl(8) command received an LDAP referral that it
182 chose not to follow, either because the local implementation
183 does not support following LDAP referrals or LDAP referral fol‐
184 lowing is disabled.
185 FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL
187 The nsdb-create-fsl(8) command received an LDAP referral that it
188 chose not to follow because the local NSDB connection parameter
189 database had no connection parameters for the NSDB targeted by
190 the LDAP referral.
191
193 Suppose you are the FedFS administrator of the example.net FedFS domain
194 and that you have created a new FSN for some fileset. The new FSN
195 looks like:
196 FSN UUID: 8e246ddc-7b46-11e0-8252-000c297fd679
198 NSDB: nsdb.example.net:389
199 Further suppose the NSDB nsdb.example.net:389 has an NSDB Container
201 Entry whose distinguished name is o=fedfs, and that an FSN record for
202 the above UUID already exists. Finally, a replica of this fileset
203 exists at fileserver.example.net:/export/path. To create a correspond‐
204 ing FSL record, you might use:
205 $ nsdb-create-fsl -D cn=Manager -e o=fedfs \
207 -l nsdb.example.net \
208 8e246ddc-7b46-11e0-8252-000c297fd679 \
209 323c5068-7c11-11e0-8d38-000c297fd679 \
210 fileserver.example.net /export/path
211 Enter NSDB password:
212 Successfully created FSL record
213 fedfsFslUuid=323c5068-7c11-11e0-8d38-000c297fd679,
214 fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs
215 A new unpopulated NFS FSL record is created on nsdb.example.net:389 as
217 a child of the FSN record with a distinguished name of
218 fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs.
220 To see the new FSL record, use nsdb-list(8) or nsdb-resolve-fsn(8). To
222 update individual attributes in the new FSL record, use nsdb-update-
223 fsl(8).
224
226 Permission to modify the LDAP's DIT is required to create a new FSL
227 record. The nsdb-create-fsl(8) command must bind as an entity permit‐
228 ted to modify the DIT to perform this operation. The nsdb-create-
229 fsl(8) command asks for a password on stdin. Standard password blank‐
230 ing techniques are used to obscure the password on the user's terminal.
231 The target LDAP server must be registered in the local NSDB connection
233 parameter database. The connection security mode listed in the NSDB
234 connection parameter database for the target LDAP server is used during
235 this operation. See nsdbparams(8) for details on how to register an
236 NSDB in the local NSDB connection parameter database.
237
239 fedfs(7), nsdb-create-fsn(8), nsdb-update-fsl(8), nsdb-resolve-fsn(8),
240 nsdb-list(8), nsdbparams(8)
241 RFC 5716 for FedFS requirements and overview
243 RFC 4510 for an introduction to LDAP
245
247 This page is part of the fedfs-utils package. A description of the
248 project and information about reporting bugs can be found at
249 http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
250
252 Chuck Lever <chuck.lever@oracle.com>
253 3 February 2014 NSDB-CREATE-FSL(8)