fedfs-get-nsdb-params (8) - Linux Manuals

fedfs-get-nsdb-params: send a FEDFS_GET_NSDB_PARAMS ADMIN protocol request

NAME

fedfs-get-nsdb-params - send a FEDFS_GET_NSDB_PARAMS ADMIN protocol request

SYNOPSIS

fedfs-get-nsdb-params [-?d] [-f certfile] [-n nettype] [-h hostname] [-l nsdbname] [-r nsdbport] [-s security]

INTRODUCTION

RFC 5716 introduces the Federated File System (FedFS, for short). FedFS is an extensible standardized mechanism by which system administrators construct a coherent namespace across multiple file servers using file system referrals. For further details, see fedfs(7).

FedFS-enabled file servers allow remote administrative access via an authenticated RPC protocol known as the FedFS ADMIN protocol. Using this protocol, FedFS administrators manage FedFS junctions and NSDB connection parameter information on remote FedFS-enabled file servers.

DESCRIPTION

The fedfs-get-nsdb-params(8) command is part of a collection of low-level single-use programs that is intended for testing the FedFS ADMIN protocol or for use in scripts. It sends a single FEDFS_GET_NSDB_PARAMS request to a remote FedFS ADMIN protocol service.

The FEDFS_GET_NSDB_PARAMS request retrieves NSDB connection parameter information stored on a remote server. For more on the specification and use of NSDB connection parameters, see nsdbparams(8) or fedfs(7).

An NSDB hostname and port number (see below) are used as the primary key to identify an entry in the remote server's NSDB connection parameter database. Details on NSDB connection parameter database entry matching can be found in nsdb-parameters(7).

OPTIONS

-d, --debug

Enables debugging messages during operation.

-?, --help

Displays fedfs-get-nsdb-params(8) version information and a usage message on stderr.

-f, --certfile=pathname

Specifies the pathname of a local file to write received certificate material into, when the specified NSDB's connection security type is TLS. If no file is specified, the certificate is ignored. The certificate is written to the specified file in PEM format.

-h, --hostname=hostname

Specifies the hostname of a remote FedFS ADMIN service. If this option is not specified, the default value is localhost.

-n, --nettype=nettype

Specifies the transport to use when contacting the remote FedFS ADMIN service. Typically the nettype is one of tcp or udp. If this option is not specified, the default value is netpath. See rpc(3t) for details.

-l, --nsdbname=NSDB-hostname

Specifies the hostname of the NSDB to insert into the new FedFS junction. If this option is not specified, the value of the FEDFS_NSDB_HOST environment variable is consulted. If the variable is not set and the --nsdbname option is not specified, the fedfs-get-nsdb-params(8) command fails.

-r, --nsdbport=NSDB-port

Specifies the IP port of the NSDB to insert into the new FedFS junction. If this option is not specified, the value of the FEDFS_NSDB_PORT environment variable is consulted. The default value if the variable is not set is 389.

-s, --security=flavor

Specifies the security flavor to use when contacting the remote FedFS ADMIN service. Valid flavors are sys, unix, krb5, krb5i, and krb5p. If this option is not specified, the unix flavor is used. See the SECURITY section of this man page for details.

EXAMPLES

Suppose you are the FedFS administrator of the example.net FedFS domain and that your domain's NSDB hostname is nsdb.example.net. If the file server fs.example.net already knows about your domain's NSDB, you can query it with:

$ fedfs-get-nsdb-params -h fs.example.net -l nsdb.example.net
Call completed successfully
ConnectionSec: FEDFS_SEC_NONE

The remote server knows about nsdb.example.net and does not use TLS when querying it to resolve junctions.

SECURITY

By default, or if the sys and unix flavors are specified with the --security=flavor option, the fedfs-create-junction(8) command uses AUTH_SYS security for the Remote Procedure Call. AUTH_SYS has known weaknesses and should be avoided on untrusted networks.

The RPC client uses the Kerberos v5 GSS mechanism if a Kerberos security flavor is specified. When specifying a Kerberos security flavor, the user must first obtain a valid Kerberos ticket using kinit(1) before running fedfs-create-junction(8).

The AUTH_NONE security flavor is no longer supported by this implementation.

COLOPHON

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

AUTHOR

Chuck Lever <chuck.lever [at] oracle.com>