GANESHA-CONFIG(8)

NAME
ganesha-config - NFS Ganesha Configuration File

SYNOPSIS
/etc/ganesha/ganesha.conf

DESCRIPTION

NFS-Ganesha obtains configuration data from the configuration file:
        /etc/ganesha/ganesha.conf

The configuration file consists of following parts:

  Comments

Empty lines and lines starting with '#' are comments.:

            # This whole line is a comment
            Protocol = TCP; # The rest of this line is a comment

  Blocks

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

            EXPORT
            {
                Export_ID = 1;
                FSAL {
                    Name = VFS:
                }
            }

NOTE: FSAL is a sub block. Refer to BLOCKS section for list of blocks and options.

  Options

Configuration options can be of following types.

1. Numeric. Numeric options can be defined in octal, decimal, or hexadecimal. The format follows ANSI C syntax. eg.:

            mode = 0755;  # This is octal 0755, 493 (decimal)

Numeric values can also be negated or logical NOT'd. eg.:

            anonymousuid = -2; # this is a negative
            mask = ~0xff; # Equivalent to 0xffffff00 (for 32 bit integers)

2. Boolean. Possible values are true, false, yes and no. 1 and 0 are not acceptable.

3. List. The option can contain a list of possible applicable values. Protocols = 3, 4, 9p;

4. String. String options such as export Path need not be enclosed in quotes but is recommended. If special characters are included, particularly non-ASCII characters, use of either single or double quotes may be required. Another set of strings that should be quoted are any strings that are a keyword or if spaces are part of the string.

  Including other config files

Additional files can be referenced in a configuration using '%include' or '%dir' or '%url' directives.:

            %include <filename>
            %dir <directory_name>
            %url <url, e.g., rados://mypool/mynamespace/myobject>

The included file is inserted into the configuration text in place of the %include or %dir or %url line. Sub-inclusions may be to any depth. Filenames or directory or URLs may optionally use '"':

            %include base.conf
            %include "base.conf"
            %dir /etc/ganesha/ganesha_config/
            %dir "/etc/ganesha/ganesha_config/"
            %url rados://mypool/mynamespace/myobject
            %url "rados://mypool/mynamespace/myobject"
            %url rados://mypool/myobject
            %url "rados://mypool/myobject"

In the case of rados:// URLs, providing a two-component URL indicates that the default namespace should be used.

  Reloading Config

A config reload can be triggered by sending the ganesha.nfsd process a SIGHUP. Not all config options may be changed with reload, those that can will be documented in the individual sections.

In general, currently dynamic config is supported for EXPORT and LOG options.

BLOCKS

NFS-Ganesha supports the following blocks:

  EXPORT {}

Along with its configuration options, the EXPORT block supports FSAL and CLIENT sub-blocks. See ganesha-export-config(8) for usage of this block and its sub-blocks.

  EXPORT_DEFAULTS {}

Refer to ganesha-export-config(8) for usage

  MDCACHE {}

Refer to ganesha-cache-config(8) for usage

  NFS_CORE_PARAM {}

Refer to ganesha-core-config(8) for usage

  NFS_IP_NAME {}

Refer to ganesha-core-config(8) for usage

  NFS_KRB5 {}

Refer to ganesha-core-config(8) for usage

  NFSv4 {}

Refer to ganesha-core-config(8) for usage

  _9P {}

Refer to ganesha-9p-config(8) for usage

  LOG {}

Refer to ganesha-log-config(8) for usage

1.**LOG { FACILITY {} }** 2.**LOG { FORMAT {} }**

  RADOS_KV {}

Refer to ganesha-core-config(8) for usage

  RADOS_URLS {}

Refer to ganesha-core-config(8) for usage

  FSAL_LIST {}

Refer to ganesha-core-config(8) for usage

  CEPH {}

Refer to ganesha-ceph-config(8) for usage

  GLUSTER {}

Refer to ganesha-gluster-config(8) for usage

  GPFS {}

Refer to ganesha-gpfs-config(8) for usage

  PROXY_V4 {}

Refer to ganesha-proxy-config(8) for usage

  PROXY_V3 {}

Refer to ganesha-proxy-v3-config(8) for usage

  RGW {}

Refer to ganesha-rgw-config(8) for usage

  VFS {}

Refer to ganesha-vfs-config(8) for usage

  XFS {}

Refer to ganesha-xfs-config(8) for usage

EXAMPLE

Along with "ganesha.conf", for each installed FSAL, a sample config file is added at:
/etc/ganesha

SEE ALSO

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-proxy-v3-config(8) ganesha-ceph-config(8) ganesha-core-config(8) ganesha-export-config(8)