draft-ietf-nfsv4-federated-fs-admin-04.txt   draft-ietf-nfsv4-federated-fs-admin-05.txt 
NFSv4 Working Group J. Lentini NFSv4 Working Group J. Lentini
Internet-Draft C. Everhart Internet-Draft C. Everhart
Intended status: Standards Track NetApp Intended status: Standards Track NetApp
Expires: July 25, 2010 D. Ellard Expires: January 11, 2011 D. Ellard
BBN Technologies Raytheon BBN Technologies
R. Tewari R. Tewari
M. Naik M. Naik
IBM Almaden IBM Almaden
January 21, 2010 July 10, 2010
Administration Protocol for Federated Filesystems Administration Protocol for Federated Filesystems
draft-ietf-nfsv4-federated-fs-admin-04 draft-ietf-nfsv4-federated-fs-admin-05
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 that enables file access and namespace traversal across
collections of independently administered fileservers. The protocol collections of independently administered fileservers. The protocol
specifies a set of interfaces by which fileservers with different specifies a set of interfaces by which fileservers with different
administrators can form a fileserver federation that provides a administrators can form a fileserver federation that provides a
namespace composed of the filesystems physically hosted on and namespace composed of the filesystems physically hosted on and
exported by the constituent fileservers. exported by the constituent fileservers.
Requirements Language Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
Status of this Memo Status of this Memo
This Internet-Draft is submitted to IETF in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF). Note that other groups may also distribute
other groups may also distribute working documents as Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at This Internet-Draft will expire on January 11, 2011.
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on July 25, 2010.
Copyright Notice Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the Copyright (c) 2010 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
skipping to change at page 2, line 23 skipping to change at page 2, line 15
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
described in the BSD License. described in the Simplified BSD License.
This document may contain material from IETF Documents or IETF This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this 10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow material may not have granted the IETF Trust the right to allow
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 . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Error Values . . . . . . . . . . . . . . . . . . . . . . . . . 7 3. Error Values . . . . . . . . . . . . . . . . . . . . . . . . . 9
4. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . 9 4. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5. Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.1. FedFsNsdbName Equality . . . . . . . . . . . . . . . . . . 12
5.1. FEDFS_CREATE_JUNCTION . . . . . . . . . . . . . . . . . . 11 5. Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.2. FEDFS_DELETE_JUNCTION . . . . . . . . . . . . . . . . . . 13 5.1. FEDFS_CREATE_JUNCTION . . . . . . . . . . . . . . . . . . 14
5.3. FEDFS_LOOKUP_FSN . . . . . . . . . . . . . . . . . . . . . 14 5.2. FEDFS_DELETE_JUNCTION . . . . . . . . . . . . . . . . . . 15
5.4. FEDFS_SET_NSDB_PARAMS . . . . . . . . . . . . . . . . . . 16 5.3. FEDFS_LOOKUP_JUNCTION . . . . . . . . . . . . . . . . . . 16
5.5. FEDFS_GET_NSDB_PARAMS . . . . . . . . . . . . . . . . . . 16 5.4. FEDFS_CREATE_REPLICATION . . . . . . . . . . . . . . . . . 18
5.6. FEDFS_GET_LIMITED_NSDB_PARAMS . . . . . . . . . . . . . . 17 5.5. FEDFS_DELETE_REPLICATION . . . . . . . . . . . . . . . . . 19
6. Security Considerations . . . . . . . . . . . . . . . . . . . 18 5.6. FEDFS_LOOKUP_REPLICATION . . . . . . . . . . . . . . . . . 20
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18 5.7. FEDFS_SET_NSDB_PARAMS . . . . . . . . . . . . . . . . . . 20
8. Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 5.8. FEDFS_GET_NSDB_PARAMS . . . . . . . . . . . . . . . . . . 21
9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.9. FEDFS_GET_LIMITED_NSDB_PARAMS . . . . . . . . . . . . . . 21
9.1. Normative References . . . . . . . . . . . . . . . . . . . 21 6. Internationalization . . . . . . . . . . . . . . . . . . . . . 22
9.2. Informative References . . . . . . . . . . . . . . . . . . 21 7. Security Considerations . . . . . . . . . . . . . . . . . . . 22
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 22 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 22 9. Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 25
10.1. Normative References . . . . . . . . . . . . . . . . . . . 25
10.2. Informative References . . . . . . . . . . . . . . . . . . 26
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 26
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 27
1. Introduction 1. Introduction
A federated filesystem enables file access and namespace traversal in A federated filesystem enables file access and namespace traversal in
a uniform, secure and consistent manner across multiple independent a uniform, secure and consistent manner across multiple independent
fileservers within an enterprise (and possibly across multiple fileservers within an enterprise (and possibly across multiple
enterprises) with reasonably good performance. 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
skipping to change at page 4, line 26 skipping to change at page 4, line 26
the fileservers to cooperatively present the namespace. Fileservers the fileservers to cooperatively present the namespace. Fileservers
may provide proprietary management tools and in some cases an may provide proprietary management tools and in some cases an
administrator may be able to use the proprietary tools to build a administrator may 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 filesystems. Relying on vendor-
proprietary tools does not work in larger enterprises or when 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 The requirements for federated namespaces are described in [RFC5716].
[FEDFS-REQTS].
The filesystem federation protocol described in [FEDFS-NSDB] allows The filesystem federation protocol described in [FEDFS-NSDB] 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.
2. Protocol 2. Protocol
skipping to change at page 5, line 28 skipping to change at page 5, line 28
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>
/// enum FedFsStatus { /// enum FedFsStatus {
/// FEDFS_OK = 0, /// FEDFS_OK = 0,
/// FEDFS_ERR_ACCESS = 1, /// FEDFS_ERR_ACCESS = 1,
/// FEDFS_ERR_BADCHAR = 2, /// FEDFS_ERR_BADCHAR = 2,
/// FEDFS_ERR_BADXDR = 3, /// FEDFS_ERR_BADNAME = 3,
/// FEDFS_ERR_EXIST = 4, /// FEDFS_ERR_NAMETOOLONG = 4,
/// FEDFS_ERR_INVAL = 5, /// FEDFS_ERR_LOOP = 5,
/// FEDFS_ERR_IO = 6, /// FEDFS_ERR_BADXDR = 6,
/// FEDFS_ERR_NOSPC = 7, /// FEDFS_ERR_EXIST = 7,
/// FEDFS_ERR_NOTDIR = 8, /// FEDFS_ERR_INVAL = 8,
/// FEDFS_ERR_NOTEMPTY = 9, /// FEDFS_ERR_IO = 9,
/// FEDFS_ERR_NOTJUNCT = 10, /// FEDFS_ERR_NOSPC = 10,
/// FEDFS_ERR_NOTLOCAL = 11, /// FEDFS_ERR_NOTDIR = 11,
/// FEDFS_ERR_PERM = 12, /// FEDFS_ERR_NOTEMPTY = 12,
/// FEDFS_ERR_ROFS = 13, /// FEDFS_ERR_NOTJUNCT = 13,
/// FEDFS_ERR_SVRFAULT = 14, /// FEDFS_ERR_NOTLOCAL = 14,
/// FEDFS_ERR_NSDB_ROUTE = 15, /// FEDFS_ERR_PERM = 15,
/// FEDFS_ERR_NSDB_DOWN = 16, /// FEDFS_ERR_ROFS = 16,
/// FEDFS_ERR_NSDB_CONN = 17, /// FEDFS_ERR_SVRFAULT = 17,
/// FEDFS_ERR_NSDB_AUTH = 18, /// FEDFS_ERR_NSDB_ROUTE = 18,
/// FEDFS_ERR_NSDB_LDAP = 19, /// FEDFS_ERR_NSDB_DOWN = 19,
/// FEDFS_ERR_NSDB_NOFSN = 20, /// FEDFS_ERR_NSDB_CONN = 20,
/// FEDFS_ERR_NSDB_NOFSL = 21, /// FEDFS_ERR_NSDB_AUTH = 21,
/// FEDFS_ERR_NSDB_RESPONSE = 22, /// FEDFS_ERR_NSDB_LDAP = 22,
/// FEDFS_ERR_NSDB_FAULT = 23, /// FEDFS_ERR_NSDB_LDAP_VAL = 23,
/// FEDFS_ERR_NSDB_PARAMS = 24 /// FEDFS_ERR_NSDB_NOFSN = 24,
/// FEDFS_ERR_NSDB_NOFSL = 25,
/// FEDFS_ERR_NSDB_RESPONSE = 26,
/// FEDFS_ERR_NSDB_FAULT = 27,
/// FEDFS_ERR_NSDB_PARAMS = 28,
/// FEDFS_ERR_PATH_TYPE_UNSUPP = 29
/// }; /// };
/// ///
/// typedef opaque FedFsUuid<16>; /// typedef opaque utf8string<>;
/// typedef utf8string utf8str_cs;
/// typedef utf8string utf8str_cis;
/// ///
/// typedef opaque FedFsNsdbName<>; /// typedef opaque FedFsUuid[16];
/// ///
/// typedef opaque FedFsPathComponent<>; /// struct FedFsNsdbName {
/// typedef FedFsPathComponent FedFsPathName<>; /// unsigned int port;
/// utf8str_cis hostname;
/// };
/// ///
/// typedef opaque FedFsNsdbContainerEntry<>; /// typedef utf8str_cs FedFsPathComponent;
/// typedef FedFsPathComponent FedFsPathName<>;
/// ///
/// struct FedFsFsn { /// struct FedFsFsn {
/// FedFsUuid fsnUuid; /// FedFsUuid fsnUuid;
/// FedFsNsdbName nsdbName; /// FedFsNsdbName nsdbName;
/// FedFsNsdbContainerEntry nce; /// };
///
/// enum FedFsFslType {
/// FEDFS_NFS_FSL = 0
/// /* other types TBD */
/// };
///
/// struct FedFsNfsFsl {
/// FedFsUuid fslUuid;
/// unsigned int port;
/// utf8str_cis hostname;
/// FedFsPathName path;
/// };
///
/// union FedFsFsl switch(FedFsFslType type) {
/// case FEDFS_NFS_FSL:
/// FedFsNfsFsl nfsFsl;
/// };
///
/// enum FedFsPathType {
/// FEDFS_PATH_SYS = 0,
/// FEDFS_PATH_NFS = 1
/// /* other types TBD */
/// };
///
/// union FedFsPath switch(FedFsPathType type) {
/// case FEDFS_PATH_SYS: /* administrative path */
/// FedFsPathName admin_path;
/// case FEDFS_PATH_NFS: /* NFS namespace path */
/// FedFsPathName nfs_path;
/// }; /// };
/// ///
/// struct FedFsCreateJunctionArgs { /// struct FedFsCreateJunctionArgs {
/// FedFsPathName path; /// FedFsPath path;
/// FedFsFsn fsn; /// FedFsFsn fsn;
/// }; /// };
/// ///
/// enum FedFsResolveType { /// enum FedFsResolveType {
/// FEDFS_RESOLVE_NONE = 0, /// FEDFS_RESOLVE_NONE = 0,
/// FEDFS_RESOLVE_CACHE = 1, /// FEDFS_RESOLVE_CACHE = 1,
/// FEDFS_RESOLVE_NSDB = 2 /// FEDFS_RESOLVE_NSDB = 2
/// }; /// };
/// ///
/// struct FedFsLookupFsnArgs { /// struct FedFsLookupFsnArgs {
/// FedFsPathName path; /// FedFsPath path;
/// FedFsResolveType resolve; /// FedFsResolveType resolve;
/// }; /// };
/// ///
/// union FedFsResolveRes switch (FedFsResolveType resolve) {
/// case FEDFS_RESOLVE_NONE:
/// void;
/// default: /* CACHE or NSDB */
/// FedFsUuid fslUuid<>;
/// };
///
/// struct FedFsLookupFsnResOk { /// struct FedFsLookupFsnResOk {
/// FedFsFsn fsn; /// FedFsFsn fsn;
/// FedFsResolveRes resolveResult; /// FedFsFsl fsl<>;
/// }; /// };
/// ///
/// union FedFsLookupFsnRes switch (FedFsStatus status) { /// union FedFsLookupFsnRes switch (FedFsStatus status) {
/// case FEDFS_OK: /// case FEDFS_OK:
/// FedFsLookupFsnResOk resok; /// FedFsLookupFsnResOk resok;
/// case FEDFS_ERR_NSDB_LDAP: /// case FEDFS_ERR_NSDB_LDAP_VAL:
/// unsigned int ldapResultCode<1>; /// unsigned int ldapResultCode;
/// 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; RFC4513, Section 3 */
/// /* other mechanisms TBD */ /// /* other mechanisms TBD */
/// }; /// };
/// ///
/// struct FedFsNsdbParams { /// union FedFsNsdbParams switch (FedFsConnectionSec secType) {
/// FedFsConnectionSec secType; /// case FEDFS_SEC_TLS:
/// /* type specific data follows */
/// opaque secData<>; /// opaque secData<>;
/// default:
/// void;
/// }; /// };
/// ///
/// struct FedFsSetNsdbParamsArgs { /// struct FedFsSetNsdbParamsArgs {
/// FedFsNsdbName nsdbName; /// FedFsNsdbName nsdbName;
/// FedFsNsdbParams params; /// FedFsNsdbParams params;
/// }; /// };
/// ///
/// union FedFsGetNsdbParamsRes switch (FedFsStatus status) { /// union FedFsGetNsdbParamsRes switch (FedFsStatus status) {
/// case FEDFS_OK: /// case FEDFS_OK:
/// FedFsNsdbParams params; /// FedFsNsdbParams params;
skipping to change at page 7, line 44 skipping to change at page 8, line 28
/// }; /// };
/// ///
/// union FedFsGetLimitedNsdbParamsRes switch (FedFsStatus status) { /// union FedFsGetLimitedNsdbParamsRes switch (FedFsStatus status) {
/// case FEDFS_OK: /// case FEDFS_OK:
/// FedFsConnectionSec secType; /// FedFsConnectionSec secType;
/// default: /// default:
/// void; /// void;
/// }; /// };
/// ///
/// program FEDFS_PROG { /// program FEDFS_PROG {
/// version FEDFS_VERSION { /// version FEDFS_V1 {
/// void FEDFS_NULL(void) = 0; /// void FEDFS_NULL(void) = 0;
/// FedFsStatus FEDFS_CREATE_JUNCTION( /// FedFsStatus FEDFS_CREATE_JUNCTION(
/// FedFsCreateJunctionArgs) = 1; /// FedFsCreateJunctionArgs) = 1;
/// FedFsStatus FEDFS_DELETE_JUNCTION( /// FedFsStatus FEDFS_DELETE_JUNCTION(
/// FedFsPathName) = 2; /// FedFsPathName) = 2;
/// FedFsLookupFsnRes FEDFS_LOOKUP_FSN( /// FedFsLookupFsnRes FEDFS_LOOKUP_JUNCTION(
/// FedFsLookupFsnArgs) = 3; /// FedFsLookupFsnArgs) = 3;
/// FedFsStatus FEDFS_CREATE_REPLICATION(
/// FedFsCreateJunctionArgs) = 7;
/// FedFsStatus FEDFS_DELETE_REPLICATION(
/// FedFsPathName) = 8;
/// FedFsLookupFsnRes FEDFS_LOOKUP_REPLICATION(
/// FedFsLookupFsnArgs) = 9;
/// FedFsStatus FEDFS_SET_NSDB_PARAMS( /// FedFsStatus FEDFS_SET_NSDB_PARAMS(
/// FedFsSetNsdbParamsArgs) = 4; /// FedFsSetNsdbParamsArgs) = 4;
/// FedFsGetNsdbParamsRes FEDFS_GET_NSDB_PARAMS( /// FedFsGetNsdbParamsRes FEDFS_GET_NSDB_PARAMS(
/// FedFsNsdbName) = 5; /// FedFsNsdbName) = 5;
/// FedFsGetLimitedNsdbParamsRes FEDFS_GET_LIMITED_NSDB_PARAMS( /// FedFsGetLimitedNsdbParamsRes FEDFS_GET_LIMITED_NSDB_PARAMS(
/// FedFsNsdbName) = 6; /// FedFsNsdbName) = 6;
/// } = 1; /// } = 1;
/// } = 100418; /// } = 100418;
<CODE ENDS> <CODE ENDS>
skipping to change at page 8, line 30 skipping to change at page 9, line 21
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 [RFC3530]. descriptions) are taken from the specification for NFSv4 [RFC3530].
Note, however, that the literal values for the status codes are Note, however, that the literal values for the status codes are
different. different.
Note that the status of an unsuccessful operation will generally only Note that the status of an unsuccessful operation will generally only
indicate the first error encountered during the attempt to execute indicate the first error encountered during the attempt to execute
the operation. the 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 which 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_BADXDR The server encountered an XDR decoding error while FEDFS_ERR_BADNAME: A name string in a request consisted of valid
UTF-8 characters supported by the server, but the name is not
supported by the server as a valid name for the current operation.
FEDFS_ERR_NAMETOOLONG: Returned when the pathname in an operation
exceeds the server's implementation limit.
FEDFS_ERR_LOOP: Returned when too many symbolic links were
encountered in resolving pathname.
FEDFS_ERR_BADXDR: The server encountered an XDR decoding error while
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 filesystem to exceed some limit (for example, if there is
a fixed number of junctions per fileset or per server). a fixed number of junctions per fileset or per server).
FEDFS_ERR_NOTDIR The caller specified a non-directory in an FEDFS_ERR_NOTDIR: The caller specified a non-directory in an
operation that requires a directory. operation that requires a directory.
FEDFS_ERR_NOTEMPTY The caller specified a directory that is not FEDFS_ERR_NOTEMPTY: The caller specified a directory that is not
empty as the operand of an operation that requires an empty empty as the operand of an operation that requires an empty
directory. directory.
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. filesystem.
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 between FEDFS_ERR_NSDB_LDAP: An LDAP error occurred on the connection
the fileserver and NSDB. between the fileserver and NSDB.
FEDFS_ERR_NSDB_NOFSN The fileserver was unable to locate the given FEDFS_ERR_NSDB_LDAP_VAL: Indicates the same error as
FEDFS_ERR_NSDB_LDAP, and allows the LDAP protocol error value to
be returned back to the client.
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_NOFSL The fileserver received a malformed response FEDFS_ERR_NSDB_RESPONSE: The fileserver received a malformed
from the NSDB. response from the NSDB.
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_PATH_TYPE_UNSUPP: The fileserver does not support the
specified FedFsPathType value.
4. Data Types 4. Data Types
The basic data types defined above MUST be formatted as follows: The basic data types defined above MUST be 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 1 UUID. The UUID should be formatted in [RFC4122] as a version 1 UUID. The UUID should be formatted in
network byte order. network byte order.
FedFsNsdbName: A variable length UTF-8 string that represents an FedFsNsdbName: A (hostname, port) pair.
NSDB's network location in DNS name notation.
The DNS name MUST be represented using a fully qualified domain The hostname is a variable length UTF-8 string that represents an
name followed by an optional ":port" suffix where "port" is the NSDB's network location in DNS name notation. The DNS name MUST
UTF-8 string representing the transport port number's decimal be represented using a fully qualified domain name. A system
value. A system (i.e. fileserver or administrative host) SHOULD (i.e. fileserver or administrative host) SHOULD resolve the fully
resolve the fully qualified domain name to a network address using qualified domain name to a network address using the system's
the system's standard resolution mechanisms. standard resolution mechanisms.
If the optional port suffix is omitted, the standard LDAP port The port is the NSDB transport port. The port value MUST be in
number, 389, SHOULD be assumed. the range 0 (zero) to 65535. A value of 0 (zero) indicates that
the standard LDAP port number, 389, SHOULD 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 SHOULD NOT contain a network address, Therefore, a FedFsNsdbName SHOULD 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
filesystem path component. filesystem path component.
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 filesystem 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.
FedFsNsdbContainerEntry: A case sensitive UTF-8 string containing FedFsPath: A pathname container. The format and semantics of the
the distinguished name of the NSDB Container Entry (NCE). A pathname are defined by the FedFsPathType value. type specific
string of up to 128 characters MUST be supported. A string description of a pathname.
greater than 128 characters MAY be supported.
A FEDFS_PATH_SYS is an implementation dependent administrative
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
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 an
NSDB name (DNS name and port value) to these LDAP connection 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.
skipping to change at page 11, line 33 skipping to change at page 12, line 43
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
certificate in binary DER format [RFC5280]. The certificate certificate in binary DER format [RFC5280]. The certificate
SHOULD be used by the fileserver to authenticate the identity of SHOULD be used by the fileserver to authenticate the identity of
the NSDB. In particular, this certificate SHOULD be used to the NSDB. In particular, this certificate SHOULD be used to
validate the NSDB's TLS certificate list chain (see 7.4.2 of validate the NSDB's TLS certificate list chain (see 7.4.2 of
[RFC5246]). The certificate could be that of a certificate [RFC5246]). The certificate could be that of a certificate
authority or a self-signed certificate. authority or a self-signed certificate.
4.1. FedFsNsdbName Equality
Two FedFsNsdbNames are considered equal if both their DNS name and
port values are the same. As described above, the standard LDAP port
number, 389, SHOULD be assumed if a port number of 0 (zero) is
specified. Therefore, the FedFsNsdbName "(nsdb.example.com, 0)" is
considered equal to "(nsdb.example.com, 389)" but not equal to
"(nsdb.example.com, 1066)" since the port number is different or
"(nsdb.foo.example.com, 389)" since the DNS name is different.
5. Procedures 5. Procedures
Fileservers that participate as "internal" nodes in the federated Fileservers that participate as "internal" nodes in the federated
namespace MUST provide these procedures: namespace MUST provide these procedures:
FEDFS_NULL The null RPC, which is included, by convention, in every FEDFS_NULL The null RPC, which is included, by convention, in every
ONC RPC protocol. ONC RPC protocol.
FEDFS_CREATE_JUNCTION Create a new junction from some location on FEDFS_CREATE_JUNCTION Create a new junction from some location on
the server (defined as a pathname) to an FSN. the server (defined as a pathname) to an FSN.
FEDFS_DELETE_JUNCTION Delete an existing junction from some location FEDFS_DELETE_JUNCTION Delete an existing junction from some location
on the server (defined as a pathname). on the server (defined as a pathname).
FEDFS_LOOKUP_FSN Query the server to discover the current value of FEDFS_LOOKUP_JUNCTION Query the server to discover the current value
the junction (if any) at a given path in the server namespace. of the junction (if any) at a given path in the server namespace.
FEDFS_CREATE_REPLICATION Set an FSN representing the replication
information for the fileset containing the pathname.
FEDFS_DELETE_REPLICATION Remove the replication information for the
fileset containing the pathname.
FEDFS_LOOKUP_REPLICATION Query the server to discover the current
replication information (if any) at the given path.
FEDFS_SET_NSDB_PARAMS Set the connection parameters for the FEDFS_SET_NSDB_PARAMS Set the connection parameters for the
specified NSDB. specified NSDB.
FEDFS_GET_NSDB_PARAMS Get the connection parameters for the FEDFS_GET_NSDB_PARAMS Get the connection parameters for the
specified NSDB. specified NSDB.
FEDFS_GET_LIMITED_NSDB_PARAMS Get a limited subset of the connection FEDFS_GET_LIMITED_NSDB_PARAMS Get a limited subset of the connection
parameters for the specified NSDB. parameters for the specified NSDB.
The FEDFS_CREATE_JUNCTION, FEDFS_DELETE_JUNCTION, FEDFS_LOOKUP_FSN, The procedures above are described in more detail in the following
FEDFS_SET_NSDB_PARAMS, FEDFS_GET_NSDB_PARAMS, and sections.
FEDFS_GET_LIMITED_NSDB_PARAMS procedures are described in more detail
in the following sections.
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.
Note that operations that modify the state of a replicated fileset Note that operations that modify the state of a replicated fileset
MUST result in the update of all of the replicas in a consistent MUST result in the update of all of the replicas in a consistent
manner. Ideally all of the replicas SHOULD be updated before any manner. Ideally all of the replicas SHOULD be updated before any
operation returns. If one or more of the replicas are unavailable, operation returns. If one or more of the replicas are unavailable,
skipping to change at page 13, line 20 skipping to change at page 14, line 44
It MUST NOT contain a junction. If the last component of the path is It MUST NOT contain a junction. If the last component of the path is
a junction (i.e., this operation is attempting to create a junction a junction (i.e., this operation is attempting to create a junction
where one already exists), then this operation MUST return the error where one already exists), then this operation MUST return the error
FEDFS_ERR_EXISTS (even if the requested junction is identical to the FEDFS_ERR_EXISTS (even if the requested junction is identical to the
current junction). If any other component of the path is a junction, current junction). If any other component of the path is a junction,
then this operation MUST fail with status FEDFS_ERR_NOTLOCAL. The then this operation MUST fail with status FEDFS_ERR_NOTLOCAL. The
path may contain a symbolic link (if supported by the local server), path may contain a symbolic link (if supported by the local server),
but the traversal of the path must remain within the server-local but the traversal of the path must remain within the server-local
namespace. namespace.
The last component of the path MUST be an empty directory. If any If any component of the path does not exist, then the operation fails
component of the path does not exist, or the final component is not a with status FEDFS_ERR_INVAL.
directory, then the operation fails with status FEDFS_ERR_INVAL.
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 the path cannot be traversed because of the final component. If the path cannot be traversed because of
insufficient permissions, or the final component is an unexecutable insufficient permissions, or the final component is an unexecutable
or unwritable directory, then the operation MAY fail with status or unwritable directory, then the operation MAY fail with status
FEDFS_ERR_ACCESS. 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. specified NSDB.
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 may return successfully. If the operation return codes the operation may return successfully. If the operation return codes
indicates success, then the caller may assume that the junction was indicates success, then the caller may assume that the junction was
successfully created and is immediately accessible. successfully created and is immediately accessible.
If successful, subsequent references via NFSv4 [RFC3530] or NFSv4.1 If successful, subsequent references via NFSv4 [RFC3530] or NFSv4.1
[NFSv4.1] 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 [FEDFS-NSDB].
Note that the effective permissions of the directory that is Note that the effective permissions of the directory that is
converted, by this operation, into a junction are the permissions of converted, by this operation, into a junction are the permissions of
the root directory of the target fileset. The original permissions the root directory of the target fileset. The original permissions
of the directory (and any other attributes it might have) are of the directory (and any other attributes it might have) are
subsumed by the junction. subsumed by the junction.
Note that this operation does not create a fileset at the location Note that this operation does not create a fileset at the location
skipping to change at page 14, line 44 skipping to change at page 16, line 18
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_INVAL. The junction then this operation MUST return status FEDFS_ERR_INVAL. The
path may contain a symbolic link (if supported by the local server), path may contain a symbolic link (if supported by the local server),
but the traversal of the path must remain within the server-local but the traversal of the path must remain within the server-local
namespace. namespace.
The last component of the path MUST be a junction. If any component
of the path does not exist, or the final component is not a junction,
then the operation fails with status FEDFS_ERR_NOTJUNCT.
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 the path cannot be traversed because of the final component. If the path cannot be traversed because of
insufficient permissions, or the parent directory of the junction insufficient permissions, or the parent directory of the junction is
unexecutable or unwritable directory, then the operation MAY fail an unexecutable or unwritable directory, then the operation MAY fail
with status FEDFS_ERR_ACCESS. 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 may return successfully. If the durable before the operation may return successfully. If the
operation return codes indicates success, then the caller may assume operation return codes indicates success, then the caller may assume
that the junction was successfully destroyed. that the junction was successfully 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.
5.3. FEDFS_LOOKUP_FSN 5.3. FEDFS_LOOKUP_JUNCTION
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, and if so, the FSN to which the junction refers
and the filerserver's ability to resolve the junction. and the filerserver's ability to resolve the junction.
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
skipping to change at page 16, line 22 skipping to change at page 17, line 40
an unexecutable or unwritable directory, then the operation MAY fail an unexecutable or unwritable directory, then the operation MAY fail
with status FEDFS_ERR_ACCESS. 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 the administrator to obtain the junction's FSN
even if the resolution would fail. even if the resolution would fail. Therefore on success, the result
of a FEDFS_RESOLVE_NONE call will return a 0 (zero) length fsl list
in the FedFsLookupFsnResOk 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 does the FSN by contacting the appropriate NSDB. If the fileserver does
not have a cache or its cache does not have a mapping for the FSN in not have a cache or its cache does not have a mapping for the FSN in
question, the result of the operation MUST be FEDFS_OK with the question, the result of the operation MUST be FEDFS_OK with the
FedFsResolveRes's resolve value set to FEDFS_RESOLVE_NONE. FedFsResolveRes's resolve value set to FEDFS_RESOLVE_NONE.
If the junction exists and the resolve parameter is set to If the junction exists and the resolve parameter is set to
FEDFS_RESOLVE_NSDB, the fileserver MUST attempt to resolve the FSN by FEDFS_RESOLVE_NSDB, the fileserver MUST attempt to resolve the FSN by
contacting the appropriate NSDB. The FSN MUST NOT be resolved using contacting the appropriate NSDB. The FSN MUST NOT be resolved using
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_NOFSN, FEDFS_ERR_NSDB_AUTH, FEDFS_ERR_NSDB_LDAP, FEDFS_ERR_NSDB_LDAP_VAL,
FEDFS_ERR_NSDB_NOFSL, FEDFS_ERR_NSDB_RESPONSE, or FEDFS_ERR_NSDB_NOFSN, FEDFS_ERR_NSDB_NOFSL, FEDFS_ERR_NSDB_RESPONSE,
FEDFS_ERR_NSDB_FAULT depending on the nature of the failure. In the or FEDFS_ERR_NSDB_FAULT depending on the nature of the failure.
case of a FEDFS_ERR_NSDB_LDAP failure, the fileserver MAY indicate
the LDAP protocol error value that was encountered in the In the case of a LDAP failure, the fileserver MAY return either
FedFsLookupFsnRes's ldapResultCode (see the resultCode values in FEDFS_ERR_NSDB_LDAP or FEDFS_ERR_NSDB_LDAP_VAL. FEDFS_ERR_NSDB_LDAP
Section 4.1.9 of [RFC4511]). indicates that an LDAP protocol error occurred during the resolution.
FEDFS_ERR_NSDB_LDAP_VAL also indicates that an LDAP protocol error
occurred during the resolution and allows the LDAP protocol error
value to be returned in the FedFsLookupFsnRes's ldapResultCode field
(see the resultCode values in Section 4.1.9 of [RFC4511]).
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. New FSLs for the given FSN SHOULD be added to the cache and updated. New FSLs for the given FSN SHOULD be added to the cache and
deleted FSLs SHOULD be removed from the cache. This behavior is deleted FSLs SHOULD be removed from the cache. This behavior is
desirable because it allows an administrator to proactively request desirable because it allows an administrator to proactively request
that the fileserver refresh its FSL cache. For example, the that the fileserver refresh its FSL cache. For example, the
administrator might like to refresh the fileserver's cache when administrator might like to refresh the fileserver's cache when
changes are made to an FSN's FSLs. changes are made to an FSN's FSLs.
If the junction is resolved, the fileserver will indicate the type of If the junction is resolved, the fileserver will indicate the type of
resolution that was performed using the FedFsResolveRes's resolve resolution that was performed using the FedFsResolveRes's resolve
value and include a list of UUIDs for the FSN's FSLs in the value and include a list of UUIDs for the FSN's FSLs in the
FedFsResolveRes's fslUuid array. FedFsResolveRes's fslUuid array.
5.4. FEDFS_SET_NSDB_PARAMS 5.4. FEDFS_CREATE_REPLICATION
This operation indicates the replication information to be returned
for a particular fileset. An NFSv4.x client may request fs_locations
or fs_locations_info at any time to detect other copies of this
fileset, and this operation supports this by supplying the FSN the
fileserver should use to respond. This FSN should be associated with
the entire fileset in which the path resides, and should be used to
satisfy fs_locations or fs_locations_info attribute requests whenever
no junction is being accessed; if a junction is being accessed, the
FSN specified by FEDFS_CREATE_JUNCTION will take precedence.
This operation differs from FEDFS_CREATE_JUNCTION in that it controls
a fileset-wide attribute not associated with a junction.
The server SHOULD permit this operation even on read-only filesets,
but MAY return FEDFS_ERR_ROFS if this is not possible.
If the path contains an invalid UTF-8 character, then status
FEDFS_ERR_BADCHAR must be returned.
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
junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL. The path may contain a symbolic link (if
supported by the local server), but the traversal of the path must
remain within the server-local namespace.
The server MAY enforce the local permissions on the path, including
the final component. If the path cannot be traversed because of
insufficient permissions, or the final component is an unexecutable
or unwritable directory, then the operation MAY fail with status
FEDFS_ERR_ACCESS.
The operation SHOULD fail with status FEDFS_ERR_NSDB_PARAMS if the
fileserver does not have any connection parameters on record for the
specified NSDB.
5.5. FEDFS_DELETE_REPLICATION
This operation removes any replication information from the fileset
in which the path resides, such that NFSv4.x client requests for
fs_locations or fs_locations_info in the absence of a junction will
not be satisfied.
This operation differs from FEDFS_DELETE_JUNCTION in that it controls
a fileset-wide attribute not associated with a junction.
The server SHOULD permit this operation even on read-only filesets,
but MAY return FEDFS_ERR_ROFS if this is not possible.
If the path contains an invalid UTF-8 character, then status
FEDFS_ERR_BADCHAR must be returned.
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
junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL.
The server MAY enforce the local permissions on the path, including
the final component. If the path cannot be traversed because of
insufficient permissions, or the parent directory of the junction
unexecutable or unwritable directory, then the operation MAY fail
with status FEDFS_ERR_ACCESS.
5.6. FEDFS_LOOKUP_REPLICATION
This operation queries a server to determine whether a fileset
containing the given path has replication information associated with
it, and if so, the FSN for that replication information.
This operation differs from FEDFS_LOOKUP_JUNCTION in that it inquires
about a fileset-wide attribute not associated with a junction.
If the path contains an invalid UTF-8 character, then status
FEDFS_ERR_BADCHAR must be returned.
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
junction, then this operation MUST fail with status
FEDFS_ERR_NOTLOCAL.
The server MAY enforce the local permissions on the path, including
the final component. If the path cannot be traversed because of
insufficient permissions, or the parent directory of the junction is
an unexecutable or unwritable directory, then the operation MAY fail
with status FEDFS_ERR_ACCESS.
Interpretation of the 'resolve' parameter shall be the same as
specified in Section 5.3 for the FEDFS_LOOKUP_JUNCTION operation.
5.7. FEDFS_SET_NSDB_PARAMS
This operations allows the administrator to set the connection This operations allows the 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. Two FedFsNsdbNames are An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1
considered equal if both their DNS name and port values are the same. define when two FedFsNsdbNames are considered equal
As described above, the standard LDAP port number, 389, SHOULD be
assumed if no port number is explicitly specified. Therefore, the
FedFsNsdbName "nsdb.example.com" is considered equal to
"nsdb.example.com:389" but not equal to "nsdb.example.com:1066" or
"nsdb.foo.example.com:389.
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 above.
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.
The operation MAY return FEDFS_ERR_ACCESS if the operation's The operation MAY return FEDFS_ERR_ACCESS if the operation's
associated user does not have sufficient permissions to create/modify associated user does not have sufficient permissions to create/modify
NSDB connection parameters. NSDB connection parameters.
5.5. FEDFS_GET_NSDB_PARAMS 5.8. FEDFS_GET_NSDB_PARAMS
This operations allows the administrator to retrieve connection This operations allows the 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. Two FedFsNsdbNames are An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1
considered equal if both their DNS name and port values are the same. define when two FedFsNsdbNames are considered equal
As described above, the standard LDAP port number, 389, SHOULD be
assumed if no port number is explicitly specified. Therefore, the
FedFsNsdbName "nsdb.example.com" is considered equal to
"nsdb.example.com:389" but not equal to "nsdb.example.com:1066" or
"nsdb.foo.example.com:389.
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 above) to the operation's NSDB
argument. Therefore, there is at most one set of connection argument. Therefore, there is at most one set of connection
parameters that can match the query described by this operation. 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 above.
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 MAY return FEDFS_ERR_NSDB_PARAMS to indicate that This operation MAY return FEDFS_ERR_NSDB_PARAMS to indicate that
there are no connection parameters on record for the given NSDB. The there are no connection parameters on record for the given NSDB. The
operation MAY return FEDFS_ERR_ACCESS if the operation's associated operation MAY return FEDFS_ERR_ACCESS if the operation's associated
user does not have sufficient permissions to view NSDB connection user does not have sufficient permissions to view NSDB connection
parameters. parameters.
5.6. FEDFS_GET_LIMITED_NSDB_PARAMS 5.9. FEDFS_GET_LIMITED_NSDB_PARAMS
This operations allows the administrator to retrieve a limited subset This operations allows the 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.
An NSDB is specified using a FedFsNsdbName. Two FedFsNsdbNames are An NSDB is specified using a FedFsNsdbName. The rules in Section 4.1
considered equal if both their DNS name and port values are the same. define when two FedFsNsdbNames are considered equal
As described above, the standard LDAP port number, 389, SHOULD be
assumed if no port number is explicitly specified. Therefore, the
FedFsNsdbName "nsdb.example.com" is considered equal to
"nsdb.example.com:389" but not equal to "nsdb.example.com:1066" or
"nsdb.foo.example.com:389.
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 above) to the operation's NSDB
argument. Therefore, there is at most one set of connection argument. Therefore, there is at most one set of connection
parameters that can match the query described by this operation. 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.
skipping to change at page 19, line 25 skipping to change at page 22, line 29
On success, this operation returns FEDFS_OK and the On success, this operation returns FEDFS_OK and the
FedFsConnectionSec value on record for the given NSDB. FedFsConnectionSec value 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 MAY return FEDFS_ERR_NSDB_PARAMS to indicate that This operation MAY return FEDFS_ERR_NSDB_PARAMS to indicate that
there are no connection parameters on record for the given NSDB. The there are no connection parameters on record for the given NSDB. The
operation MAY return FEDFS_ERR_ACCESS if the operation's associated operation MAY return FEDFS_ERR_ACCESS if the operation's associated
user does not have sufficient permissions to view the subset of NSDB user does not have sufficient permissions to view the subset of NSDB
connection parameters returned by this procedure. connection parameters returned by this procedure.
6. Security Considerations 6. Internationalization
TBD. All UTF-8 strings and DNS names will conform to the rules
defined by rfc3530bis.
7. Security Considerations
The ONC RPC protocol supports authentication, integrity and privacy The ONC RPC protocol supports authentication, integrity and privacy
via the RPCSEC_GSS framework [RFC2203]. Fileservers which support via the RPCSEC_GSS framework [RFC2203]. Fileservers which support
the FedFS administration protocol described above MUST support the FedFS administration protocol described above MUST support
RPCSEC_GSS. RPCSEC_GSS.
7. IANA Considerations 8. 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 7.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. This document describes version 1 of the ONC RPC program 100418.
8. Glossary 9. Glossary
Administrator: user with the necessary authority to initiate Administrator: 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.
Client: Any client that accesses the fileserver data using a Client: Any client that accesses the fileserver data using a
supported filesystem access protocol. supported filesystem access protocol.
skipping to change at page 21, line 49 skipping to change at page 25, line 9
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.
9. References 10. References
9.1. Normative References
10.1. Normative References
[RFC1094] Nowicki, B., "NFS: Network File System Protocol [RFC1094] Nowicki, B., "NFS: Network File System Protocol
specification", RFC 1094, March 1989. specification", RFC 1094, March 1989.
[RFC1813] Callaghan, B., Pawlowski, B., and P. Staubach, "NFS [RFC1813] Callaghan, B., Pawlowski, B., and P. Staubach, "NFS
Version 3 Protocol Specification", RFC 1813, June 1995. Version 3 Protocol Specification", RFC 1813, June 1995.
[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.
skipping to change at page 22, line 43 skipping to change at page 26, line 5
(TLS) Protocol Version 1.2", RFC 5246, August 2008. (TLS) Protocol Version 1.2", RFC 5246, August 2008.
[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.
[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.
9.2. Informative References 10.2. Informative References
[FEDFS-NSDB] [FEDFS-NSDB]
Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M. Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M.
Naik, "NSDB Protocol for Federated Filesystems", Naik, "NSDB Protocol for Federated Filesystems",
draft-ietf-nfsv4-federated-fs-protocol (Work In Progress), draft-ietf-nfsv4-federated-fs-protocol (Work In Progress),
2009. 2010.
[FEDFS-REQTS]
Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M.
Naik, "Requirements for Federated File Systems", RFC 5716,
January 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 2.0, November 2009.
[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 17.0, November 2009.
[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 19.0, November 2009.
[NFSv4.1] Shepler, S., Eisler, M., and D. Noveck, "Network File [RFC3530] Shepler, S., Callaghan, B., Robinson, D., Thurlow, R.,
Beame, C., Eisler, M., and D. Noveck, "Network File System
(NFS) version 4 Protocol", RFC 3530, April 2003.
[RFC5661] Shepler, S., Eisler, M., and D. Noveck, "Network File
System (NFS) Version 4 Minor Version 1 Protocol", System (NFS) Version 4 Minor Version 1 Protocol",
RFC 5661, January 2010. RFC 5661, January 2010.
[NFSv4.1-XDR] [RFC5662] Shepler, S., Eisler, M., and D. Noveck, "Network File
Shepler, S., Eisler, M., and D. Noveck, "Network File
System (NFS) Version 4 Minor Version 1 External Data System (NFS) Version 4 Minor Version 1 External Data
Representation Standard (XDR) Description", RFC 5662, Representation Standard (XDR) Description", RFC 5662,
January 2010. January 2010.
[RFC3530] Shepler, S., Callaghan, B., Robinson, D., Thurlow, R., [RFC5716] Lentini, J., Everhart, C., Ellard, D., Tewari, R., and M.
Beame, C., Eisler, M., and D. Noveck, "Network File System Naik, "Requirements for Federated File Systems", RFC 5716,
(NFS) version 4 Protocol", RFC 3530, April 2003. January 2010.
Appendix A. Acknowledgments Appendix A. Acknowledgments
We would like to thank Paul Lemahieu of EMC, Robert Thurlow of Sun We would like to thank Robert Thurlow of Sun Microsystems for helping
Microsystems, and Mario Wurzl of EMC for helping to author this to author this document, including drafting the replication procedure
document. text.
We would also like to thank Paul Lemahieu of EMC and Mario Wurzl of
EMC for helping to author this document.
We would also like to thank Trond Myklebust for suggesting We would also like to thank Trond Myklebust for suggesting
improvements to the FSL pathname format and Nicolas Williams for his improvements to the FSL pathname format, Chuck Lever for suggesting
suggestions. improvements to the XDR type definitions and error codes, and Nicolas
Williams for his suggestions.
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 described by the authors of the NFSv4.1 XDR specification [RFC5662].
[NFSv4.1-XDR].
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 US
Phone: +1 781-768-5359 Phone: +1 781-768-5359
skipping to change at page 24, line 26 skipping to change at page 27, line 29
Craig Everhart Craig Everhart
NetApp NetApp
7301 Kit Creek Rd 7301 Kit Creek Rd
Research Triangle Park, NC 27709 Research Triangle Park, NC 27709
US US
Phone: +1 919-476-5320 Phone: +1 919-476-5320
Email: everhart@netapp.com Email: everhart@netapp.com
Daniel Ellard Daniel Ellard
BBN Technologies Raytheon BBN Technologies
10 Moulton Street 10 Moulton Street
Cambridge, MA 02138 Cambridge, MA 02138
US US
Phone: +1 617-873-8000 Phone: +1 617-873-8000
Email: dellard@bbn.com Email: dellard@bbn.com
Renu Tewari Renu Tewari
IBM Almaden IBM Almaden
650 Harry Rd 650 Harry Rd
 End of changes. 87 change blocks. 
204 lines changed or deleted 362 lines changed or added

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