3 # xapi plugin script to update the cache of configuration items in the
4 # ovs-vswitchd configuration that are managed in the xapi database when
5 # integrated with Citrix management tools.
7 # Copyright (C) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
9 # Licensed under the Apache License, Version 2.0 (the "License");
10 # you may not use this file except in compliance with the License.
11 # You may obtain a copy of the License at:
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 # See the License for the specific language governing permissions and
19 # limitations under the License.
21 # TBD: - error handling needs to be improved. Currently this can leave
22 # TBD: the system in a bad state if anything goes wrong.
30 vsctl = '/usr/bin/ovs-vsctl'
31 ofctl = '/usr/bin/ovs-ofctl'
32 cacert_filename = '/etc/openvswitch/vswitchd.cacert'
35 # Delete the CA certificate, so that we go back to boot-strapping mode
38 os.remove(cacert_filename)
40 # Ignore error if file doesn't exist
44 def update(session, args):
45 # Refresh bridge network UUIDs in case this host joined or left a pool.
46 script = '/opt/xensource/libexec/interface-reconfigure'
48 retval = subprocess.call([script, 'rewrite'])
50 syslog.syslog('%s exited with status %d' % (script, retval))
52 syslog.syslog('%s: failed to execute (%s)' % (script, e.strerror))
54 pools = session.xenapi.pool.get_all()
55 # We assume there is only ever one pool...
57 raise XenAPIPlugin.Failure('NO_POOL_FOR_HOST', [])
59 raise XenAPIPlugin.Failure('MORE_THAN_ONE_POOL_FOR_HOST', [])
60 new_controller = False
61 pool = session.xenapi.pool.get_record(pools[0])
62 controller = pool.get('vswitch_controller')
64 currentControllers = vswitchCurrentControllers()
66 if not controller and currentControllers:
69 emergency_reset(session, None)
73 ret_str += 'Successfully removed controller config. '
74 # controller cannot be empty, otherwise, this will always be True.
75 elif controller and controller not in currentControllers:
78 emergency_reset(session, None)
81 setControllerCfg(controller)
83 ret_str += 'Successfully set controller to %s. ' % controller
86 pool_fail_mode = pool['other_config']['vswitch-controller-fail-mode']
92 for rec in session.xenapi.network.get_all_records().values():
94 bton[rec['bridge']] = rec
98 # If new controller, get management MAC addresses from XAPI now
99 # in case fail_mode set to secure which may affect XAPI access
102 host_mgmt_device = None
105 query = 'field "management"="true"'
106 recs = session.xenapi.PIF.get_all_records_where(query)
107 for rec in recs.itervalues():
108 pool_mgmt_macs[rec.get('MAC')] = rec.get('device')
111 fail_mode_changed = False
112 for bridge in vswitchCfgQuery(['list-br']).split():
113 network = bton[bridge]
114 bridge = vswitchCfgQuery(['br-to-parent', bridge])
116 xapi_dib = network['other_config'].get('vswitch-disable-in-band')
120 ovs_dib = vswitchCfgQuery(['--', '--if-exists', 'get', 'Bridge',
122 'other_config:disable-in-band']).strip('"')
124 # Do nothing if setting is invalid, and warn the user.
125 if xapi_dib not in ['true', 'false', '']:
126 ret_str += '"' + xapi_dib + '"' + \
127 ' is an invalid value for vswitch-disable-in-band on ' + \
130 # Change bridge disable-in-band option if XAPI and OVS states differ.
131 elif xapi_dib != ovs_dib:
134 vswitchCfgMod(['--', 'set', 'Bridge', bridge,
135 'other_config:disable-in-band=' + xapi_dib])
138 vswitchCfgMod(['--', 'remove', 'Bridge', bridge,
139 'other_config', 'disable-in-band'])
142 # Change bridge fail_mode if XAPI state differs from OVS state.
143 bridge_fail_mode = vswitchCfgQuery(['get', 'Bridge',
144 bridge, 'fail_mode']).strip('[]"')
147 other_config = bton[bridge]['other_config']
148 fail_mode = other_config['vswitch-controller-fail-mode']
152 if fail_mode not in ['secure', 'standalone']:
153 fail_mode = pool_fail_mode
155 if fail_mode != 'secure':
156 fail_mode = 'standalone'
158 if bridge_fail_mode != fail_mode:
159 vswitchCfgMod(['--', 'set', 'Bridge', bridge,
160 'fail_mode=%s' % fail_mode])
161 fail_mode_changed = True
163 # Determine local mgmt MAC address if host being added to secure
164 # pool so we can add default flows to allow management traffic
165 if new_controller and fail_mode_changed and pool_fail_mode == 'secure':
166 oc = vswitchCfgQuery(['get', 'Bridge', bridge, 'other-config'])
167 m = re.match('.*hwaddr="([0-9a-fA-F:].*)".*', oc)
168 if m and m.group(1) in pool_mgmt_macs.keys():
170 host_mgmt_mac = m.group(1)
171 host_mgmt_device = pool_mgmt_macs[host_mgmt_mac]
173 if (host_mgmt_mac is not None and mgmt_bridge is not None and
174 host_mgmt_device is not None):
175 tp = 'idle_timeout=0,priority=0'
176 port = vswitchCfgQuery(['get', 'interface', host_mgmt_device,
179 addFlow(mgmt_bridge, '%s,in_port=%s,arp,nw_proto=1,actions=local' %
181 addFlow(mgmt_bridge, '%s,in_port=local,arp,dl_src=%s,actions=%s' %
182 (tp, host_mgmt_mac, port))
183 addFlow(mgmt_bridge, '%s,in_port=%s,dl_dst=%s,actions=local' %
184 (tp, port, host_mgmt_mac))
185 addFlow(mgmt_bridge, '%s,in_port=local,dl_src=%s,actions=%s' %
186 (tp, host_mgmt_mac, port))
189 ret_str += 'Updated in-band management. '
190 if fail_mode_changed:
191 ret_str += 'Updated fail_mode. '
196 return 'No change to configuration'
199 def vswitchCurrentControllers():
200 controllers = vswitchCfgQuery(['get-manager'])
202 def parse_controller(controller):
203 if controller.startswith('ssl:'):
204 return controller.split(':')[1]
206 return controller.split(':')[0]
208 return [parse_controller(controller)
209 for controller in controllers.split('\n')
213 def removeControllerCfg():
214 vswitchCfgMod(['--', 'del-manager',
218 def setControllerCfg(controller):
219 # /etc/xensource/xapi-ssl.pem is mentioned twice below because it
220 # contains both the private key and the certificate.
221 vswitchCfgMod(['--', 'del-manager',
223 '--', '--bootstrap', 'set-ssl',
224 '/etc/xensource/xapi-ssl.pem',
225 '/etc/xensource/xapi-ssl.pem',
227 '--', 'set-manager', 'ssl:' + controller + ':6640'])
230 def vswitchCfgQuery(action_args):
231 cmd = [vsctl, '-vconsole:off'] + action_args
232 output = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()
233 if len(output) == 0 or output[0] is None:
236 output = output[0].strip()
240 def vswitchCfgMod(action_args):
241 cmd = [vsctl, '--timeout=5', '-vconsole:off'] + action_args
242 exitcode = subprocess.call(cmd)
244 raise XenAPIPlugin.Failure('VSWITCH_CONFIG_MOD_FAILURE',
245 [str(exitcode), str(action_args)])
248 def emergency_reset(session, args):
249 cmd = [vsctl, '--timeout=5', 'emer-reset']
250 exitcode = subprocess.call(cmd)
252 raise XenAPIPlugin.Failure('VSWITCH_EMER_RESET_FAILURE',
255 return 'Successfully reset configuration'
258 def addFlow(switch, flow):
259 cmd = [ofctl, 'add-flow', switch, flow]
260 exitcode = subprocess.call(cmd)
262 raise XenAPIPlugin.Failure('VSWITCH_ADD_FLOW_FAILURE',
263 [str(exitcode), str(switch), str(flow)])
266 if __name__ == '__main__':
267 XenAPIPlugin.dispatch({'update': update,
268 'emergency_reset': emergency_reset})