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 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 # FORCE_COREFILES: If 'y' then core files will be enabled.
21 # FORCE_COREFILES=y
22
23 # COREFILE_PATTERN: Pattern used to determine path and filename for
24 #     core files when FORCE_COREFILES is 'y'.  This is Linux specific.
25 #     See the manpage for "core".
26 # COREFILE_PATTERN="/var/log/%e-%t"
27
28 # VSWITCHD_CONF: File in which ovs-vswitchd stores its configuration.
29 # VSWITCHD_CONF=/etc/ovs-vswitchd.conf
30
31 # VSWITCHD_PIDFILE: File in which to store the pid of the running
32 #     ovs-vswitchd.
33 # VSWITCHD_PIDFILE=/var/run/ovs-vswitchd.pid
34
35 # VSWITCHD_RUN_DIR: Set the directory in which ovs-vswitchd should be
36 #     run.  This mainly affects where core files will be placed.
37 # VSWITCHD_RUN_DIR=/var/xen/vswitch
38
39 # VSWITCHD_PRIORITY: "nice" priority at which to run ovs-vswitchd and related
40 #     processes.
41 # VSWITCHD_PRIORITY=-10
42
43 # VSWITCHD_LOGFILE: File to send the FILE_LOGLEVEL log messages to.
44 # VSWITCHD_LOGFILE=/var/log/ovs-vswitchd.log
45
46 # VSWITCHD_MEMLEAK_LOGFILE: File for logging memory leak data.
47 #     Enabling this option will slow ovs-vswitchd significantly.  Do not
48 #     enable it except to debug a suspected memory leak.  Use the
49 #     ovs-parse-leaks utility included with Open vSwitch to parse the
50 #     log file.  For best results, you also need debug symbols.
51 # VSWITCHD_MEMLEAK_LOGFILE=""
52
53 # VSWITCHD_FILE_LOGLEVEL: Log level at which to log into the
54 #     VSWITCHD_LOG file.  If this is null or not set the logfile will
55 #     not be created and nothing will be sent to it.  This is the
56 #     default.  The available options are: EMER, WARN, INFO and DBG.
57 # VSWITCHD_FILE_LOGLEVEL=""
58
59 # VSWITCHD_SYSLOG_LOGLEVEL: Log level at which to log into syslog.  If
60 #     this is null or not set the default is to log to syslog
61 #     emergency and warning level messages only.
62 # VSWITCHD_SYSLOG_LOGLEVEL="WARN"
63
64 # VSWITCHD_STRACE_LOG: File for logging strace output.
65 #     If this is set to a nonempty string, then ovs-vswitchd will run
66 #     under strace, whose output will be logged to the specified file.
67 #     Enabling this option will slow ovs-vswitchd significantly.
68 #     VSWITCHD_STRACE_LOG and VSWITCHD_VALGRIND_LOG are mutually exclusive.
69 # VSWITCHD_STRACE_LOG=""
70
71 # VSWITCHD_STRACE_OPT: Options to pass to strace.
72 #     This option's value is honored only when VSWITCHD_STRACE_LOG is
73 #     set to a nonempty string.
74 # VSWITCHD_STRACE_OPT=""
75
76 # VSWITCHD_VALGRIND_LOG: File for logging valgrind output.
77 #     If this is set to a nonempty string, then ovs-vswitchd will run
78 #     under valgrind, whose output will be logged to the specified file.
79 #     Enabling this option will slow ovs-vswitchd by 100X or more.
80 #     valgrind is not installed by default on XenServer systems; you must
81 #     install it by hand to usefully enable this option.
82 #     VSWITCHD_STRACE_LOG and VSWITCHD_VALGRIND_LOG are mutually exclusive.
83 # VSWITCHD_VALGRIND_LOG=""
84
85 # VSWITCHD_VALGRIND_OPT: Options to pass to valgrind.
86 #     This option's value is honored only when VSWITCHD_VALGRIND_LOG is
87 #     set to a nonempty string.
88 # VSWITCHD_VALGRIND_OPT=""
89
90 # BRCOMPATD_PIDFILE: File in which to store the pid of the running
91 #     ovs-brcompatd (the Linux bridge compatibility daemon for ovs-vswitchd).
92 #     If this is the empty string, ovs-brcompatd will not be started and
93 #     the brcompat_mod kernel module will not be inserted.  Note that
94 #     the default is to use brcompat!
95 # BRCOMPATD_PIDFILE=/var/run/ovs-brcompatd.pid
96
97 # BRCOMPATD_RUN_DIR: Set the directory in which ovs-brcompatd should be
98 #     run.  This mainly affects where core files will be placed.
99 # BRCOMPATD_RUN_DIR=/var/xen/vswitch
100
101 # BRCOMPATD_PRIORITY: "nice" priority at which to run ovs-vswitchd and related
102 #     processes.
103 # BRCOMPATD_PRIORITY=-10
104
105 # BRCOMPATD_LOGFILE: File to send the FILE_LOGLEVEL log messages to.
106 # BRCOMPATD_LOGFILE=/var/log/ovs-brcompatd.log
107
108 # BRCOMPATD_FILE_LOGLEVEL: Log level at which to log into the
109 #     BRCOMPATD_LOG file.  If this is null or not set the logfile will
110 #     not be created and nothing will be sent to it.  This is the
111 #     default.  The available options are: EMER, WARN, INFO and DBG.
112 # BRCOMPATD_FILE_LOGLEVEL=""
113
114 # BRCOMPATD_SYSLOG_LOGLEVEL: Log level at which to log into syslog.  If
115 #     this is null or not set the default is to log to syslog
116 #     emergency and warning level messages only.
117 # BRCOMPATD_SYSLOG_LOGLEVEL="WARN"
118
119 # BRCOMPATD_MEMLEAK_LOGFILE: File for logging memory leak data.
120 #     Enabling this option will slow ovs-brcompatd significantly.  Do not
121 #     enable it except to debug a suspected memory leak.  Use the
122 #     ovs-parse-leaks utility included with Open vSwitch to parse the
123 #     log file.  For best results, you also need debug symbols.
124 # BRCOMPATD_MEMLEAK_LOGFILE=""
125
126 # BRCOMPATD_STRACE_LOG: File for logging strace output.
127 #     If this is set to a nonempty string, then ovs-brcompatd will run
128 #     under strace, whose output will be logged to the specified file.
129 #     Enabling this option will slow brcompatd significantly.
130 #     BRCOMPATD_STRACE_LOG and BRCOMPATD_VALGRIND_LOG are mutually exclusive.
131 # BRCOMPATD_STRACE_LOG=""
132
133 # BRCOMPATD_STRACE_OPT: Options to pass to strace.
134 #     This option's value is honored only when BRCOMPATD_STRACE_LOG is
135 #     set to a nonempty string.
136 # BRCOMPATD_STRACE_OPT=""
137
138 # BRCOMPATD_VALGRIND_LOG: File for logging valgrind output.
139 #     If this is set to a nonempty string, then ovs-brcompatd will run
140 #     under valgrind, whose output will be logged to the specified file.
141 #     Enabling this option will slow brcompatd by 100X or more.
142 #     valgrind is not installed by default on XenServer systems; you must
143 #     install it by hand to usefully enable this option.
144 #     BRCOMPATD_STRACE_LOG and BRCOMPATD_VALGRIND_LOG are mutually exclusive.
145 # BRCOMPATD_VALGRIND_LOG=""
146
147 # BRCOMPATD_VALGRIND_OPT: Options to pass to valgrind.
148 #     This option's value is honored only when BRCOMPATD_VALGRIND_LOG is
149 #     set to a nonempty string.
150 # BRCOMPATD_VALGRIND_OPT=""