debian/openflow-switch.template

   1 # This is a POSIX shell fragment                -*- sh -*-
   2
   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.
   9
  10 # NETDEVS: Which network devices should the OpenFlow switch include?
  11 #
  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.
  16 #
  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.
  22 #NETDEVS=""
  23
  24 # MODE: The OpenFlow switch has three modes that determine how it
  25 # reaches the controller:
  26 #
  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.
  33 #
  34 # * in-band: As above, but the location of the controller is manually
  35 #   configured.
  36 #
  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
  41 #   question.
  42 #
  43 # Set MODE to 'discovery', 'in-band', or 'out-of-band' for these
  44 # respective cases.
  45 MODE=discovery
  46
  47 # SWITCH_IP: In 'in-band' mode, the switch's IP address may be
  48 # configured statically or dynamically:
  49 #
  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 (see below).
  53 #
  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.
  58 #
  59 # This setting has no effect unless MODE is set to 'in-band'.
  60 SWITCH_IP=dhcp
  61
  62 # SWITCH_NETMASK: IP netmask to use in 'in-band' mode when the switch
  63 # IP address is not 'dhcp'.
  64 #SWITCH_NETMASK=255.255.255.0
  65
  66 # SWITCH_GATEWAY: IP gateway to use in 'in-band' mode when the switch
  67 # IP address is not 'dhcp'.
  68 #SWITCH_GATEWAY=192.168.1.1
  69
  70 # CONTROLLER: Location of controller.
  71 # One of the following formats:
  72 #  tcp:HOST[:PORT]         via TCP to PORT (default: 6633) on HOST
  73 #  ssl:HOST[:PORT]         via SSL to PORT (default: 6633) on HOST
  74 # The default below assumes that the controller is running locally.
  75 # This setting has no effect when MODE is set to 'discovery'.
  76 #CONTROLLER="tcp:127.0.0.1"
  77
  78 # PRIVKEY: Name of file containing switch's private key.
  79 # Required if SSL enabled.
  80 #PRIVKEY=/etc/openflow-switch/of0-privkey.pem
  81
  82 # CERT: Name of file containing certificate for private key.
  83 # Required if SSL enabled.
  84 #CERT=/etc/openflow-switch/of0-cert.pem
  85
  86 # CACERT: Name of file containing controller CA certificate.
  87 # Required if SSL enabled.
  88 #CACERT=/etc/openflow-switch/cacert.pem
  89
  90 # CACERT_MODE: Two modes are available:
  91 #
  92 # * secure: The controller CA certificate named in CACERT above must exist.
  93 #   (You must copy it manually from the PKI server or another trusted source.)
  94 #
  95 # * bootstrap: If the controller CA certificate named in CACERT above does
  96 #   not exist, the switch will obtain it from the controller the first time
  97 #   it connects and save a copy to the file named in CACERT.  This is insecure,
  98 #   in the same way that initial connections with ssh are insecure, but
  99 #   it is convenient.
 100 #
 101 # Set CACERT_MODE to 'secure' or 'bootstrap' for these respective cases.
 102 #CACERT_MODE=secure
 103
 104 # MGMT_VCONNS: List of vconns (space-separated) on which secchan
 105 # should listen for management connections from dpctl, etc.
 106 # openflow-switchui by default connects to
 107 # unix:/var/run/secchan.mgmt, so do not disable this if you want to
 108 # use openflow-switchui.
 109 MGMT_VCONNS="punix:/var/run/secchan.mgmt"
 110
 111 # MONITOR_VCONN:  Name of vconn on which secchan should listen for
 112 # monitoring connections from dpctl.
 113 MONITOR_VCONN="punix:/var/run/secchan.monitor"
 114
 115 # COMMANDS: Access control list for the commands that can be executed
 116 # remotely over the OpenFlow protocol, as a comma-separated list of
 117 # shell glob patterns.  Negative patterns (beginning with !) act as a
 118 # blacklist.  To be executable, a command name must match one positive
 119 # pattern and not match any negative patterns.
 120 #COMMANDS="reboot,update"
 121
 122 # DISCONNECTED_MODE: Switch behavior when attempts to connect to the
 123 # controller repeatedly fail, either 'switch', to act as an L2 switch
 124 # in this case, or 'drop', to drop all packets (except those necessary
 125 # to connect to the controller).  If unset, the default is 'drop'.
 126 #DISCONNECTED_MODE=switch
 127
 128 # STP: Enable or disabled 802.1D-1998 Spanning Tree Protocol.  Set to
 129 # 'yes' to enable STP, 'no' to disable it.  If unset, secchan's
 130 # current default is 'no' (but this may change in the future).
 131 #STP=no
 132
 133 # RATE_LIMIT: Maximum number of received frames, that do not match any
 134 # existing switch flow, to forward up to the controller per second.
 135 # The valid range is 100 and up.  If unset, this rate will not be
 136 # limited.
 137 #RATE_LIMIT=1000
 138
 139 # INACTIVITY_PROBE: The maximum number of seconds of inactivity on the
 140 # controller connection before secchan sends an inactivity probe
 141 # message to the controller.  The valid range is 5 and up.  If unset,
 142 # secchan defaults to 15 seconds.
 143 #INACTIVITY_PROBE=5
 144
 145 # MAX_BACKOFF: The maximum time that secchan will wait between
 146 # attempts to connect to the controller.  The valid range is 1 and up.
 147 # If unset, secchan defaults to 15 seconds.
 148 #MAX_BACKOFF=15
 149
 150 # DAEMON_OPTS: Additional options to pass to secchan, e.g. "--fail=open"
 151 DAEMON_OPTS=""
 152
 153 # CORE_LIMIT: Maximum size for core dumps.
 154 #
 155 # Leaving this unset will use the system default.  Setting it to 0
 156 # will disable core dumps.  Setting it to "unlimited" will dump all
 157 # core files regardless of size.
 158 #CORE_LIMIT=unlimited
 159
 160 # DATAPATH_ID: Identifier for this switch.
 161 #
 162 # By default, the switch generates a new, random datapath ID every time
 163 # it starts up.  By setting this value, the datapath ID will be consistent
 164 # from one run to the next.
 165 #
 166 # Set DATAPATH_ID to a MAC address in the form XX:XX:XX:XX:XX:XX where each
 167 # X is a hexadecimal digit (0-9 or a-f).
 168 #DATAPATH_ID=XX:XX:XX:XX:XX:XX