draft-ietf-nfsv4-federated-fs-admin-15.txt   rfc7533.txt 
NFSv4 Working Group J. Lentini Internet Engineering Task Force (IETF) J. Lentini
Internet-Draft NetApp Request for Comments: 7533 NetApp
Intended status: Standards Track D. Ellard Category: Standards Track R. Tewari
Expires: June 15, 2013 Raytheon BBN Technologies ISSN: 2070-1721 IBM Almaden
R. Tewari
IBM Almaden
C. Lever, Ed. C. Lever, Ed.
Oracle Corporation Oracle Corporation
December 12, 2012 March 2015
Administration Protocol for Federated Filesystems Administration Protocol for Federated File Systems
draft-ietf-nfsv4-federated-fs-admin-15
Abstract Abstract
This document describes the administration protocol for a federated This document describes the administration protocol for a federated
file system that enables file access and namespace traversal across file system (FedFS) that enables file access and namespace traversal
collections of independently administered fileservers. The protocol across collections of independently administered fileservers. The
specifies a set of interfaces by which fileservers with different protocol specifies a set of interfaces by which fileservers with
administrators can form a fileserver federation that provides a different administrators can form a fileserver federation that
namespace composed of the filesystems physically hosted on and provides a namespace composed of the file systems physically hosted
exported by the constituent fileservers. on and exported by the constituent fileservers.
Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
Status of this Memo
This Internet-Draft is submitted in full conformance with the Status of This Memo
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering This is an Internet Standards Track document.
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months This document is a product of the Internet Engineering Task Force
and may be updated, replaced, or obsoleted by other documents at any (IETF). It represents the consensus of the IETF community. It has
time. It is inappropriate to use Internet-Drafts as reference received public review and has been approved for publication by the
material or to cite them other than as "work in progress." Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 5741.
This Internet-Draft will expire on June 15, 2013. Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc7533.
Copyright Notice Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the
Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 3, line 7 skipping to change at page 3, line 7
modifications of such material outside the IETF Standards Process. modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other it for publication as an RFC or to translate it into languages other
than English. than English.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5 1. Introduction ....................................................4
1.1. Definitions . . . . . . . . . . . . . . . . . . . . . . . 5 1.1. Definitions ................................................4
2. Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 1.2. Requirements Language ......................................6
3. Error Values . . . . . . . . . . . . . . . . . . . . . . . . . 13 2. Protocol ........................................................7
4. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3. Error Values ...................................................12
4.1. FedFsNsdbName Equality . . . . . . . . . . . . . . . . . . 18 4. Data Types .....................................................15
5. Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.1. FedFsNsdbName Equality ....................................17
5.1. FEDFS_NULL . . . . . . . . . . . . . . . . . . . . . . . . 19 5. Procedures .....................................................17
5.1.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 19 5.1. FEDFS_NULL ................................................18
5.1.2. Description . . . . . . . . . . . . . . . . . . . . . 19 5.1.1. Synopsis ...........................................18
5.1.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 19 5.1.2. Description ........................................18
5.2. FEDFS_CREATE_JUNCTION . . . . . . . . . . . . . . . . . . 19 5.1.3. Errors .............................................18
5.2.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 19 5.2. FEDFS_CREATE_JUNCTION .....................................18
5.2.2. Description . . . . . . . . . . . . . . . . . . . . . 19 5.2.1. Synopsis ...........................................18
5.2.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 21 5.2.2. Description ........................................18
5.3. FEDFS_DELETE_JUNCTION . . . . . . . . . . . . . . . . . . 21 5.2.3. Errors .............................................20
5.3.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 21 5.3. FEDFS_DELETE_JUNCTION .....................................20
5.3.2. Description . . . . . . . . . . . . . . . . . . . . . 21 5.3.1. Synopsis ...........................................20
5.3.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 22 5.3.2. Description ........................................20
5.4. FEDFS_LOOKUP_JUNCTION . . . . . . . . . . . . . . . . . . 23 5.3.3. Errors .............................................22
5.4.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 23 5.4. FEDFS_LOOKUP_JUNCTION .....................................22
5.4.2. Description . . . . . . . . . . . . . . . . . . . . . 23 5.4.1. Synopsis ...........................................22
5.4.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 26 5.4.2. Description ........................................22
5.5. FEDFS_CREATE_REPLICATION . . . . . . . . . . . . . . . . . 26 5.4.3. Errors .............................................25
5.5.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 26 5.5. FEDFS_CREATE_REPLICATION ..................................26
5.5.2. Description . . . . . . . . . . . . . . . . . . . . . 26 5.5.1. Synopsis ...........................................26
5.5.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 27 5.5.2. Description ........................................26
5.6. FEDFS_DELETE_REPLICATION . . . . . . . . . . . . . . . . . 28 5.5.3. Errors .............................................27
5.6.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 28 5.6. FEDFS_DELETE_REPLICATION ..................................27
5.6.2. Description . . . . . . . . . . . . . . . . . . . . . 28 5.6.1. Synopsis ...........................................27
5.6.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 29 5.6.2. Description ........................................27
5.7. FEDFS_LOOKUP_REPLICATION . . . . . . . . . . . . . . . . . 29 5.6.3. Errors .............................................28
5.7.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 29 5.7. FEDFS_LOOKUP_REPLICATION ..................................28
5.7.2. Description . . . . . . . . . . . . . . . . . . . . . 29 5.7.1. Synopsis ...........................................28
5.7.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 30 5.7.2. Description ........................................28
5.8. FEDFS_SET_NSDB_PARAMS . . . . . . . . . . . . . . . . . . 31 5.7.3. Errors .............................................29
5.8.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 31 5.8. FEDFS_SET_NSDB_PARAMS .....................................30
5.8.2. Description . . . . . . . . . . . . . . . . . . . . . 31 5.8.1. Synopsis ...........................................30
5.8.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 31 5.8.2. Description ........................................30
5.9. FEDFS_GET_NSDB_PARAMS . . . . . . . . . . . . . . . . . . 32 5.8.3. Errors .............................................31
5.9.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 32 5.9. FEDFS_GET_NSDB_PARAMS .....................................31
5.9.2. Description . . . . . . . . . . . . . . . . . . . . . 32 5.9.1. Synopsis ...........................................31
5.9.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 32 5.9.2. Description ........................................31
5.10. FEDFS_GET_LIMITED_NSDB_PARAMS . . . . . . . . . . . . . . 33 5.9.3. Errors .............................................32
5.10.1. Synopsis . . . . . . . . . . . . . . . . . . . . . . . 33 5.10. FEDFS_GET_LIMITED_NSDB_PARAMS ............................32
5.10.2. Description . . . . . . . . . . . . . . . . . . . . . 33 5.10.1. Synopsis ..........................................32
5.10.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 34 5.10.2. Description .......................................32
6. Security Considerations . . . . . . . . . . . . . . . . . . . 34 5.10.3. Errors ............................................33
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 35 6. Security Considerations ........................................33
8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 35 7. IANA Considerations ............................................34
8.1. Normative References . . . . . . . . . . . . . . . . . . . 35 8. References .....................................................34
8.2. Informative References . . . . . . . . . . . . . . . . . . 36 8.1. Normative References ......................................34
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 36 8.2. Informative References ....................................35
Appendix B. RFC Editor Notes . . . . . . . . . . . . . . . . . . 37 Acknowledgments ...................................................36
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 37 Authors' Addresses ................................................37
1. Introduction 1. Introduction
A federated filesystem enables file access and namespace traversal in A federated file system enables file access and namespace traversal
a uniform, secure and consistent manner across multiple independent in a uniform, secure, and consistent manner across multiple
fileservers within an enterprise (and possibly across multiple independent fileservers within an enterprise (and possibly across
enterprises) with reasonably good performance. multiple enterprises) with reasonably good performance.
Traditionally, building a namespace that spans multiple fileservers Traditionally, building a namespace that spans multiple fileservers
has been difficult for two reasons. First, the fileservers that has been difficult for two reasons. First, the fileservers that
export pieces of the namespace are often not in the same export pieces of the namespace are often not in the same
administrative domain. Second, there is no standard mechanism for administrative domain. Second, there is no standard mechanism for
the fileservers to cooperatively present the namespace. Fileservers the fileservers to cooperatively present the namespace. Fileservers
might provide proprietary management tools and in some cases an might provide proprietary management tools, and in some cases, an
administrator might be able to use the proprietary tools to build a administrator might be able to use the proprietary tools to build a
shared namespace out of the exported filesystems. Relying on vendor- shared namespace out of the exported file systems. Relying on
proprietary tools does not work in larger enterprises or when vendor-proprietary tools does not work in larger enterprises or when
collaborating across enterprises because it is likely that the system collaborating across enterprises because it is likely that the system
will contain fileservers running different software, each with their will contain fileservers running different software, each with their
own protocols, with no common protocol to manage the namespace or own protocols, with no common protocol to manage the namespace or
exchange namespace information. exchange namespace information.
The requirements for federated namespaces are described in [RFC5716]. The requirements for federated namespaces are described in [RFC5716].
The filesystem federation protocol described in [FEDFS-NSDB] allows The protocol for federated file systems described in [RFC7532] allows
fileservers from different vendors and/or with different fileservers from different vendors and/or with different
administrators to cooperatively build a namespace. administrators to cooperatively build a namespace.
This document describes the protocol used by administrators to This document describes the protocol used by administrators to
configure the fileservers and construct the namespace. configure the fileservers and construct the namespace.
1.1. Definitions 1.1. Definitions
Administrator: A user with the necessary authority to initiate Administrator: A user with the necessary authority to initiate
administrative tasks on one or more servers. administrative tasks on one or more servers.
Admin Entity: A server or agent that administers a collection of Admin Entity: A server or agent that administers a collection of
fileservers and persistently stores the namespace information. fileservers and persistently stores the namespace information.
File-access Client: Standard off-the-shelf network attached storage File-Access Client: Standard off-the-shelf, network-attached storage
(NAS) client software that communicates with fileservers using a (NAS) client software that communicates with fileservers using a
standard file-access protocol. standard file-access protocol.
Federation: A set of fileserver collections and singleton Federation: A set of fileserver collections and singleton
fileservers that use a common set of interfaces and protocols in fileservers that use a common set of interfaces and protocols in
order to provide to file-access clients a federated namespace order to provide to file-access clients a federated namespace
accessible through a filesystem access protocol. accessible through a file system access protocol.
Fileserver: A server that stores physical fileset data, or refers Fileserver: A server that stores physical fileset data or refers
file-access clients to other fileservers. A fileserver provides file-access clients to other fileservers. A fileserver provides
access to its shared filesystem data via a file-access protocol. access to its shared file system data via a file-access protocol.
Fileset: The abstraction of a set of files and the directory tree Fileset: The abstraction of a set of files and the directory tree
that contains them. A fileset is the fundamental unit of data that contains them. A fileset is the fundamental unit of data
management in the federation. management in the federation.
Note that all files within a fileset are descendants of one Note that all files within a fileset are descendants of one
directory, and that filesets do not span filesystems. directory and that filesets do not span file systems.
Filesystem: A self-contained unit of export for a fileserver, and File System: A self-contained unit of export for a fileserver and
the mechanism used to implement filesets. The fileset does not the mechanism used to implement filesets. The fileset does not
need to be rooted at the root of the filesystem, nor at the export need to be rooted at the root of the file system, nor at the
point for the filesystem. export point for the file system.
A single filesystem MAY implement more than one fileset, if the A single file system MAY implement more than one fileset, if the
file-access protocol and the fileserver permit this. file-access protocol and the fileserver permit this.
File-access Protocol: A network filesystem access protocol such as File-Access Protocol: A network file system access protocol such as
NFSv3 [RFC1813], NFSv4 [3530bis], or CIFS (Common Internet File the Network File System (NFS) version 4 [RFC7530] or the Common
System) [MS-SMB] [MS-SMB2] [MS-CIFS]. Internet File System (CIFS) [MS-SMB] [MS-SMB2] [MS-CIFS].
FSL (Fileset Location): The location of the implementation of a FSL (Fileset Location): The location of the implementation of a
fileset at a particular moment in time. An FSL MUST be something fileset at a particular moment in time. An FSL MUST be something
that can be translated into a protocol-specific description of a that can be translated into a protocol-specific description of a
resource that a file-access client can access directly, such as an resource that a file-access client can access directly, such as an
fs_locations attribute (for NFSv4), or a share name (for CIFS). fs_locations attribute (for NFSv4) or a share name (for CIFS).
FSN (Fileset Name): A platform-independent and globally unique name FSN (Fileset Name): A platform-independent and globally unique name
for a fileset. Two FSLs that implement replicas of the same for a fileset. Two FSLs that implement replicas of the same
fileset MUST have the same FSN, and if a fileset is migrated from fileset MUST have the same FSN, and if a fileset is migrated from
one location to another, the FSN of that fileset MUST remain the one location to another, the FSN of that fileset MUST remain the
same. same.
Junction: A filesystem object used to link a directory name in the Junction: A file system object used to link a directory name in the
current fileset with an object within another fileset. The current fileset with an object within another fileset. The
server-side "link" from a leaf node in one fileset to the root of server-side "link" from a leaf node in one fileset to the root of
another fileset. another fileset.
Namespace: A filename/directory tree that a sufficiently authorized Namespace: A filename/directory tree that a sufficiently authorized
file-access client can observe. file-access client can observe.
NSDB (Namespace Database) Service: A service that maps FSNs to FSLs. NSDB (Namespace Database) Service: A service that maps FSNs to FSLs.
The NSDB may also be used to store other information, such as The NSDB may also be used to store other information, such as
annotations for these mappings and their components. annotations for these mappings and their components.
NSDB Node: The name or location of a server that implements part of NSDB Node: The name or location of a server that implements part of
the NSDB service and is responsible for keeping track of the FSLs the NSDB service and is responsible for keeping track of the FSLs
(and related info) that implement a given partition of the FSNs. (and related information) that implement a given partition of the
FSNs.
Referral: A server response to a file-access client access that Referral: A server response to a file-access client access that
directs the client to evaluate the current object as a reference directs the client to evaluate the current object as a reference
to an object at a different location (specified by an FSL) in to an object at a different location (specified by an FSL) in
another fileset, and possibly hosted on another fileserver. The another fileset and possibly hosted on another fileserver. The
client re-attempts the access to the object at the new location. client re-attempts the access to the object at the new location.
Replica: A replica is a redundant implementation of a fileset. Each Replica: A redundant implementation of a fileset. Each replica
replica shares the same FSN, but has a different FSL. shares the same FSN but has a different FSL.
Replicas may be used to increase availability or performance. Replicas may be used to increase availability or performance.
Updates to replicas of the same fileset MUST appear to occur in Updates to replicas of the same fileset MUST appear to occur in
the same order, and therefore each replica is self-consistent at the same order; therefore, each replica is self-consistent at any
any moment. moment.
We do not assume that updates to each replica occur We do not assume that updates to each replica occur
simultaneously. If a replica is offline or unreachable, the other simultaneously. If a replica is offline or unreachable, the other
replicas may be updated. replicas may be updated.
Server Collection: A set of fileservers administered as a unit. A Server Collection: A set of fileservers administered as a unit. A
server collection may be administered with vendor-specific server collection may be administered with vendor-specific
software. software.
The namespace provided by a server collection could be part of the The namespace provided by a server collection could be part of the
federated namespace. federated namespace.
Singleton Server: A server collection containing only one server; a Singleton Server: A server collection containing only one server; a
stand-alone fileserver. stand-alone fileserver.
1.2. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
2. Protocol 2. Protocol
The RPC protocol used by the administration operations is ONC RPC The Remote Procedure Call (RPC) protocol used to convey
[RFC5531]. The data structures used for the parameters and return administration operations is the Open Network Computing (ONC) RPC
values of these procedures are expressed in this document in XDR protocol [RFC5531]. The data structures used for the parameters and
[RFC4506]. return values of these procedures are expressed in this document in
External Data Representation (XDR) [RFC4506].
The XDR definitions below are formatted to allow the reader to easily The XDR definitions below are formatted to allow the reader to easily
extract them from the document. The reader can use the following extract them from the document. The reader can use the following
shell script to extract the definitions: shell script to extract the definitions:
<CODE BEGINS> <CODE BEGINS>
#!/bin/sh #!/bin/sh
grep '^ *///' | sed 's?^ */// ??' | sed 's?^ *///$??' grep '^ *///' | sed 's?^ */// ??' | sed 's?^ *///$??'
<CODE ENDS> <CODE ENDS>
If the above script is stored in a file called "extract.sh", and this If the above script is stored in a file called "extract.sh" and this
document is in a file called "spec.txt", then the reader can do: document is in a file called "spec.txt", then the reader can do:
<CODE BEGINS> <CODE BEGINS>
sh extract.sh < spec.txt > admin1.xdr sh extract.sh < spec.txt > admin1.xdr
<CODE ENDS> <CODE ENDS>
The effect of the script is to remove leading white space from each The effect of the script is to remove leading white space from each
line, plus a sentinel sequence of "///". line, plus a sentinel sequence of "///".
The protocol definition in XDR notation is shown below. We begin by The protocol definition in XDR notation is shown below. We begin by
defining basic constants and structures used by the protocol. We defining basic constants and structures used by the protocol. We
then present the procedures defined by the protocol. then present the procedures defined by the protocol.
<CODE BEGINS> <CODE BEGINS>
/// /* /// /*
/// * Copyright (c) 2010-2012 IETF Trust and the persons identified /// * Copyright (c) 2015 IETF Trust and the persons identified
/// * as authors of the code. All rights reserved. /// * as authors of the code. All rights reserved.
/// * /// *
/// * The authors of the code are the authors of /// * The authors of the code are:
/// * [draft-ietf-nfsv4-federated-fs-admin-xx.txt]: J. Lentini, /// * J. Lentini, C. Everhart, D. Ellard, R. Tewari, and M. Naik.
/// * C. Everhart, D. Ellard, R. Tewari, and M. Naik.
/// * /// *
/// * Redistribution and use in source and binary forms, with /// * Redistribution and use in source and binary forms, with
/// * or without modification, are permitted provided that the /// * or without modification, are permitted provided that the
/// * following conditions are met: /// * following conditions are met:
/// * /// *
/// * - Redistributions of source code must retain the above /// * - Redistributions of source code must retain the above
/// * copyright notice, this list of conditions and the /// * copyright notice, this list of conditions and the
/// * following disclaimer. /// * following disclaimer.
/// * /// *
/// * - Redistributions in binary form must reproduce the above /// * - Redistributions in binary form must reproduce the above
skipping to change at page 12, line 15 skipping to change at page 11, line 22
/// case FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL: /// case FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL:
/// FedFsNsdbName targetNsdb; /// FedFsNsdbName targetNsdb;
/// case FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL: /// case FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL:
/// FedFsLookupResReferralVal resReferralVal; /// FedFsLookupResReferralVal resReferralVal;
/// default: /// default:
/// void; /// void;
/// }; /// };
/// ///
/// enum FedFsConnectionSec { /// enum FedFsConnectionSec {
/// FEDFS_SEC_NONE = 0, /// FEDFS_SEC_NONE = 0,
/// FEDFS_SEC_TLS = 1 /* StartTLS mechanism; RFC4513, Section 3 */ /// FEDFS_SEC_TLS = 1 /* StartTLS mechanism; RFC 4513, Section 3 */
/// }; /// };
/// ///
/// union FedFsNsdbParams switch (FedFsConnectionSec secType) { /// union FedFsNsdbParams switch (FedFsConnectionSec secType) {
/// case FEDFS_SEC_TLS: /// case FEDFS_SEC_TLS:
/// opaque secData<>; /// opaque secData<>;
/// default: /// default:
/// void; /// void;
/// }; /// };
/// ///
/// struct FedFsSetNsdbParamsArgs { /// struct FedFsSetNsdbParamsArgs {
skipping to change at page 13, line 30 skipping to change at page 12, line 37
<CODE ENDS> <CODE ENDS>
3. Error Values 3. Error Values
The results of successful operations will consist of a status of The results of successful operations will consist of a status of
FEDFS_OK. The results of unsuccessful operations will begin with a FEDFS_OK. The results of unsuccessful operations will begin with a
status, other than FEDFS_OK, that indicates the reason why the status, other than FEDFS_OK, that indicates the reason why the
operation failed. operation failed.
Many of the error status names and meanings (and the prose for their Many of the error status names and meanings (and the prose for their
descriptions) are taken from the specification for NFSv4 [3530bis]. descriptions) are taken from the specification for NFSv4 [RFC7530].
Note, however, that the numeric values for the status codes are Note, however, that the numeric values for the status codes are
different. For example, the name and meaning of FEDFS_ERR_ACCESS was different. For example, the name and meaning of FEDFS_ERR_ACCESS was
inspired by NFSv4's NFS4ERR_ACCESS, but their numeric values are inspired by NFSv4's NFS4ERR_ACCESS, but their numeric values are
different. different.
The status of an unsuccessful operation will generally only indicate The status of an unsuccessful operation will generally only indicate
the first error encountered during the attempt to execute the the first error encountered during the attempt to execute the
operation. operation.
FEDFS_OK: No errors were encountered. The operation was a success. FEDFS_OK: No errors were encountered. The operation was a success.
FEDFS_ERR_ACCESS: Permission denied. The caller does not have the FEDFS_ERR_ACCESS: Permission denied. The caller does not have the
correct permission to perform the requested operation. correct permission to perform the requested operation.
FEDFS_ERR_BADCHAR: A UTF-8 string contains a character which is not FEDFS_ERR_BADCHAR: A UTF-8 string contains a character that is not
supported by the server in the context in which it being used. supported by the server in the context in which it being used.
FEDFS_ERR_BADNAME: A name string in a request consisted of valid FEDFS_ERR_BADNAME: A name string in a request consisted of valid
UTF-8 characters supported by the server, but the name is not UTF-8 characters supported by the server, but the name is not
supported by the server as a valid name for the current operation. supported by the server as a valid name for the current operation.
FEDFS_ERR_NAMETOOLONG: Returned when the pathname in an operation FEDFS_ERR_NAMETOOLONG: Returned when the pathname in an operation
exceeds the server's implementation limit. exceeds the server's implementation limit.
FEDFS_ERR_LOOP: Returned when too many symbolic links were FEDFS_ERR_LOOP: Returned when too many symbolic links were
skipping to change at page 14, line 26 skipping to change at page 13, line 29
processing an operation. processing an operation.
FEDFS_ERR_EXIST: The junction specified already exists. FEDFS_ERR_EXIST: The junction specified already exists.
FEDFS_ERR_INVAL: Invalid argument for an operation. FEDFS_ERR_INVAL: Invalid argument for an operation.
FEDFS_ERR_IO: A hard error occurred while processing the requested FEDFS_ERR_IO: A hard error occurred while processing the requested
operation. operation.
FEDFS_ERR_NOSPC: The requested operation would have caused the FEDFS_ERR_NOSPC: The requested operation would have caused the
server's filesystem to exceed some limit (for example, if there is server's file system to exceed some limit (for example, if there
a fixed number of junctions per fileset or per server). is a fixed number of junctions per fileset or per server).
FEDFS_ERR_NOTJUNCT: The caller specified a path that does not end in FEDFS_ERR_NOTJUNCT: The caller specified a path that does not end in
a junction as the operand for an operation that requires the last a junction as the operand for an operation that requires the last
component of the path to be a junction. component of the path to be a junction.
FEDFS_ERR_NOTLOCAL: The caller specified a path that contains a FEDFS_ERR_NOTLOCAL: The caller specified a path that contains a
junction in any position other than the last component. junction in any position other than the last component.
FEDFS_ERR_PERM: The operation was not allowed because the caller is FEDFS_ERR_PERM: The operation was not allowed because the caller is
either not a privileged user or not the owner of an object that either not a privileged user or not the owner of an object that
would be modified by the operation. would be modified by the operation.
FEDFS_ERR_ROFS: A modifying operation was attempted on a read-only FEDFS_ERR_ROFS: A modifying operation was attempted on a read-only
filesystem. file system.
FEDFS_ERR_SVRFAULT: An unanticipated non-protocol error occurred on FEDFS_ERR_SVRFAULT: An unanticipated non-protocol error occurred on
the server. the server.
FEDFS_ERR_NSDB_ROUTE: The fileserver was unable to find a route to FEDFS_ERR_NSDB_ROUTE: The fileserver was unable to find a route to
the NSDB. the NSDB.
FEDFS_ERR_NSDB_DOWN: The fileserver determined that the NSDB was FEDFS_ERR_NSDB_DOWN: The fileserver determined that the NSDB was
down. down.
FEDFS_ERR_NSDB_CONN: The fileserver was unable to establish a FEDFS_ERR_NSDB_CONN: The fileserver was unable to establish a
connection with the NSDB. connection with the NSDB.
FEDFS_ERR_NSDB_AUTH: The fileserver was unable to authenticate and FEDFS_ERR_NSDB_AUTH: The fileserver was unable to authenticate and
establish a secure connection with the NSDB. establish a secure connection with the NSDB.
FEDFS_ERR_NSDB_LDAP: An LDAP error occurred on the connection FEDFS_ERR_NSDB_LDAP: A Lightweight Directory Access Protocol (LDAP)
between the fileserver and NSDB. error occurred on the connection between the fileserver and NSDB.
FEDFS_ERR_NSDB_LDAP_VAL: Indicates the same error as FEDFS_ERR_NSDB_LDAP_VAL: Indicates the same error as
FEDFS_ERR_NSDB_LDAP, and allows the LDAP protocol error value to FEDFS_ERR_NSDB_LDAP and allows the LDAP protocol error value to be
be returned back to an ADMIN protocol client. returned back to an ADMIN protocol client.
FEDFS_ERR_NSDB_NONCE: The fileserver was unable to locate the NCE in FEDFS_ERR_NSDB_NONCE: The fileserver was unable to locate the NSDB
the appropriate NSDB. Container Entry (NCE) in the appropriate NSDB.
FEDFS_ERR_NSDB_NOFSN: The fileserver was unable to locate the given FEDFS_ERR_NSDB_NOFSN: The fileserver was unable to locate the given
FSN in the appropriate NSDB. FSN in the appropriate NSDB.
FEDFS_ERR_NSDB_NOFSL: The fileserver was unable to locate any FSLs FEDFS_ERR_NSDB_NOFSL: The fileserver was unable to locate any FSLs
for the given FSN in the appropriate NSDB. for the given FSN in the appropriate NSDB.
FEDFS_ERR_NSDB_RESPONSE: The fileserver received a malformed FEDFS_ERR_NSDB_RESPONSE: The fileserver received a malformed
response from the NSDB. This includes situations when an NSDB response from the NSDB. This includes situations when an NSDB
entry (e.g., FSN or FSL) is missing a required attribute. entry (e.g., FSN or FSL) is missing a required attribute.
skipping to change at page 15, line 41 skipping to change at page 14, line 44
FEDFS_ERR_NSDB_FAULT: An unanticipated error related to the NSDB FEDFS_ERR_NSDB_FAULT: An unanticipated error related to the NSDB
occurred. occurred.
FEDFS_ERR_NSDB_PARAMS: The fileserver does not have any connection FEDFS_ERR_NSDB_PARAMS: The fileserver does not have any connection
parameters on record for the specified NSDB. parameters on record for the specified NSDB.
FEDFS_ERR_NSDB_LDAP_REFERRAL: The fileserver received an LDAP FEDFS_ERR_NSDB_LDAP_REFERRAL: The fileserver received an LDAP
referral that it was unable to follow. referral that it was unable to follow.
FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL: Indicates the same error as FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL: Indicates the same error as
FEDFS_ERR_NSDB_LDAP_REFERRAL, and allows the LDAP protocol error FEDFS_ERR_NSDB_LDAP_REFERRAL and allows the LDAP protocol error
value to be returned back to an ADMIN protocol client. value to be returned back to an ADMIN protocol client.
FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED: The fileserver received an FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED: The fileserver received an
LDAP referral that it chose not to follow, either because the LDAP referral that it chose not to follow, either because the
fileserver does not support following LDAP referrals or LDAP fileserver does not support following LDAP referrals or LDAP
referral following is disabled. referral following is disabled.
FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL: The fileserver received an LDAP FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL: The fileserver received an LDAP
referral that it chose not to follow because the fileserver had no referral that it chose not to follow because the fileserver had no
NSDB parameters for the NSDB targeted by the LDAP referral. NSDB parameters for the NSDB targeted by the LDAP referral.
FEDFS_ERR_PATH_TYPE_UNSUPP: The fileserver does not support the FEDFS_ERR_PATH_TYPE_UNSUPP: The fileserver does not support the
specified FedFsPathType value. specified FedFsPathType value.
FEDFS_ERR_NOTSUPP: The fileserver does not support the specified FEDFS_ERR_NOTSUPP: The fileserver does not support the specified
procedure. procedure.
FEDFS_ERR_DELAY: The fileserver initiated the request, but was not FEDFS_ERR_DELAY: The fileserver initiated the request but was not
able to complete it in a timely fashion. The ADMIN protocol able to complete it in a timely fashion. The ADMIN protocol
client should wait and then try the request with a new RPC client should wait and then try the request with a new RPC
transaction ID. transaction ID.
FEDFS_ERR_NO_CACHE: The fileserver does not implement an FSN-to-FSL FEDFS_ERR_NO_CACHE: The fileserver does not implement an FSN-to-FSL
cache. cache.
FEDFS_ERR_UNKNOWN_CACHE: The software receiving the ONC RPC request FEDFS_ERR_UNKNOWN_CACHE: The software receiving the ONC RPC request
is unaware if the fileserver implements an FSN-to-FSL cache or is unaware if the fileserver implements an FSN-to-FSL cache or is
unable to communicate with the FSN-to-FSL cache if it exists. unable to communicate with the FSN-to-FSL cache if it exists.
FEDFS_ERR_NO_CACHE_UPDATE: The fileserver was unable to update its FEDFS_ERR_NO_CACHE_UPDATE: The fileserver was unable to update its
FSN-to-FSL cache. FSN-to-FSL cache.
4. Data Types 4. Data Types
The basic data types defined above are formatted as follows: The basic data types defined above are formatted as follows:
FedFsUuid: A universally unique identifier (UUID) as described in FedFsUuid: A universally unique identifier (UUID) as described in
[RFC4122] as a version 4 UUID. The UUID MUST be formatted in [RFC4122] as a version 4 UUID. The UUID MUST be formatted in
network byte order. network byte order.
FedFsNsdbName: A (hostname, port) pair. FedFsNsdbName: A (hostname, port) pair.
The hostname is a variable length UTF-8 string that represents an The hostname is a variable-length UTF-8 string that represents an
NSDB's network location in DNS name notation. It SHOULD be NSDB's network location in DNS name notation. It SHOULD be
prepared using the server4 rules defined in Chapter 12 prepared using the domain name rules defined in Section 12.6
"Internationalization" of [3530bis]. The DNS name MUST be ("Types with Processing Defined by Other Internet Areas") of
represented using a fully qualified domain name. [RFC7530]. The DNS name MUST be represented using a fully
qualified domain name.
The port value in the FedFsNsdbName indicates the LDAP port on the The port value in the FedFsNsdbName indicates the LDAP port on the
NSDB (see [RFC4511]). The value MUST be in the range 0 to 65535. NSDB (see [RFC4511]). The value MUST be in the range 0 to 65535.
A value of 0 indicates that the standard LDAP port number, 389, A value of 0 indicates that the standard LDAP port number, 389,
MUST be assumed. MUST be assumed.
FSNs are immutable and invariant. The attributes of an FSN, FSNs are immutable and invariant. The attributes of an FSN,
including the fedfsNsdbName, are expected to remain constant. including the fedfsNsdbName, are expected to remain constant.
Therefore, a FedFsNsdbName MUST NOT contain a network address, Therefore, a FedFsNsdbName MUST NOT contain a network address,
such as an IPv4 or IPv6 address, as this would indefinitely assign such as an IPv4 or IPv6 address, as this would indefinitely assign
the network address. the network address.
FedFsPathComponent: A case sensitive UTF-8 string containing a FedFsPathComponent: A case-sensitive UTF-8 string containing a file
filesystem path component. It MUST be prepared using the system path component. The component names of an NFSv4 pathname
component4 rules defined in Chapter 12 "Internationalization" of MUST be prepared using the component name rules defined in
[3530bis]. Section 12 ("Internationalization") of [RFC7530] prior to encoding
the path component of an NFS URI.
FedFsPathName: A variable length array of FedFsPathComponent values FedFsPathName: A variable-length array of FedFsPathComponent values
representing a filesystem path. The path's first component is representing a file system path. The path's first component is
stored at the first position of the array, the second component is stored at the first position of the array, the second component is
stored at the second position of the array, and so on. stored at the second position of the array, and so on.
The path "/" MUST be encoded as an array with zero components. The path "/" MUST be encoded as an array with zero components.
A FedFsPathName MUST NOT contain any zero-length components. A FedFsPathName MUST NOT contain any zero-length components.
FedFsPath: A pathname container. The format and semantics of the FedFsPath: A pathname container. The format and semantics of the
pathname are defined by the FedFsPathType value. pathname are defined by the FedFsPathType value.
FedFsPathType: The type specific description of a pathname. FedFsPathType: The type-specific description of a pathname.
A FEDFS_PATH_SYS is an implementation dependent administrative A FEDFS_PATH_SYS is an implementation-dependent administrative
pathname. For example, it could be a local file system path. pathname. For example, it could be a local file system path.
A FEDFS_PATH_NFS is a pathname in the NFSv4 server's single-server A FEDFS_PATH_NFS is a pathname in the NFSv4 server's single-server
namespace. namespace.
FedFsNsdbParams: A set of parameters for connecting to an NSDB. FedFsNsdbParams: A set of parameters for connecting to an NSDB.
Conceptually the fileserver contains a data structure that maps an Conceptually, the fileserver contains a data structure that maps
NSDB name (DNS name and port value) to these LDAP connection an NSDB name (DNS name and port value) to these LDAP connection
parameters. parameters.
The secType field indicates the security mechanism that MUST be The secType field indicates the security mechanism that MUST be
used to protect all connections to the NSDB with the connection used to protect all connections to the NSDB with the connection
parameters. parameters.
A value of FEDFS_SEC_NONE indicates that a transport security A value of FEDFS_SEC_NONE indicates that a transport security
mechanism MUST NOT be used when connecting to the NSDB. In this mechanism MUST NOT be used when connecting to the NSDB. In this
case, the secData array will have a length of zero. case, the secData array will have a length of zero.
A value of FEDFS_SEC_TLS indicates that the StartTLS security A value of FEDFS_SEC_TLS indicates that the StartTLS security
mechanism [RFC4513] MUST be used to protect all connections to the mechanism [RFC4513] MUST be used to protect all connections to the
NSDB. In this case, the secData array will contain an X.509v3 NSDB. In this case, the secData array will contain an X.509v3
root certificate in binary DER format [RFC5280] fulfilling the TLS root certificate in binary DER format [RFC5280] fulfilling the
requirement that root keys be distributed independently from the Transport Layer Security (TLS) requirement that root keys be
TLS protocol. The certificate MUST be used by the fileserver as a distributed independently from the TLS protocol. The certificate
Trust Anchor to validate the NSDB's TLS server certificate list MUST be used by the fileserver as a trust anchor to validate the
chain (see section 7.4.2 of [RFC5246]) and thus authenticate the NSDB's TLS server certificate list chain (see Section 7.4.2 of
identitiy of the NSDB. The certificate could be that of a [RFC5246]) and thus authenticate the identity of the NSDB. The
certificate authority or a self-signed certificate. To ensure certificate could be that of a certificate authority or a self-
that this security configuration information does not cause signed certificate. To ensure that this security configuration
vulnerabilities for other services, trust anchors provided through information does not cause vulnerabilities for other services,
secData MUST only be used for the NSDB service (as opposed to trust anchors provided through secData MUST only be used for the
being installed as system-wide trust anchors for other services). NSDB service (as opposed to being installed as system-wide trust
Most popular TLS libraries provide ways in which this can be done anchors for other services). Most popular TLS libraries provide
such as denoting a private file system location for the ways in which this can be done, such as denoting a private file
certificates. system location for the certificates.
4.1. FedFsNsdbName Equality 4.1. FedFsNsdbName Equality
Two FedFsNsdbNames are considered equal if their respective hostname Two FedFsNsdbNames are considered equal if their respective hostname
and port fields contain the same values. The only exception to this and port fields contain the same values. The only exception to this
rule is that a value of 0 in the port field always matches the rule is that a value of 0 in the port field always matches the
standard LDAP port number, 389. standard LDAP port number, 389.
Therefore, the FedFsNsdbName "(nsdb.example.com, 0)" is considered Therefore, the FedFsNsdbName "(nsdb.example.com, 0)" is considered
equal to "(nsdb.example.com, 389)" but not equal to equal to "(nsdb.example.com, 389)" but not equal to
"(nsdb.example.com, 1066)" since the port numbers are different, or "(nsdb.example.com, 1066)" since the port numbers are different or
"(nsdb.foo.example.com, 389)" since the hostnames are different. "(nsdb.foo.example.com, 389)" since the hostnames are different.
5. Procedures 5. Procedures
The procedures defined in Section 2 are described in detail in the The procedures defined in Section 2 are described in detail in the
following sections. following sections.
Fileservers that participate as "internal" nodes in the federated Fileservers that participate as "internal" nodes in the federated
namespace MUST implement the following procedures: namespace MUST implement the following procedures:
FEDFS_NULL FEDFS_NULL
FEDFS_CREATE_JUNCTION FEDFS_CREATE_JUNCTION
FEDFS_DELETE_JUNCTION FEDFS_DELETE_JUNCTION
FEDFS_LOOKUP_JUNCTION FEDFS_LOOKUP_JUNCTION
FEDFS_SET_NSDB_PARAMS FEDFS_SET_NSDB_PARAMS
FEDFS_GET_NSDB_PARAMS FEDFS_GET_NSDB_PARAMS
FEDFS_GET_LIMITED_NSDB_PARAMS FEDFS_GET_LIMITED_NSDB_PARAMS
and SHOULD implement the following procedures: Furthermore, they SHOULD implement the following procedures:
FEDFS_CREATE_REPLICATION FEDFS_CREATE_REPLICATION
FEDFS_DELETE_REPLICATION FEDFS_DELETE_REPLICATION
FEDFS_LOOKUP_REPLICATION FEDFS_LOOKUP_REPLICATION
Fileservers that participate as "leaf" nodes in the namespace (i.e., Fileservers that participate as "leaf" nodes in the namespace (i.e.,
fileservers that host filesets that are the target of junctions, but fileservers that host filesets that are the target of junctions but
that do not contain any junctions) are not required to implement any that do not contain any junctions) are not required to implement any
of these operations. of these operations.
Operations that modify the state of a replicated fileset MUST result Operations that modify the state of a replicated fileset MUST result
in the update of all of the replicas in a consistent manner. Ideally in the update of all of the replicas in a consistent manner.
all of the replicas SHOULD be updated before any operation returns. Ideally, all of the replicas SHOULD be updated before any operation
If one or more of the replicas are unavailable, the operation MAY returns. If one or more of the replicas are unavailable, the
succeed, but the changes MUST be applied before the unavailable operation MAY succeed, but the changes MUST be applied before the
replicas are brought back online. We assume that replicas are unavailable replicas are brought back online. We assume that
updated via some protocol that permits state changes to be reflected replicas are updated via some protocol that permits state changes to
consistently across the set of replicas in such a manner that the be reflected consistently across the set of replicas in such a manner
replicas will converge to a consistent state within a bounded number that the replicas will converge to a consistent state within a
of successful message exchanges between the servers hosting the bounded number of successful message exchanges between the servers
replicas. hosting the replicas.
5.1. FEDFS_NULL 5.1. FEDFS_NULL
5.1.1. Synopsis 5.1.1. Synopsis
The standard NULL procedure. The standard NULL procedure.
5.1.2. Description 5.1.2. Description
The null RPC, which is included, by convention, in every ONC RPC The null RPC, which is included, by convention, in every ONC RPC
skipping to change at page 20, line 39 skipping to change at page 19, line 44
be traversed because of insufficient permissions, or the final be traversed because of insufficient permissions, or the final
component is an unexecutable or unwritable directory, then the component is an unexecutable or unwritable directory, then the
operation MUST fail with status FEDFS_ERR_ACCESS. operation MUST fail with status FEDFS_ERR_ACCESS.
The operation SHOULD fail with status FEDFS_ERR_NSDB_PARAMS if the The operation SHOULD fail with status FEDFS_ERR_NSDB_PARAMS if the
fileserver does not have any connection parameters on record for the fileserver does not have any connection parameters on record for the
specified NSDB, or the server may allow the operation to proceed specified NSDB, or the server may allow the operation to proceed
using some set of default NSDB connection parameters. using some set of default NSDB connection parameters.
The association between the path and the FSN MUST be durable before The association between the path and the FSN MUST be durable before
the operation returns successfully. If the operation return codes the operation returns successfully. If the operation return code
indicates success, then the junction was successfully created and is indicates success, then the junction was successfully created and is
immediately accessible. immediately accessible.
If successful, subsequent references via NFSv4.0 [3530bis] or NFSv4.1 If successful, subsequent references via NFSv4.0 [RFC7530] or NFSv4.1
[RFC5661] clients to the directory that has been replaced by the [RFC5661] clients to the directory that has been replaced by the
junction will result in a referral to a current location of the junction will result in a referral to a current location of the
target fileset [FEDFS-NSDB]. target fileset [RFC7532].
The effective permissions of the directory that is converted, by this The effective permissions of the directory that is converted, by this
operation, into a junction are the permissions of the root directory operation, into a junction are the permissions of the root directory
of the target fileset. The original permissions of the directory of the target fileset. The original permissions of the directory
(and any other attributes it might have) are subsumed by the (and any other attributes it might have) are subsumed by the
junction. junction.
This operation does not create a fileset at the location targeted by This operation does not create a fileset at the location targeted by
the junction. If the target fileset does not exist, the junction the junction. If the target fileset does not exist, the junction
will still be created. An NFS client will discover the missing will still be created. An NFS client will discover the missing
skipping to change at page 22, line 22 skipping to change at page 21, line 26
was used to create the junction. If the namespace on the server has was used to create the junction. If the namespace on the server has
changed, then the junction might now appear at a different path than changed, then the junction might now appear at a different path than
where it was created. If there is more than one valid path to the where it was created. If there is more than one valid path to the
junction, any of them can be used. junction, any of them can be used.
The path is REQUIRED to exist and be completely local to the server. The path is REQUIRED to exist and be completely local to the server.
It MUST NOT contain a junction, except as the final component, which It MUST NOT contain a junction, except as the final component, which
MUST be a junction. If any other component of the path is a MUST be a junction. If any other component of the path is a
junction, then this operation MUST fail with status junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL. If the last component of the path is not a FEDFS_ERR_NOTLOCAL. If the last component of the path is not a
junction then this operation MUST return status FEDFS_ERR_NOTJUNCT. junction, then this operation MUST return status FEDFS_ERR_NOTJUNCT.
The path might contain a symbolic link (if supported by the local The path might contain a symbolic link (if supported by the local
server), but the traversal of the path MUST remain within the server- server), but the traversal of the path MUST remain within the server-
local namespace. local namespace.
The server MAY enforce the local permissions on the path, including The server MAY enforce the local permissions on the path, including
the final component. If a server wishes to report that a path cannot the final component. If a server wishes to report that a path cannot
be traversed because of insufficient permissions, or the final be traversed because of insufficient permissions, or the final
component is an unexecutable or unwritable directory, then the component is an unexecutable or unwritable directory, then the
operation MUST fail with status FEDFS_ERR_ACCESS. operation MUST fail with status FEDFS_ERR_ACCESS.
The removal of the association between the path and the FSN MUST be The removal of the association between the path and the FSN MUST be
durable before the operation returns successfully. If the operation durable before the operation returns successfully. If the operation
return codes indicates success, then the junction was successfully return code indicates success, then the junction was successfully
destroyed. destroyed.
The effective permissions and other attributes of the directory that The effective permissions and other attributes of the directory that
is restored by this operation SHOULD be identical to their value is restored by this operation SHOULD be identical to their value
prior to the creation of the junction. prior to the creation of the junction.
After removal of the junction, the fileserver MAY check if any of its After removal of the junction, the fileserver MAY check if any of its
existing junctions reference the NSDB specified in the removed existing junctions reference the NSDB specified in the removed
junction's FSN. If the NSDB is not referenced, the fileserver MAY junction's FSN. If the NSDB is not referenced, the fileserver MAY
delete the connection parameters of the unreferenced NSDB. delete the connection parameters of the unreferenced NSDB.
skipping to change at page 23, line 29 skipping to change at page 22, line 34
5.4. FEDFS_LOOKUP_JUNCTION 5.4. FEDFS_LOOKUP_JUNCTION
5.4.1. Synopsis 5.4.1. Synopsis
Query the server to discover the current value of the junction (if Query the server to discover the current value of the junction (if
any) at a given path in the server namespace. any) at a given path in the server namespace.
5.4.2. Description 5.4.2. Description
This operation queries a server to determine whether a given path This operation queries a server to determine whether a given path
ends in a junction, and if so, the FSN to which the junction refers ends in a junction. If it does, the FSN to which the junction refers
and the filerserver's ability to resolve the junction. and the fileserver's ability to resolve the junction is returned.
Ordinary NFSv4 operations do not provide any general mechanism to Ordinary NFSv4 operations do not provide any general mechanism to
determine whether an object is a junction -- there is no encoding determine whether an object is a junction -- there is no encoding
specified by the NFSv4 protocol that can represent this information. specified by the NFSv4 protocol that can represent this information.
As with FEDFS_CREATE_JUNCTION, the pathname MUST be in the form of an As with FEDFS_CREATE_JUNCTION, the pathname MUST be in the form of an
array of one or more UTF-8 path component strings. It is not array of one or more UTF-8 path component strings. It is not
required that this path be accessible in any other manner (e.g., to a required that this path be accessible in any other manner (e.g., to a
file-access client). This path does not appear in the federated file-access client). This path does not appear in the federated
namespace, except by coincidence; there is no requirement that the namespace, except by coincidence; there is no requirement that the
global namespace reflect the server namespace, nor is it required global namespace reflect the server namespace, nor is it required
that this path be relative to the server pseudo-root. It does not that this path be relative to the server pseudo-root. It does not
need to be a path that is accessible via NFS. need to be a path that is accessible via NFS.
If the path contains a character that is not supported by the server, If the path contains a character that is not supported by the server,
then status FEDFS_ERR_BADCHAR MUST be returned. then status FEDFS_ERR_BADCHAR MUST be returned.
The path used to lookup a junction might not be the same path that The path used to look up a junction might not be the same path that
was used to create the junction. If the namespace on the server has was used to create the junction. If the namespace on the server has
changed, then a junction might now appear at a different path than changed, then a junction might now appear at a different path than
where it was created. If there is more than one valid path to the where it was created. If there is more than one valid path to the
junction, any of them might be used. junction, any of them might be used.
The path is REQUIRED to exist and be completely local to the server. The path is REQUIRED to exist and be completely local to the server.
It MUST NOT contain a junction, except as the final component. If It MUST NOT contain a junction, except as the final component. If
any other component of the path is a junction, then this operation any other component of the path is a junction, then this operation
MUST fail with status FEDFS_ERR_NOTLOCAL. If the last component of MUST fail with status FEDFS_ERR_NOTLOCAL. If the last component of
the path is not a junction then this operation MUST return the status the path is not a junction, then this operation MUST return the
FEDFS_ERR_NOTJUNCT. The path might contain a symbolic link (if status FEDFS_ERR_NOTJUNCT. The path might contain a symbolic link
supported by the local server), but the traversal of the path MUST (if supported by the local server), but the traversal of the path
remain within the server-local namespace. MUST remain within the server-local namespace.
The server MAY enforce the local permissions on the path, including The server MAY enforce the local permissions on the path, including
the final component. If a server wishes to report that a path cannot the final component. If a server wishes to report that a path cannot
be traversed because of insufficient permissions, or the final be traversed because of insufficient permissions, or the final
component is an unexecutable or unwritable directory, then the component is an unexecutable or unwritable directory, then the
operation MUST fail with status FEDFS_ERR_ACCESS. operation MUST fail with status FEDFS_ERR_ACCESS.
If the junction exists, the resolve parameter allows for testing the If the junction exists, the resolve parameter allows for testing the
fileserver's ability to resolve the junction. If the junction does fileserver's ability to resolve the junction. If the junction does
not exist, the fileserver will ignore the resolve parameter. not exist, the fileserver will ignore the resolve parameter.
If the junction exists and the resolve parameter is set to If the junction exists and the resolve parameter is set to
FEDFS_RESOLVE_NONE, the fileserver MUST NOT attempt to resolve the FEDFS_RESOLVE_NONE, the fileserver MUST NOT attempt to resolve the
FSN. This will allow the administrator to obtain the junction's FSN FSN. This will allow an administrator to obtain the junction's FSN
even if the resolution would fail. Therefore on success, the result even if the resolution would fail. Therefore, on success, the result
of a FEDFS_RESOLVE_NONE call will return a 0 length fsl list in the of a FEDFS_RESOLVE_NONE call will return a zero-length fsl list in
FedFsLookupResOk structure. the FedFsLookupResOk structure.
If the junction exists and the resolve parameter is set to If the junction exists and the resolve parameter is set to
FEDFS_RESOLVE_CACHE, the fileserver MUST attempt to resolve the FSN FEDFS_RESOLVE_CACHE, the fileserver MUST attempt to resolve the FSN
using its FSL cache, if one exists. The fileserver MUST NOT resolve using its FSL cache, if one exists. The fileserver MUST NOT resolve
the FSN by contacting the appropriate NSDB. If the fileserver's the FSN by contacting the appropriate NSDB. If the fileserver's
cache does not have a mapping for the FSN in question, the result of cache does not have a mapping for the FSN in question, the result of
the operation MUST be FEDFS_OK with 0 elements in the the operation MUST be FEDFS_OK with 0 elements in the
FedFsLookupResOk structure's fsl array. The operation MAY fail with FedFsLookupResOk structure's fsl array. The operation MAY fail with
status FEDFS_ERR_NO_CACHE if the fileserver does not contain an FSN- status FEDFS_ERR_NO_CACHE if the fileserver does not contain an FSN-
to-FSL cache or with status FEDFS_ERR_UNKNOWN_CACHE if the state of to-FSL cache or with status FEDFS_ERR_UNKNOWN_CACHE if the state of
skipping to change at page 25, line 8 skipping to change at page 24, line 12
cached information. The resolution MAY fail with cached information. The resolution MAY fail with
FEDFS_ERR_NSDB_ROUTE, FEDFS_ERR_NSDB_DOWN, FEDFS_ERR_NSDB_CONN, FEDFS_ERR_NSDB_ROUTE, FEDFS_ERR_NSDB_DOWN, FEDFS_ERR_NSDB_CONN,
FEDFS_ERR_NSDB_AUTH, FEDFS_ERR_NSDB_LDAP, FEDFS_ERR_NSDB_LDAP_VAL, FEDFS_ERR_NSDB_AUTH, FEDFS_ERR_NSDB_LDAP, FEDFS_ERR_NSDB_LDAP_VAL,
FEDFS_ERR_NSDB_NOFSN, FEDFS_ERR_NSDB_NOFSL, FEDFS_ERR_NSDB_NONCE, FEDFS_ERR_NSDB_NOFSN, FEDFS_ERR_NSDB_NOFSL, FEDFS_ERR_NSDB_NONCE,
FEDFS_ERR_NSDB_RESPONSE, FEDFS_ERR_NSDB_FAULT, FEDFS_ERR_NSDB_RESPONSE, FEDFS_ERR_NSDB_FAULT,
FEDFS_ERR_NSDB_LDAP_REFERRAL, FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL, FEDFS_ERR_NSDB_LDAP_REFERRAL, FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL,
FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED, or FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED, or
FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL, depending on the nature of the FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL, depending on the nature of the
failure. failure.
In the case of a LDAP failure, the fileserver MUST return either In the case of an LDAP failure, the fileserver MUST return either
FEDFS_ERR_NSDB_LDAP or FEDFS_ERR_NSDB_LDAP_VAL. FEDFS_ERR_NSDB_LDAP FEDFS_ERR_NSDB_LDAP or FEDFS_ERR_NSDB_LDAP_VAL. FEDFS_ERR_NSDB_LDAP
indicates that an LDAP protocol error occurred during the resolution. indicates that an LDAP protocol error occurred during the resolution.
FEDFS_ERR_NSDB_LDAP_VAL also indicates that an LDAP protocol error FEDFS_ERR_NSDB_LDAP_VAL also indicates that an LDAP protocol error
occurred during the resolution and allows the LDAP protocol error occurred during the resolution and allows the LDAP protocol error
value to be returned in the FedFsLookupRes's ldapResultCode field value to be returned in the FedFsLookupRes's ldapResultCode field
(see the resultCode values in Section 4.1.9 of [RFC4511]). (see the resultCode values in Section 4.1.9 of [RFC4511]).
If the NSDB responds with an LDAP referral, either the Referral type If the NSDB responds with an LDAP referral, either the Referral type
defined in Section 4.1.10 of [RFC4511] or the SearchResultReference defined in Section 4.1.10 of [RFC4511] or the SearchResultReference
type defined in Section 4.5.3 of [RFC4511], the fileserver SHOULD type defined in Section 4.5.3 of [RFC4511], the fileserver SHOULD
process the LDAP referral using the same policies as the fileserver's process the LDAP referral using the same policies as the fileserver's
file-access protocol server. The fileserver MUST indicate a failure file-access protocol server. The fileserver MUST indicate a failure
while processing the LDAP referral using while processing the LDAP referral using
FEDFS_ERR_NSDB_LDAP_REFERRAL, FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL, FEDFS_ERR_NSDB_LDAP_REFERRAL, FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL,
FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED, or FEDFS_ERR_NSDB_LDAP_REFERRAL_NOTFOLLOWED, or
FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL. The FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL. The
FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL is analogous to the FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL is analogous to the
FEDFS_ERR_NSDB_LDAP_VAL error and allows the LDAP protocol error FEDFS_ERR_NSDB_LDAP_VAL error and allows the LDAP protocol error
value to be returned in the FedFsLookupResReferralVal's value to be returned in the FedFsLookupResReferralVal's
ldapResultCode field. The FEDFS_ERR_NSDB_LDAP_REFERRAL and ldapResultCode field. The FEDFS_ERR_NSDB_LDAP_REFERRAL and
FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL errors errors allow the NSDB FEDFS_ERR_NSDB_PARAMS_LDAP_REFERRAL errors allow the NSDB targeted by
targeted by the LDAP referral to be returned in the FedFsLookupRes's the LDAP referral to be returned in the FedFsLookupRes's targetNsdb
targetNsdb field. Similarly, the FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL field. Similarly, the FEDFS_ERR_NSDB_LDAP_REFERRAL_VAL error
error includes this information in the FedFsLookupResReferralVal's includes this information in the FedFsLookupResReferralVal's
targetNsdb. targetNsdb.
If the fileserver has a cache of FSL records, the process of If the fileserver has a cache of FSL records, the process of
resolving an FSN using an NSDB SHOULD result in the cache being resolving an FSN using an NSDB SHOULD result in the cache being
updated. A failure to update the cache MAY be indicated with the updated. A failure to update the cache MAY be indicated with the
FEDFS_ERR_NO_CACHE_UPDATE status value, or the operation may complete FEDFS_ERR_NO_CACHE_UPDATE status value, or the operation may complete
successfully. successfully.
When updating the cache, new FSLs for the given FSN SHOULD be added When updating the cache, new FSLs for the given FSN SHOULD be added
to the cache and deleted FSLs SHOULD be removed from the cache. This to the cache, and deleted FSLs SHOULD be removed from the cache.
behavior is desirable because it allows an administrator to This behavior is desirable because it allows an administrator to
proactively request that the fileserver refresh its FSL cache. For proactively request that the fileserver refresh its FSL cache. For
example, the administrator might like to refresh the fileserver's example, an administrator might like to refresh the fileserver's
cache when changes are made to an FSN's FSLs. cache when changes are made to an FSN's FSLs.
If the junction is resolved, the fileserver will include a list of If the junction is resolved, the fileserver will include a list of
UUIDs for the FSN's FSLs in the FedFsLookupResOk structure's fsl UUIDs for the FSN's FSLs in the FedFsLookupResOk structure's fsl
array. array.
5.4.3. Errors 5.4.3. Errors
FEDFS_ERR_ACCESS FEDFS_ERR_ACCESS
FEDFS_ERR_BADCHAR FEDFS_ERR_BADCHAR
skipping to change at page 27, line 7 skipping to change at page 26, line 19
Set an FSN representing the replication information for the fileset Set an FSN representing the replication information for the fileset
containing the pathname. containing the pathname.
5.5.2. Description 5.5.2. Description
This operation indicates the replication information to be returned This operation indicates the replication information to be returned
for a particular fileset. An NFSv4 client might request fs_locations for a particular fileset. An NFSv4 client might request fs_locations
or fs_locations_info at any time to detect other copies of this or fs_locations_info at any time to detect other copies of this
fileset, and this operation supports this by supplying the FSN the fileset, and this operation supports this by supplying the FSN the
fileserver should use to respond. This FSN should be associated with fileserver should use to respond. This FSN should be associated with
the entire fileset in which the path resides, and should be used to the entire fileset in which the path resides and should be used to
satisfy fs_locations or fs_locations_info attribute requests whenever satisfy fs_locations or fs_locations_info attribute requests whenever
no junction is being accessed; if a junction is being accessed, the no junction is being accessed; if a junction is being accessed, the
FSN specified by FEDFS_CREATE_JUNCTION will take precedence. Setting FSN specified by FEDFS_CREATE_JUNCTION will take precedence. Setting
the replication FSN on a fileset that already has a replication FSN the replication FSN on a fileset that already has a replication FSN
set is allowed. set is allowed.
This operation differs from FEDFS_CREATE_JUNCTION in that it controls This operation differs from FEDFS_CREATE_JUNCTION in that it controls
a fileset-wide attribute not associated with a junction. a fileset-wide attribute not associated with a junction.
The server SHOULD permit this operation even on read-only filesets, The server SHOULD permit this operation even on read-only filesets
but MUST return FEDFS_ERR_ROFS if this is not possible. but MUST return FEDFS_ERR_ROFS if this is not possible.
If the path contains a character that is not supported by the server, If the path contains a character that is not supported by the server,
then status FEDFS_ERR_BADCHAR MUST be returned. then status FEDFS_ERR_BADCHAR MUST be returned.
The path is REQUIRED to exist and be completely local to the server. The path is REQUIRED to exist and be completely local to the server.
It MUST NOT contain a junction. If any component of the path is a It MUST NOT contain a junction. If any component of the path is a
junction, then this operation MUST fail with status junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL. The path might contain a symbolic link (if FEDFS_ERR_NOTLOCAL. The path might contain a symbolic link (if
supported by the local server), but the traversal of the path MUST supported by the local server), but the traversal of the path MUST
skipping to change at page 27, line 41 skipping to change at page 27, line 5
the final component. If a server wishes to report that a path cannot the final component. If a server wishes to report that a path cannot
be traversed because of insufficient permissions, or the final be traversed because of insufficient permissions, or the final
component is an unexecutable or unwritable directory, then the component is an unexecutable or unwritable directory, then the
operation MUST fail with status FEDFS_ERR_ACCESS. operation MUST fail with status FEDFS_ERR_ACCESS.
The operation SHOULD fail with status FEDFS_ERR_NSDB_PARAMS if the The operation SHOULD fail with status FEDFS_ERR_NSDB_PARAMS if the
fileserver does not have any connection parameters on record for the fileserver does not have any connection parameters on record for the
specified NSDB, or the server may allow the operation to proceed specified NSDB, or the server may allow the operation to proceed
using some set of default NSDB connection parameters. using some set of default NSDB connection parameters.
The same FSN value SHOULD be associated with all replicas of a The same FSN value SHOULD be associated with all replicas of a file
filesystem. Depending on the underlying representation, the FSN system. Depending on the underlying representation, the FSN
associated with a filesystem might or might not be replicated associated with a file system might or might not be replicated
automatically with the filesystem replication mechanism. Therefore automatically with the file system replication mechanism. Therefore,
if FEDFS_CREATE_REPLICATION is used on one replica of a filesystem, if FEDFS_CREATE_REPLICATION is used on one replica of a file system,
it SHOULD be used on all replicas. it SHOULD be used on all replicas.
5.5.3. Errors 5.5.3. Errors
FEDFS_ERR_ACCESS FEDFS_ERR_ACCESS
FEDFS_ERR_BADCHAR FEDFS_ERR_BADCHAR
FEDFS_ERR_BADNAME FEDFS_ERR_BADNAME
FEDFS_ERR_NAMETOOLONG FEDFS_ERR_NAMETOOLONG
FEDFS_ERR_LOOP FEDFS_ERR_LOOP
FEDFS_ERR_BADXDR FEDFS_ERR_BADXDR
FEDFS_ERR_EXIST FEDFS_ERR_EXIST
FEDFS_ERR_INVAL FEDFS_ERR_INVAL
FEDFS_ERR_IO FEDFS_ERR_IO
FEDFS_ERR_NOSPC FEDFS_ERR_NOSPC
skipping to change at page 28, line 39 skipping to change at page 27, line 49
5.6.2. Description 5.6.2. Description
This operation removes any replication information from the fileset This operation removes any replication information from the fileset
in which the path resides, such that NFSv4 client requests for in which the path resides, such that NFSv4 client requests for
fs_locations or fs_locations_info in the absence of a junction will fs_locations or fs_locations_info in the absence of a junction will
not be satisfied. not be satisfied.
This operation differs from FEDFS_DELETE_JUNCTION in that it controls This operation differs from FEDFS_DELETE_JUNCTION in that it controls
a fileset-wide attribute not associated with a junction. a fileset-wide attribute not associated with a junction.
The server SHOULD permit this operation even on read-only filesets, The server SHOULD permit this operation even on read-only filesets
but MUST return FEDFS_ERR_ROFS if this is not possible. but MUST return FEDFS_ERR_ROFS if this is not possible.
If the path contains a character that is not supported by the server, If the path contains a character that is not supported by the server,
then status FEDFS_ERR_BADCHAR MUST be returned. then status FEDFS_ERR_BADCHAR MUST be returned.
The path is REQUIRED to exist and be completely local to the server. The path is REQUIRED to exist and be completely local to the server.
It MUST NOT contain a junction. If any component of the path is a It MUST NOT contain a junction. If any component of the path is a
junction, then this operation MUST fail with status junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL. FEDFS_ERR_NOTLOCAL.
skipping to change at page 29, line 38 skipping to change at page 28, line 49
5.7.1. Synopsis 5.7.1. Synopsis
Query the server to discover the current replication information (if Query the server to discover the current replication information (if
any) at the given path. any) at the given path.
5.7.2. Description 5.7.2. Description
This operation queries a server to determine whether a fileset This operation queries a server to determine whether a fileset
containing the given path has replication information associated with containing the given path has replication information associated with
it, and if so, the FSN for that replication information. it. If it does, the FSN for that replication information is
returned.
This operation differs from FEDFS_LOOKUP_JUNCTION in that it inquires This operation differs from FEDFS_LOOKUP_JUNCTION in that it inquires
about a fileset-wide attribute not associated with a junction. about a fileset-wide attribute not associated with a junction.
If the path contains a character that is not supported by the server, If the path contains a character that is not supported by the server,
then status FEDFS_ERR_BADCHAR MUST be returned. then status FEDFS_ERR_BADCHAR MUST be returned.
The path is REQUIRED to exist and be completely local to the server. The path is REQUIRED to exist and be completely local to the server.
It MUST NOT contain a junction. If any component of the path is a It MUST NOT contain a junction. If any component of the path is a
junction, then this operation MUST fail with status junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL. FEDFS_ERR_NOTLOCAL.
The server MAY enforce the local permissions on the path, including The server MAY enforce the local permissions on the path, including
the final component. If a server wishes to report that a path cannot the final component. If a server wishes to report that a path cannot
be traversed because of insufficient permissions, or the final be traversed because of insufficient permissions, or the final
component is an unexecutable or unwritable directory, then the component is an unexecutable or unwritable directory, then the
operation MUST fail with status FEDFS_ERR_ACCESS. operation MUST fail with status FEDFS_ERR_ACCESS.
Interpretation of the 'resolve' parameter and the procedure's results Interpretation of the resolve parameter and the procedure's results
shall be the same as specified in Section 5.4 for the shall be the same as specified in Section 5.4 for the
FEDFS_LOOKUP_JUNCTION operation. FEDFS_LOOKUP_JUNCTION operation.
5.7.3. Errors 5.7.3. Errors
FEDFS_ERR_ACCESS FEDFS_ERR_ACCESS
FEDFS_ERR_BADCHAR FEDFS_ERR_BADCHAR
FEDFS_ERR_BADNAME FEDFS_ERR_BADNAME
FEDFS_ERR_NAMETOOLONG FEDFS_ERR_NAMETOOLONG
FEDFS_ERR_LOOP FEDFS_ERR_LOOP
skipping to change at page 31, line 13 skipping to change at page 30, line 21
FEDFS_ERR_UNKNOWN_CACHE FEDFS_ERR_UNKNOWN_CACHE
5.8. FEDFS_SET_NSDB_PARAMS 5.8. FEDFS_SET_NSDB_PARAMS
5.8.1. Synopsis 5.8.1. Synopsis
Set the connection parameters for the specified NSDB. Set the connection parameters for the specified NSDB.
5.8.2. Description 5.8.2. Description
This operations allows the administrator to set the connection This operation allows an administrator to set the connection
parameters for a given NSDB. parameters for a given NSDB.
If a record for the given NSDB does not exist, a new record is If a record for the given NSDB does not exist, a new record is
created with the specified connection parameters. created with the specified connection parameters.
If a record for the given NSDB does exist, the existing connection If a record for the given NSDB does exist, the existing connection
parameters are replaced with the specified connection parameters. parameters are replaced with the specified connection parameters.
An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1 An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1
define when two FedFsNsdbNames are considered equal. define when two FedFsNsdbNames are considered equal.
The given NSDB need not be referenced by any junctions on the The given NSDB need not be referenced by any junctions on the
fileserver. This situation will occur when connection parameters for fileserver. This situation will occur when connection parameters for
a new NSDB are installed. a new NSDB are installed.
The format of the connection parameters is described above. The format of the connection parameters is described in Section 4.
On success, this operation returns FEDFS_OK. When the operation On success, this operation returns FEDFS_OK. When the operation
returns, the new connection parameters SHOULD be used for all returns, the new connection parameters SHOULD be used for all
subsequent LDAP connections to the given NSDB. Existing connections subsequent LDAP connections to the given NSDB. Existing connections
MAY be terminated and re-established using the new connection MAY be terminated and re-established using the new connection
parameters. The connection parameters SHOULD be durable across parameters. The connection parameters SHOULD be durable across
fileserver reboots. fileserver reboots.
On failure, an error value indicating the type of error is returned. On failure, an error value indicating the type of error is returned.
If the operation's associated user does not have sufficient If the operation's associated user does not have sufficient
skipping to change at page 32, line 17 skipping to change at page 31, line 26
FEDFS_ERR_DELAY FEDFS_ERR_DELAY
5.9. FEDFS_GET_NSDB_PARAMS 5.9. FEDFS_GET_NSDB_PARAMS
5.9.1. Synopsis 5.9.1. Synopsis
Get the connection parameters for the specified NSDB. Get the connection parameters for the specified NSDB.
5.9.2. Description 5.9.2. Description
This operations allows the administrator to retrieve connection This operations allows an administrator to retrieve connection
parameters, if they exist, for the given NSDB. parameters, if they exist, for the given NSDB.
An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1 An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1
define when two FedFsNsdbNames are considered equal. define when two FedFsNsdbNames are considered equal.
A set of connection parameters is considered a match if their A set of connection parameters is considered a match if their
associated NSDB is equal (as defined above) to the operation's NSDB associated NSDB is equal (as defined in Section 4.1) to the
argument. Therefore, there is at most one set of connection operation's NSDB argument. Therefore, there is at most one set of
parameters that can match the query described by this operation. connection parameters that can match the query described by this
operation.
The format of the connection parameters is described above. The format of the connection parameters is described in Section 4.
On success, this operation returns FEDFS_OK and the connection On success, this operation returns FEDFS_OK and the connection
parameters on record for the given NSDB. parameters on record for the given NSDB.
On failure, an error value indicating the type of error is returned. On failure, an error value indicating the type of error is returned.
This operation MUST return FEDFS_ERR_NSDB_PARAMS to indicate that This operation MUST return FEDFS_ERR_NSDB_PARAMS to indicate that
there are no connection parameters on record for the given NSDB. If there are no connection parameters on record for the given NSDB. If
the operation's associated user does not have sufficient permissions the operation's associated user does not have sufficient permissions
to view NSDB connection parameters, the operation MUST return to view NSDB connection parameters, the operation MUST return
FEDFS_ERR_ACCESS. FEDFS_ERR_ACCESS.
skipping to change at page 33, line 16 skipping to change at page 32, line 27
5.10. FEDFS_GET_LIMITED_NSDB_PARAMS 5.10. FEDFS_GET_LIMITED_NSDB_PARAMS
5.10.1. Synopsis 5.10.1. Synopsis
Get a limited subset of the connection parameters for the specified Get a limited subset of the connection parameters for the specified
NSDB. NSDB.
5.10.2. Description 5.10.2. Description
This operation allows the administrator to retrieve a limited subset This operation allows an administrator to retrieve a limited subset
of information on the connection parameters, if they exist, for the of information on the connection parameters, if they exist, for the
given NSDB. given NSDB.
A NSDB is specified using a FedFsNsdbName. The rules in Section 4.1 An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1
define when two FedFsNsdbNames are considered equal. define when two FedFsNsdbNames are considered equal.
A set of connection parameters is considered a match if their A set of connection parameters is considered a match if their
associated NSDB is equal (as defined above) to the operation's NSDB associated NSDB is equal (as defined in Section 4.1) to the
argument. Therefore, there is at most one set of connection operation's NSDB argument. Therefore, there is at most one set of
parameters that can match the query described by this operation. connection parameters that can match the query described by this
operation.
This operation returns a limited subset of the connection parameters. This operation returns a limited subset of the connection parameters.
Only the FedFsConnectionSec mechanism that is used to protect Only the FedFsConnectionSec mechanism that is used to protect
communication between the fileserver and NSDB is returned. communication between the fileserver and NSDB is returned.
Viewing the limited subset of NSDB connection parameters returned by Viewing the limited subset of NSDB connection parameters returned by
FEDFS_GET_LIMITED_NSDB_PARAMS MAY be a less privileged operation than FEDFS_GET_LIMITED_NSDB_PARAMS MAY be a less privileged operation than
viewing the entire set of NSDB connection parameters returned by viewing the entire set of NSDB connection parameters returned by
FEDFS_GET_NSDB_PARAMS. For example, the full contents of an NSDB's FEDFS_GET_NSDB_PARAMS. For example, the full contents of an NSDB's
connection parameters could contain sensitive information for some connection parameters could contain sensitive information for some
skipping to change at page 34, line 20 skipping to change at page 33, line 30
FEDFS_ERR_BADXDR FEDFS_ERR_BADXDR
FEDFS_ERR_INVAL FEDFS_ERR_INVAL
FEDFS_ERR_IO FEDFS_ERR_IO
FEDFS_ERR_SVRFAULT FEDFS_ERR_SVRFAULT
FEDFS_ERR_NSDB_PARAMS FEDFS_ERR_NSDB_PARAMS
FEDFS_ERR_NOTSUPP FEDFS_ERR_NOTSUPP
FEDFS_ERR_DELAY FEDFS_ERR_DELAY
6. Security Considerations 6. Security Considerations
The Security Considerations of [RFC5531] apply to the protocol The security considerations of [RFC5531] apply to the protocol
described in this document. The ONC RPC protocol supports described in this document. The ONC RPC protocol supports
authentication, integrity and privacy via the RPCSEC_GSS framework authentication, integrity, and privacy via the RPCSEC_GSS framework
[RFC2203]. Fileservers which support the FedFS administration [RFC2203]. Fileservers that support the FedFS administration
protocol described above MUST support RPCSEC_GSS. protocol described in this document MUST support RPCSEC_GSS.
As with NFSv4.1 (see Section 2.2.1.1.1.1 of [RFC5661]), FedFS As with NFSv4.1 (see Section 2.2.1.1.1.1 of [RFC5661]), FedFS
administration protocol clients and servers MUST support RPCSEC_GSS's administration protocol clients and servers MUST support RPCSEC_GSS's
integrity and authentication services. FedFS administration protocol integrity and authentication services. FedFS administration protocol
servers MUST support RPCSEC_GSS's privacy service. FedFS servers MUST support RPCSEC_GSS's privacy service. FedFS
administration protocol clients SHOULD support RPCSEC_GSS's privacy administration protocol clients SHOULD support RPCSEC_GSS's privacy
service. When RPCSEC_GSS is employed on behalf of the FedFS service. When RPCSEC_GSS is employed on behalf of the FedFS
administration protocol, RPCSEC_GSS data integrity SHOULD be used. administration protocol, RPCSEC_GSS data integrity SHOULD be used.
It is strongly RECOMMENDED that an Access Control Service be employed It is strongly RECOMMENDED that an Access Control Service be employed
to restrict access to a fileserver's FedFS administration to restrict access to a fileserver's FedFS administration
configuration data via the FedFS administrative protocol to prevent configuration data via the FedFS administrative protocol to prevent
FedFS namespace corruption, and protect NSDB communication FedFS namespace corruption and protect NSDB communication parameters.
parameters.
For example, when the FedFsNsdbParams secType field value For example, when the FedFsNsdbParams secType field value
FEDFS_SEC_TLS is chosen, the payload is used to provision the trust FEDFS_SEC_TLS is chosen, the payload is used to provision the trust
anchor root certificate for TLS secure communication between the anchor root certificate for TLS secure communication between the
fileserver and the NSDB. In this case, RPCSEC_GSS with data fileserver and the NSDB. In this case, RPCSEC_GSS with data
integrity SHOULD be employed along with an Access Control Service to integrity SHOULD be employed along with an Access Control Service to
restrict access to domain adminstrators restrict access to domain administrators.
FEDFS_GET_LIMITED_NSDB_PARAMS's interaction with the NSDB's FEDFS_GET_LIMITED_NSDB_PARAMS's interaction with the NSDB's
connection parameters is discussed in Section 5.10.2. connection parameters is discussed in Section 5.10.2.
7. IANA Considerations 7. IANA Considerations
A range of ONC RPC program numbers were assigned for use by FedFS A range of ONC RPC program numbers were assigned for use by FedFS
using the procedure described in Section 7.3 "Program Number using the procedure described in Section 8.3 ("Program Number
Assignment" of [RFC5531]. The FedFS range is: Assignment") of [RFC5531]. The FedFS range is:
IETF NFSv4 Working Group - FedFS 100418 - 100421 IETF NFSv4 Working Group - FedFS 100418 - 100421
This document describes version 1 of the ONC RPC program 100418 with Program 100418 has been removed from the reserved FedFS range and
the short name "fedfs_admin", a Description of "FedFS assigned to version 1 of the ONC RPC program (100418) described in
Administration", and a reference of [RFCTBD10]. Program 100418 will this document with the short name "fedfs_admin", a Description of
be removed from the reserved FedFS range and assigned these new "FedFS Administration", and a reference to RFC 7533.
values.
8. References 8. References
8.1. Normative References 8.1. Normative References
[3530bis] Haynes, T. and D. Noveck, "NFS Version 4 Protocol",
draft-ietf-nfsv4-rfc3530bis (Work In Progress), 2010.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
[RFC2203] Eisler, M., Chiu, A., and L. Ling, "RPCSEC_GSS Protocol [RFC2203] Eisler, M., Chiu, A., and L. Ling, "RPCSEC_GSS Protocol
Specification", RFC 2203, September 1997. Specification", RFC 2203, September 1997,
<http://www.rfc-editor.org/info/rfc2203>.
[RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
Unique IDentifier (UUID) URN Namespace", RFC 4122, Unique IDentifier (UUID) URN Namespace", RFC 4122, July
July 2005. 2005, <http://www.rfc-editor.org/info/rfc4122>.
[RFC4506] Eisler, M., "XDR: External Data Representation Standard", [RFC4506] Eisler, M., Ed., "XDR: External Data Representation
STD 67, RFC 4506, May 2006. Standard", STD 67, RFC 4506, May 2006,
<http://www.rfc-editor.org/info/rfc4506>.
[RFC4511] Sermersheim, J., "Lightweight Directory Access Protocol [RFC4511] Sermersheim, J., Ed., "Lightweight Directory Access
(LDAP): The Protocol", RFC 4511, June 2006. Protocol (LDAP): The Protocol", RFC 4511, June 2006,
<http://www.rfc-editor.org/info/rfc4511>.
[RFC4513] Harrison, R., "Lightweight Directory Access Protocol [RFC4513] Harrison, R., Ed., "Lightweight Directory Access Protocol
(LDAP): Authentication Methods and Security Mechanisms", (LDAP): Authentication Methods and Security Mechanisms",
RFC 4513, June 2006. RFC 4513, June 2006,
<http://www.rfc-editor.org/info/rfc4513>.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, August 2008. (TLS) Protocol Version 1.2", RFC 5246, August 2008,
<http://www.rfc-editor.org/info/rfc5246>.
[RFC5280] Cooper, D., Santesson, S., Farrell, S., Boeyen, S., [RFC5280] Cooper, D., Santesson, S., Farrell, S., Boeyen, S.,
Housley, R., and W. Polk, "Internet X.509 Public Key Housley, R., and W. Polk, "Internet X.509 Public Key
Infrastructure Certificate and Certificate Revocation List Infrastructure Certificate and Certificate Revocation List
(CRL) Profile", RFC 5280, May 2008. (CRL) Profile", RFC 5280, May 2008,
<http://www.rfc-editor.org/info/rfc5280>.
[RFC5531] Thurlow, R., "RPC: Remote Procedure Call Protocol [RFC5531] Thurlow, R., "RPC: Remote Procedure Call Protocol
Specification Version 2", RFC 5531, May 2009. Specification Version 2", RFC 5531, May 2009,
<http://www.rfc-editor.org/info/rfc5531>.
8.2. Informative References [RFC7530] Haynes, T., Ed. and D. Noveck, Ed., "Network File System
(NFS) Version 4 Protocol", RFC 7530, March 2015,
<http://www.rfc-editor.org/info/rfc7530>.
[FEDFS-NSDB] 8.2. Informative References
Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M.
Naik, "NSDB Protocol for Federated Filesystems",
draft-ietf-nfsv4-federated-fs-protocol (Work In Progress),
2010.
[MS-CIFS] Microsoft Corporation, "Common Internet File System (CIFS) [MS-CIFS] Microsoft Corporation, "Common Internet File System (CIFS)
Protocol Specification", MS-CIFS 2.0, November 2009. Protocol Specification", MS-CIFS 24.0, May 2014.
[MS-SMB] Microsoft Corporation, "Server Message Block (SMB) [MS-SMB] Microsoft Corporation, "Server Message Block (SMB)
Protocol Specification", MS-SMB 17.0, November 2009. Protocol Specification", MS-SMB 43.0, May 2014.
[MS-SMB2] Microsoft Corporation, "Server Message Block (SMB) Version [MS-SMB2] Microsoft Corporation, "Server Message Block (SMB) Version
2 Protocol Specification", MS-SMB2 19.0, November 2009. 2 Protocol Specification", MS-SMB2 46.0, May 2014.
[RFC1813] Callaghan, B., Pawlowski, B., and P. Staubach, "NFS
Version 3 Protocol Specification", RFC 1813, June 1995.
[RFC5661] Shepler, S., Eisler, M., and D. Noveck, "Network File [RFC5661] Shepler, S., Ed., Eisler, M., Ed., and D. Noveck, Ed.,
System (NFS) Version 4 Minor Version 1 Protocol", "Network File System (NFS) Version 4 Minor Version 1
RFC 5661, January 2010. Protocol", RFC 5661, January 2010,
<http://www.rfc-editor.org/info/rfc5661>.
[RFC5662] Shepler, S., Eisler, M., and D. Noveck, "Network File [RFC5662] Shepler, S., Ed., Eisler, M., Ed., and D. Noveck, Ed.,
System (NFS) Version 4 Minor Version 1 External Data "Network File System (NFS) Version 4 Minor Version 1
Representation Standard (XDR) Description", RFC 5662, External Data Representation Standard (XDR) Description",
January 2010. RFC 5662, January 2010,
<http://www.rfc-editor.org/info/rfc5662>.
[RFC5716] Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M. [RFC5716] Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M.
Naik, "Requirements for Federated File Systems", RFC 5716, Naik, "Requirements for Federated File Systems", RFC 5716,
January 2010. January 2010, <http://www.rfc-editor.org/info/rfc5716>.
Appendix A. Acknowledgments [RFC7532] Lentini, J., Tewari, R., and C. Lever, Ed., "Namespace
Database (NSDB) Protocol for Federated File Systems", RFC
7532, March 2015,
<http://www.rfc-editor.org/info/rfc7532>.
Acknowledgments
Daniel Ellard contributed significant parts of this document.
The authors and editor would like to thank Craig Everhart and Manoj The authors and editor would like to thank Craig Everhart and Manoj
Naik, who were co-authors of an earlier version of this document. In Naik, who were co-authors of an earlier draft version of this
addition, we would like to thank Paul Lemahieu, Mario Wurzl, and document. In addition, we would like to thank Paul Lemahieu, Mario
Robert Thurlow for helping to author this document. Wurzl, and Robert Thurlow for helping to author this document.
We would like to thank Trond Myklebust for suggesting improvements to We would like to thank Trond Myklebust for suggesting improvements to
the FSL pathname format, David Noveck for his suggestions on the FSL pathname format, David Noveck for his suggestions on
internationalization and path encoding rules, and Nicolas Williams internationalization and path encoding rules, and Nicolas Williams
for his suggestions. for his suggestions.
The editor gratefully acknowledges the IESG reviewers, whose The editor gratefully acknowledges the IESG reviewers, whose
constructive comments helped make this a much stronger document. constructive comments helped make this a much stronger document.
Finally, we would like to thank Andy Adamson, Rob Thurlow, and Tom Finally, we would like to thank Andy Adamson, Rob Thurlow, and Tom
Haynes for helping to get this document out the door. Haynes for helping to get this document out the door.
The extract.sh shell script and formatting conventions were first The extract.sh shell script and formatting conventions were first
described by the authors of the NFSv4.1 XDR specification [RFC5662]. described by the authors of the NFSv4.1 XDR specification [RFC5662].
Appendix B. RFC Editor Notes
[RFC Editor: please remove this section prior to publishing this
document as an RFC]
[RFC Editor: prior to publishing this document as an RFC, please
replace all occurrences of RFCTBD10 with RFCxxxx where xxxx is the
RFC number of this document]
Authors' Addresses Authors' Addresses
James Lentini James Lentini
NetApp NetApp
1601 Trapelo Rd, Suite 16 1601 Trapelo Rd, Suite 16
Waltham, MA 02451 Waltham, MA 02451
US United States
Phone: +1 781-768-5359 Phone: +1 781-768-5359
Email: jlentini@netapp.com EMail: jlentini@netapp.com
Daniel Ellard
Raytheon BBN Technologies
10 Moulton Street
Cambridge, MA 02138
US
Phone: +1 617-873-8004
Email: dellard@bbn.com
Renu Tewari Renu Tewari
IBM Almaden IBM Almaden
650 Harry Rd 650 Harry Rd
San Jose, CA 95120 San Jose, CA 95120
US United States
Email: tewarir@us.ibm.com EMail: tewarir@us.ibm.com
Charles Lever (editor) Charles Lever (editor)
Oracle Corporation Oracle Corporation
1015 Granger Avenue 1015 Granger Avenue
Ann Arbor, MI 48104 Ann Arbor, MI 48104
US United States
Phone: +1 248-614-5091 Phone: +1 248-614-5091
Email: chuck.lever@oracle.com EMail: chuck.lever@oracle.com
 End of changes. 120 change blocks. 
305 lines changed or deleted 297 lines changed or added

This html diff was produced by rfcdiff 1.42. The latest version is available from http://tools.ietf.org/tools/rfcdiff/