1NSDB-DELETE-FSL(8) System Manager's Manual NSDB-DELETE-FSL(8)
3
7 nsdb-delete-fsl - delete a fileset location (FSL) record from an NSDB
8
10 nsdb-delete-fsl [-?d] [-D binddn] [-e nce] [-l nsdbname] [-r nsdbport]
11 fsl-uuid
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-delete-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 deletes a FedFS fileset location
33 (FSL) record from 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. These records are stored as
41 children of FSN records. Replicas of these records can exist on more
42 than one LDAP server.
43 The nsdb-delete-fsl(8) command removes an FSL record from the named
45 NSDB. It does not remove parent FSN records. To remove FSN records,
46 use the nsdb-delete-fsn(8) command. It does not remove a replica of a
47 fileset. To remove fileset replicas, use appropriate file server
48 administrative commands.
49 This command has two positional parameters. The first parameter speci‐
51 fies the target FSN UUID. If a record for this FSN does not already
52 exist, the nsdb-delete-fsn(8) command fails. The second parameter
53 specifies the UUID of the FSL record to remove. If a record for this
54 FSL does not exist, the nsdb-delete-fsn(8) command fails.
55
57 -d, --debug
58 Enables debugging messages during operation.
59 -?, --help
61 Displays nsdb-delete-fsl(8) version information and a usage mes‐
62 sage on stderr.
63 -D, --binddn=bind-distinguished-name
65 Specifies a distinguished name of an entity used to bind to the
66 LDAP server where the NSDB resides. If the --binddn option is
67 not specified, the value of the FEDFS_NSDB_ADMIN environment
68 variable is consulted. If this variable is not set, the NSDB
69 connection parameter database is searched for this DN. If none
70 of these is specified, or if this entity does not have permis‐
71 sion to modify this area of the server's DIT, the nsdb-delete-
72 fsl(8) command fails.
73 -e, --nce=NSDB-container-entry-distinguished-name
75 Specifies the distinguished name of the NSDB Container Entry
76 under which this FSL is to be created. If the --nce option is
77 not specified, the value of the FEDFS_NSDB_NCE environment vari‐
78 able is consulted. If this variable is not set, then the NSDB
79 connection parameter database is searched for this DN. If none
80 of these is specified, the nsdb-delete-fsl(8) command fails.
81 -l, --nsdbname=NSDB-hostname
83 Specifies the hostname of the NSDB where the new FSL record
84 should reside. If the --nsdbname option is not specified, the
85 value of the FEDFS_NSDB_HOST environment variable is consulted.
86 If the variable is not set and the --nsdbname option is not
87 specified, the nsdb-delete-fsl(8) command fails.
88 -r, --nsdbport=NSDB-port
90 Specifies the IP port of the NSDB where the new FSL record
91 should reside. If the --nsdbport option is not specified, the
92 value of the FEDFS_NSDB_PORT environment variable is consulted.
93 The default value if the variable is not set is 389.
94
96 The NSDB returns a value that reflects the success of the requested
97 operation.
98 FEDFS_OK
100 The LDAP modify request succeeded.
101 FEDFS_ERR_ACCESS
103 The bound entity does not have permission to perform the
104 requested operation.
105 FEDFS_ERR_INVAL
107 One of the arguments was not valid.
108 FEDFS_ERR_SVRFAULT
110 An unanticipated non-protocol error occurred.
111 FEDFS_ERR_NSDB_ROUTE
113 The nsdb-delete-fsl(8) command was unable to find a route to the
114 specified NSDB.
115 FEDFS_ERR_NSDB_DOWN
117 The nsdb-delete-fsl(8) command determined that the specified
118 NSDB was down.
119 FEDFS_ERR_NSDB_CONN
121 The nsdb-delete-fsl(8) command was unable to establish a connec‐
122 tion with the specified NSDB.
123 FEDFS_ERR_NSDB_AUTH
125 The nsdb-delete-fsl(8) command was unable to authenticate and
126 establish a secure connection with the specified NSDB.
127 FEDFS_ERR_NSDB_LDAP
129 A non-specific LDAP error occurred on the connection between the
130 nsdb-delete-fsl(8) command and specified NSDB.
131 FEDFS_ERR_NSDB_LDAP_VAL
133 An LDAP error occurred on the connection between the nsdb-
134 delete-fsl(8) command and specified NSDB. The specific error
135 may be displayed on the command line.
136 FEDFS_ERR_NSDB_NONCE
138 The nsdb-delete-fsl(8) command was unable to locate the NCE on
139 the specified NSDB.
140 FEDFS_ERR_NSDB_NOFSN
142 The nsdb-delete-fsl(8) command was unable to locate the speci‐
143 fied FSN on the specified NSDB.
144 FEDFS_ERR_NSDB_NOFSL
146 The nsdb-delete-fsl(8) command was unable to locate the speci‐
147 fied FSL for the specified FSN on the specified NSDB.
148 FEDFS_ERR_NSDB_RESPONSE
150 The nsdb-delete-fsl(8) command received a malformed response
151 from the specified NSDB.
152 FEDFS_ERR_NSDB_FAULT
154 An unanticipated error related to the specified NSDB occurred.
155 FEDFS_ERR_NSDB_PARAMS
157 The local NSDB connection parameter database does not have any
158 connection parameters on record for the specified NSDB.
159 FEDFS_ERR_NSDB_LDAP_REFERRAL
161 The nsdb-delete-fsl(8) command received an LDAP referral that it
162 was unable to follow.
163 FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL
165 The nsdb-delete-fsl(8) command received an LDAP referral that it
166 was unable to follow. A specific error may be displayed on the
167 command line.
168 FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED
170 The nsdb-delete-fsl(8) command received an LDAP referral that it
171 chose not to follow, either because the local implementation
172 does not support following LDAP referrals or LDAP referral fol‐
173 lowing is disabled.
174 FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL
176 The nsdb-delete-fsl(8) command received an LDAP referral that it
177 chose not to follow because the local NSDB connection parameter
178 database had no connection parameters for the NSDB targeted by
179 the LDAP referral.
180
182 Suppose you are the FedFS administrator of the example.net FedFS domain
183 and that you have an FSN that looks like:
184 FSN UUID: 8e246ddc-7b46-11e0-8252-000c297fd679
186 NSDB: nsdb.example.net:389
187 Further suppose the NSDB nsdb.example.net:389 has an NSDB Container
189 Entry whose distinguished name is o=fedfs. The replica of this fileset
190 that exists at fileserver.example.net:/path has just been removed, and
191 it's FSL UUID is 323c5068-7c11-11e0-8d38-000c297fd679. To delete the
192 corresponding FSL record, you might use:
193 $ nsdb-delete-fsl -D cn=Manager -e o=fedfs \
195 -l nsdb.example.net \
196 8e246ddc-7b46-11e0-8252-000c297fd679
197 323c5068-7c11-11e0-8d38-000c297fd679
198 Enter NSDB password:
199 Successfully deleted FSL record
200 fedfsFslUuid=323c5068-7c11-11e0-8d38-000c297fd679,
201 fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs
202 The FSL record for the specified replica is removed, leaving possibly
204 other FSL records for this fileset, and leaving the parent FSN record
205 intact.
206
208 Permission to modify the LDAP's DIT is required to delete an FSL
209 record. The nsdb-delete-fsl(8) command must bind as an entity permit‐
210 ted to modify the DIT to perform this operation. The nsdb-delete-
211 fsl(8) command asks for a password on stdin. Standard password blank‐
212 ing techniques are used to obscure the password on the user's terminal.
213 The target LDAP server must be registered in the local NSDB connection
215 parameter database. The connection security mode listed in the NSDB
216 connection parameter database for the target LDAP server is used during
217 this operation. See nsdbparams(8) for details on how to register an
218 NSDB in the local NSDB connection parameter database.
219
221 fedfs(7), nsdb-delete-fsn(8), nsdb-list(8), nsdbparams(8)
222 RFC 5716 for FedFS requirements and overview
224 RFC 4510 for an introduction to LDAP
226
228 This page is part of the fedfs-utils package. A description of the
229 project and information about reporting bugs can be found at
230 http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
231
233 Chuck Lever <chuck.lever@oracle.com>
234 3 February 2014 NSDB-DELETE-FSL(8)