code.grnet.gr Git - ganeti-local/blob - lib/rpc_defs.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21 """RPC definitions for communication between master and node daemons.
  22
  23 RPC definition fields:
  24
  25   - Name as string
  26   - L{SINGLE} for single-node calls, L{MULTI} for multi-node
  27   - Name resolver option(s), can be callable receiving all arguments in a tuple
  28   - Timeout (e.g. L{constants.RPC_TMO_NORMAL}), or callback receiving all
  29     arguments in a tuple to calculate timeout
  30   - List of arguments as tuples
  31
  32     - Name as string
  33     - Argument kind used for encoding/decoding
  34     - Description for docstring (can be C{None})
  35
  36   - Custom body encoder (e.g. for preparing per-node bodies)
  37   - Return value wrapper (e.g. for deserializing into L{objects}-based objects)
  38   - Short call description for docstring
  39
  40 """
  41
  42 from ganeti import constants
  43 from ganeti import utils
  44 from ganeti import objects
  45
  46
  47 # Guidelines for choosing timeouts:
  48 # - call used during watcher: timeout of 1min, constants.RPC_TMO_URGENT
  49 # - trivial (but be sure it is trivial)
  50 #     (e.g. reading a file): 5min, constants.RPC_TMO_FAST
  51 # - other calls: 15 min, constants.RPC_TMO_NORMAL
  52 # - special calls (instance add, etc.):
  53 #     either constants.RPC_TMO_SLOW (1h) or huge timeouts
  54
  55 SINGLE = "single-node"
  56 MULTI = "multi-node"
  57
  58 ACCEPT_OFFLINE_NODE = object()
  59
  60 # Constants for encoding/decoding
  61 (ED_OBJECT_DICT,
  62  ED_OBJECT_DICT_LIST,
  63  ED_INST_DICT,
  64  ED_INST_DICT_HVP_BEP_DP,
  65  ED_NODE_TO_DISK_DICT,
  66  ED_INST_DICT_OSP_DP,
  67  ED_IMPEXP_IO,
  68  ED_FILE_DETAILS,
  69  ED_FINALIZE_EXPORT_DISKS,
  70  ED_COMPRESS,
  71  ED_BLOCKDEV_RENAME,
  72  ED_DISKS_DICT_DP,
  73  ED_SINGLE_DISK_DICT_DP,
  74  ED_NIC_DICT) = range(1, 15)
  75
  76
  77 def _Prepare(calls):
  78   """Converts list of calls to dictionary.
  79
  80   """
  81   return utils.SequenceToDict(calls)
  82
  83
  84 def _MigrationStatusPostProc(result):
  85   """Post-processor for L{rpc.RpcRunner.call_instance_get_migration_status}.
  86
  87   """
  88   if not result.fail_msg and result.payload is not None:
  89     result.payload = objects.MigrationStatus.FromDict(result.payload)
  90   return result
  91
  92
  93 def _BlockdevFindPostProc(result):
  94   """Post-processor for L{rpc.RpcRunner.call_blockdev_find}.
  95
  96   """
  97   if not result.fail_msg and result.payload is not None:
  98     result.payload = objects.BlockDevStatus.FromDict(result.payload)
  99   return result
 100
 101
 102 def _BlockdevGetMirrorStatusPostProc(result):
 103   """Post-processor for L{rpc.RpcRunner.call_blockdev_getmirrorstatus}.
 104
 105   """
 106   if not result.fail_msg:
 107     result.payload = map(objects.BlockDevStatus.FromDict, result.payload)
 108   return result
 109
 110
 111 def _BlockdevGetMirrorStatusMultiPreProc(node, args):
 112   """Prepares the appropriate node values for blockdev_getmirrorstatus_multi.
 113
 114   """
 115   # there should be only one argument to this RPC, already holding a
 116   # node->disks dictionary, we just need to extract the value for the
 117   # current node
 118   assert len(args) == 1
 119   return [args[0][node]]
 120
 121
 122 def _BlockdevGetMirrorStatusMultiPostProc(result):
 123   """Post-processor for L{rpc.RpcRunner.call_blockdev_getmirrorstatus_multi}.
 124
 125   """
 126   if not result.fail_msg:
 127     for idx, (success, status) in enumerate(result.payload):
 128       if success:
 129         result.payload[idx] = (success, objects.BlockDevStatus.FromDict(status))
 130
 131   return result
 132
 133
 134 def _NodeInfoPreProc(node, args):
 135   """Prepare the exclusive_storage argument for node_info calls."""
 136   assert len(args) == 3
 137   # The third argument is either a dictionary with one value for each node, or
 138   # a fixed value to be used for all the nodes
 139   if type(args[2]) is dict:
 140     return [args[0], args[1], args[2][node]]
 141   else:
 142     return args
 143
 144
 145 def _OsGetPostProc(result):
 146   """Post-processor for L{rpc.RpcRunner.call_os_get}.
 147
 148   """
 149   if not result.fail_msg and isinstance(result.payload, dict):
 150     result.payload = objects.OS.FromDict(result.payload)
 151   return result
 152
 153
 154 def _ImpExpStatusPostProc(result):
 155   """Post-processor for import/export status.
 156
 157   @rtype: Payload containing list of L{objects.ImportExportStatus} instances
 158   @return: Returns a list of the state of each named import/export or None if
 159            a status couldn't be retrieved
 160
 161   """
 162   if not result.fail_msg:
 163     decoded = []
 164
 165     for i in result.payload:
 166       if i is None:
 167         decoded.append(None)
 168         continue
 169       decoded.append(objects.ImportExportStatus.FromDict(i))
 170
 171     result.payload = decoded
 172
 173   return result
 174
 175
 176 def _TestDelayTimeout((duration, )):
 177   """Calculate timeout for "test_delay" RPC.
 178
 179   """
 180   return int(duration + 5)
 181
 182
 183 _FILE_STORAGE_CALLS = [
 184   ("file_storage_dir_create", SINGLE, None, constants.RPC_TMO_FAST, [
 185     ("file_storage_dir", None, "File storage directory"),
 186     ], None, None, "Create the given file storage directory"),
 187   ("file_storage_dir_remove", SINGLE, None, constants.RPC_TMO_FAST, [
 188     ("file_storage_dir", None, "File storage directory"),
 189     ], None, None, "Remove the given file storage directory"),
 190   ("file_storage_dir_rename", SINGLE, None, constants.RPC_TMO_FAST, [
 191     ("old_file_storage_dir", None, "Old name"),
 192     ("new_file_storage_dir", None, "New name"),
 193     ], None, None, "Rename file storage directory"),
 194   ]
 195
 196 _STORAGE_CALLS = [
 197   ("storage_list", MULTI, None, constants.RPC_TMO_NORMAL, [
 198     ("su_name", None, None),
 199     ("su_args", None, None),
 200     ("name", None, None),
 201     ("fields", None, None),
 202     ], None, None, "Get list of storage units"),
 203   ("storage_modify", SINGLE, None, constants.RPC_TMO_NORMAL, [
 204     ("su_name", None, None),
 205     ("su_args", None, None),
 206     ("name", None, None),
 207     ("changes", None, None),
 208     ], None, None, "Modify a storage unit"),
 209   ("storage_execute", SINGLE, None, constants.RPC_TMO_NORMAL, [
 210     ("su_name", None, None),
 211     ("su_args", None, None),
 212     ("name", None, None),
 213     ("op", None, None),
 214     ], None, None, "Executes an operation on a storage unit"),
 215   ]
 216
 217 _INSTANCE_CALLS = [
 218   ("instance_info", SINGLE, None, constants.RPC_TMO_URGENT, [
 219     ("instance", None, "Instance name"),
 220     ("hname", None, "Hypervisor type"),
 221     ], None, None, "Returns information about a single instance"),
 222   ("all_instances_info", MULTI, None, constants.RPC_TMO_URGENT, [
 223     ("hypervisor_list", None, "Hypervisors to query for instances"),
 224     ], None, None,
 225    "Returns information about all instances on the given nodes"),
 226   ("instance_list", MULTI, None, constants.RPC_TMO_URGENT, [
 227     ("hypervisor_list", None, "Hypervisors to query for instances"),
 228     ], None, None, "Returns the list of running instances on the given nodes"),
 229   ("instance_reboot", SINGLE, None, constants.RPC_TMO_NORMAL, [
 230     ("inst", ED_INST_DICT, "Instance object"),
 231     ("reboot_type", None, None),
 232     ("shutdown_timeout", None, None),
 233     ("reason_text", None, "Reason for the reboot"),
 234     ], None, None, "Returns the list of running instances on the given nodes"),
 235   ("instance_shutdown", SINGLE, None, constants.RPC_TMO_NORMAL, [
 236     ("instance", ED_INST_DICT, "Instance object"),
 237     ("timeout", None, None),
 238     ], None, None, "Stops an instance"),
 239   ("instance_balloon_memory", SINGLE, None, constants.RPC_TMO_NORMAL, [
 240     ("instance", ED_INST_DICT, "Instance object"),
 241     ("memory", None, None),
 242     ], None, None, "Modify the amount of an instance's runtime memory"),
 243   ("instance_run_rename", SINGLE, None, constants.RPC_TMO_SLOW, [
 244     ("instance", ED_INST_DICT, "Instance object"),
 245     ("old_name", None, None),
 246     ("debug", None, None),
 247     ], None, None, "Run the OS rename script for an instance"),
 248   ("instance_migratable", SINGLE, None, constants.RPC_TMO_NORMAL, [
 249     ("instance", ED_INST_DICT, "Instance object"),
 250     ], None, None, "Checks whether the given instance can be migrated"),
 251   ("migration_info", SINGLE, None, constants.RPC_TMO_NORMAL, [
 252     ("instance", ED_INST_DICT, "Instance object"),
 253     ], None, None,
 254     "Gather the information necessary to prepare an instance migration"),
 255   ("accept_instance", SINGLE, None, constants.RPC_TMO_NORMAL, [
 256     ("instance", ED_INST_DICT, "Instance object"),
 257     ("info", None, "Result for the call_migration_info call"),
 258     ("target", None, "Target hostname (usually an IP address)"),
 259     ], None, None, "Prepare a node to accept an instance"),
 260   ("instance_finalize_migration_dst", SINGLE, None, constants.RPC_TMO_NORMAL, [
 261     ("instance", ED_INST_DICT, "Instance object"),
 262     ("info", None, "Result for the call_migration_info call"),
 263     ("success", None, "Whether the migration was a success or failure"),
 264     ], None, None, "Finalize any target-node migration specific operation"),
 265   ("instance_migrate", SINGLE, None, constants.RPC_TMO_SLOW, [
 266     ("instance", ED_INST_DICT, "Instance object"),
 267     ("target", None, "Target node name"),
 268     ("live", None, "Whether the migration should be done live or not"),
 269     ], None, None, "Migrate an instance"),
 270   ("instance_finalize_migration_src", SINGLE, None, constants.RPC_TMO_SLOW, [
 271     ("instance", ED_INST_DICT, "Instance object"),
 272     ("success", None, "Whether the migration succeeded or not"),
 273     ("live", None, "Whether the user requested a live migration or not"),
 274     ], None, None, "Finalize the instance migration on the source node"),
 275   ("instance_get_migration_status", SINGLE, None, constants.RPC_TMO_SLOW, [
 276     ("instance", ED_INST_DICT, "Instance object"),
 277     ], None, _MigrationStatusPostProc, "Report migration status"),
 278   ("instance_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
 279     ("instance_hvp_bep", ED_INST_DICT_HVP_BEP_DP, None),
 280     ("startup_paused", None, None),
 281     ], None, None, "Starts an instance"),
 282   ("instance_os_add", SINGLE, None, constants.RPC_TMO_1DAY, [
 283     ("instance_osp", ED_INST_DICT_OSP_DP, None),
 284     ("reinstall", None, None),
 285     ("debug", None, None),
 286     ], None, None, "Starts an instance"),
 287   ]
 288
 289 _IMPEXP_CALLS = [
 290   ("import_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
 291     ("opts", ED_OBJECT_DICT, None),
 292     ("instance", ED_INST_DICT, None),
 293     ("component", None, None),
 294     ("dest", ED_IMPEXP_IO, "Import destination"),
 295     ], None, None, "Starts an import daemon"),
 296   ("export_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
 297     ("opts", ED_OBJECT_DICT, None),
 298     ("host", None, None),
 299     ("port", None, None),
 300     ("instance", ED_INST_DICT, None),
 301     ("component", None, None),
 302     ("source", ED_IMPEXP_IO, "Export source"),
 303     ], None, None, "Starts an export daemon"),
 304   ("impexp_status", SINGLE, None, constants.RPC_TMO_FAST, [
 305     ("names", None, "Import/export names"),
 306     ], None, _ImpExpStatusPostProc, "Gets the status of an import or export"),
 307   ("impexp_abort", SINGLE, None, constants.RPC_TMO_NORMAL, [
 308     ("name", None, "Import/export name"),
 309     ], None, None, "Aborts an import or export"),
 310   ("impexp_cleanup", SINGLE, None, constants.RPC_TMO_NORMAL, [
 311     ("name", None, "Import/export name"),
 312     ], None, None, "Cleans up after an import or export"),
 313   ("export_info", SINGLE, None, constants.RPC_TMO_FAST, [
 314     ("path", None, None),
 315     ], None, None, "Queries the export information in a given path"),
 316   ("finalize_export", SINGLE, None, constants.RPC_TMO_NORMAL, [
 317     ("instance", ED_INST_DICT, None),
 318     ("snap_disks", ED_FINALIZE_EXPORT_DISKS, None),
 319     ], None, None, "Request the completion of an export operation"),
 320   ("export_list", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
 321    "Gets the stored exports list"),
 322   ("export_remove", SINGLE, None, constants.RPC_TMO_FAST, [
 323     ("export", None, None),
 324     ], None, None, "Requests removal of a given export"),
 325   ]
 326
 327 _X509_CALLS = [
 328   ("x509_cert_create", SINGLE, None, constants.RPC_TMO_NORMAL, [
 329     ("validity", None, "Validity in seconds"),
 330     ], None, None, "Creates a new X509 certificate for SSL/TLS"),
 331   ("x509_cert_remove", SINGLE, None, constants.RPC_TMO_NORMAL, [
 332     ("name", None, "Certificate name"),
 333     ], None, None, "Removes a X509 certificate"),
 334   ]
 335
 336 _BLOCKDEV_CALLS = [
 337   ("bdev_sizes", MULTI, None, constants.RPC_TMO_URGENT, [
 338     ("devices", None, None),
 339     ], None, None,
 340    "Gets the sizes of requested block devices present on a node"),
 341   ("blockdev_create", SINGLE, None, constants.RPC_TMO_NORMAL, [
 342     ("bdev", ED_OBJECT_DICT, None),
 343     ("size", None, None),
 344     ("owner", None, None),
 345     ("on_primary", None, None),
 346     ("info", None, None),
 347     ("exclusive_storage", None, None),
 348     ], None, None, "Request creation of a given block device"),
 349   ("blockdev_wipe", SINGLE, None, constants.RPC_TMO_SLOW, [
 350     ("bdev", ED_SINGLE_DISK_DICT_DP, None),
 351     ("offset", None, None),
 352     ("size", None, None),
 353     ], None, None,
 354     "Request wipe at given offset with given size of a block device"),
 355   ("blockdev_remove", SINGLE, None, constants.RPC_TMO_NORMAL, [
 356     ("bdev", ED_OBJECT_DICT, None),
 357     ], None, None, "Request removal of a given block device"),
 358   ("blockdev_pause_resume_sync", SINGLE, None, constants.RPC_TMO_NORMAL, [
 359     ("disks", ED_DISKS_DICT_DP, None),
 360     ("pause", None, None),
 361     ], None, None, "Request a pause/resume of given block device"),
 362   ("blockdev_assemble", SINGLE, None, constants.RPC_TMO_NORMAL, [
 363     ("disk", ED_SINGLE_DISK_DICT_DP, None),
 364     ("owner", None, None),
 365     ("on_primary", None, None),
 366     ("idx", None, None),
 367     ], None, None, "Request assembling of a given block device"),
 368   ("blockdev_shutdown", SINGLE, None, constants.RPC_TMO_NORMAL, [
 369     ("disk", ED_SINGLE_DISK_DICT_DP, None),
 370     ], None, None, "Request shutdown of a given block device"),
 371   ("blockdev_addchildren", SINGLE, None, constants.RPC_TMO_NORMAL, [
 372     ("bdev", ED_SINGLE_DISK_DICT_DP, None),
 373     ("ndevs", ED_OBJECT_DICT_LIST, None),
 374     ], None, None,
 375    "Request adding a list of children to a (mirroring) device"),
 376   ("blockdev_removechildren", SINGLE, None, constants.RPC_TMO_NORMAL, [
 377     ("bdev", ED_OBJECT_DICT, None),
 378     ("ndevs", ED_OBJECT_DICT_LIST, None),
 379     ], None, None,
 380    "Request removing a list of children from a (mirroring) device"),
 381   ("blockdev_close", SINGLE, None, constants.RPC_TMO_NORMAL, [
 382     ("instance_name", None, None),
 383     ("disks", ED_OBJECT_DICT_LIST, None),
 384     ], None, None, "Closes the given block devices"),
 385   ("blockdev_getsize", SINGLE, None, constants.RPC_TMO_NORMAL, [
 386     ("disks", ED_OBJECT_DICT_LIST, None),
 387     ], None, None, "Returns the size of the given disks"),
 388   ("drbd_disconnect_net", MULTI, None, constants.RPC_TMO_NORMAL, [
 389     ("nodes_ip", None, None),
 390     ("disks", ED_OBJECT_DICT_LIST, None),
 391     ], None, None, "Disconnects the network of the given drbd devices"),
 392   ("drbd_attach_net", MULTI, None, constants.RPC_TMO_NORMAL, [
 393     ("nodes_ip", None, None),
 394     ("disks", ED_DISKS_DICT_DP, None),
 395     ("instance_name", None, None),
 396     ("multimaster", None, None),
 397     ], None, None, "Connects the given DRBD devices"),
 398   ("drbd_wait_sync", MULTI, None, constants.RPC_TMO_SLOW, [
 399     ("nodes_ip", None, None),
 400     ("disks", ED_DISKS_DICT_DP, None),
 401     ], None, None,
 402    "Waits for the synchronization of drbd devices is complete"),
 403   ("blockdev_grow", SINGLE, None, constants.RPC_TMO_NORMAL, [
 404     ("cf_bdev", ED_SINGLE_DISK_DICT_DP, None),
 405     ("amount", None, None),
 406     ("dryrun", None, None),
 407     ("backingstore", None, None),
 408     ], None, None, "Request growing of the given block device by a"
 409    " given amount"),
 410   ("blockdev_export", SINGLE, None, constants.RPC_TMO_1DAY, [
 411     ("cf_bdev", ED_SINGLE_DISK_DICT_DP, None),
 412     ("dest_node", None, None),
 413     ("dest_path", None, None),
 414     ("cluster_name", None, None),
 415     ], None, None, "Export a given disk to another node"),
 416   ("blockdev_snapshot", SINGLE, None, constants.RPC_TMO_NORMAL, [
 417     ("cf_bdev", ED_SINGLE_DISK_DICT_DP, None),
 418     ], None, None, "Export a given disk to another node"),
 419   ("blockdev_rename", SINGLE, None, constants.RPC_TMO_NORMAL, [
 420     ("devlist", ED_BLOCKDEV_RENAME, None),
 421     ], None, None, "Request rename of the given block devices"),
 422   ("blockdev_find", SINGLE, None, constants.RPC_TMO_NORMAL, [
 423     ("disk", ED_OBJECT_DICT, None),
 424     ], None, _BlockdevFindPostProc,
 425     "Request identification of a given block device"),
 426   ("blockdev_getmirrorstatus", SINGLE, None, constants.RPC_TMO_NORMAL, [
 427     ("disks", ED_DISKS_DICT_DP, None),
 428     ], None, _BlockdevGetMirrorStatusPostProc,
 429     "Request status of a (mirroring) device"),
 430   ("blockdev_getmirrorstatus_multi", MULTI, None, constants.RPC_TMO_NORMAL, [
 431     ("node_disks", ED_NODE_TO_DISK_DICT, None),
 432     ], _BlockdevGetMirrorStatusMultiPreProc,
 433    _BlockdevGetMirrorStatusMultiPostProc,
 434     "Request status of (mirroring) devices from multiple nodes"),
 435   ("blockdev_setinfo", SINGLE, None, constants.RPC_TMO_NORMAL, [
 436     ("disk", ED_OBJECT_DICT, None),
 437     ("info", None, None),
 438     ], None, None, "Sets metadata information on a given block device"),
 439   ]
 440
 441 _OS_CALLS = [
 442   ("os_diagnose", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
 443    "Request a diagnose of OS definitions"),
 444   ("os_validate", MULTI, None, constants.RPC_TMO_FAST, [
 445     ("required", None, None),
 446     ("name", None, None),
 447     ("checks", None, None),
 448     ("params", None, None),
 449     ], None, None, "Run a validation routine for a given OS"),
 450   ("os_get", SINGLE, None, constants.RPC_TMO_FAST, [
 451     ("name", None, None),
 452     ], None, _OsGetPostProc, "Returns an OS definition"),
 453   ]
 454
 455 _EXTSTORAGE_CALLS = [
 456   ("extstorage_diagnose", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
 457    "Request a diagnose of ExtStorage Providers"),
 458   ]
 459
 460 _NODE_CALLS = [
 461   ("node_has_ip_address", SINGLE, None, constants.RPC_TMO_FAST, [
 462     ("address", None, "IP address"),
 463     ], None, None, "Checks if a node has the given IP address"),
 464   ("node_info", MULTI, None, constants.RPC_TMO_URGENT, [
 465     ("vg_names", None,
 466      "Names of the volume groups to ask for disk space information"),
 467     ("hv_names", None,
 468      "Names of the hypervisors to ask for node information"),
 469     ("exclusive_storage", None,
 470      "Whether exclusive storage is enabled"),
 471     ], _NodeInfoPreProc, None, "Return node information"),
 472   ("node_verify", MULTI, None, constants.RPC_TMO_NORMAL, [
 473     ("checkdict", None, None),
 474     ("cluster_name", None, None),
 475     ], None, None, "Request verification of given parameters"),
 476   ("node_volumes", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
 477    "Gets all volumes on node(s)"),
 478   ("node_demote_from_mc", SINGLE, None, constants.RPC_TMO_FAST, [], None, None,
 479    "Demote a node from the master candidate role"),
 480   ("node_powercycle", SINGLE, ACCEPT_OFFLINE_NODE, constants.RPC_TMO_NORMAL, [
 481     ("hypervisor", None, "Hypervisor type"),
 482     ], None, None, "Tries to powercycle a node"),
 483   ]
 484
 485 _MISC_CALLS = [
 486   ("lv_list", MULTI, None, constants.RPC_TMO_URGENT, [
 487     ("vg_name", None, None),
 488     ], None, None, "Gets the logical volumes present in a given volume group"),
 489   ("vg_list", MULTI, None, constants.RPC_TMO_URGENT, [], None, None,
 490    "Gets the volume group list"),
 491   ("bridges_exist", SINGLE, None, constants.RPC_TMO_URGENT, [
 492     ("bridges_list", None, "Bridges which must be present on remote node"),
 493     ], None, None, "Checks if a node has all the bridges given"),
 494   ("etc_hosts_modify", SINGLE, None, constants.RPC_TMO_NORMAL, [
 495     ("mode", None,
 496      "Mode to operate; currently L{constants.ETC_HOSTS_ADD} or"
 497      " L{constants.ETC_HOSTS_REMOVE}"),
 498     ("name", None, "Hostname to be modified"),
 499     ("ip", None, "IP address (L{constants.ETC_HOSTS_ADD} only)"),
 500     ], None, None, "Modify hosts file with name"),
 501   ("drbd_helper", MULTI, None, constants.RPC_TMO_URGENT, [],
 502    None, None, "Gets DRBD helper"),
 503   ("restricted_command", MULTI, None, constants.RPC_TMO_SLOW, [
 504     ("cmd", None, "Command name"),
 505     ], None, None, "Runs restricted command"),
 506   ("run_oob", SINGLE, None, constants.RPC_TMO_NORMAL, [
 507     ("oob_program", None, None),
 508     ("command", None, None),
 509     ("remote_node", None, None),
 510     ("timeout", None, None),
 511     ], None, None, "Runs out-of-band command"),
 512   ("hooks_runner", MULTI, None, constants.RPC_TMO_NORMAL, [
 513     ("hpath", None, None),
 514     ("phase", None, None),
 515     ("env", None, None),
 516     ], None, None, "Call the hooks runner"),
 517   ("iallocator_runner", SINGLE, None, constants.RPC_TMO_NORMAL, [
 518     ("name", None, "Iallocator name"),
 519     ("idata", None, "JSON-encoded input string"),
 520     ], None, None, "Call an iallocator on a remote node"),
 521   ("test_delay", MULTI, None, _TestDelayTimeout, [
 522     ("duration", None, None),
 523     ], None, None, "Sleep for a fixed time on given node(s)"),
 524   ("hypervisor_validate_params", MULTI, None, constants.RPC_TMO_NORMAL, [
 525     ("hvname", None, "Hypervisor name"),
 526     ("hvfull", None, "Parameters to be validated"),
 527     ], None, None, "Validate hypervisor params"),
 528   ("get_watcher_pause", SINGLE, None, constants.RPC_TMO_URGENT, [],
 529     None, None, "Get watcher pause end"),
 530   ("set_watcher_pause", MULTI, None, constants.RPC_TMO_URGENT, [
 531     ("until", None, None),
 532     ], None, None, "Set watcher pause end"),
 533   ]
 534
 535 CALLS = {
 536   "RpcClientDefault":
 537     _Prepare(_IMPEXP_CALLS + _X509_CALLS + _OS_CALLS + _NODE_CALLS +
 538              _FILE_STORAGE_CALLS + _MISC_CALLS + _INSTANCE_CALLS +
 539              _BLOCKDEV_CALLS + _STORAGE_CALLS + _EXTSTORAGE_CALLS),
 540   "RpcClientJobQueue": _Prepare([
 541     ("jobqueue_update", MULTI, None, constants.RPC_TMO_URGENT, [
 542       ("file_name", None, None),
 543       ("content", ED_COMPRESS, None),
 544       ], None, None, "Update job queue file"),
 545     ("jobqueue_purge", SINGLE, None, constants.RPC_TMO_NORMAL, [], None, None,
 546      "Purge job queue"),
 547     ("jobqueue_rename", MULTI, None, constants.RPC_TMO_URGENT, [
 548       ("rename", None, None),
 549       ], None, None, "Rename job queue file"),
 550     ("jobqueue_set_drain_flag", MULTI, None, constants.RPC_TMO_URGENT, [
 551       ("flag", None, None),
 552       ], None, None, "Set job queue drain flag"),
 553     ]),
 554   "RpcClientBootstrap": _Prepare([
 555     ("node_start_master_daemons", SINGLE, None, constants.RPC_TMO_FAST, [
 556       ("no_voting", None, None),
 557       ], None, None, "Starts master daemons on a node"),
 558     ("node_activate_master_ip", SINGLE, None, constants.RPC_TMO_FAST, [
 559       ("master_params", ED_OBJECT_DICT, "Network parameters of the master"),
 560       ("use_external_mip_script", None,
 561        "Whether to use the user-provided master IP address setup script"),
 562       ], None, None,
 563       "Activates master IP on a node"),
 564     ("node_stop_master", SINGLE, None, constants.RPC_TMO_FAST, [], None, None,
 565      "Deactivates master IP and stops master daemons on a node"),
 566     ("node_deactivate_master_ip", SINGLE, None, constants.RPC_TMO_FAST, [
 567       ("master_params", ED_OBJECT_DICT, "Network parameters of the master"),
 568       ("use_external_mip_script", None,
 569        "Whether to use the user-provided master IP address setup script"),
 570       ], None, None,
 571      "Deactivates master IP on a node"),
 572     ("node_change_master_netmask", SINGLE, None, constants.RPC_TMO_FAST, [
 573       ("old_netmask", None, "The old value of the netmask"),
 574       ("netmask", None, "The new value of the netmask"),
 575       ("master_ip", None, "The master IP"),
 576       ("master_netdev", None, "The master network device"),
 577       ], None, None, "Change master IP netmask"),
 578     ("node_leave_cluster", SINGLE, None, constants.RPC_TMO_NORMAL, [
 579       ("modify_ssh_setup", None, None),
 580       ], None, None,
 581      "Requests a node to clean the cluster information it has"),
 582     ("master_info", MULTI, None, constants.RPC_TMO_URGENT, [], None, None,
 583      "Query master info"),
 584     ]),
 585   "RpcClientDnsOnly": _Prepare([
 586     ("version", MULTI, ACCEPT_OFFLINE_NODE, constants.RPC_TMO_URGENT, [], None,
 587      None, "Query node version"),
 588     ("node_verify_light", MULTI, None, constants.RPC_TMO_NORMAL, [
 589       ("checkdict", None, None),
 590       ("cluster_name", None, None),
 591       ], None, None, "Request verification of given parameters"),
 592     ]),
 593   "RpcClientConfig": _Prepare([
 594     ("upload_file", MULTI, None, constants.RPC_TMO_NORMAL, [
 595       ("file_name", ED_FILE_DETAILS, None),
 596       ], None, None, "Upload a file"),
 597     ("write_ssconf_files", MULTI, None, constants.RPC_TMO_NORMAL, [
 598       ("values", None, None),
 599       ], None, None, "Write ssconf files"),
 600     ]),
 601   }