.\" Man page generated from reStructuredText.
.
.TH "GANESHA-EXPORT-CONFIG" "8" "Jan 20, 2021" "" "NFS-Ganesha"
.SH NAME
ganesha-export-config \- NFS Ganesha Export Configuration File
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
/etc/ganesha/ganesha.conf
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
NFS\-Ganesha obtains configuration data from the configuration file:
.INDENT 0.0
.INDENT 3.5
/etc/ganesha/ganesha.conf
.UNINDENT
.UNINDENT
.sp
This file lists NFS\-Ganesha Export block config options.
.SS EXPORT_DEFAULTS {}
.sp
These options are all "export permissions" options, and will be
repeated in the EXPORT {} and EXPORT { CLIENT {} } blocks.
.sp
These options will all be dynamically updateable.
.INDENT 0.0
.TP
.B Access_Type(enum, default None)
.INDENT 7.0
.TP
.B Possible values:
None, RW, RO, MDONLY, MDONLY_RO
.UNINDENT
.TP
.B Protocols(enum list, default [3,4])
.INDENT 7.0
.TP
.B Possible values:
3, 4, NFS3, NFS4, V3, V4, NFSv3, NFSv4, 9P
.UNINDENT
.UNINDENT
.sp
Transports(enum list, values [UDP, TCP, RDMA], default [UDP, TCP])
.sp
Anonymous_uid(anonid, range INT32_MIN to UINT32_MAX, default \-2)
.sp
Anonymous_gid(anonid, range INT32_MIN to UINT32_MAX, default \-2)
.INDENT 0.0
.TP
.B SecType(enum list, default [none, sys])
.INDENT 7.0
.TP
.B Possible values:
none, sys, krb5, krb5i, krb5p
.UNINDENT
.UNINDENT
.sp
PrivilegedPort(bool, default false)
.sp
Manage_Gids(bool, default false)
.INDENT 0.0
.TP
.B Squash(enum, default root_sqaush)
.INDENT 7.0
.TP
.B Possible values:
root, root_squash, rootsquash,
rootid, root_id_squash, rootidsquash,
all, all_squash, allsquash,
all_anomnymous, allanonymous,
no_root_squash, none, noidsquash
.UNINDENT
.sp
Each line of defaults above are synonyms
.UNINDENT
.sp
Security_Label(bool, default false)
.sp
\fBNFS_Commit(bool, default false)\fP
.INDENT 0.0
.TP
.B Delegations(enum, default None)
.INDENT 7.0
.TP
.B Possible values:
None, read, write, readwrite, r, w, rw
.UNINDENT
.UNINDENT
.sp
\fBAttr_Expiration_Time(int32, range \-1 to INT32_MAX, default 60)\fP
.SS EXPORT {}
.INDENT 0.0
.TP
.B Export_id (required):
An identifier for the export, must be unique and betweem 0 and 65535.
If Export_Id 0 is specified, Pseudo must be the root path (/).
.TP
.B Path (required)
The directory in the exported file system this export is rooted on
(may be ignored for some FSALs). It need not be unique if Pseudo and/or Tag are specified.
.sp
Note that if it is not unique, and the core option mount_path_pseudo
is not set true, a v3 mount using the path will ONLY be able to
access the first export configured. To access other exports the
Tag option would need to be used.
.TP
.B Pseudo (required v4)
This option specifies the position in the Pseudo FS this export occupies if
this is an NFS v4 export. It must be unique. By using different Pseudo options,
the same Path may be exported multiple times.
.sp
This option is used to place the export within the NFS v4 Pseudo
Filesystem. This creates a single name space for NFS v4. Clients may
mount the root of the Pseudo Filesystem and navigate to exports.
Note that the Path and Tag options are not at all visible to NFS v4
clients.
.sp
Export id 0 is automatically created to provide the root and any
directories necessary to navigate to exports if there is no other
export specified with Pseudo = /;. Note that if an export is
specified with Pseudo = /;, it need not be export id 0. Specifying
such an export with FSAL { name = PSEUDO; } may be used to create a
Pseudo FS with specific options. Such an export may also use other
FSALs (though directories to reach exports will ONLY be
automatically created on FSAL PSEUDO exports).
.TP
.B Tag (no default)
This option allows an alternative access for NFS v3
mounts. The option MUST not have a leading /. Clients
may not mount subdirectories (i.e. if Tag = foo, the
client may not mount foo/baz). By using different
Tag options, the same Path may be exported multiple
times.
.TP
.B MaxRead (64*1024*1024)
The maximum read size on this export
.TP
.B MaxWrite (64*1024*1024)
The maximum write size on this export
.TP
.B PrefRead (64*1024*1024)
The preferred read size on this export
.TP
.B PrefWrite (64*1024*1024)
The preferred write size on this export
.TP
.B PrefReaddir (16384)
The preferred readdir size on this export
.TP
.B MaxOffsetWrite (INT64_MAX)
Maximum file offset that may be written
Range is 512 to UINT64_MAX
.TP
.B MaxOffsetRead (INT64_MAX)
Maximum file offset that may be read
Range is 512 to UINT64_MAX
.TP
.B CLIENT (optional)
See the \fBEXPORT { CLIENT  {} }\fP block.
.TP
.B FSAL (required)
See the \fBEXPORT { FSAL  {} }\fP block.
.UNINDENT
.SS EXPORT { CLIENT  {} }
.sp
Take all the "export permissions" options from EXPORT_DEFAULTS.
The client lists are dynamically updateable.
.INDENT 0.0
.TP
.B Clients(client list, empty)
Client list entries can take on one of the following forms:
Match any client:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
@name       Netgroup name
x.x.x.x/y   IPv4 network address
wildcarded  If the string contains at least one ? or *
            character (and is not simply "*"), the string is
            used to pattern match host names. Note that [] may
            also be used, but the pattern MUST have at least one
            ? or *
hostname    Match a single client (match is by IP address, all
            addresses returned by getaddrinfo will match, the
            getaddrinfo call is made at config parsing time)
IP address  Match a single client
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS EXPORT { FSAL {} }
.sp
NFS\-Ganesha supports the following FSALs:
\fBCeph\fP
\fBGluster\fP
\fBGPFS\fP
\fBProxy\fP
\fBRGW\fP
\fBVFS\fP
\fBLUSTRE\fP
.sp
Refer to individual FSAL config file for list of config options.
.SH SEE ALSO
.sp
ganesha\-config(8)
ganesha\-rgw\-config(8)
ganesha\-vfs\-config(8)
ganesha\-lustre\-config(8)
ganesha\-xfs\-config(8)
ganesha\-gpfs\-config(8)
ganesha\-9p\-config(8)
ganesha\-proxy\-config(8)
ganesha\-ceph\-config(8)
.\" Generated by docutils manpage writer.
.