fedfs-create-replication(8)

1
2FEDFS-CREATE-REPLICATION(8) System Manager's ManualFEDFS-CREATE-REPLICATION(8)
3
4
5

NAME

7       fedfs-create-replication - send a FEDFS_CREATE_REPLICATION ADMIN proto‐
8       col request
9

SYNOPSIS

11       fedfs-create-replication [-?d] [-n nettype] [-h hostname] [-l nsdbname]
12       [-r nsdbport] [-s security] path 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-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_CREATE_REPLI‐
29       CATION request to a remote FedFS ADMIN protocol service.
30
31       The FEDFS_CREATE_REPLICATION request creates a replication marker in  a
32       local  file system on a remote file server.  The contents of a replica‐
33       tion marker are an UUID and an NSDB name and port.
34
35       The fedfs-create-replication(8) command takes two positional parameters
36       which specify the pathname on the remote server of the replication, and
37       an UUID.  This pathname is relative to the roo of the local file system
38       on  the  remote server.  Required NSDB information can be inferred from
39       the command's environment or specified on the command line.  The  mean‐
40       ing of these arguments is described in more detail in fedfs(7).
41

OPTIONS

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

EXAMPLES

80       Suppose you are the FedFS administrator of the example.net FedFS domain
81       and  that your domain's NSDB hostname is nsdb.example.net.  To create a
82       new FedFS replication on the file server fs.example.net, use:
83
84              $ fedfs-create-replication -h fs.example.net -l nsdb.example.net
85              \      /export/replication1 `uuidgen -t`
86
87       In  this  example,  a  new UUID is created on the spot.  It can be read
88       back from the server using the fedfs-lookup-replication(8) command.
89

SECURITY

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

COLOPHON

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

AUTHOR

116       Chuck Lever <chuck.lever@oracle.com>
117
118
119
120                                3 February 2014    FEDFS-CREATE-REPLICATION(8)