Statistics
| Branch: | Tag: | Revision:

root / lib / rpc_defs.py @ 8ef418bb

History | View | Annotate | Download (24.6 kB)

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
    ("hvparams", None, "Hypervisor parameters"),
222
    ], None, None, "Returns information about a single instance"),
223
  ("all_instances_info", MULTI, None, constants.RPC_TMO_URGENT, [
224
    ("hypervisor_list", None, "Hypervisors to query for instances"),
225
    ("all_hvparams", None, "Dictionary mapping hypervisor names to hvparams"),
226
    ], None, None,
227
   "Returns information about all instances on the given nodes"),
228
  ("instance_list", MULTI, None, constants.RPC_TMO_URGENT, [
229
    ("hypervisor_list", None, "Hypervisors to query for instances"),
230
    ("hvparams", None, "Hvparams of all hypervisors"),
231
    ], None, None, "Returns the list of running instances on the given nodes"),
232
  ("instance_reboot", SINGLE, None, constants.RPC_TMO_NORMAL, [
233
    ("inst", ED_INST_DICT, "Instance object"),
234
    ("reboot_type", None, None),
235
    ("shutdown_timeout", None, None),
236
    ("reason", None, "The reason for the reboot"),
237
    ], None, None, "Returns the list of running instances on the given nodes"),
238
  ("instance_shutdown", SINGLE, None, constants.RPC_TMO_NORMAL, [
239
    ("instance", ED_INST_DICT, "Instance object"),
240
    ("timeout", None, None),
241
    ("reason", None, "The reason for the shutdown"),
242
    ], None, None, "Stops an instance"),
243
  ("instance_balloon_memory", SINGLE, None, constants.RPC_TMO_NORMAL, [
244
    ("instance", ED_INST_DICT, "Instance object"),
245
    ("memory", None, None),
246
    ], None, None, "Modify the amount of an instance's runtime memory"),
247
  ("instance_run_rename", SINGLE, None, constants.RPC_TMO_SLOW, [
248
    ("instance", ED_INST_DICT, "Instance object"),
249
    ("old_name", None, None),
250
    ("debug", None, None),
251
    ], None, None, "Run the OS rename script for an instance"),
252
  ("instance_migratable", SINGLE, None, constants.RPC_TMO_NORMAL, [
253
    ("instance", ED_INST_DICT, "Instance object"),
254
    ], None, None, "Checks whether the given instance can be migrated"),
255
  ("migration_info", SINGLE, None, constants.RPC_TMO_NORMAL, [
256
    ("instance", ED_INST_DICT, "Instance object"),
257
    ], None, None,
258
    "Gather the information necessary to prepare an instance migration"),
259
  ("accept_instance", SINGLE, None, constants.RPC_TMO_NORMAL, [
260
    ("instance", ED_INST_DICT, "Instance object"),
261
    ("info", None, "Result for the call_migration_info call"),
262
    ("target", None, "Target hostname (usually an IP address)"),
263
    ], None, None, "Prepare a node to accept an instance"),
264
  ("instance_finalize_migration_dst", SINGLE, None, constants.RPC_TMO_NORMAL, [
265
    ("instance", ED_INST_DICT, "Instance object"),
266
    ("info", None, "Result for the call_migration_info call"),
267
    ("success", None, "Whether the migration was a success or failure"),
268
    ], None, None, "Finalize any target-node migration specific operation"),
269
  ("instance_migrate", SINGLE, None, constants.RPC_TMO_SLOW, [
270
    ("instance", ED_INST_DICT, "Instance object"),
271
    ("target", None, "Target node name"),
272
    ("live", None, "Whether the migration should be done live or not"),
273
    ], None, None, "Migrate an instance"),
274
  ("instance_finalize_migration_src", SINGLE, None, constants.RPC_TMO_SLOW, [
275
    ("instance", ED_INST_DICT, "Instance object"),
276
    ("success", None, "Whether the migration succeeded or not"),
277
    ("live", None, "Whether the user requested a live migration or not"),
278
    ], None, None, "Finalize the instance migration on the source node"),
