1NSDB-RESOLVE-FSN(8) System Manager's Manual NSDB-RESOLVE-FSN(8)
3
7 nsdb-resolve-fsn - resolve a fileset name (FSN) record on an NSDB
8
10 nsdb-resolve-fsn [-?d] [-e nce] [-l nsdbname] [-r nsdbport] fsn-uuid
11
13 RFC 5716 introduces the Federated File System (FedFS, for short).
14 FedFS is an extensible standardized mechanism by which system adminis‐
15 trators construct a coherent namespace across multiple file servers
16 using file system referrals. For further details, see fedfs(7).
17 The bulk of FedFS junction information in a FedFS domain is stored on
19 one or more LDAP servers. These servers are known as namespace data‐
20 bases, or NSDBs, for short.
21 FedFS-enabled file servers and clients access the information stored on
23 NSDBs via standard LDAP queries. FedFS-enabled file servers use these
24 queries to resolve FedFS junctions. FedFS administrators use them to
25 manage information about file sets contained in a FedFS domain name
26 space.
27
29 The nsdb-resolve-fsn(8) command is part of a collection of low-level
30 single-use programs that are intended for testing the NSDB protocol or
31 for use in scripts. This command resolves a FedFS fileset name (FSN)
32 record on an NSDB into a list of fileset locations.
33 A fileset name, or FSN, uniquely identifies a fileset in FedFS. An FSN
35 consists of a UUID and the hostname and port of an NSDB. This pair is
36 intended to be unique across all of FedFS. The meaning of these items
37 is described in more detail in fedfs(7).
38 A FedFS junction contains an FSN. There can be multiple junctions that
40 contain a particular FSN. There is exactly one FSN record stored on an
41 NSDB that corresponds to this FSN. The FSN record can have zero or
42 more FSL records as children. Replicas of these records can exist on
43 more than one LDAP server.
44 The nsdb-resolve-fsn(8) command looks up an FSN record on the named
46 NSDB and returns the set of FSL records that are its children. This is
47 the same operation that FedFS-enabled file servers perform when resolv‐
48 ing the FSN contained in a FedFS junction.
49 This command has one positional parameter which specifies the UUID of
51 the FSN record to resolve.
52
54 -d, --debug
55 Enables debugging messages during operation.
56 -?, --help
58 Displays nsdb-resolve-fsn(8) version information and a usage
59 message on stderr.
60 -e, --nce=NSDB-container-entry-distinguished-name
62 Specifies the distinguished name of the NSDB Container Entry
63 under which this FSN record resides. If the --nce option is not
64 specified, the value of the FEDFS_NSDB_NCE environment variable
65 is consulted. If this variable is not set, then the NSDB con‐
66 nection parameter database is searched for this DN. If none of
67 these is specified, the nsdb-resolve-fsn(8) command searches the
68 NSDB's naming contexts to discover its NCEs.
69 -l, --nsdbname=NSDB-host-name
71 Specifies the NSDB hostname portion of the FSN to resolve. If
72 the --nsdbname option is not specified, the value of the
73 FEDFS_NSDB_HOST environment variable is consulted. If the vari‐
74 able is not set and the --nsdbname option is not specified, the
75 nsdb-resolve-fsn(8) command fails.
76 -r, --nsdbport=NSDB-port
78 Specifies the NSDB IP port portion of the FSN to resolve. If
79 the --nsdbport option is not specified, the value of the
80 FEDFS_NSDB_PORT environment variable is consulted. The default
81 value if the variable is not set is 389.
82
84 The NSDB returns a value that reflects the success of the requested
85 operation.
86 FEDFS_OK
88 The LDAP query succeeded.
89 FEDFS_ERR_ACCESS
91 The anonymous entity does not have permission to perform the
92 requested operation.
93 FEDFS_ERR_INVAL
95 One of the arguments was not valid.
96 FEDFS_ERR_SVRFAULT
98 An unanticipated non-protocol error occurred.
99 FEDFS_ERR_NSDB_ROUTE
101 The nsdb-resolve-fsn(8) command was unable to find a route to
102 the specified NSDB.
103 FEDFS_ERR_NSDB_DOWN
105 The nsdb-resolve-fsn(8) command determined that the specified
106 NSDB was down.
107 FEDFS_ERR_NSDB_CONN
109 The nsdb-resolve-fsn(8) command was unable to establish a con‐
110 nection with the specified NSDB.
111 FEDFS_ERR_NSDB_AUTH
113 The nsdb-resolve-fsn(8) command was unable to authenticate and
114 establish a secure connection with the specified NSDB.
115 FEDFS_ERR_NSDB_LDAP
117 A non-specific LDAP error occurred on the connection between the
118 nsdb-resolve-fsn(8) command and specified NSDB.
119 FEDFS_ERR_NSDB_LDAP_VAL
121 An LDAP error occurred on the connection between the nsdb-
122 resolve-fsn(8) command and specified NSDB. The specific error
123 may be displayed on the command line.
124 FEDFS_ERR_NSDB_NONCE
126 The nsdb-resolve-fsn(8) command was unable to locate the NCE on
127 the specified NSDB.
128 FEDFS_ERR_NSDB_NOFSN
130 The nsdb-resolve-fsn(8) command was unable to locate the speci‐
131 fied FSN on the specified NSDB.
132 FEDFS_ERR_NSDB_NOFSL
134 The nsdb-resolve-fsn(8) command was unable to locate any FSLs
135 for the specified FSN on the specified NSDB.
136 FEDFS_ERR_NSDB_RESPONSE
138 The nsdb-resolve-fsn(8) command received a malformed response
139 from the specified NSDB.
140 FEDFS_ERR_NSDB_FAULT
142 An unanticipated error related to the specified NSDB occurred.
143 FEDFS_ERR_NSDB_PARAMS
145 The local NSDB connection parameter database does not have any
146 connection parameters on record for the specified NSDB.
147 FEDFS_ERR_NSDB_LDAP_REFERRAL
149 The nsdb-resolve-fsn(8) command received an LDAP referral that
150 it was unable to follow.
151 FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL
153 The nsdb-resolve-fsn(8) command received an LDAP referral that
154 it was unable to follow. A specific error may be displayed on
155 the command line.
156 FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED
158 The nsdb-resolve-fsn(8) command received an LDAP referral that
159 it chose not to follow, either because the local implementation
160 does not support following LDAP referrals or LDAP referral fol‐
161 lowing is disabled.
162 FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL
164 The nsdb-resolve-fsn(8) command received an LDAP referral that
165 it chose not to follow because the local NSDB connection parame‐
166 ter database had no connection parameters for the NSDB targeted
167 by the LDAP referral.
168
170 Suppose you are the FedFS administrator of the example.net FedFS domain
171 and that you have created a new FSN that looks like:
172 FSN UUID: 8e246ddc-7b46-11e0-8252-000c297fd679
174 NSDB: nsdb.example.net:389
175 Further suppose the NSDB nsdb.example.net:389 has an NSDB Container
177 Entry whose distinguished name is o=fedfs, and that the FSN has a sin‐
178 gle FSL child record. To resolve the FSN, you might use:
179 $ nsdb-resolve-fsn -e o=fedfs \
181 -l nsdb.example.net \
182 8e246ddc-7b46-11e0-8252-000c297fd679
183 For FSN UUID 8e246ddc-7b46-11e0-8252-000c297fd679
185 FSN TTL 600
186 ------------------------------------------------------
188 dn: fedfsFslUuid=323c5068-7c11-11e0-8d38-000c297fd679,
189 fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs
190 FSN UUID: 8e246ddc-7b46-11e0-8252-000c297fd679
192 FSL UUID: 323c5068-7c11-11e0-8d38-000c297fd679
193 NFS fls_server: fileserver.example.net
194 NFS fli_rootpath: /path
196 NFS fls_currency: -1
197 and so on.
199
201 The NSDB protocol draft standard requires that FedFS FSN and FSL
202 records are readable by everyone. The nsdb-resolve-fsn(8) command uses
203 anonymous binding to perform LDAP queries.
204 The target LDAP server must be registered in the local NSDB connection
206 parameter database. The connection security mode listed in the NSDB
207 connection parameter database for the target LDAP server is used during
208 this operation. See nsdbparams(8) for details on how to register an
209 NSDB in the local NSDB connection parameter database.
210
212 fedfs(7), nsdb-list(8), nsdbparams(8)
213 RFC 5716 for FedFS requirements and overview
215 RFC 4510 for an introduction to LDAP
217
219 This page is part of the fedfs-utils package. A description of the
220 project and information about reporting bugs can be found at
221 http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
222
224 Chuck Lever <chuck.lever@oracle.com>
225 3 February 2014 NSDB-RESOLVE-FSN(8)