Merge "citrix" branch into "master".
[sliver-openvswitch.git] / xenserver / usr_share_vswitch_scripts_sysconfig.template
1 ### Configuration options for vswitch
2
3 # Copyright (C) 2009, 2010 Nicira Networks, Inc.
4 #
5 # Copying and distribution of this file, with or without modification,
6 # are permitted in any medium without royalty provided the copyright
7 # notice and this notice are preserved.  This file is offered as-is,
8 # without warranty of any kind.
9
10 # ENABLE_BRCOMPAT: If 'y' than emulate linux bridging interfaces
11 #    using the brcompat kernel module and ovs-brcompatd daemon
12 # ENABLE_BRCOMPAT=y
13
14 # ENABLE_FAKE_PROC_NET: If 'y' then emulate linux bonding and vlan
15 #    files in /proc as if the bonding and vlan demultiplexing done in
16 #    ovs-vswitchd were being implemented using existing Linux mechanisms.
17 #    This is useful in some cases when replacing existing solutions.
18 # ENABLE_FAKE_PROC_NET=y
19
20 # ENABLE_MONITOR: If 'y' then monitor daemon processes and restart them
21 #    if they die due to an error signal.
22 # ENABLE_MONITOR=y
23
24 # FORCE_COREFILES: If 'y' then core files will be enabled.
25 # FORCE_COREFILES=y
26
27 # COREFILE_PATTERN: Pattern used to determine path and filename for
28 #     core files when FORCE_COREFILES is 'y'.  This is Linux specific.
29 #     See the manpage for "core".
30 # COREFILE_PATTERN="/var/log/%e-%t"
31
32 # OVSDB_SERVER_REMOTES: Space-separated list of methods on which to have
33 #     ovsdb-server listen or connect for a JSON-RPC connection.
34 # OVSDB_SERVER_REMOTES="punix:/var/run/ovsdb-server db:Open_vSwitch,managers"
35
36 # OVSDB_SERVER_DB: File for which ovsdb-server uses for storage.
37 # OVSDB_SERVER_DB=/etc/ovs-vswitchd.conf.db
38
39 # OVSDB_SERVER_PIDFILE: File in which to store the pid of the running
40 #     ovsdb-server.
41 # OVSDB_SERVER_PIDFILE=/var/run/ovsdb-server.pid
42
43 # OVSDB_SERVER_RUN_DIR: Set the directory in which ovsdb-server should be
44 #     run.  This mainly affects where core files will be placed.
45 # OVSDB_SERVER_RUN_DIR=/var/xen/vswitch
46
47 # OVSDB_SERVER_PRIORITY: "nice" priority at which to run ovsdb-server and 
48 #     related processes.
49 # OVSDB_SERVER_PRIORITY=-10
50
51 # OVSDB_SERVER_LOGFILE: File to send the FILE_LOGLEVEL log messages to.
52 # OVSDB_SERVER_LOGFILE=/var/log/ovsdb-server.log
53
54 # OVSDB_SERVER_FILE_LOGLEVEL: Log level at which to log into the
55 #     OVSDB_SERVER_LOG file.  If this is null or not set the logfile will
56 #     not be created and nothing will be sent to it.  This is the
57 #     default.  The available options are: EMER, WARN, INFO and DBG.
58 # OVSDB_SERVER_FILE_LOGLEVEL=""
59
60 # OVSDB_SERVER_SYSLOG_LOGLEVEL: Log level at which to log into syslog.  If
61 #     this is null or not set the default is to log to syslog
62 #     emergency and warning level messages only.
63 # OVSDB_SERVER_SYSLOG_LOGLEVEL="WARN"
64
65 # OVSDB_SERVER_MEMLEAK_LOGFILE: File for logging memory leak data.
66 #     Enabling this option will slow ovsdb-server significantly.  Do not
67 #     enable it except to debug a suspected memory leak.  Use the
68 #     ovs-parse-leaks utility included with Open vSwitch to parse the
69 #     log file.  For best results, you also need debug symbols.
70 # OVSDB_SERVER_MEMLEAK_LOGFILE=""
71
72 # OVSDB_SERVER_STRACE_LOG: File for logging strace output.
73 #     If this is set to a nonempty string, then ovsdb-server will run
74 #     under strace, whose output will be logged to the specified file.
75 #     Enabling this option will slow ovsdb-server significantly.
76 #     OVSDB_SERVER_STRACE_LOG and OVSDB_SERVER_VALGRIND_LOG are mutually 
77 #     exclusive.
78 # OVSDB_SERVER_STRACE_LOG=""
79
80 # OVSDB_SERVER_STRACE_OPT: Options to pass to strace.
81 #     This option's value is honored only when OVSDB_SERVER_STRACE_LOG is
82 #     set to a nonempty string.
83 # OVSDB_SERVER_STRACE_OPT=""
84
85 # OVSDB_SERVER_VALGRIND_LOG: File for logging valgrind output.
86 #     If this is set to a nonempty string, then ovsdb-server will run
87 #     under valgrind, whose output will be logged to the specified file.
88 #     Enabling this option will slow ovsdb-server by 100X or more.
89 #     valgrind is not installed by default on XenServer systems; you must
90 #     install it by hand to usefully enable this option.
91 #     OVSDB_SERVER_STRACE_LOG and OVSDB_SERVER_VALGRIND_LOG are mutually 
92 #     exclusive.
93 # OVSDB_SERVER_VALGRIND_LOG=""
94
95 # OVSDB_SERVER_VALGRIND_OPT: Options to pass to valgrind.
96 #     This option's value is honored only when OVSDB_SERVER_VALGRIND_LOG is
97 #     set to a nonempty string.
98 # OVSDB_SERVER_VALGRIND_OPT=""
99
100 # VSWITCHD_OVSDB_SERVER: Method to have ovs-vswitchd initiate a JSON-RPC
101 #     connection to an ovsdb-server instance.
102 # VSWITCHD_OVSDB_SERVER=unix:/var/run/ovsdb-server
103
104 # VSWITCHD_OVSDB_SCHEMA: Schema file to use for generating a new OVSDB
105 #     ovs-vswitchd database.
106 # VSWITCHD_OVSDB_SCHEMA=/usr/share/vswitch/vswitch.ovsschema
107
108 # VSWITCHD_PIDFILE: File in which to store the pid of the running
109 #     ovs-vswitchd.
110 # VSWITCHD_PIDFILE=/var/run/ovs-vswitchd.pid
111
112 # VSWITCHD_RUN_DIR: Set the directory in which ovs-vswitchd should be
113 #     run.  This mainly affects where core files will be placed.
114 # VSWITCHD_RUN_DIR=/var/xen/vswitch
115
116 # VSWITCHD_PRIORITY: "nice" priority at which to run ovs-vswitchd and related
117 #     processes.
118 # VSWITCHD_PRIORITY=-10
119
120 # VSWITCHD_MLOCKALL: Whether to pass ovs-vswitchd the --mlockall option.
121 #     This option should be set to "yes" or "no".  The default is "yes".
122 #     Enabling this option can avoid networking interruptions due to
123 #     system memory pressure in extraordinary situations, such as multiple
124 #     concurrent VM import operations.
125 # VSWITCHD_MLOCKALL=yes
126
127 # VSWITCHD_LOGFILE: File to send the FILE_LOGLEVEL log messages to.
128 # VSWITCHD_LOGFILE=/var/log/ovs-vswitchd.log
129
130 # VSWITCHD_FILE_LOGLEVEL: Log level at which to log into the
131 #     VSWITCHD_LOG file.  If this is null or not set the logfile will
132 #     not be created and nothing will be sent to it.  This is the
133 #     default.  The available options are: EMER, WARN, INFO and DBG.
134 # VSWITCHD_FILE_LOGLEVEL=""
135
136 # VSWITCHD_SYSLOG_LOGLEVEL: Log level at which to log into syslog.  If
137 #     this is null or not set the default is to log to syslog
138 #     emergency and warning level messages only.
139 # VSWITCHD_SYSLOG_LOGLEVEL="WARN"
140
141 # VSWITCHD_MEMLEAK_LOGFILE: File for logging memory leak data.
142 #     Enabling this option will slow ovs-vswitchd significantly.  Do not
143 #     enable it except to debug a suspected memory leak.  Use the
144 #     ovs-parse-leaks utility included with Open vSwitch to parse the
145 #     log file.  For best results, you also need debug symbols.
146 # VSWITCHD_MEMLEAK_LOGFILE=""
147
148 # VSWITCHD_STRACE_LOG: File for logging strace output.
149 #     If this is set to a nonempty string, then ovs-vswitchd will run
150 #     under strace, whose output will be logged to the specified file.
151 #     Enabling this option will slow ovs-vswitchd significantly.
152 #     VSWITCHD_STRACE_LOG and VSWITCHD_VALGRIND_LOG are mutually exclusive.
153 # VSWITCHD_STRACE_LOG=""
154
155 # VSWITCHD_STRACE_OPT: Options to pass to strace.
156 #     This option's value is honored only when VSWITCHD_STRACE_LOG is
157 #     set to a nonempty string.
158 # VSWITCHD_STRACE_OPT=""
159
160 # VSWITCHD_VALGRIND_LOG: File for logging valgrind output.
161 #     If this is set to a nonempty string, then ovs-vswitchd will run
162 #     under valgrind, whose output will be logged to the specified file.
163 #     Enabling this option will slow ovs-vswitchd by 100X or more.
164 #     valgrind is not installed by default on XenServer systems; you must
165 #     install it by hand to usefully enable this option.
166 #     VSWITCHD_STRACE_LOG and VSWITCHD_VALGRIND_LOG are mutually exclusive.
167 # VSWITCHD_VALGRIND_LOG=""
168
169 # VSWITCHD_VALGRIND_OPT: Options to pass to valgrind.
170 #     This option's value is honored only when VSWITCHD_VALGRIND_LOG is
171 #     set to a nonempty string.
172 # VSWITCHD_VALGRIND_OPT=""
173
174 # BRCOMPATD_PIDFILE: File in which to store the pid of the running
175 #     ovs-brcompatd (the Linux bridge compatibility daemon for ovs-vswitchd).
176 #     If this is the empty string, ovs-brcompatd will not be started and
177 #     the brcompat_mod kernel module will not be inserted.  Note that
178 #     the default is to use brcompat!
179 # BRCOMPATD_PIDFILE=/var/run/ovs-brcompatd.pid
180
181 # BRCOMPATD_RUN_DIR: Set the directory in which ovs-brcompatd should be
182 #     run.  This mainly affects where core files will be placed.
183 # BRCOMPATD_RUN_DIR=/var/xen/vswitch
184
185 # BRCOMPATD_PRIORITY: "nice" priority at which to run ovs-vswitchd and related
186 #     processes.
187 # BRCOMPATD_PRIORITY=-10
188
189 # BRCOMPATD_LOGFILE: File to send the FILE_LOGLEVEL log messages to.
190 # BRCOMPATD_LOGFILE=/var/log/ovs-brcompatd.log
191
192 # BRCOMPATD_FILE_LOGLEVEL: Log level at which to log into the
193 #     BRCOMPATD_LOG file.  If this is null or not set the logfile will
194 #     not be created and nothing will be sent to it.  This is the
195 #     default.  The available options are: EMER, WARN, INFO and DBG.
196 # BRCOMPATD_FILE_LOGLEVEL=""
197
198 # BRCOMPATD_SYSLOG_LOGLEVEL: Log level at which to log into syslog.  If
199 #     this is null or not set the default is to log to syslog
200 #     emergency and warning level messages only.
201 # BRCOMPATD_SYSLOG_LOGLEVEL="WARN"
202
203 # BRCOMPATD_MEMLEAK_LOGFILE: File for logging memory leak data.
204 #     Enabling this option will slow ovs-brcompatd significantly.  Do not
205 #     enable it except to debug a suspected memory leak.  Use the
206 #     ovs-parse-leaks utility included with Open vSwitch to parse the
207 #     log file.  For best results, you also need debug symbols.
208 # BRCOMPATD_MEMLEAK_LOGFILE=""
209
210 # BRCOMPATD_STRACE_LOG: File for logging strace output.
211 #     If this is set to a nonempty string, then ovs-brcompatd will run
212 #     under strace, whose output will be logged to the specified file.
213 #     Enabling this option will slow brcompatd significantly.
214 #     BRCOMPATD_STRACE_LOG and BRCOMPATD_VALGRIND_LOG are mutually exclusive.
215 # BRCOMPATD_STRACE_LOG=""
216
217 # BRCOMPATD_STRACE_OPT: Options to pass to strace.
218 #     This option's value is honored only when BRCOMPATD_STRACE_LOG is
219 #     set to a nonempty string.
220 # BRCOMPATD_STRACE_OPT=""
221
222 # BRCOMPATD_VALGRIND_LOG: File for logging valgrind output.
223 #     If this is set to a nonempty string, then ovs-brcompatd will run
224 #     under valgrind, whose output will be logged to the specified file.
225 #     Enabling this option will slow brcompatd by 100X or more.
226 #     valgrind is not installed by default on XenServer systems; you must
227 #     install it by hand to usefully enable this option.
228 #     BRCOMPATD_STRACE_LOG and BRCOMPATD_VALGRIND_LOG are mutually exclusive.
229 # BRCOMPATD_VALGRIND_LOG=""
230
231 # BRCOMPATD_VALGRIND_OPT: Options to pass to valgrind.
232 #     This option's value is honored only when BRCOMPATD_VALGRIND_LOG is
233 #     set to a nonempty string.
234 # BRCOMPATD_VALGRIND_OPT=""