279
  ("instance_get_migration_status", SINGLE, None, constants.RPC_TMO_SLOW, [
280
    ("instance", ED_INST_DICT, "Instance object"),
281
    ], None, _MigrationStatusPostProc, "Report migration status"),
282
  ("instance_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
283
    ("instance_hvp_bep", ED_INST_DICT_HVP_BEP_DP, None),
284
    ("startup_paused", None, None),
285
    ("reason", None, "The reason for the startup"),
286
    ], None, None, "Starts an instance"),
287
  ("instance_os_add", SINGLE, None, constants.RPC_TMO_1DAY, [
288
    ("instance_osp", ED_INST_DICT_OSP_DP, None),
289
    ("reinstall", None, None),
290
    ("debug", None, None),
291
    ], None, None, "Starts an instance"),
292
  ]
293

    
294
_IMPEXP_CALLS = [
295
  ("import_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
296
    ("opts", ED_OBJECT_DICT, None),
297
    ("instance", ED_INST_DICT, None),
298
    ("component", None, None),
299
    ("dest", ED_IMPEXP_IO, "Import destination"),
300
    ], None, None, "Starts an import daemon"),
301
  ("export_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
302
    ("opts", ED_OBJECT_DICT, None),
303
    ("host", None, None),
304
    ("port", None, None),
305
    ("instance", ED_INST_DICT, None),
306
    ("component", None, None),
307
    ("source", ED_IMPEXP_IO, "Export source"),
308
    ], None, None, "Starts an export daemon"),
309
  ("impexp_status", SINGLE, None, constants.RPC_TMO_FAST, [
310
    ("names", None, "Import/export names"),
311
    ], None, _ImpExpStatusPostProc, "Gets the status of an import or export"),
312
  ("impexp_abort", SINGLE, None, constants.RPC_TMO_NORMAL, [
313
    ("name", None, "Import/export name"),
314
    ], None, None, "Aborts an import or export"),
315
  ("impexp_cleanup", SINGLE, None, constants.RPC_TMO_NORMAL, [
316
    ("name", None, "Import/export name"),
317
    ], None, None, "Cleans up after an import or export"),
318
  ("export_info", SINGLE, None, constants.RPC_TMO_FAST, [
319
    ("path", None, None),
320
    ], None, None, "Queries the export information in a given path"),
321
  ("finalize_export", SINGLE, None, constants.RPC_TMO_NORMAL, [
322
    ("instance", ED_INST_DICT, None),
323
    ("snap_disks", ED_FINALIZE_EXPORT_DISKS, None),
324
    ], None, None, "Request the completion of an export operation"),
325
  ("export_list", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
326
   "Gets the stored exports list"),
327
  ("export_remove", SINGLE, None, constants.RPC_TMO_FAST, [
328
    ("export", None, None),
329
    ], None, None, "Requests removal of a given export"),
330
  ]
331

    
332
_X509_CALLS = [
333
  ("x509_cert_create", SINGLE, None, constants.RPC_TMO_NORMAL, [
334
    ("validity", None, "Validity in seconds"),
335
    ], None, None, "Creates a new X509 certificate for SSL/TLS"),
336
  ("x509_cert_remove", SINGLE, None, constants.RPC_TMO_NORMAL, [
337
    ("name", None, "Certificate name"),
338
    ], None, None, "Removes a X509 certificate"),
339
  ]
