Statistics
| Branch: | Tag: | Revision:

root / lib / rpc_defs.py @ 06c2fb4a

History | View | Annotate | Download (24.8 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,
75
 ED_DEVICE_DICT) = range(1, 16)
76

    
77

    
78
def _Prepare(calls):
79
  """Converts list of calls to dictionary.
80

81
  """
82
  return utils.SequenceToDict(calls)
83

    
84

    
85
def _MigrationStatusPostProc(result):
86
  """Post-processor for L{rpc.RpcRunner.call_instance_get_migration_status}.
87

88
  """
89
  if not result.fail_msg and result.payload is not None:
90
    result.payload = objects.MigrationStatus.FromDict(result.payload)
91
  return result
92

    
93

    
94
def _BlockdevFindPostProc(result):
95
  """Post-processor for L{rpc.RpcRunner.call_blockdev_find}.
96

97
  """
98
  if not result.fail_msg and result.payload is not None:
99
    result.payload = objects.BlockDevStatus.FromDict(result.payload)
100
  return result
101

    
102

    
103
def _BlockdevGetMirrorStatusPostProc(result):
104
  """Post-processor for L{rpc.RpcRunner.call_blockdev_getmirrorstatus}.
105

106
  """
107
  if not result.fail_msg:
108
    result.payload = map(objects.BlockDevStatus.FromDict, result.payload)
109
  return result
110

    
111

    
112
def _BlockdevGetMirrorStatusMultiPreProc(node, args):
113
  """Prepares the appropriate node values for blockdev_getmirrorstatus_multi.
114

115
  """
116
  # there should be only one argument to this RPC, already holding a
117
  # node->disks dictionary, we just need to extract the value for the
118
  # current node
119
  assert len(args) == 1
120
  return [args[0][node]]
121

    
122

    
123
def _BlockdevGetMirrorStatusMultiPostProc(result):
124
  """Post-processor for L{rpc.RpcRunner.call_blockdev_getmirrorstatus_multi}.
125

126
  """
127
  if not result.fail_msg:
128
    for idx, (success, status) in enumerate(result.payload):
129
      if success:
130
        result.payload[idx] = (success, objects.BlockDevStatus.FromDict(status))
131

    
132
  return result
133

    
134

    
135
def _NodeInfoPreProc(node, args):
136
  """Prepare the exclusive_storage argument for node_info calls."""
137
  assert len(args) == 3
138
  # The third argument is either a dictionary with one value for each node, or
139
  # a fixed value to be used for all the nodes
140
  if type(args[2]) is dict:
141
    return [args[0], args[1], args[2][node]]
142
  else:
143
    return args
144

    
145

    
146
def _OsGetPostProc(result):
147
  """Post-processor for L{rpc.RpcRunner.call_os_get}.
148

149
  """
150
  if not result.fail_msg and isinstance(result.payload, dict):
151
    result.payload = objects.OS.FromDict(result.payload)
152
  return result
153

    
154

    
155
def _ImpExpStatusPostProc(result):
156
  """Post-processor for import/export status.
157

158
  @rtype: Payload containing list of L{objects.ImportExportStatus} instances
159
  @return: Returns a list of the state of each named import/export or None if
160
           a status couldn't be retrieved
161

162
  """
163
  if not result.fail_msg:
164
    decoded = []
165

    
166
    for i in result.payload:
167
      if i is None:
168
        decoded.append(None)
169
        continue
170
      decoded.append(objects.ImportExportStatus.FromDict(i))
171

    
172
    result.payload = decoded
173

    
174
  return result
175

    
176

    
177
def _TestDelayTimeout((duration, )):
178
  """Calculate timeout for "test_delay" RPC.
179

180
  """
181
  return int(duration + 5)
182

    
183

    
184
_FILE_STORAGE_CALLS = [
185
  ("file_storage_dir_create", SINGLE, None, constants.RPC_TMO_FAST, [
186
    ("file_storage_dir", None, "File storage directory"),
187
    ], None, None, "Create the given file storage directory"),
188
  ("file_storage_dir_remove", SINGLE, None, constants.RPC_TMO_FAST, [
189
    ("file_storage_dir", None, "File storage directory"),
190
    ], None, None, "Remove the given file storage directory"),
191
  ("file_storage_dir_rename", SINGLE, None, constants.RPC_TMO_FAST, [
192
    ("old_file_storage_dir", None, "Old name"),
193
    ("new_file_storage_dir", None, "New name"),
194
    ], None, None, "Rename file storage directory"),
195
  ]
