1NSDB-DELETE-FSN(8) System Manager's Manual NSDB-DELETE-FSN(8)
3
7 nsdb-delete-fsn - delete a fileset name (FSN) record from an NSDB
8
10 nsdb-delete-fsn [-?dy] [-D binddn] [-e nce] [-l nsdbname] [-r nsdbport]
11 fsn-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-fsn(8) command is part of a collection of low-level
31 single-use programs that are intended for testing the NSDB protocol or
32 for use in scripts. This command deletes a FedFS fileset name (FSN)
33 record from an NSDB.
34 A fileset name, or FSN, uniquely identifies a fileset in FedFS. An FSN
36 consists of a UUID and the hostname and port of an NSDB. This pair is
37 intended to be unique across all of FedFS. The meaning of these items
38 is described in more detail in fedfs(7).
39 A FedFS junction contains an FSN. There can be multiple junctions that
41 contain a particular FSN. There is exactly one FSN record stored on an
42 NSDB that corresponds to this FSN. The FSN record can have zero or
43 more FSL records as children. Replicas of these records can exist on
44 more than one LDAP server.
45 The nsdb-delete-fsn(8) command removes an FSN record from the named
47 NSDB after it is no longer used in FedFS junctions. It does not remove
48 FedFS junctions. To remove a junction, use the fedfs-delete-junc‐
49 tion(8) command
50 The default behavior, if the --delete option is not specified, removes
52 the specified FSN record and all of its FSL children records. If the
53 --delete option is specified, all FSL child records of the specified
54 FSN record are removed, but the specified FSN record is left in place.
55 This command has one positional parameter which specifies the UUID of
57 the FSN record to modify or remove.
58
60 -d, --debug
61 Enables debugging messages during operation.
62 -?, --help
64 Displays nsdb-delete-fsn(8) version information and a usage mes‐
65 sage on stderr.
66 -D, --binddn=bind-distinguished-name
68 Specifies a distinguished name of an entity used to bind to the
69 LDAP server where the NSDB resides. If the --binddn option is
70 not specified, the value of the FEDFS_NSDB_ADMIN environment
71 variable is consulted. If this variable is not set, the NSDB
72 connection parameter database is searched for this DN. If none
73 of these is specified, or if this entity does not have permis‐
74 sion to modify this area of the server's DIT, the nsdb-delete-
75 fsn(8) command fails.
76 -e, --nce=NSDB-container-entry-distinguished-name
78 Specifies the distinguished name of the NSDB Container Entry
79 under which the doomed FSN record exists. If the --nce option
80 is not specified, the value of the FEDFS_NSDB_NCE environment
81 variable is consulted. If this variable is not set, then the
82 NSDB connection parameter database is searched for this DN. If
83 none of these is specified, the nsdb-delete-fsn(8) command
84 fails.
85 -l, --nsdbname=NSDB-host-name
87 Specifies the hostname of the NSDB where the doomed FSN record
88 resides. If the --nsdbname option is not specified, the value
89 of the FEDFS_NSDB_HOST environment variable is consulted. If
90 the variable is not set and the --nsdbname option is not speci‐
91 fied, the nsdb-delete-fsn(8) command fails.
92 -r, --nsdbport=NSDB-port
94 Specifies the IP port of the NSDB where the doomed FSN record
95 resides. If the --nsdbport option is not specified, the value
96 of the FEDFS_NSDB_PORT environment variable is consulted. The
97 default value if the variable is not set is 389.
98 -y, --leavefsn
100 Specifies that the specified FSN record should remain, but all
101 FSL records associated with the specified FSN record should be
102 deleted.
103
105 The NSDB returns a value that reflects the success of the requested
106 operation.
107 FEDFS_OK
109 The LDAP modify request succeeded.
110 FEDFS_ERR_ACCESS
112 The bound entity does not have permission to perform the
113 requested operation.
114 FEDFS_ERR_INVAL
116 One of the arguments was not valid.
117 FEDFS_ERR_SVRFAULT
119 An unanticipated non-protocol error occurred.
120 FEDFS_ERR_NSDB_ROUTE
122 The nsdb-delete-fsn(8) command was unable to find a route to the
123 specified NSDB.
124 FEDFS_ERR_NSDB_DOWN
126 The nsdb-delete-fsn(8) command determined that the specified
127 NSDB was down.
128 FEDFS_ERR_NSDB_CONN
130 The nsdb-delete-fsn(8) command was unable to establish a connec‐
131 tion with the specified NSDB.
132 FEDFS_ERR_NSDB_AUTH
134 The nsdb-delete-fsn(8) command was unable to authenticate and
135 establish a secure connection with the specified NSDB.
136 FEDFS_ERR_NSDB_LDAP
138 A non-specific LDAP error occurred on the connection between the
139 nsdb-delete-fsn(8) command and specified NSDB.
140 FEDFS_ERR_NSDB_LDAP_VAL
142 An LDAP error occurred on the connection between the nsdb-
143 delete-fsn(8) command and specified NSDB. The specific error
144 may be displayed on the command line.
145 FEDFS_ERR_NSDB_NONCE
147 The nsdb-delete-fsn(8) command was unable to locate the NCE on
148 the specified NSDB.
149 FEDFS_ERR_NSDB_NOFSN
151 The nsdb-delete-fsn(8) command was unable to locate the speci‐
152 fied FSN on the specified NSDB.
153 FEDFS_ERR_NSDB_RESPONSE
155 The nsdb-delete-fsn(8) command received a malformed response
156 from the specified NSDB.
157 FEDFS_ERR_NSDB_FAULT
159 An unanticipated error related to the specified NSDB occurred.
160 FEDFS_ERR_NSDB_PARAMS
162 The local NSDB connection parameter database does not have any
163 connection parameters on record for the specified NSDB.
164 FEDFS_ERR_NSDB_LDAP_REFERRAL
166 The nsdb-delete-fsn(8) command received an LDAP referral that it
167 was unable to follow.
168 FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL
170 The nsdb-delete-fsn(8) command received an LDAP referral that it
171 was unable to follow. A specific error may be displayed on the
172 command line.
173 FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED
175 The nsdb-delete-fsn(8) command received an LDAP referral that it
176 chose not to follow, either because the local implementation
177 does not support following LDAP referrals or LDAP referral fol‐
178 lowing is disabled.
179 FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL
181 The nsdb-delete-fsn(8) command received an LDAP referral that it
182 chose not to follow because the local NSDB connection parameter
183 database had no connection parameters for the NSDB targeted by
184 the LDAP referral.
185
187 Suppose you are the FedFS administrator of the example.net FedFS domain
188 and that you want to remove the FSN record for this FSN:
189 FSN UUID: 8e246ddc-7b46-11e0-8252-000c297fd679
191 NSDB: nsdb.example.net:389
192 Further suppose the NSDB nsdb.example.net:389 has an NSDB Container
194 Entry whose distinguished name is o=fedfs. To delete the corresponding
195 FSN record, you might use:
196 $ nsdb-delete-fsn -D cn=Manager -e o=fedfs \
198 -l nsdb.example.net \
199 8e246ddc-7b46-11e0-8252-000c297fd679
200 Enter NSDB password:
201 Successfully deleted FSN record
202 fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs
203 In this example, all FSL child records for this FSN record are also
205 removed.
206
208 Permission to modify the LDAP's DIT is required to delete an FSN
209 record. The nsdb-delete-fsn(8) command must bind as an entity permit‐
210 ted to modify the DIT to perform this operation. The nsdb-delete-
211 fsn(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), fedfs-delete-junction(8), nsdb-delete-fsl(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-FSN(8)