340

    
341
_BLOCKDEV_CALLS = [
342
  ("bdev_sizes", MULTI, None, constants.RPC_TMO_URGENT, [
343
    ("devices", None, None),
344
    ], None, None,
345
   "Gets the sizes of requested block devices present on a node"),
346
  ("blockdev_create", SINGLE, None, constants.RPC_TMO_NORMAL, [
347
    ("bdev", ED_OBJECT_DICT, None),
348
    ("size", None, None),
349
    ("owner", None, None),
350
    ("on_primary", None, None),
351
    ("info", None, None),
352
    ("exclusive_storage", None, None),
353
    ], None, None, "Request creation of a given block device"),
354
  ("blockdev_wipe", SINGLE, None, constants.RPC_TMO_SLOW, [
355
    ("bdev", ED_SINGLE_DISK_DICT_DP, None),
356
    ("offset", None, None),
357
    ("size", None, None),
358
    ], None, None,
359
    "Request wipe at given offset with given size of a block device"),
360
  ("blockdev_remove", SINGLE, None, constants.RPC_TMO_NORMAL, [
361
    ("bdev", ED_OBJECT_DICT, None),
362
    ], None, None, "Request removal of a given block device"),
363
  ("blockdev_pause_resume_sync", SINGLE, None, constants.RPC_TMO_NORMAL, [
364
    ("disks", ED_DISKS_DICT_DP, None),
365
    ("pause", None, None),
366
    ], None, None, "Request a pause/resume of given block device"),
367
  ("blockdev_assemble", SINGLE, None, constants.RPC_TMO_NORMAL, [
368
    ("disk", ED_SINGLE_DISK_DICT_DP, None),
369
    ("owner", None, None),
370
    ("on_primary", None, None),
371
    ("idx", None, None),
372
    ], None, None, "Request assembling of a given block device"),
373
  ("blockdev_shutdown", SINGLE, None, constants.RPC_TMO_NORMAL, [
374
    ("disk", ED_SINGLE_DISK_DICT_DP, None),
375
    ], None, None, "Request shutdown of a given block device"),
376
  ("blockdev_addchildren", SINGLE, None, constants.RPC_TMO_NORMAL, [
377
    ("bdev", ED_SINGLE_DISK_DICT_DP, None),
378
    ("ndevs", ED_OBJECT_DICT_LIST, None),
379
    ], None, None,
380
   "Request adding a list of children to a (mirroring) device"),
381
  ("blockdev_removechildren", SINGLE, None, constants.RPC_TMO_NORMAL, [
382
    ("bdev", ED_OBJECT_DICT, None),
383
    ("ndevs", ED_OBJECT_DICT_LIST, None),
384
    ], None, None,
385
   "Request removing a list of children from a (mirroring) device"),
386
  ("blockdev_close", SINGLE, None, constants.RPC_TMO_NORMAL, [
387
    ("instance_name", None, None),
388
    ("disks", ED_OBJECT_DICT_LIST, None),
389
    ], None, None, "Closes the given block devices"),
390
  ("blockdev_getdimensions", SINGLE, None, constants.RPC_TMO_NORMAL, [
391
    ("disks", ED_OBJECT_DICT_LIST, None),
392
    ], None, None, "Returns size and spindles of the given disks"),
393
  ("drbd_disconnect_net", MULTI, None, constants.RPC_TMO_NORMAL, [
394
    ("nodes_ip", None, None),
395
    ("disks", ED_OBJECT_DICT_LIST, None),
396
    ], None, None, "Disconnects the network of the given drbd devices"),
397
  ("drbd_attach_net", MULTI, None, constants.RPC_TMO_NORMAL, [
398
    ("nodes_ip", None, None),
399
    ("disks", ED_DISKS_DICT_DP, None),
400
    ("instance_name", None, None),
401
    ("multimaster", None, None),
402
    ], None, None, "Connects the given DRBD devices"),
403
  ("drbd_wait_sync", MULTI, None, constants.RPC_TMO_SLOW, [
404
    ("nodes_ip", None, None),
405
    ("disks", ED_DISKS_DICT_DP, None),
406
    ], None, None,
407
   "Waits for the synchronization of drbd devices is complete"),
408
  ("blockdev_grow", SINGLE, None, constants.RPC_TMO_NORMAL, [
409
    ("cf_bdev", ED_SINGLE_DISK_DICT_DP, None),
410
    ("amount", None, None),
411
    ("dryrun", None, None),
412
    ("backingstore", None, None),
413
    ], None, None, "Request growing of the given block device by a"
414
   " given amount"),
415
  ("blockdev_export", SINGLE, None, constants.RPC_TMO_1DAY, [
416
    ("cf_bdev", ED_SINGLE_DISK_DICT_DP, None),
417
    ("dest_node", None, None),
418
    ("dest_path", None, None),
419
    ("cluster_name", None, None),
420
    ], None, None, "Export a given disk to another node"),
421
  ("blockdev_snapshot", SINGLE, None, constants.RPC_TMO_NORMAL, [
422
    ("cf_bdev", ED_SINGLE_DISK_DICT_DP, None),
423
    ], None, None, "Export a given disk to another node"),
424
  ("blockdev_rename", SINGLE, None, constants.RPC_TMO_NORMAL, [
425
    ("devlist", ED_BLOCKDEV_RENAME, None),
426
    ], None, None, "Request rename of the given block devices"),
427
  ("blockdev_find", SINGLE, None, constants.RPC_TMO_NORMAL, [
428
    ("disk", ED_OBJECT_DICT, None),
429
    ], None, _BlockdevFindPostProc,
430
    "Request identification of a given block device"),
431
  ("blockdev_getmirrorstatus", SINGLE, None, constants.RPC_TMO_NORMAL, [
432
    ("disks", ED_DISKS_DICT_DP, None),
433
    ], None, _BlockdevGetMirrorStatusPostProc,
434
    "Request status of a (mirroring) device"),
435
  ("blockdev_getmirrorstatus_multi", MULTI, None, constants.RPC_TMO_NORMAL, [
436
    ("node_disks", ED_NODE_TO_DISK_DICT, None),
437
    ], _BlockdevGetMirrorStatusMultiPreProc,
438
   _BlockdevGetMirrorStatusMultiPostProc,
439
    "Request status of (mirroring) devices from multiple nodes"),
440
  ("blockdev_setinfo", SINGLE, None, constants.RPC_TMO_NORMAL, [
441
    ("disk", ED_OBJECT_DICT, None),
442
    ("info", None, None),
443
    ], None, None, "Sets metadata information on a given block device"),
444
  ]
