xenserver/usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py

   1 # Copyright (c) Citrix Systems 2008. All rights reserved.
   2 # xsconsole is proprietary software.
   3 #
   4 # Xen, the Xen logo, XenCenter, XenMotion are trademarks or registered
   5 # trademarks of Citrix Systems, Inc., in the United States and other
   6 # countries.
   7
   8 # Copyright (c) 2009, 2010 Nicira Networks.
   9
  10 from XSConsoleLog import *
  11
  12 import os
  13 import socket
  14 import subprocess
  15
  16 vsctl="/usr/bin/ovs-vsctl"
  17
  18 if __name__ == "__main__":
  19     raise Exception("This script is a plugin for xsconsole and cannot run independently")
  20
  21 from XSConsoleStandard import *
  22
  23 class VSwitchService:
  24     service = {}
  25
  26     def __init__(self, name, processname=None):
  27         self.name = name
  28         self.processname = processname
  29         if self.processname == None:
  30             self.processname = name
  31
  32     def version(self):
  33         try:
  34             output = ShellPipe(["service", self.name, "version"]).Stdout()
  35         except StandardError, e:
  36             XSLogError("vswitch version retrieval error: " + str(e))
  37             return "<unknown>"
  38         for line in output:
  39             if self.processname in line:
  40                 return line.split()[-1]
  41         return "<unknown>"
  42
  43     def status(self):
  44         try:
  45             output = ShellPipe(["service", self.name, "status"]).Stdout()
  46         except StandardError, e:
  47             XSLogError("vswitch status retrieval error: " + str(e))
  48             return "<unknown>"
  49         if len(output) == 0:
  50             return "<unknown>"
  51         for line in output:
  52             if self.processname not in line:
  53                 continue
  54             elif "running" in line:
  55                 return "Running"
  56             elif "stop" in line:
  57                 return "Stopped"
  58             else:
  59                 return "<unknown>"
  60         return "<unknown>"
  61
  62     def restart(self):
  63         try:
  64             ShellPipe(["service", self.name, "restart"]).Call()
  65         except StandardError, e:
  66             XSLogError("vswitch restart error: " + str(e))
  67
  68     @classmethod
  69     def Inst(cls, name, processname=None):
  70         key = name
  71         if processname != None:
  72             key = key + "-" + processname
  73         if name not in cls.service:
  74             cls.service[key] = VSwitchService(name, processname)
  75         return cls.service[key]
  76
  77 class VSwitchConfig:
  78
  79     @staticmethod
  80     def Get(action):
  81         try:
  82             arg = [vsctl, "-vANY:console:emer"] + action.split()
  83             output = ShellPipe(arg).Stdout()
  84         except StandardError, e:
  85             XSLogError("config retrieval error: " + str(e))
  86             return "<unknown>"
  87
  88         if len(output) == 0:
  89             output = ""
  90         else:
  91             output = output[0].strip()
  92         return output
  93
  94
  95 class VSwitchControllerDialogue(Dialogue):
  96     def __init__(self):
  97         Dialogue.__init__(self)
  98         data=Data.Inst()
  99
 100         self.hostsInPool = 0
 101         self.hostsUpdated = 0
 102         pool = data.GetPoolForThisHost()
 103         if pool is not None:
 104             self.controller = pool.get("other_config", {}).get("vSwitchController", "")
 105         else:
 106             self.controller = ""
 107
 108         choiceDefs = [
 109             ChoiceDef(Lang("Set pool-wide controller"),
 110                       lambda: self.getController()),
 111             ChoiceDef(Lang("Delete pool-wide controller"),
 112                       lambda: self.deleteController()),
 113             ChoiceDef(Lang("Resync server controller config"),
 114                       lambda: self.syncController()),
 115 #             ChoiceDef(Lang("Restart ovs-vswitchd"),
 116 #                       lambda: self.restartService("vswitch")),
 117 #             ChoiceDef(Lang("Restart ovs-brcompatd"),
 118 #                       lambda: self.restartService("vswitch-brcompatd"))
 119             ]
 120         self.menu = Menu(self, None, Lang("Configure vSwitch"), choiceDefs)
 121
 122         self.ChangeState("INITIAL")
 123
 124     def BuildPane(self):
 125         pane = self.NewPane(DialoguePane(self.parent))
 126         pane.TitleSet(Lang("Configure vSwitch"))
 127         pane.AddBox()
 128
 129     def ChangeState(self, inState):
 130         self.state = inState
 131         self.BuildPane()
 132         self.UpdateFields()
 133
 134     def UpdateFields(self):
 135         self.Pane().ResetPosition()
 136         getattr(self, "UpdateFields" + self.state)() # Dispatch method named 'UpdateFields'+self.state
 137
 138     def UpdateFieldsINITIAL(self):
 139         pane = self.Pane()
 140         pane.AddTitleField(Lang("Select an action"))
 141         pane.AddMenuField(self.menu)
 142         pane.AddKeyHelpField( { Lang("<Enter>") : Lang("OK"), Lang("<Esc>") : Lang("Cancel") } )
 143
 144     def UpdateFieldsGETCONTROLLER(self):
 145         pane = self.Pane()
 146         pane.ResetFields()
 147
 148         pane.AddTitleField(Lang("Enter IP address of controller"))
 149         pane.AddInputField(Lang("Address", 16), self.controller, "address")
 150         pane.AddKeyHelpField( { Lang("<Enter>") : Lang("OK"), Lang("<Esc>") : Lang("Exit") } )
 151         if pane.CurrentInput() is None:
 152             pane.InputIndexSet(0)
 153
 154     def HandleKey(self, inKey):
 155         handled = False
 156         if hasattr(self, "HandleKey" + self.state):
 157             handled = getattr(self, "HandleKey" + self.state)(inKey)
 158         if not handled and inKey == 'KEY_ESCAPE':
 159             Layout.Inst().PopDialogue()
 160             handled = True
 161         return handled
 162
 163     def HandleKeyINITIAL(self, inKey):
 164         return self.menu.HandleKey(inKey)
 165
 166     def HandleKeyGETCONTROLLER(self, inKey):
 167         pane = self.Pane()
 168         if pane.CurrentInput() is None:
 169             pane.InputIndexSet(0)
 170         if inKey == 'KEY_ENTER':
 171             inputValues = pane.GetFieldValues()
 172             self.controller = inputValues['address']
 173             Layout.Inst().PopDialogue()
 174
 175             # Make sure the controller is specified as a valid dotted quad
 176             try:
 177                 socket.inet_aton(self.controller)
 178             except socket.error:
 179                 Layout.Inst().PushDialogue(InfoDialogue(Lang("Please enter in dotted quad format")))
 180                 return True
 181
 182             Layout.Inst().TransientBanner(Lang("Setting controller..."))
 183             try:
 184                 self.SetController(self.controller)
 185                 Layout.Inst().PushDialogue(InfoDialogue(Lang("Setting controller successful")))
 186             except Exception, e:
 187                 Layout.Inst().PushDialogue(InfoDialogue(Lang("Setting controller failed")))
 188
 189             self.ChangeState("INITIAL")
 190             return True
 191         else:
 192             return pane.CurrentInput().HandleKey(inKey)
 193
 194     def restartService(self, name):
 195         s = VSwitchService.Inst(name)
 196         s.restart()
 197         Layout.Inst().PopDialogue()
 198
 199     def getController(self):
 200         self.ChangeState("GETCONTROLLER")
 201         self.Pane().InputIndexSet(0)
 202
 203     def deleteController(self):
 204         self.controller = ""
 205         Layout.Inst().PopDialogue()
 206         Layout.Inst().TransientBanner(Lang("Deleting controller..."))
 207         try:
 208             self.SetController(None)
 209             Layout.Inst().PushDialogue(InfoDialogue(Lang("Controller deletion successful")))
 210         except Exception, e:
 211             Layout.Inst().PushDialogue(InfoDialogue(Lang("Controller deletion failed")))
 212
 213     def syncController(self):
 214         Layout.Inst().PopDialogue()
 215         Layout.Inst().TransientBanner(Lang("Resyncing controller setting..."))
 216         try:
 217             Task.Sync(lambda s: self._updateThisServer(s))
 218             Layout.Inst().PushDialogue(InfoDialogue(Lang("Resyncing controller config successful")))
 219         except Exception, e:
 220             Layout.Inst().PushDialogue(InfoDialogue(Lang("Resyncing controller config failed")))
 221
 222     def SetController(self, ip):
 223         self.hostsInPool = 0
 224         self.hostsUpdated = 0
 225         Task.Sync(lambda s: self._modifyPoolConfig(s, "vSwitchController", ip))
 226         # Should be done asynchronously, maybe with an external script?
 227         Task.Sync(lambda s: self._updateActiveServers(s))
 228
 229     def _modifyPoolConfig(self, session, key, value):
 230         """Modify pool configuration.
 231
 232         If value == None then delete key, otherwise set key to value."""
 233         pools = session.xenapi.pool.get_all()
 234         # We assume there is only ever one pool...
 235         if len(pools) == 0:
 236             log.error("No pool for host.")
 237             raise XenAPIPlugin.Failure("NO_POOL_FOR_HOST", [])
 238         if len(pools) > 1:
 239             log.error("More than one pool for host.")
 240             raise XenAPIPlugin.Failure("MORE_THAN_ONE_POOL_FOR_HOST", [])
 241         session.xenapi.pool.remove_from_other_config(pools[0], key)
 242         if value != None:
 243             session.xenapi.pool.add_to_other_config(pools[0], key, value)
 244         Data.Inst().Update()
 245
 246     def _updateActiveServers(self, session):
 247         hosts = session.xenapi.host.get_all()
 248         self.hostsUpdated = 0
 249         self.hostsInPool = len(hosts)
 250         self.UpdateFields()
 251         for host in hosts:
 252             Layout.Inst().TransientBanner("Updating host %d out of %d"
 253                     % (self.hostsUpdated + 1, self.hostsInPool))
 254             session.xenapi.host.call_plugin(host, "vswitch-cfg-update", "update", {})
 255             self.hostsUpdated = self.hostsUpdated + 1
 256
 257     def _updateThisServer(self, session):
 258         data = Data.Inst()
 259         host = data.host.opaqueref()
 260         session.xenapi.host.call_plugin(host, "vswitch-cfg-update", "update", {})
 261
 262
 263 class XSFeatureVSwitch:
 264
 265     @classmethod
 266     def StatusUpdateHandler(cls, inPane):
 267         data = Data.Inst()
 268
 269         inPane.AddTitleField(Lang("vSwitch"))
 270
 271         inPane.NewLine()
 272
 273         inPane.AddStatusField(Lang("Version", 20),
 274                               VSwitchService.Inst("vswitch", "ovs-vswitchd").version())
 275
 276         inPane.NewLine()
 277
 278         pool = data.GetPoolForThisHost()
 279         if pool is not None:
 280             dbController = pool.get("other_config", {}).get("vSwitchController", "")
 281         else:
 282             dbController = ""
 283
 284         if dbController == "":
 285             dbController = Lang("<None>")
 286         inPane.AddStatusField(Lang("Controller (config)", 20), dbController)
 287         controller = VSwitchConfig.Get("get Open_vSwitch . managers")
 288         controller = controller.strip('[]"')
 289
 290         if controller == "":
 291             controller = Lang("<None>")
 292         elif controller[0:4] == "ssl:":
 293             controller = controller.split(':')[1]
 294         inPane.AddStatusField(Lang("Controller (in-use)", 20), controller)
 295
 296         inPane.NewLine()
 297         inPane.AddStatusField(Lang("ovs-vswitchd status", 20),
 298                               VSwitchService.Inst("vswitch", "ovs-vswitchd").status())
 299         inPane.AddStatusField(Lang("ovsdb-server status", 20),
 300                               VSwitchService.Inst("vswitch", "ovsdb-server").status())
 301         inPane.AddStatusField(Lang("ovs-brcompatd status", 20),
 302                               VSwitchService.Inst("vswitch", "ovs-brcompatd").status())
 303
 304         inPane.AddKeyHelpField( {
 305             Lang("<Enter>") : Lang("Reconfigure"),
 306             Lang("<F5>") : Lang("Refresh")
 307         })
 308
 309     @classmethod
 310     def ActivateHandler(cls):
 311         DialogueUtils.AuthenticatedOnly(lambda: Layout.Inst().PushDialogue(VSwitchControllerDialogue()))
 312
 313     def Register(self):
 314         Importer.RegisterNamedPlugIn(
 315             self,
 316             'VSwitch', # Key of this plugin for replacement, etc.
 317             {
 318                 'menuname' : 'MENU_NETWORK',
 319                 'menupriority' : 800,
 320                 'menutext' : Lang('vSwitch') ,
 321                 'statusupdatehandler' : self.StatusUpdateHandler,
 322                 'activatehandler' : self.ActivateHandler
 323             }
 324         )
 325
 326 # Register this plugin when module is imported
 327 XSFeatureVSwitch().Register()