nsdb-create-fsl (8) - Linux Manuals

nsdb-create-fsl: create a fileset location (FSL) record on an NSDB

NAME

nsdb-create-fsl - create a fileset location (FSL) record on an NSDB

SYNOPSIS

nsdb-create-fsl [-?d] [-D binddn] [-e nce] [-l nsdbname] [-o serverport] [-r nsdbport] fsn-uuid fsl-uuid servername serverpath

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).

The bulk of FedFS junction information in a FedFS domain is stored on one or more LDAP servers. These servers are known as namespace databases, or NSDBs, for short.

FedFS-enabled file servers and clients access the information stored on NSDBs via standard LDAP queries. FedFS-enabled file servers use these queries to resolve FedFS junctions. FedFS administrators use them to manage information about file sets contained in a FedFS domain name space.

DESCRIPTION

The nsdb-create-fsl(8) command is part of a collection of low-level single-use programs that is intended for testing the NSDB protocol or for use in scripts. This command creates a FedFS fileset location (FSL) record on an NSDB.

A fileset location, or FSL, uniquely identifies the location of one replica of a fileset. An FSL record contains two UUIDs and other information, depending on the subtype of the FSL. The meaning of these items is described in more detail in fedfs(7).

FSLs are stored in records on an NSDB. FSL records are stored as children of FSN records. Replicas of these records can exist on more than one LDAP server.

The nsdb-create-fsl(8) command creates an FSL record on the named NSDB. It does not create parent FSN records. To create FSN records, use the nsdb-create-fsn(8) command. It does not create a replica of a fileset. To create a fileset replica, use appropriate file server administrative commands.

This command has four positional parameters. The first parameter specifies the target FSN UUID. If a record for this FSN does not already exist, the nsdb-create-fsn(8) command fails. The second parameter specifies the UUID of the new FSL record. If a record for this FSL already exists, the nsdb-create-fsn(8) command fails.

The third parameter specifies the hostname of the fileserver where the fileset replica resides. The fourth parameter specifies the export path of that replica. The nsdb-create-fsn(8) command does not verify that a replica exists at that location.

OPTIONS

-d, --debug

Enables debugging messages during operation.

-?, --help

Displays nsdb-create-fsl(8) version information and a usage message on stderr.

-D, --binddn=bind-distinguished-name

Specifies a distinguished name of an entity used to bind to the LDAP server where the NSDB resides. If the --binddn option is not specified, the value of the FEDFS_NSDB_ADMIN environment variable is consulted. If this variable is not set, the NSDB connection parameter database is searched for this DN. If none of these is specified, or if this entity does not have permission to modify this area of the server's DIT, the nsdb-create-fsl(8) command fails.

-e, --nce=NSDB-container-entry-distinguished-name

Specifies the distinguished name of the NSDB Container Entry under which this FSL record is to be created. If the --nce option is not specified, the value of the FEDFS_NSDB_NCE environment variable is consulted. If this variable is not set, then the NSDB connection parameter database is searched for this DN. If none of these is specified, the nsdb-create-fsl(8) command fails.

-l, --nsdbname=NSDB-hostname

Specifies the hostname of the NSDB where the new FSL record should reside. If the --nsdbname 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 nsdb-create-fsl(8) command fails.

-r, --nsdbport=NSDB-port

Specifies the IP port of the NSDB where the new FSL record should reside. If the --nsdbport 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.

-o, --serverport=file-server-port

Specifies the IP port of the file server a client should mount to access this fileset location. The default value if this option is not specified is 2049.

EXIT CODES

The NSDB returns a value that reflects the success of the requested operation.

FEDFS_OK

The LDAP modify request succeeded.

FEDFS_ERR_ACCESS

The bound entity does not have permission to perform the requested operation.

FEDFS_ERR_INVAL

One of the arguments was not valid.

FEDFS_ERR_SVRFAULT

An unanticipated non-protocol error occurred.

FEDFS_ERR_NSDB_ROUTE

The nsdb-create-fsl(8) command was unable to find a route to the specified NSDB.

FEDFS_ERR_NSDB_DOWN

