.\" Man page generated from reStructuredText.
.
.TH "GANESHA-CONFIG" "8" "Jan 18, 2019" "" "NFS-Ganesha"
.SH NAME
ganesha-config \- NFS Ganesha 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
.nf
/etc/ganesha/ganesha.conf
.fi
.sp
.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
The configuration file consists of following parts:
.SS Comments
.sp
Empty lines and lines starting with ‘#’ are comments.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# This whole line is a comment
Protocol = TCP; # The rest of this line is a comment
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Blocks
.sp
Related options are grouped together into "blocks".
A block is a name followed by parameters enclosed between "{"
and "}".
A block can contain other sub blocks as well.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
EXPORT
{
    Export_ID = 1;
    FSAL {
        Name = VFS:
    }
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
NOTE: FSAL is a sub block.
Refer to \fBBLOCKS\fP section for list of blocks and options.
.SS Options
.sp
Configuration options can be of following types.
.sp
1. \fBNumeric.\fP Numeric options can be defined in octal, decimal, or hexadecimal.
The format follows ANSI C syntax.
eg.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mode = 0755;  # This is octal 0755, 493 (decimal)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Numeric values can also be negated or logical NOT\(aqd.
eg.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
anonymousuid = \-2; # this is a negative
mask = ~0xff; # Equivalent to 0xffffff00 (for 32 bit integers)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
2. \fBBoolean.\fP Possible values are true, false, yes and no.
1 and 0 are not acceptable.
.sp
3. \fBList.\fP The option can contain a list of possible applicable values.
Protocols = 3, 4, 9p;
.SS Including other config files
.sp
Additional files can be referenced in a configuration using \(aq%include\(aq
and \(aq%url\(aq directives.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
%include <filename>
%url <url, e.g., rados://mypool/myobject>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The included file is inserted into the configuration text in place of
the %include or %url line. Sub\-inclusions may be to any depth. Filenames and
URLs may optionally use \(aq"\(aq:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
%include base.conf
%include "base.conf"
%url rados://mypool/myobject
%url "rados://mypool/myobject"
.ft P
.fi
.UNINDENT
.UNINDENT
.SH BLOCKS
.sp
NFS\-Ganesha supports the following blocks:
.SS EXPORT {}
.sp
Along with its configuration options, the \fBEXPORT\fP block supports \fBFSAL\fP
and \fBCLIENT\fP sub\-blocks. See
ganesha\-export\-config(8) for usage of this
block and its sub\-blocks.
.SS EXPORT_DEFAULTS {}
.sp
Refer to ganesha\-export\-config(8) for usage
.SS CACHEINODE {}
.sp
Refer to ganesha\-cache\-config(8) for usage
.SS NFS_CORE_PARAM {}
.sp
Refer to ganesha\-core\-config(8) for usage
.SS NFS_IP_NAME {}
.sp
Refer to ganesha\-core\-config(8) for usage
.SS NFS_KRB5 {}
.sp
Refer to ganesha\-core\-config(8) for usage
.SS NFSv4 {}
.sp
Refer to ganesha\-core\-config(8) for usage
.SS CEPH {}
.sp
Refer to ganesha\-ceph\-config(8) for usage
.SS 9P {}
.sp
Refer to ganesha\-9p\-config(8) for usage
.SS GLUSTER {}
.sp
Refer to ganesha\-gluster\-config(8) for usage
.SS GPFS {}
.sp
Refer to ganesha\-gpfs\-config(8) for usage
.SS LOG {}
.sp
Refer to ganesha\-log\-config(8) for usage
.sp
1.**LOG { FACILITY {} }**
2.**LOG { FORMAT {} }**
.SS PROXY {}
.sp
Refer to ganesha\-proxy\-config(8) for usage
.SS RGW {}
.sp
Refer to ganesha\-rgw\-config(8) for usage
.SS VFS {}
.sp
Refer to ganesha\-vfs\-config(8) for usage
.SS XFS {}
.sp
Refer to ganesha\-xfs\-config(8) for usage
.SH EXAMPLE
.sp
Along with "ganesha.conf", for each installed FSAL, a sample config file is added at:
.nf
/etc/ganesha
.fi
.sp
.SH SEE ALSO
.sp
ganesha\-log\-config(8)
ganesha\-rgw\-config(8)
ganesha\-vfs\-config(8)
ganesha\-lustre\-config(8)
ganesha\-xfs\-config(8)
ganesha\-gpfs\-config(8)
ganesha\-gluster\-config(8)
ganesha\-9p\-config(8)
ganesha\-proxy\-config(8)
ganesha\-ceph\-config(8)
ganesha\-core\-config(8)
ganesha\-export\-config(8)
.\" Generated by docutils manpage writer.
.