1FEDFS-LOOKUP-REPLICATION(8) System Manager's ManualFEDFS-LOOKUP-REPLICATION(8)
3
7 fedfs-lookup-replication - send a FEDFS_LOOKUP_REPLICATION ADMIN proto‐
8 col request
9
11 fedfs-lookup-replication [-?d] [-n nettype] [-h hostname] [-s security]
12 [-t resolvetype] path
13
15 RFC 5716 introduces the Federated File System (FedFS, for short).
16 FedFS is an extensible standardized mechanism by which system adminis‐
17 trators construct a coherent namespace across multiple file servers
18 using file system referrals. For further details, see fedfs(7).
19 FedFS-enabled file servers allow remote administrative access via an
21 authenticated RPC protocol known as the FedFS ADMIN protocol. Using
22 this protocol, FedFS administrators manage FedFS junctions and NSDB
23 connection parameter information on remote FedFS-enabled file servers.
24
26 The fedfs-lookup-replication(8) command is part of a collection of low-
27 level single-use programs that is intended for testing the FedFS ADMIN
28 protocol or for use in scripts. It sends a single FEDFS_LOOKUP_REPLI‐
29 CATION request to a remote FedFS ADMIN protocol service.
30 The FEDFS_LOOKUP_REPLICATION request causes a remote server to reveal
32 the contents of a replication marker, or to report cached or immediate
33 NSDB lookup results as that server sees them. The fedfs-lookup-repli‐
34 cation(8) command takes a single positional parameter which is the
35 pathname on the remote server of the junction to be looked up. The
36 pathname is relative to the root of the local file system on the remote
37 server.
38 Resolving a junction means performing an NSDB query with the contents
40 of the junction to obtain a list of fileset locations, or FSLs, match‐
41 ing the stored UUID. The meaning of these is described in more detail
42 in fedfs(7).
43 There are three distinct types of replication lookup:
45 none The remote server reports the actual contents of the replication
47 stored on its local disk. This includes a UUID and the name and
48 port of an NSDB. If the -t option is not specified, this type
49 of lookup is performed.
50 cache The remote server reports lookup results it may have cached from
52 previous replication lookup requests. This includes a UUID, the
53 name and port of an NSDB, and the cached list of fileset loca‐
54 tions matching the UUID in the replication marker. Not all
55 FedFS ADMIN service implementations support this type of
56 request.
57 nsdb The remote server performs a fresh replication lookup, and the
59 results are returned. This includes an UUID, the name and port
60 of an NSDB, and a list of fileset locations matching the UUID in
61 the replication marker.
62
64 -d, --debug
65 Enables debugging messages during operation.
66 -?, --help
68 Displays fedfs-lookup-replication(8) version information and a
69 usage message on stderr.
70 -h, --hostname=hostname
72 Specifies the hostname of a remote FedFS ADMIN service. If this
73 option is not specified, the default value is localhost.
74 -n, --nettype=nettype
76 Specifies the transport to use when contacting the remote FedFS
77 ADMIN service. Typically the nettype is one of tcp or udp. If
78 this option is not specified, the default value is netpath. See
79 rpc(3t) for details.
80 -t, --resolvetype=type
82 Specifies the desired type of resolution. Valid values for type
83 are 0, none, fedfs_resolve_none, 1, cache, fedfs_resolve_cache,
84 2, nsdb, or fedfs_resolve_nsdb. The value is not case-sensi‐
85 tive. If this option is not specified, the default value is
86 none.
87 -s, --security=flavor
89 Specifies the security flavor to use when contacting the remote
90 FedFS ADMIN service. Valid flavors are sys, unix, krb5, krb5i,
91 and krb5p. If this option is not specified, the unix flavor is
92 used. See the SECURITY section of this man page for details.
93
95 Suppose you are the FedFS administrator of the example.net FedFS domain
96 and that your domain's NSDB hostname is nsdb.example.net. You have
97 created a FedFS replication on file server fs.example.net. To see how
98 the replication appears on the remote server, use:
99 $ fedfs-lookup-replication -h fs.example.net /export/replica‐
101 tion1
102 Call completed successfully
103 FSN UUID: 89c6d208-7280-11e0-9f1d-000c297fd679
104 NSDB: nsdb.example.net:389
105 To see real-time replication resolution results as the remote server
107 sees them, use:
108 $ fedfs-lookup-replication -h fs.example.net -t nsdb
110 /export/replication1
111 Server returned FEDFS_ERR_NSDB_NOFSN
112 In this example, the replication marker exists on the file server, but
114 the domain's NSDB has not yet been updated to contain a list of fileset
115 locations for the UUID contained in the replication marker. The file
116 server is therefore not able to resolve the replication.
117
119 By default, or if the sys and unix flavors are specified with the
120 --security=flavor option, the fedfs-create-junction(8) command uses
121 AUTH_SYS security for the Remote Procedure Call. AUTH_SYS has known
122 weaknesses and should be avoided on untrusted networks.
123 The RPC client uses the Kerberos v5 GSS mechanism if a Kerberos secu‐
125 rity flavor is specified. When specifying a Kerberos security flavor,
126 the user must first obtain a valid Kerberos ticket using kinit(1)
127 before running fedfs-create-junction(8).
128 The AUTH_NONE security flavor is no longer supported by this implemen‐
130 tation.
131
133 fedfs(7), rpc.fedfsd(8), kinit(1), rpc(3t)
134 RFC 5716 for FedFS requirements and overview
136
138 This page is part of the fedfs-utils package. A description of the
139 project and information about reporting bugs can be found at
140 http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
141
143 Chuck Lever <chuck.lever@oracle.com>
144 3 February 2014 FEDFS-LOOKUP-REPLICATION(8)