1FEDFS-LOOKUP-JUNCTION(8) System Manager's Manual FEDFS-LOOKUP-JUNCTION(8)
3
7 fedfs-lookup-junction - send a FEDFS_LOOKUP_JUNCTION ADMIN protocol
8 request
9
11 fedfs-lookup-junction [-?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-junction(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_JUNC‐
29 TION request to a remote FedFS ADMIN protocol service.
30 The FEDFS_LOOKUP_JUNCTION request causes a remote server to reveal the
32 contents of a junction, or to report cached or immediate NSDB lookup
33 results as that server sees them. The contents of a FedFS junction are
34 an FSN UUID and an NSDB name and port.
35 The fedfs-lookup-junction(8) command takes a single positional parame‐
37 ter which is the pathname on the remote server of the junction to be
38 looked up. The pathname is relative to the root of the local file sys‐
39 tem on the remote server.
40 Resolving a junction means performing an NSDB query with the contents
42 of the junction to obtain a list of fileset locations, or FSLs, match‐
43 ing the stored FSN UUID. The meaning of these is described in more
44 detail in fedfs(7).
45 There are three distinct types of junction lookup:
47 none The remote server reports the actual contents of the junction
49 stored on its local disk. This includes an FSN UUID and the
50 name and port of an NSDB. If the -t option is not specified,
51 this type of lookup is performed.
52 cache The remote server reports lookup results it may have cached from
54 previous junction lookup requests. This includes an FSN UUID,
55 the name and port of an NSDB, and the cached list of fileset
56 locations matching the FSN UUID in the junction. Not all FedFS
57 ADMIN service implementations support this type of request.
58 nsdb The remote server performs a fresh junction lookup and the
60 results are returned. This includes an FSN UUID, the name and
61 port of an NSDB, and a list of fileset locations matching the
62 FSN UUID in the junction.
63
65 -d, --debug
66 Enables debugging messages during operation.
67 -?, --help
69 Displays fedfs-lookup-junction(8) version information and a
70 usage message on stderr.
71 -h, --hostname=hostname
73 Specifies the hostname of a remote FedFS ADMIN service. If this
74 option is not specified, the default value is localhost.
75 -n, --nettype=nettype
77 Specifies the transport to use when contacting the remote FedFS
78 ADMIN service. Typically the nettype is one of tcp or udp. If
79 this option is not specified, the default value is netpath. See
80 rpc(3t) for details.
81 -p, --path=pathname
83 Specifies the location on the remote server where the target
84 FedFS junction resides. This pathname is relative to the remote
85 server's physical root directory, not the remote server's NFS
86 pseudoroot.
87 -t, --resolvetype=type
89 Specifies the desired type of resolution. Valid values for type
90 are 0, none, fedfs_resolve_none, 1, cache, fedfs_resolve_cache,
91 2, nsdb, or fedfs_resolve_nsdb. The value is not case-sensi‐
92 tive. If this option is not specified, the default value is
93 none.
94 -s, --security=flavor
96 Specifies the security flavor to use when contacting the remote
97 FedFS ADMIN service. Valid flavors are sys, unix, krb5, krb5i,
98 and krb5p. If this option is not specified, the unix flavor is
99 used. See the SECURITY section of this man page for details.
100
102 Suppose you are the FedFS administrator of the example.net FedFS domain
103 and that your domain's NSDB hostname is nsdb.example.net. You have
104 created a FedFS junction on remote server fs.example.net. To see how
105 the junction appears on the file server, use:
106 $ fedfs-lookup-junction -h fs.example.net /export/junction1
108 Call completed successfully
109 FSN UUID: 89c6d208-7280-11e0-9f1d-000c297fd679
110 NSDB: nsdb.example.net:389
111 To see real-time junction lookup results as the remote server sees
113 them, use:
114 $ fedfs-lookup-junction -h fs.example.net -t nsdb /export/junc‐
116 tion1
117 Server returned FEDFS_ERR_NSDB_NOFSN
118 In this example, the junction exists on the file server, but the
120 domain's NSDB has not yet been updated to contain a list of fileset
121 locations for the FSN UUID contained in the junction. The file server
122 is therefore not able to resolve the junction.
123
125 By default, or if the sys and unix flavors are specified with the
126 --security=flavor option, the fedfs-create-junction(8) command uses
127 AUTH_SYS security for the Remote Procedure Call. AUTH_SYS has known
128 weaknesses and should be avoided on untrusted networks.
129 The RPC client uses the Kerberos v5 GSS mechanism if a Kerberos secu‐
131 rity flavor is specified. When specifying a Kerberos security flavor,
132 the user must first obtain a valid Kerberos ticket using kinit(1)
133 before running fedfs-create-junction(8).
134 The AUTH_NONE security flavor is no longer supported by this implemen‐
136 tation.
137
139 fedfs(7), rpc.fedfsd(8), kinit(1), rpc(3t)
140 RFC 5716 for FedFS requirements and overview
142
144 This page is part of the fedfs-utils package. A description of the
145 project and information about reporting bugs can be found at
146 http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
147
149 Chuck Lever <chuck.lever@oracle.com>
150 3 February 2014 FEDFS-LOOKUP-JUNCTION(8)