fedfs-create-junction(8)

1
2FEDFS-CREATE-JUNCTION(8)    System Manager's Manual   FEDFS-CREATE-JUNCTION(8)
3
4
5

NAME

7       fedfs-create-junction  -  send  a  FEDFS_CREATE_JUNCTION ADMIN protocol
8       request
9

SYNOPSIS

11       fedfs-create-junction [-?d] [-n nettype] [-h  hostname]  [-l  nsdbname]
12       [-r nsdbport] [-s security] path fsn-uuid
13

INTRODUCTION

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
20       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

DESCRIPTION

26       The  fedfs-create-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_CREATE_JUNC‐
29       TION request to a remote FedFS ADMIN protocol service.
30
31       The FEDFS_CREATE_JUNCTION request creates a FedFS junction in  a  local
32       file  system on a remote file server.  The contents of a FedFS junction
33       are an FSN UUID and an NSDB name and port.
34
35       The fedfs-create-junction(8) command takes  two  positional  parameters
36       which  specify  the  pathname on the remote server of the new junction,
37       and the FSN UUID.  This pathname is relative to the root of  the  local
38       file  system  on  the  remote server.  Required NSDB information can be
39       inferred from the command's environment or  specified  on  the  command
40       line.   The  meaning  of these arguments is described in more detail in
41       fedfs(7).
42
43       The FEDFS_CREATE_JUNCTION request does not create an  FSN  record.   To
44       create  an FSN record, use the nsdb-create-fsn(8) command.  Resolving a
45       junction that contains an FSN UUID without a matching FSN record on the
46       NSDB results in an error on the file server.
47

OPTIONS

49       -d, --debug
50              Enables debugging messages during operation.
51
52       -?, --help
53              Displays  fedfs-create-junction(8)  version  information  and  a
54              usage message on stderr.
55
56       -h, --hostname=hostname
57              Specifies the hostname of a remote FedFS ADMIN service.  If this
58              option is not specified, the default value is localhost.
59
60       -n, --nettype=nettype
61              Specifies  the transport to use when contacting the remote FedFS
62              ADMIN service.  Typically the nettype is one of tcp or udp.   If
63              this option is not specified, the default value is netpath.  See
64              rpc(3t) for details.
65
66       -l, --nsdbname=NSDB-hostname
67              Specifies the hostname of the NSDB to insert into the new  FedFS
68              junction.   If  this  option  is not specified, the value of the
69              FEDFS_NSDB_HOST environment variable is consulted.  If the vari‐
70              able  is not set and the --nsdbname option is not specified, the
71              fedfs-create-junction(8) command fails.
72
73       -r, --nsdbport=NSDB-port
74              Specifies the IP port of the NSDB to insert into the  new  FedFS
75              junction.   If  this  option  is not specified, the value of the
76              FEDFS_NSDB_PORT environment variable is consulted.  The  default
77              value if the variable is not set is 389.
78
79       -s, --security=flavor
80              Specifies  the security flavor to use when contacting the remote
81              FedFS ADMIN service.  Valid flavors are sys, unix, krb5,  krb5i,
82              and  krb5p.  If this option is not specified, the unix flavor is
83              used.  See the SECURITY section of this man page for details.
84

EXAMPLES

86       Suppose you are the FedFS administrator of the example.net FedFS domain
87       and  that your domain's NSDB hostname is nsdb.example.net.  To create a
88       new FedFS junction on the file server fs.example.net, use:
89
90              $ fedfs-create-junction -h fs.example.net -l nsdb.example.net  \
91                   /export/junction1 `uuidgen -t`
92
93       In this example, a new FSN UUID is created on the spot.  It can be read
94       back from the remote server using the fedfs-lookup-junction(8) command,
95       and added to the NSDB using the nsdb-create-fsn(8) command.
96

SECURITY

98       By  default,  or  if  the  sys  and unix flavors are specified with the
99       --security=flavor option,  the  fedfs-create-junction(8)  command  uses
100       AUTH_SYS  security  for  the Remote Procedure Call.  AUTH_SYS has known
101       weaknesses and should be avoided on untrusted networks.
102
103       The RPC client uses the Kerberos v5 GSS mechanism if a  Kerberos  secu‐
104       rity  flavor is specified.  When specifying a Kerberos security flavor,
105       the user must first obtain  a  valid  Kerberos  ticket  using  kinit(1)
106       before running fedfs-create-junction(8).
107
108       The  AUTH_NONE security flavor is no longer supported by this implemen‐
109       tation.
110

COLOPHON

118       This  page  is  part  of the fedfs-utils package.  A description of the
119       project  and  information  about  reporting  bugs  can  be   found   at
120       http://wiki.linux-nfs.org/wiki/index.php/FedFsUtilsProject.
121

AUTHOR

123       Chuck Lever <chuck.lever@oracle.com>
124
125
126
127                                3 February 2014       FEDFS-CREATE-JUNCTION(8)