The nsdb-create-fsl(8) command determined that the specified NSDB was down.

FEDFS_ERR_NSDB_CONN

The nsdb-create-fsl(8) command was unable to establish a connection with the specified NSDB.

FEDFS_ERR_NSDB_AUTH

The nsdb-create-fsl(8) command was unable to authenticate and establish a secure connection with the specified NSDB.

FEDFS_ERR_NSDB_LDAP

A non-specific LDAP error occurred on the connection between the nsdb-create-fsl(8) command and specified NSDB.

FEDFS_ERR_NSDB_LDAP_VAL

An LDAP error occurred on the connection between the nsdb-create-fsl(8) command and specified NSDB. The specific error may be displayed on the command line.

FEDFS_ERR_NSDB_NONCE

The nsdb-create-fsl(8) command was unable to locate the NCE on the specified NSDB.

FEDFS_ERR_NSDB_NOFSN

The nsdb-create-fsl(8) command was unable to locate the specified FSN on the specified NSDB.

FEDFS_ERR_NSDB_NOFSL

The nsdb-create-fsl(8) command was unable to locate the specified FSL for the specified FSN on the specified NSDB.

FEDFS_ERR_NSDB_RESPONSE

The nsdb-create-fsl(8) command received a malformed response from the specified NSDB.

FEDFS_ERR_NSDB_FAULT

An unanticipated error related to the specified NSDB occurred.

FEDFS_ERR_NSDB_PARAMS

The local NSDB connection parameter database does not have any connection parameters on record for the specified NSDB.

FEDFS_ERR_NSDB_LDAP_REFERRAL

The nsdb-create-fsl(8) command received an LDAP referral that it was unable to follow.

FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL

The nsdb-create-fsl(8) command received an LDAP referral that it was unable to follow. A specific error may be displayed on the command line.

FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED

The nsdb-create-fsl(8) command received an LDAP referral that it chose not to follow, either because the local implementation does not support following LDAP referrals or LDAP referral following is disabled.

FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL

The nsdb-create-fsl(8) command received an LDAP referral that it chose not to follow because the local NSDB connection parameter database had no connection parameters for the NSDB targeted by the LDAP referral.

EXAMPLES

Suppose you are the FedFS administrator of the example.net FedFS domain and that you have created a new FSN for some fileset. The new FSN looks like:

       FSN UUID: 8e246ddc-7b46-11e0-8252-000c297fd679

       NSDB: nsdb.example.net:389

Further suppose the NSDB nsdb.example.net:389 has an NSDB Container Entry whose distinguished name is o=fedfs, and that an FSN record for the above UUID already exists. Finally, a replica of this fileset exists at fileserver.example.net:/export/path. To create a corresponding FSL record, you might use:

$ nsdb-create-fsl -D cn=Manager -e o=fedfs \
       -l nsdb.example.net \

       8e246ddc-7b46-11e0-8252-000c297fd679 \

       323c5068-7c11-11e0-8d38-000c297fd679 \

       fileserver.example.net /export/path

Enter NSDB password:
Successfully created FSL record
  fedfsFslUuid=323c5068-7c11-11e0-8d38-000c297fd679,
  fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs

A new unpopulated NFS FSL record is created on nsdb.example.net:389 as a child of the FSN record with a distinguished name of

fedfsFsnUuid=8e246ddc-7b46-11e0-8252-000c297fd679,o=fedfs.

To see the new FSL record, use nsdb-list(8) or nsdb-resolve-fsn(8). To update individual attributes in the new FSL record, use nsdb-update-fsl(8).

SECURITY

Permission to modify the LDAP's DIT is required to create a new FSL record. The nsdb-create-fsl(8) command must bind as an entity permitted to modify the DIT to perform this operation. The nsdb-create-fsl(8) command asks for a password on stdin. Standard password blanking techniques are used to obscure the password on the user's terminal.

The target LDAP server must be registered in the local NSDB connection parameter database. The connection security mode listed in the NSDB connection parameter database for the target LDAP server is used during this operation. See nsdbparams(8) for details on how to register an NSDB in the local NSDB connection parameter database.

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>