445

    
446
_OS_CALLS = [
447
  ("os_diagnose", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
448
   "Request a diagnose of OS definitions"),
449
  ("os_validate", MULTI, None, constants.RPC_TMO_FAST, [
450
    ("required", None, None),
451
    ("name", None, None),
452
    ("checks", None, None),
453
    ("params", None, None),
454
    ], None, None, "Run a validation routine for a given OS"),
455
  ("os_get", SINGLE, None, constants.RPC_TMO_FAST, [
456
    ("name", None, None),
457
    ], None, _OsGetPostProc, "Returns an OS definition"),
458
  ]
459

    
460
_EXTSTORAGE_CALLS = [
461
  ("extstorage_diagnose", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
462
   "Request a diagnose of ExtStorage Providers"),
463
  ]
464

    
465
_NODE_CALLS = [
466
  ("node_has_ip_address", SINGLE, None, constants.RPC_TMO_FAST, [
467
    ("address", None, "IP address"),
468
    ], None, None, "Checks if a node has the given IP address"),
469
  ("node_info", MULTI, None, constants.RPC_TMO_URGENT, [
470
    ("storage_units", None,
471
     "List of tuples '<storage_type>,<key>' to ask for disk space"
472
     " information"),
473
    ("hv_specs", None,
474
     "List of hypervisor specification (name, hvparams) to ask for node "
475
     "information"),
476
    ("exclusive_storage", None,
477
     "Whether exclusive storage is enabled"),
478
    ], _NodeInfoPreProc, None, "Return node information"),
479
  ("node_verify", MULTI, None, constants.RPC_TMO_NORMAL, [
480
    ("checkdict", None, "What to verify"),
481
    ("cluster_name", None, "Cluster name"),
482
    ("all_hvparams", None, "Dictionary mapping hypervisor names to hvparams"),
483
    ], None, None, "Request verification of given parameters"),
484
  ("node_volumes", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
485
   "Gets all volumes on node(s)"),
486
  ("node_demote_from_mc", SINGLE, None, constants.RPC_TMO_FAST, [], None, None,
487
   "Demote a node from the master candidate role"),
488
  ("node_powercycle", SINGLE, ACCEPT_OFFLINE_NODE, constants.RPC_TMO_NORMAL, [
489
    ("hypervisor", None, "Hypervisor type"),
490
    ("hvparams", None, "Hypervisor parameters"),
491
    ], None, None, "Tries to powercycle a node"),
492
  ]
