1NSDB-LIST(8) System Manager's Manual NSDB-LIST(8)
3
7 nsdb-list - list file set name and location entries on an NSDB
8
10 nsdb-list [-?d] [-e nce] [-l nsdbname] [-r nsdbport]
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-list(8) command is part of a collection of low-level single-
30 use programs that is intended for testing the NSDB protocol or for use
31 in scripts. It retrieves the list of file set name and location
32 records stored on an NSDB under one NSDB Container Entry.
33
35 -d, --debug
36 Specifies that debugging messages be produced during operation.
37 -?, --help
39 Prints an nsdb-list(8) version and usage message on stderr, then
40 exits.
41 -l, --nsdbname=NSDB-hostname
43 Specifies the hostname of the NSDB to enumerate. If the --nsdb‐
44 name option is not specified, the value of the FEDFS_NSDB_HOST
45 environment variable is consulted. If the variable is not set
46 and the --nsdbname option is not specified, the nsdb-list(8)
47 command fails.
48 -r, --nsdbport=NSDB-port
50 Specifies the IP port of the NSDB to enumerate. If the --nsdb‐
51 port option is not specified, the value of the FEDFS_NSDB_PORT
52 environment variable is consulted. The default value if the
53 variable is not set is 389.
54 -e, --nce=NSDB-container-entry
56 Limits the query to a particular NSDB Container Entry on the
57 target NSDB. If the --nce option is not specified, the value of
58 the FEDFS_NSDB_NCE environment variable is consulted. If the
59 variable is not set and the --nce option is not specified, or
60 the specified NCE does not exist on the target NSDB, the nsdb-
61 list(8) command fails.
62
64 The NSDB returns a value that reflects the success of the requested
65 operation.
66 FEDFS_OK
68 The LDAP query succeeded. A list of FSN and FSL records are
69 summarized on stdout.
70 FEDFS_ERR_ACCESS
72 The anonymous entity does not have permission to perform the
73 requested operation.
74 FEDFS_ERR_INVAL
76 One of the arguments was not valid.
77 FEDFS_ERR_SVRFAULT
79 An unanticipated non-protocol error occurred.
80 FEDFS_ERR_NSDB_ROUTE
82 The nsdb-list(8) command was unable to find a route to the spec‐
83 ified NSDB.
84 FEDFS_ERR_NSDB_DOWN
86 The nsdb-list(8) command determined that the specified NSDB was
87 down.
88 FEDFS_ERR_NSDB_CONN
90 The nsdb-list(8) command was unable to establish a connection
91 with the specified NSDB.
92 FEDFS_ERR_NSDB_AUTH
94 The nsdb-list(8) command was unable to authenticate and estab‐
95 lish a secure connection with the specified NSDB.
96 FEDFS_ERR_NSDB_LDAP
98 A non-specific LDAP error occurred on the connection between the
99 nsdb-list(8) command and specified NSDB.
100 FEDFS_ERR_NSDB_LDAP_VAL
102 An LDAP error occurred on the connection between the nsdb-
103 list(8) command and specified NSDB. The specific error may be
104 displayed on the command line.
105 FEDFS_ERR_NSDB_NONCE
107 The nsdb-list(8) command was unable to locate the NCE on the
108 specified NSDB.
109 FEDFS_ERR_NSDB_RESPONSE
111 The nsdb-list(8) command received a malformed response from the
112 specified NSDB.
113 FEDFS_ERR_NSDB_FAULT
115 An unanticipated error related to the specified NSDB occurred.
116 FEDFS_ERR_NSDB_PARAMS
118 The local NSDB connection parameter database does not have any
119 connection parameters on record for the specified NSDB.
120 FEDFS_ERR_NSDB_LDAP_REFERRAL
122 The nsdb-list(8) command received an LDAP referral that it was
123 unable to follow.
124 FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL
126 The nsdb-list(8) command received an LDAP referral that it was
127 unable to follow. A specific error may be displayed on the com‐
128 mand line.
129 FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED
131 The nsdb-list(8) command received an LDAP referral that it chose
132 not to follow, either because the local implementation does not
133 support following LDAP referrals or LDAP referral following is
134 disabled.
135 FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL
137 The nsdb-list(8) command received an LDAP referral that it chose
138 not to follow because the local NSDB connection parameter data‐
139 base had no connection parameters for the NSDB targeted by the
140 LDAP referral.
141
143 Suppose you are the FedFS administrator of the example.net FedFS domain
144 and that you want to know if the LDAP server ldap.example.net is an
145 NSDB. Use:
146 $ nsdb-list -l ldap.example.net -e o=fedfs
148 NSDB: ldap.example.net:389
149 NCE: o=fedfs
151 FSN UUID: c1c21720-1fcd-4ad6-a837-f57af4cf2972
153 FSL UUID: 4c887035-ad2f-4ba8-ab75-7118df9714cd
154 FSL UUID: 84445758-b5fb-4acc-814b-cc121b3bafe9
155 There is a single file set name, with two file set location records,
157 registered under "o=fedfs" on this NSDB. To resolve the listed FSN
158 UUID, use the nsdb-resolve-junction(8) command.
159
161 The NSDB protocol draft standard requires that FedFS FSN and FSL
162 records are readable by everyone. The nsdb-list(8) command uses anony‐
163 mous binding when performing LDAP queries.
164 The target LDAP server must be registered in the local NSDB connection
166 parameter database. The connection security mode listed in the NSDB
167 connection parameter database for the target LDAP server is used during
168 this operation. See nsdbparams(8) for details on how to register an
169 NSDB in the local NSDB connection parameter database.
170
172 fedfs(7), nsdb-resolve-junction(8), nsdbparams(8)
173 RFC 5716 for FedFS requirements and overview
175 RFC 4510 for an introduction to LDAP
177
179 This page is part of the fedfs-utils package. A description of the
180 project and information about reporting bugs can be found at
181 http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
182
184 Chuck Lever <chuck.lever@oracle.com>
185 3 February 2014 NSDB-LIST(8)