Implement Debian-based packaging and deployment infrastructure.
[sliver-openvswitch.git] / debian / openflow-switch.templates
1 Template: openflow-switch/netdevs
2 Type: multiselect
3 _Choices: ${choices}
4 _Description: OpenFlow switch network devices:
5  Choose the network devices that should become part of the OpenFlow
6  switch.  At least two devices must be selected for this machine to be
7  a useful switch.  Unselecting all network devices will disable the
8  OpenFlow switch entirely.
9  .
10  The network devices that you select should not be configured with IP
11  or IPv6 addresses, even if the switch contacts the controller over
12  one of the selected network devices.  This is because a running
13  OpenFlow switch takes over network devices at a low level: they
14  become part of the switch and cannot be used for other purposes.
15
16 Template: openflow-switch/no-netdevs
17 Type: error
18 _Description: No network devices were selected.
19  No network devices were selected for inclusion in the OpenFlow switch.
20  The switch will be disabled.
21
22 Template: openflow-switch/configured-netdevs
23 Type: note
24 _Description: Some Network Devices Have IP or IPv6 Addresses
25  The following network devices selected to be part of the OpenFlow switch
26  have IP or IPv6 addresses configured:
27  .
28  ${configured-netdevs}
29  .
30  This is usually a mistake, even if the switch contacts the controller over
31  one of the selected network devices.  This is because a running
32  OpenFlow switch takes over network devices at a low level: they
33  become part of the switch and cannot be used for other purposes.
34  .
35  If this is an unintentional mistake, move back and fix the selection,
36  or de-configure the IP or IPv6 from these network devices.
37
38 Template: openflow-switch/band
39 Type: select
40 _Choices: in-band, out-of-band
41 Default: in-band
42 _Description: Switch-to-controller access method:
43  The OpenFlow switch must be able to contact the OpenFlow controller over
44  the network.  It can do so in one of two ways:
45  .
46  in-band: A single network is used for OpenFlow traffic and other data
47  traffic; that is, the switch contacts the controller over one of the
48  network devices selected as OpenFlow switch netdevs in the previous
49  question.  This is the most common case.
50  .
51  out-of-band: OpenFlow traffic uses a network separate from the data traffic
52  that it controls.  If this is the case, the control network must already
53  be configured on a network device other than one of those selected as
54  an OpenFlow switch netdev in the previous question.
55
56 Template: openflow-switch/switch-ip
57 Type: string
58 Default: dhcp
59 _Description: Switch IP address:
60  For in-band communication with the controller, the OpenFlow switch must
61  be able to determine its own IP address.  Its IP address may be configured
62  statically or dynamically.
63  .
64  For static configuration, specify the switch's IP address as a string.
65  .
66  For dynamic configuration with DHCP (the most common case), specify "dhcp".
67  Configuration with DHCP will only work reliably if the network topology
68  allows the switch to contact the DHCP server before it connects to the
69  OpenFlow controller.
70
71 Template: openflow-switch/switch-ip-error
72 Type: error
73 _Description: The switch IP address is invalid.
74  The switch IP address must specified as "dhcp" or a valid IP address in
75  dotted-octet form (e.g. "1.2.3.4").
76
77 Template: openflow-switch/controller-vconn
78 Type: string
79 _Description: Controller location:
80  Specify how the OpenFlow switch should connect to the OpenFlow controller.
81  The value should be in form "ssl:HOST[:PORT]" to connect to the controller
82  over SSL (recommended for security) or "tcp:HOST[:PORT]" to connect over
83  cleartext TCP.
84
85 Template: openflow-switch/controller-vconn-error
86 Type: error
87 _Description: The controller location is invalid.
88  The controller location must be specifed as "ssl:HOST[:PORT]" to
89  connect to the controller over SSL (recommended for security) or
90  "tcp:HOST[:PORT]" to connect over cleartext TCP.
91
92 Template: openflow-switch/pki-host
93 Type: string
94 _Description: OpenFlow PKI server host name:
95  Specify the host name or IP address of the server that hosts the OpenFlow
96  public key infrastructure (PKI).  This is usually the same host as the
97  OpenFlow controller.
98  .
99  The setup process will connect to the OpenFlow PKI server over
100  HTTP, using the system's configured default HTTP proxy (if any).
101
102 Template: openflow-switch/fetch-cacert-failed
103 Type: error
104 _Description: The switch CA certificate could not be retrieved.
105  Retrieval of ${url} failed, with the following status: "${error}".
106  .
107  Ensure that the OpenFlow PKI server is correctly configured and
108  available on ${pki-host}.  If the system is configured to use an HTTP
109  proxy, also make sure that the HTTP proxy is available and that the
110  PKI server can be reached through it.
111
112 Template: openflow-switch/verify-controller-ca
113 Type: select
114 _Choices: yes, no
115 Default: yes
116 _Description: Is ${fingerprint} the controller CA's fingerprint?
117  If a man-in-the-middle attack is possible in your network
118  environment, check that the controller CA's fingerprint is really
119  ${fingerprint}.  Answer "yes" if it matches, "no" if
120  there is a discrepancy.
121  .
122  If a man-in-the-middle attack is not a concern, there is no need to
123  verify the fingerprint.  Simply answer "yes".
124
125 Template: openflow-switch/send-cert-req
126 Type: select
127 _Choices: yes, no
128 Default: yes
129 _Description: Send certificate request to switch CA?
130  Before it can connect to the controller over SSL, the OpenFlow
131  switch's key must be signed by the switch certificate authority (CA)
132  located on the OpenFlow PKI server, which is usually collocated with
133  the OpenFlow controller.  A signing request can be sent to the PKI
134  server now.
135  .
136  Answer "yes" to send a signing request to the switch CA now.  This is
137  ordinarily the correct choice.  There is no harm in sending a given
138  signing request more than once.
139  .
140  Answer "no" to skip sending a signing request to the switch CA.
141  Unless the request has already been sent to the switch CA, manual
142  sending of the request and signing will be necessary.
143
144 Template: openflow-switch/send-cert-req-failed
145 Type: error
146 _Description: The certificate request could not be sent.
147  Posting to ${url} failed, with the following status: "${error}".
148  .
149  Ensure that the OpenFlow PKI server is correctly configured and
150  available on ${pki-host}.
151
152 Template: openflow-switch/fetch-switch-cert
153 Type: select
154 _Choices: yes, no
155 _Description: Fetch signed switch certificate from PKI server?
156  Before it can connect to the controller over SSL, the OpenFlow
157  switch's key must be signed by the switch certificate authority (CA)
158  located on the OpenFlow PKI server, which is usually collocated with
159  the OpenFlow controller.
160  .
161  At this point, a signing request has been sent to the switch CA (or
162  sending a request has been manually skipped), but the signed
163  certificate has not yet been retrieved.  Manual action may need to be
164  taken at the PKI server to approve the signing request.
165  .
166  Answer "yes" to attempt to retrieve the signed switch certificate
167  from the switch CA.  If the switch certificate request has been
168  signed at the PKI server, this is the correct choice.
169  .
170  Answer "no" to postpone switch configuration.  The configuration
171  process must be restarted later, when the switch certificate request
172  has been signed.
173
174 Template: openflow-switch/fetch-switch-cert-failed
175 Type: error
176 _Description: Signed switch certificate could not be retrieved.
177  The signed switch certificate could not be retrieved from the switch
178  CA: retrieval of ${url} failed, with the following status: "${error}".
179  .
180  This probably indicates that the switch's certificate request has not
181  yet been signed.  If this is the problem, it may be fixed by signing
182  the certificate request at ${pki-host}, then trying to fetch the
183  signed switch certificate again.
184
185 Template: openflow-switch/complete
186 Type: note
187 _Description: OpenFlow Switch Setup Finished
188  Setup of this OpenFlow switch is finished.  Complete the setup procedure
189  to enable the switch.