1GANESHA-CONFIG(8)                 NFS-Ganesha                GANESHA-CONFIG(8)
2
3
4

NAME

6       ganesha-config - NFS Ganesha Configuration File
7

SYNOPSIS

9       /etc/ganesha/ganesha.conf
10
11

DESCRIPTION

13       NFS-Ganesha obtains configuration data from the configuration file:
14          /etc/ganesha/ganesha.conf
15
16       The configuration file consists of following parts:
17
18   Comments
19       Empty lines and lines starting with '#' are comments.:
20
21          # This whole line is a comment
22          Protocol = TCP; # The rest of this line is a comment
23
24   Blocks
25       Related  options are grouped together into "blocks".  A block is a name
26       followed by parameters enclosed between "{" and "}".  A block can  con‐
27       tain other sub blocks as well.:
28
29          EXPORT
30          {
31              Export_ID = 1;
32              FSAL {
33                  Name = VFS:
34              }
35          }
36
37       NOTE:  FSAL is a sub block.  Refer to BLOCKS section for list of blocks
38       and options.
39
40   Options
41       Configuration options can be of following types.
42
43       1. Numeric. Numeric options can be defined in octal, decimal, or  hexa‐
44       decimal.  The format follows ANSI C syntax.  eg.:
45
46          mode = 0755;  # This is octal 0755, 493 (decimal)
47
48       Numeric values can also be negated or logical NOT'd.  eg.:
49
50          anonymousuid = -2; # this is a negative
51          mask = ~0xff; # Equivalent to 0xffffff00 (for 32 bit integers)
52
53       2.  Boolean.  Possible values are true, false, yes and no.  1 and 0 are
54       not acceptable.
55
56       3. List. The option can contain a list of possible  applicable  values.
57       Protocols = 3, 4, 9p;
58
59   Including other config files
60       Additional  files can be referenced in a configuration using '%include'
61       or '%dir' or '%url' directives.:
62
63          %include <filename>
64          %dir <directory_name>
65          %url <url, e.g., rados://mypool/mynamespace/myobject>
66
67       The included file is inserted into the configuration text in  place  of
68       the  %include or %dir or %url line. Sub-inclusions may be to any depth.
69       Filenames or directory or URLs may optionally use '"':
70
71          %include base.conf
72          %include "base.conf"
73          %dir /etc/ganesha/ganesha_config/
74          %dir "/etc/ganesha/ganesha_config/"
75          %url rados://mypool/mynamespace/myobject
76          %url "rados://mypool/mynamespace/myobject"
77          %url rados://mypool/myobject
78          %url "rados://mypool/myobject"
79
80       In the case of rados:// URLs, providing a two-component  URL  indicates
81       that the default namespace should be used.
82
83   Reloading Config
84       A  config reload can be triggered by sending the ganesha.nfsd process a
85       SIGHUP.  Not all config options may be changed with reload, those  that
86       can will be documented in the individual sections.
87
88       In  general,  currently  dynamic config is supported for EXPORT and LOG
89       options.
90

BLOCKS

92       NFS-Ganesha supports the following blocks:
93
94   EXPORT {}
95       Along with its configuration options, the EXPORT  block  supports  FSAL
96       and  CLIENT  sub-blocks. See ganesha-export-config(8) for usage of this
97       block and its sub-blocks.
98
99   EXPORT_DEFAULTS {}
100       Refer to ganesha-export-config(8) for usage
101
102   MDCACHE {}
103       Refer to ganesha-cache-config(8) for usage
104
105   NFS_CORE_PARAM {}
106       Refer to ganesha-core-config(8) for usage
107
108   NFS_IP_NAME {}
109       Refer to ganesha-core-config(8) for usage
110
111   NFS_KRB5 {}
112       Refer to ganesha-core-config(8) for usage
113
114   NFSv4 {}
115       Refer to ganesha-core-config(8) for usage
116
117   CEPH {}
118       Refer to ganesha-ceph-config(8) for usage
119
120   9P {}
121       Refer to ganesha-9p-config(8) for usage
122
123   GLUSTER {}
124       Refer to ganesha-gluster-config(8) for usage
125
126   GPFS {}
127       Refer to ganesha-gpfs-config(8) for usage
128
129   LOG {}
130       Refer to ganesha-log-config(8) for usage
131
132       1.**LOG { FACILITY {} }** 2.**LOG { FORMAT {} }**
133
134   PROXY_V4 {}
135       Refer to ganesha-proxy-config(8) for usage
136
137   PROXY_V3 {}
138       Refer to ganesha-proxy-v3-config(8) for usage
139
140   RGW {}
141       Refer to ganesha-rgw-config(8) for usage
142
143   VFS {}
144       Refer to ganesha-vfs-config(8) for usage
145
146   XFS {}
147       Refer to ganesha-xfs-config(8) for usage
148

EXAMPLE

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

SEE ALSO

156       ganesha-log-config(8)    ganesha-rgw-config(8)    ganesha-vfs-config(8)
157       ganesha-lustre-config(8)  ganesha-xfs-config(8)  ganesha-gpfs-config(8)
158       ganesha-gluster-config(8)  ganesha-9p-config(8) ganesha-proxy-config(8)
159       ganesha-proxy-v3-config(8)                       ganesha-ceph-config(8)
160       ganesha-core-config(8) ganesha-export-config(8)
161
162
163
164
165                                 Feb 28, 2023                GANESHA-CONFIG(8)
Impressum