ganesha-config(8)

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       4.  String.  String options such as export Path need not be enclosed in
60       quotes but is recommended. If special characters are included, particu‐
61       larly  non-ASCII  characters, use of either single or double quotes may
62       be required.  Another set of strings that  should  be  quoted  are  any
63       strings that are a keyword or if spaces are part of the string.
64
65   Including other config files
66       Additional  files can be referenced in a configuration using '%include'
67       or '%dir' or '%url' directives.:
68
69          %include <filename>
70          %dir <directory_name>
71          %url <url, e.g., rados://mypool/mynamespace/myobject>
72
73       The included file is inserted into the configuration text in  place  of
74       the  %include or %dir or %url line. Sub-inclusions may be to any depth.
75       Filenames or directory or URLs may optionally use '"':
76
77          %include base.conf
78          %include "base.conf"
79          %dir /etc/ganesha/ganesha_config/
80          %dir "/etc/ganesha/ganesha_config/"
81          %url rados://mypool/mynamespace/myobject
82          %url "rados://mypool/mynamespace/myobject"
83          %url rados://mypool/myobject
84          %url "rados://mypool/myobject"
85
86       In the case of rados:// URLs, providing a two-component  URL  indicates
87       that the default namespace should be used.
88
89   Reloading Config
90       A  config reload can be triggered by sending the ganesha.nfsd process a
91       SIGHUP.  Not all config options may be changed with reload, those  that
92       can will be documented in the individual sections.
93
94       In  general,  currently  dynamic config is supported for EXPORT and LOG
95       options.
96

BLOCKS

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

EXAMPLE

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

NAME

SYNOPSIS

DESCRIPTION

BLOCKS

EXAMPLE

SEE ALSO