196

    
197
_STORAGE_CALLS = [
198
  ("storage_list", MULTI, None, constants.RPC_TMO_NORMAL, [
199
    ("su_name", None, None),
200
    ("su_args", None, None),
201
    ("name", None, None),
202
    ("fields", None, None),
203
    ], None, None, "Get list of storage units"),
204
  ("storage_modify", SINGLE, None, constants.RPC_TMO_NORMAL, [
205
    ("su_name", None, None),
206
    ("su_args", None, None),
207
    ("name", None, None),
208
    ("changes", None, None),
209
    ], None, None, "Modify a storage unit"),
210
  ("storage_execute", SINGLE, None, constants.RPC_TMO_NORMAL, [
211
    ("su_name", None, None),
212
    ("su_args", None, None),
213
    ("name", None, None),
214
    ("op", None, None),
215
    ], None, None, "Executes an operation on a storage unit"),
216
  ]
217

    
218
_INSTANCE_CALLS = [
219
  ("instance_info", SINGLE, None, constants.RPC_TMO_URGENT, [
220
    ("instance", None, "Instance name"),
221
    ("hname", None, "Hypervisor type"),
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
    ], None, None,
226
   "Returns information about all instances on the given nodes"),
227
  ("instance_list", MULTI, None, constants.RPC_TMO_URGENT, [
228
    ("hypervisor_list", None, "Hypervisors to query for instances"),
229
    ], None, None, "Returns the list of running instances on the given nodes"),
230
  ("instance_reboot", SINGLE, None, constants.RPC_TMO_NORMAL, [
231
    ("inst", ED_INST_DICT, "Instance object"),
232
    ("reboot_type", None, None),
233
    ("shutdown_timeout", None, None),
234
    ("reason", None, "The reason for the reboot"),
235
    ], None, None, "Returns the list of running instances on the given nodes"),
236
  ("instance_shutdown", SINGLE, None, constants.RPC_TMO_NORMAL, [
237
    ("instance", ED_INST_DICT, "Instance object"),
238
    ("timeout", None, None),
239
    ("reason", None, "The reason for the shutdown"),
240
    ], None, None, "Stops an instance"),
241
  ("instance_balloon_memory", SINGLE, None, constants.RPC_TMO_NORMAL, [
242
    ("instance", ED_INST_DICT, "Instance object"),
243
    ("memory", None, None),
244
    ], None, None, "Modify the amount of an instance's runtime memory"),
245
  ("instance_run_rename", SINGLE, None, constants.RPC_TMO_SLOW, [
246
    ("instance", ED_INST_DICT, "Instance object"),
247
    ("old_name", None, None),
248
    ("debug", None, None),
249
    ], None, None, "Run the OS rename script for an instance"),
250
  ("instance_migratable", SINGLE, None, constants.RPC_TMO_NORMAL, [
251
    ("instance", ED_INST_DICT, "Instance object"),
252
    ], None, None, "Checks whether the given instance can be migrated"),
253
  ("migration_info", SINGLE, None, constants.RPC_TMO_NORMAL, [
254
    ("instance", ED_INST_DICT, "Instance object"),
255
    ], None, None,
256
    "Gather the information necessary to prepare an instance migration"),
257
  ("accept_instance", SINGLE, None, constants.RPC_TMO_NORMAL, [
258
    ("instance", ED_INST_DICT, "Instance object"),
259
    ("info", None, "Result for the call_migration_info call"),
260
    ("target", None, "Target hostname (usually an IP address)"),
261
    ], None, None, "Prepare a node to accept an instance"),
262
  ("instance_finalize_migration_dst", SINGLE, None, constants.RPC_TMO_NORMAL, [
263
    ("instance", ED_INST_DICT, "Instance object"),
264
    ("info", None, "Result for the call_migration_info call"),
265
    ("success", None, "Whether the migration was a success or failure"),
266
    ], None, None, "Finalize any target-node migration specific operation"),
267
  ("instance_migrate", SINGLE, None, constants.RPC_TMO_SLOW, [
268
    ("instance", ED_INST_DICT, "Instance object"),
269
    ("target", None, "Target node name"),
270
    ("live", None, "Whether the migration should be done live or not"),
271
    ], None, None, "Migrate an instance"),
272
  ("instance_finalize_migration_src", SINGLE, None, constants.RPC_TMO_SLOW, [
273
    ("instance", ED_INST_DICT, "Instance object"),
274
    ("success", None, "Whether the migration succeeded or not"),
275
    ("live", None, "Whether the user requested a live migration or not"),
276
    ], None, None, "Finalize the instance migration on the source node"),
277
  ("instance_get_migration_status", SINGLE, None, constants.RPC_TMO_SLOW, [
278
    ("instance", ED_INST_DICT, "Instance object"),
279
    ], None, _MigrationStatusPostProc, "Report migration status"),
280
  ("instance_start", SINGLE, None, constants.RPC_TMO_NORMAL, [
281
    ("instance_hvp_bep", ED_INST_DICT_HVP_BEP_DP, None),
282
    ("startup_paused", None, None),
283
    ("reason", None, "The reason for the startup"),
284
    ], None, None, "Starts an instance"),
285
  ("instance_os_add", SINGLE, None, constants.RPC_TMO_1DAY, [
286
    ("instance_osp", ED_INST_DICT_OSP_DP, None),
287
    ("reinstall", None, None),
288
    ("debug", None, None),
289
    ], None, None, "Starts an instance"),
290
  ("hotplug_device", SINGLE, None, constants.RPC_TMO_NORMAL, [
291
    ("instance", ED_INST_DICT, "Instance object"),
292
    ("action", None, "Hotplug Action"),
293
    ("dev_type", None, "Device type"),
294
    ("device", ED_DEVICE_DICT, "Device dict"),
295
    ("extra", None, "Extra info for device (dev_path for disk)"),
296
    ("seq", None, "Device seq"),
297
    ], None, None, "Hoplug a device to a running instance"),
298
  ("hotplug_supported", SINGLE, None, constants.RPC_TMO_NORMAL, [
299
    ("instance", ED_INST_DICT, "Instance object"),
300
    ], None, None, "Check if hotplug is supported"),
301
  ]