493

    
494
_MISC_CALLS = [
495
  ("lv_list", MULTI, None, constants.RPC_TMO_URGENT, [
496
    ("vg_name", None, None),
497
    ], None, None, "Gets the logical volumes present in a given volume group"),
498
  ("vg_list", MULTI, None, constants.RPC_TMO_URGENT, [], None, None,
499
   "Gets the volume group list"),
500
  ("bridges_exist", SINGLE, None, constants.RPC_TMO_URGENT, [
501
    ("bridges_list", None, "Bridges which must be present on remote node"),
502
    ], None, None, "Checks if a node has all the bridges given"),
503
  ("etc_hosts_modify", SINGLE, None, constants.RPC_TMO_NORMAL, [
504
    ("mode", None,
505
     "Mode to operate; currently L{constants.ETC_HOSTS_ADD} or"
506
     " L{constants.ETC_HOSTS_REMOVE}"),
507
    ("name", None, "Hostname to be modified"),
508
    ("ip", None, "IP address (L{constants.ETC_HOSTS_ADD} only)"),
509
    ], None, None, "Modify hosts file with name"),
510
  ("drbd_helper", MULTI, None, constants.RPC_TMO_URGENT, [],
511
   None, None, "Gets DRBD helper"),
512
  ("restricted_command", MULTI, None, constants.RPC_TMO_SLOW, [
513
    ("cmd", None, "Command name"),
514
    ], None, None, "Runs restricted command"),
515
  ("run_oob", SINGLE, None, constants.RPC_TMO_NORMAL, [
516
    ("oob_program", None, None),
517
    ("command", None, None),
518
    ("remote_node", None, None),
519
    ("timeout", None, None),
520
    ], None, None, "Runs out-of-band command"),
521
  ("hooks_runner", MULTI, None, constants.RPC_TMO_NORMAL, [
522
    ("hpath", None, None),
523
    ("phase", None, None),
524
    ("env", None, None),
525
    ], None, None, "Call the hooks runner"),
526
  ("iallocator_runner", SINGLE, None, constants.RPC_TMO_NORMAL, [
527
    ("name", None, "Iallocator name"),
528
    ("idata", None, "JSON-encoded input string"),
529
    ], None, None, "Call an iallocator on a remote node"),
530
  ("test_delay", MULTI, None, _TestDelayTimeout, [
531
    ("duration", None, None),
532
    ], None, None, "Sleep for a fixed time on given node(s)"),
533
  ("hypervisor_validate_params", MULTI, None, constants.RPC_TMO_NORMAL, [
534
    ("hvname", None, "Hypervisor name"),
535
    ("hvfull", None, "Parameters to be validated"),
536
    ], None, None, "Validate hypervisor params"),
537
  ("get_watcher_pause", SINGLE, None, constants.RPC_TMO_URGENT, [],
538
    None, None, "Get watcher pause end"),
539
  ("set_watcher_pause", MULTI, None, constants.RPC_TMO_URGENT, [
540
    ("until", None, None),
541
    ], None, None, "Set watcher pause end"),
542
  ]
