fedfs-get-limited-nsdb-params(8)

1
2FEDFS-GET-LIMITED-NSDB-PARAMSS(y8s)tem Manager's MaFnEuDaFlS-GET-LIMITED-NSDB-PARAMS(8)
3
4
5

NAME

7       fedfs-get-limited-nsdb-params  -  send  a FEDFS_GET_LIMITED_NSDB_PARAMS
8       ADMIN protocol request
9

SYNOPSIS

11       fedfs-get-limited-nsdb-params [-?d]  [-n  nettype]  [-h  hostname]  [-l
12       nsdbname] [-r nsdbport] [-s security]
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-get-limited-nsdb-params(8) command is part of a collection of
27       low-level single-use programs that is intended for  testing  the  FedFS
28       ADMIN protocol or for use in scripts.  It sends a single FEDFS_GET_LIM‐
29       ITED_NSDB_PARAMS request to a remote FedFS ADMIN protocol service.   It
30       is similar to the fedfs-get-nsdb-params(8) command, but cannot retrieve
31       an X.509 certificate.
32
33       The FEDFS_GET_LIMITED_NSDB_PARAMS  request  retrieves  NSDB  connection
34       parameter information stored on a remote server.  For more on the spec‐
35       ification and use of NSDB connection parameters, see  nsdbparams(8)  or
36       fedfs(7).
37
38       An  NSDB  hostname and port number (see below) are are used as the pri‐
39       mary key to identify an entry in the remote  server's  NSDB  connection
40       parameter  database.   The  NSDB  connection parameter database matches
41       NSDB hostnames and ports by exact value.  In other words, if two unique
42       hostnames  point  to the IP address of the same physical NSDB, they are
43       still considered separate entries in the local NSDB connection  parame‐
44       ter database.
45

OPTIONS

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

EXAMPLES

84       Suppose you are the FedFS administrator of the example.net FedFS domain
85       and  that your domain's NSDB hostname is nsdb.example.net.  If the file
86       server fs.example.net already knows about your domain's NSDB,  you  can
87       query it with:
88
89              $  fedfs-get-limited-nsdb-params -h fs.example.net -l nsdb.exam‐
90              ple.net
91              Call completed successfully
92              ConnectionSec: FEDFS_SEC_NONE
93
94       The remote server knows about nsdb.example.net and  does  not  use  TLS
95       when querying it to resolve junctions.
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 2014FEDFS-GET-LIMITED-NSDB-PARAMS(8)