302

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

    
341
_X509_CALLS = [
342
  ("x509_cert_create", SINGLE, None, constants.RPC_TMO_NORMAL, [
343
    ("validity", None, "Validity in seconds"),
344
    ], None, None, "Creates a new X509 certificate for SSL/TLS"),
345
  ("x509_cert_remove", SINGLE, None, constants.RPC_TMO_NORMAL, [
346
    ("name", None, "Certificate name"),
347
    ], None, None, "Removes a X509 certificate"),
348
  ]
349

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

    
456
_OS_CALLS = [
457
  ("os_diagnose", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
458
   "Request a diagnose of OS definitions"),
459
  ("os_validate", MULTI, None, constants.RPC_TMO_FAST, [
460
    ("required", None, None),
461
    ("name", None, None),
462
    ("checks", None, None),
463
    ("params", None, None),
464
    ], None, None, "Run a validation routine for a given OS"),
465
  ("os_get", SINGLE, None, constants.RPC_TMO_FAST, [
466
    ("name", None, None),
467
    ], None, _OsGetPostProc, "Returns an OS definition"),
468
  ]
469

    
470
_EXTSTORAGE_CALLS = [
471
  ("extstorage_diagnose", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
472
   "Request a diagnose of ExtStorage Providers"),
473
  ]
474

    
475
_NODE_CALLS = [
476
  ("node_has_ip_address", SINGLE, None, constants.RPC_TMO_FAST, [
477
    ("address", None, "IP address"),
478
    ], None, None, "Checks if a node has the given IP address"),
479
  ("node_info", MULTI, None, constants.RPC_TMO_URGENT, [
480
    ("vg_names", None,
481
     "Names of the volume groups to ask for disk space information"),
482
    ("hv_names", None,
483
     "Names of the hypervisors to ask for node information"),
484
    ("exclusive_storage", None,
485
     "Whether exclusive storage is enabled"),
486
    ], _NodeInfoPreProc, None, "Return node information"),
487
  ("node_verify", MULTI, None, constants.RPC_TMO_NORMAL, [
488
    ("checkdict", None, None),
489
    ("cluster_name", None, None),
490
    ], None, None, "Request verification of given parameters"),
491
  ("node_volumes", MULTI, None, constants.RPC_TMO_FAST, [], None, None,
492
   "Gets all volumes on node(s)"),
493
  ("node_demote_from_mc", SINGLE, None, constants.RPC_TMO_FAST, [], None, None,
494
   "Demote a node from the master candidate role"),
495
  ("node_powercycle", SINGLE, ACCEPT_OFFLINE_NODE, constants.RPC_TMO_NORMAL, [
496
    ("hypervisor", None, "Hypervisor type"),
497
    ], None, None, "Tries to powercycle a node"),
498
  ]
499

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

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