543

    
544
CALLS = {
545
  "RpcClientDefault":
546
    _Prepare(_IMPEXP_CALLS + _X509_CALLS + _OS_CALLS + _NODE_CALLS +
547
             _FILE_STORAGE_CALLS + _MISC_CALLS + _INSTANCE_CALLS +
548
             _BLOCKDEV_CALLS + _STORAGE_CALLS + _EXTSTORAGE_CALLS),
549
  "RpcClientJobQueue": _Prepare([
550
    ("jobqueue_update", MULTI, None, constants.RPC_TMO_URGENT, [
551
      ("file_name", None, None),
552
      ("content", ED_COMPRESS, None),
553
      ], None, None, "Update job queue file"),
554
    ("jobqueue_purge", SINGLE, None, constants.RPC_TMO_NORMAL, [], None, None,
555
     "Purge job queue"),
556
    ("jobqueue_rename", MULTI, None, constants.RPC_TMO_URGENT, [
557
      ("rename", None, None),
558
      ], None, None, "Rename job queue file"),
559
    ("jobqueue_set_drain_flag", MULTI, None, constants.RPC_TMO_URGENT, [
560
      ("flag", None, None),
561
      ], None, None, "Set job queue drain flag"),
562
    ]),
563
  "RpcClientBootstrap": _Prepare([
564
    ("node_start_master_daemons", SINGLE, None, constants.RPC_TMO_FAST, [
565
      ("no_voting", None, None),
566
      ], None, None, "Starts master daemons on a node"),
567
    ("node_activate_master_ip", SINGLE, None, constants.RPC_TMO_FAST, [
568
      ("master_params", ED_OBJECT_DICT, "Network parameters of the master"),
569
      ("use_external_mip_script", None,
570
       "Whether to use the user-provided master IP address setup script"),
571
      ], None, None,
572
      "Activates master IP on a node"),
573
    ("node_stop_master", SINGLE, None, constants.RPC_TMO_FAST, [], None, None,
574
     "Deactivates master IP and stops master daemons on a node"),
575
    ("node_deactivate_master_ip", SINGLE, None, constants.RPC_TMO_FAST, [
576
      ("master_params", ED_OBJECT_DICT, "Network parameters of the master"),
577
      ("use_external_mip_script", None,
578
       "Whether to use the user-provided master IP address setup script"),
579
      ], None, None,
580
     "Deactivates master IP on a node"),
581
    ("node_change_master_netmask", SINGLE, None, constants.RPC_TMO_FAST, [
582
      ("old_netmask", None, "The old value of the netmask"),
583
      ("netmask", None, "The new value of the netmask"),
584
      ("master_ip", None, "The master IP"),
585
      ("master_netdev", None, "The master network device"),
586
      ], None, None, "Change master IP netmask"),
587
    ("node_leave_cluster", SINGLE, None, constants.RPC_TMO_NORMAL, [
588
      ("modify_ssh_setup", None, None),
589
      ], None, None,
590
     "Requests a node to clean the cluster information it has"),
591
    ("master_info", MULTI, None, constants.RPC_TMO_URGENT, [], None, None,
592
     "Query master info"),
593
    ]),
594
  "RpcClientDnsOnly": _Prepare([
595
    ("version", MULTI, ACCEPT_OFFLINE_NODE, constants.RPC_TMO_URGENT, [], None,
596
     None, "Query node version"),
597
    ("node_verify_light", MULTI, None, constants.RPC_TMO_NORMAL, [
598
      ("checkdict", None, "What to verify"),
599
      ("cluster_name", None, "Cluster name"),
600
      ("hvparams", None, "Dictionary mapping hypervisor names to hvparams"),
601
      ], None, None, "Request verification of given parameters"),
602
    ]),
603
  "RpcClientConfig": _Prepare([
604
    ("upload_file", MULTI, None, constants.RPC_TMO_NORMAL, [
605
      ("file_name", ED_FILE_DETAILS, None),
606
      ], None, None, "Upload a file"),
607
    ("write_ssconf_files", MULTI, None, constants.RPC_TMO_NORMAL, [
608
      ("values", None, None),
609
      ], None, None, "Write ssconf files"),
610
    ]),
611
  }