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.
31 vsctl="/usr/bin/ovs-vsctl"
32 ofctl="/usr/bin/ovs-ofctl"
33 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
43 def update(session, args):
44 # Refresh bridge network UUIDs in case this host joined or left a pool.
45 script = "/opt/xensource/libexec/interface-reconfigure"
47 retval = subprocess.call([script, "rewrite"])
49 syslog.syslog("%s exited with status %d" % (script, retval))
51 syslog.syslog("%s: failed to execute (%s)" % (script, e.strerror))
53 pools = session.xenapi.pool.get_all()
54 # We assume there is only ever one pool...
56 raise XenAPIPlugin.Failure("NO_POOL_FOR_HOST", [])
58 raise XenAPIPlugin.Failure("MORE_THAN_ONE_POOL_FOR_HOST", [])
59 new_controller = False
60 pool = session.xenapi.pool.get_record(pools[0])
61 controller = pool.get("vswitch_controller", "")
63 currentController = vswitchCurrentController()
64 if controller == "" and currentController != "":
67 emergency_reset(session, None)
71 ret_str += "Successfully removed controller config. "
72 elif controller != currentController:
75 emergency_reset(session, None)
78 setControllerCfg(controller)
80 ret_str += "Successfully set controller to %s. " % controller
83 pool_fail_mode = pool["other_config"]["vswitch-controller-fail-mode"]
89 for rec in session.xenapi.network.get_all_records().values():
91 bton[rec['bridge']] = rec
95 # If new controller, get management MAC addresses from XAPI now
96 # in case fail_mode set to secure which may affect XAPI access
99 host_mgmt_device = None
102 recs = session.xenapi.PIF.get_all_records_where('field "management"="true"')
103 for rec in recs.itervalues():
104 pool_mgmt_macs[rec.get('MAC')] = rec.get('device')
107 fail_mode_changed = False
108 for bridge in vswitchCfgQuery(['list-br']).split():
109 network = bton[bridge]
110 bridge = vswitchCfgQuery(['br-to-parent', bridge])
112 xapi_dib = network['other_config'].get('vswitch-disable-in-band')
116 ovs_dib = vswitchCfgQuery(['--', '--if-exists', 'get', 'Bridge',
118 'other_config:disable-in-band']).strip('"')
120 # Do nothing if setting is invalid, and warn the user.
121 if xapi_dib not in ['true', 'false', '']:
122 ret_str += '"' + xapi_dib + '"' + \
123 ' is an invalid value for vswitch-disable-in-band on ' + \
126 # Change bridge disable-in-band option if XAPI and OVS states differ.
127 elif xapi_dib != ovs_dib:
130 vswitchCfgMod(['--', 'set', 'Bridge', bridge,
131 'other_config:disable-in-band=' + xapi_dib])
134 vswitchCfgMod(['--', 'remove', 'Bridge', bridge,
135 'other_config', 'disable-in-band'])
138 # Change bridge fail_mode if XAPI state differs from OVS state.
139 bridge_fail_mode = vswitchCfgQuery(["get", "Bridge",
140 bridge, "fail_mode"]).strip('[]"')
143 fail_mode = bton[bridge]["other_config"]["vswitch-controller-fail-mode"]
147 if fail_mode not in ['secure', 'standalone']:
148 fail_mode = pool_fail_mode
150 if fail_mode != 'secure':
151 fail_mode = 'standalone'
153 if bridge_fail_mode != fail_mode:
154 vswitchCfgMod(['--', 'set', 'Bridge', bridge,
155 "fail_mode=%s" % fail_mode])
156 fail_mode_changed = True
158 # Determine local mgmt MAC address if host being added to secure
159 # pool so we can add default flows to allow management traffic
160 if new_controller and fail_mode_changed and pool_fail_mode == "secure":
161 oc = vswitchCfgQuery(["get", "Bridge", bridge, "other-config"])
162 m = re.match('.*hwaddr="([0-9a-fA-F:].*)".*', oc)
163 if m and m.group(1) in pool_mgmt_macs.keys():
165 host_mgmt_mac = m.group(1)
166 host_mgmt_device = pool_mgmt_macs[host_mgmt_mac]
168 if host_mgmt_mac is not None and mgmt_bridge is not None and \
169 host_mgmt_device is not None:
170 tp = "idle_timeout=0,priority=0"
171 port = vswitchCfgQuery(["get", "interface", host_mgmt_device, "ofport"])
172 addFlow(mgmt_bridge, "%s,in_port=%s,arp,nw_proto=1,actions=local" % \
174 addFlow(mgmt_bridge, "%s,in_port=local,arp,dl_src=%s,actions=%s" % \
175 (tp, host_mgmt_mac, port))
176 addFlow(mgmt_bridge, "%s,in_port=%s,dl_dst=%s,actions=local" % \
177 (tp, port, host_mgmt_mac))
178 addFlow(mgmt_bridge, "%s,in_port=local,dl_src=%s,actions=%s" % \
179 (tp, host_mgmt_mac, port))
182 ret_str += "Updated in-band management. "
183 if fail_mode_changed:
184 ret_str += "Updated fail_mode. "
189 return "No change to configuration"
191 def vswitchCurrentController():
192 controller = vswitchCfgQuery(["get-manager"])
195 if len(controller) < 4 or controller[0:4] != "ssl:":
198 return controller.split(':')[1]
200 def removeControllerCfg():
201 vswitchCfgMod(["--", "del-manager",
204 def setControllerCfg(controller):
205 # /etc/xensource/xapi-ssl.pem is mentioned twice below because it
206 # contains both the private key and the certificate.
207 vswitchCfgMod(["--", "del-manager",
209 "--", "--bootstrap", "set-ssl",
210 "/etc/xensource/xapi-ssl.pem",
211 "/etc/xensource/xapi-ssl.pem",
213 "--", "set-manager", 'ssl:' + controller + ':6632'])
215 def vswitchCfgQuery(action_args):
216 cmd = [vsctl, "-vconsole:off"] + action_args
217 output = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()
218 if len(output) == 0 or output[0] == None:
221 output = output[0].strip()
224 def vswitchCfgMod(action_args):
225 cmd = [vsctl, "--timeout=5", "-vconsole:off"] + action_args
226 exitcode = subprocess.call(cmd)
228 raise XenAPIPlugin.Failure("VSWITCH_CONFIG_MOD_FAILURE",
229 [ str(exitcode) , str(action_args) ])
231 def emergency_reset(session, args):
232 cmd = [vsctl, "--timeout=5", "emer-reset"]
233 exitcode = subprocess.call(cmd)
235 raise XenAPIPlugin.Failure("VSWITCH_EMER_RESET_FAILURE",
238 return "Successfully reset configuration"
240 def addFlow(switch, flow):
241 cmd = [ofctl, "add-flow", switch, flow]
242 exitcode = subprocess.call(cmd)
244 raise XenAPIPlugin.Failure("VSWITCH_ADD_FLOW_FAILURE",
245 [ str(exitcode) , str(switch), str(flow) ])
247 if __name__ == "__main__":
248 XenAPIPlugin.dispatch({"update": update,
249 "emergency_reset": emergency_reset})