1 # This is a POSIX shell fragment -*- sh -*-
3 # To configure the secure channel, fill in the following properly and
4 # uncomment them. Afterward, the secure channel will come up
5 # automatically at boot time. It can be started immediately with
6 # /etc/init.d/openflow-switch start
7 # Alternatively, use the ofp-switch-setup program (from the
8 # openflow-switch-config package) to do everything automatically.
10 # NETDEVS: Which network devices should the OpenFlow switch include?
12 # List the network devices that should become part of the OpenFlow
13 # switch, separated by spaces. At least two devices must be selected
14 # for this machine to be a useful switch. Unselecting all network
15 # devices will disable the OpenFlow switch entirely.
17 # The network devices that you select should not be configured with IP
18 # or IPv6 addresses, even if the switch contacts the controller over
19 # one of the selected network devices. This is because a running
20 # OpenFlow switch takes over network devices at a low level: they
21 # become part of the switch and cannot be used for other purposes.
24 # MODE: The OpenFlow switch has three modes that determine how it
25 # reaches the controller:
27 # * in-band with discovery: A single network is used for OpenFlow
28 # traffic and other data traffic; that is, the switch contacts the
29 # controller over one of the network devices selected as OpenFlow
30 # switch ports. The switch automatically determines the location of
31 # the controller using a DHCP request with an OpenFlow-specific
32 # vendor option. This is the most common case.
34 # * in-band: As above, but the location of the controller is manually
37 # * out-of-band: OpenFlow traffic uses a network separate from the
38 # data traffic that it controls. If this is the case, the control
39 # network must already be configured on a network device other than
40 # one of those selected as an OpenFlow switch port in the previous
43 # Set MODE to 'discovery', 'in-band', or 'out-of-band' for these
47 # SWITCH_IP: In 'in-band' mode, the switch's IP address may be
48 # configured statically or dynamically:
50 # * For static configuration, specify the switch's IP address as a
51 # string. In this case you may also set SWITCH_NETMASK and
52 # SWITCH_GATEWAY appropriately.
54 # * For dynamic configuration with DHCP (the most common case),
55 # specify "dhcp". Configuration with DHCP will only work reliably
56 # if the network topology allows the switch to contact the DHCP
57 # server before it connects to the OpenFlow controller.
59 # This setting has no effect unless MODE is set to 'in-band'.
61 #SWITCH_NETMASK=255.255.255.0
62 #SWITCH_GATEWAY=192.168.1.1
64 # CONTROLLER: Location of controller.
65 # One of the following formats:
66 # tcp:HOST[:PORT] via TCP to PORT (default: 6633) on HOST
67 # ssl:HOST[:PORT] via SSL to PORT (default: 6633) on HOST
68 # The default below assumes that the controller is running locally.
69 # This setting has no effect when MODE is set to 'discovery'.
70 #CONTROLLER="tcp:127.0.0.1"
72 # PRIVKEY: Name of file containing switch's private key.
73 # Required if SSL enabled.
74 #PRIVKEY=/etc/openflow-switch/of0-privkey.pem
76 # CERT: Name of file containing certificate for private key.
77 # Required if SSL enabled.
78 #CERT=/etc/openflow-switch/of0-cert.pem
80 # CACERT: Name of file containing controller CA certificate.
81 # Required if SSL enabled.
82 #CACERT=/etc/openflow-switch/cacert.pem
84 # CACERT_MODE: Two modes are available:
86 # * secure: The controller CA certificate named in CACERT above must exist.
87 # (You must copy it manually from the PKI server or another trusted source.)
89 # * bootstrap: If the controller CA certificate named in CACERT above does
90 # not exist, the switch will obtain it from the controller the first time
91 # it connects and save a copy to the file named in CACERT. This is insecure,
92 # in the same way that initial connections with ssh are insecure, but
95 # Set CACERT_MODE to 'secure' or 'bootstrap' for these respective cases.
98 # MGMT_VCONNS: List of vconns (space-separated) on which secchan
99 # should listen for management connections from dpctl, etc.
100 # openflow-switchui by default connects to
101 # unix:/var/run/secchan.mgmt, so do not disable this if you want to
102 # use openflow-switchui.
103 MGMT_VCONNS="punix:/var/run/secchan.mgmt"
105 # MONITOR_VCONN: Name of vconn on which secchan should listen for
106 # monitoring connections from dpctl.
107 MONITOR_VCONN="punix:/var/run/secchan.monitor"
109 # COMMANDS: Access control list for the commands that can be executed
110 # remotely over the OpenFlow protocol, as a comma-separated list of
111 # shell glob patterns. Negative patterns (beginning with !) act as a
112 # blacklist. To be executable, a command name must match one positive
113 # pattern and not match any negative patterns.
114 #COMMANDS="reboot,update"
116 # DAEMON_OPTS: Additional options to pass to secchan, e.g. "--fail=open"
119 # CORE_LIMIT: Maximum size for core dumps.
121 # Leaving this unset will use the system default. Setting it to 0
122 # will disable core dumps. Setting it to "unlimited" will dump all
123 # core files regardless of size.
124 #CORE_LIMIT=unlimited
126 # DATAPATH_ID: Identifier for this switch.
128 # By default, the switch generates a new, random datapath ID every time
129 # it starts up. By setting this value, the datapath ID will be consistent
130 # from one run to the next.
132 # Set DATAPATH_ID to a MAC address in the form XX:XX:XX:XX:XX:XX where each
133 # X is a hexadecimal digit (0-9 or a-f).
134 #DATAPATH_ID=XX:XX:XX:XX:XX:XX