1
2
3
4 """Automatically generated RPC client wrappers.
5
6 """
7
8 from ganeti import rpc_defs
9
10
11
13
14
15
16 _CALLS = rpc_defs.CALLS['RpcClientBootstrap']
17
20 """Wrapper for RPC call 'master_node_name'
21
22 Returns the master node name
23
24 @note: This is a multi-node call with a timeout of 1m 0s
25 @type node_list: list of string
26 @param node_list: List of node names
27
28 """
29 return (self._Call(_def, node_list, []))
30
33 """Wrapper for RPC call 'node_activate_master_ip'
34
35 Activates master IP on a node
36
37 @note: This is a single-node call with a timeout of 5m 0s
38 @type node: string
39 @param node: Node name
40 @param master_params: Network parameters of the master
41 @param use_external_mip_script: Whether to use the user-provided
42 master IP address setup script
43
44 """
45 return (self._Call(_def, [node], [master_params,
46 use_external_mip_script])[node])
47
51 """Wrapper for RPC call 'node_change_master_netmask'
52
53 Change master IP netmask
54
55 @note: This is a single-node call with a timeout of 5m 0s
56 @type node: string
57 @param node: Node name
58 @param old_netmask: The old value of the netmask
59 @param netmask: The new value of the netmask
60 @param master_ip: The master IP
61 @param master_netdev: The master network device
62
63 """
64 return (self._Call(_def, [node], [old_netmask, netmask, master_ip,
65 master_netdev])[node])
66
69 """Wrapper for RPC call 'node_deactivate_master_ip'
70
71 Deactivates master IP on a node
72
73 @note: This is a single-node call with a timeout of 5m 0s
74 @type node: string
75 @param node: Node name
76 @param master_params: Network parameters of the master
77 @param use_external_mip_script: Whether to use the user-provided
78 master IP address setup script
79
80 """
81 return (self._Call(_def, [node], [master_params,
82 use_external_mip_script])[node])
83
86 """Wrapper for RPC call 'node_leave_cluster'
87
88 Requests a node to clean the cluster information it has
89
90 @note: This is a single-node call with a timeout of 15m 0s
91 @type node: string
92 @param node: Node name
93
94 """
95 return (self._Call(_def, [node], [modify_ssh_setup])[node])
96
99 """Wrapper for RPC call 'node_start_master_daemons'
100
101 Starts master daemons on a node
102
103 @note: This is a single-node call with a timeout of 5m 0s
104 @type node: string
105 @param node: Node name
106
107 """
108 return (self._Call(_def, [node], [no_voting])[node])
109
112 """Wrapper for RPC call 'node_stop_master'
113
114 Deactivates master IP and stops master daemons on a node
115
116 @note: This is a single-node call with a timeout of 5m 0s
117 @type node: string
118 @param node: Node name
119
120 """
121 return (self._Call(_def, [node], [])[node])
122
123
125
126
127
128 _CALLS = rpc_defs.CALLS['RpcClientConfig']
129
132 """Wrapper for RPC call 'upload_file'
133
134 Upload files
135
136 @note: This is a multi-node call with a timeout of 15m 0s
137 @type node_list: list of string
138 @param node_list: List of node names
139
140 """
141 return (self._Call(_def, node_list, [file_name]))
142
145 """Wrapper for RPC call 'upload_file_single'
146
147 Upload files
148
149 @note: This is a multi-node call with a timeout of 15m 0s
150 @type node_list: list of string
151 @param node_list: List of node names
152 @param file_name: The name of the file
153 @param content: The data to be uploaded
154 @param mode: The mode of the file or None
155 @param uid: The owner of the file
156 @param gid: The group of the file
157 @param atime: The file's last access time
158 @param mtime: The file's last modification time
159
160 """
161 return (self._Call(_def, node_list, [file_name, content, mode, uid,
162 gid, atime, mtime]))
163
166 """Wrapper for RPC call 'write_ssconf_files'
167
168 Write ssconf files
169
170 @note: This is a multi-node call with a timeout of 15m 0s
171 @type node_list: list of string
172 @param node_list: List of node names
173
174 """
175 return (self._Call(_def, node_list, [values]))
176
177
179
180
181
182 _CALLS = rpc_defs.CALLS['RpcClientDefault']
183
186 """Wrapper for RPC call 'accept_instance'
187
188 Prepare a node to accept an instance
189
190 @note: This is a single-node call with a timeout of 15m 0s
191 @type node: string
192 @param node: Node name
193 @param instance: Instance object
194 @param info: Result for the call_migration_info call
195 @param target: Target hostname (usually an IP address)
196
197 """
198 return (self._Call(_def, [node], [instance, info, target])[node])
199
202 """Wrapper for RPC call 'all_instances_info'
203
204 Returns information about all instances on the given nodes
205
206 @note: This is a multi-node call with a timeout of 1m 0s
207 @type node_list: list of string
208 @param node_list: List of node names
209 @param hypervisor_list: Hypervisors to query for instances
210 @param all_hvparams: Dictionary mapping hypervisor names to hvparams
211
212 """
213 return (self._Call(_def, node_list, [hypervisor_list, all_hvparams]))
214
217 """Wrapper for RPC call 'bdev_sizes'
218
219 Gets the sizes of requested block devices present on a node
220
221 @note: This is a multi-node call with a timeout of 1m 0s
222 @type node_list: list of string
223 @param node_list: List of node names
224
225 """
226 return (self._Call(_def, node_list, [devices]))
227
230 """Wrapper for RPC call 'blockdev_addchildren'
231
232 Request adding a list of children to a (mirroring) device
233
234 @note: This is a single-node call with a timeout of 15m 0s
235 @type node: string
236 @param node: Node name
237
238 """
239 return (self._Call(_def, [node], [bdev, ndevs])[node])
240
243 """Wrapper for RPC call 'blockdev_assemble'
244
245 Request assembling of a given block device
246
247 @note: This is a single-node call with a timeout of 15m 0s
248 @type node: string
249 @param node: Node name
250
251 """
252 return (self._Call(_def, [node], [disk, instance, on_primary,
253 idx])[node])
254
257 """Wrapper for RPC call 'blockdev_close'
258
259 Closes the given block devices
260
261 @note: This is a single-node call with a timeout of 15m 0s
262 @type node: string
263 @param node: Node name
264
265 """
266 return (self._Call(_def, [node], [instance_name, disks])[node])
267
270 """Wrapper for RPC call 'blockdev_convert'
271
272 Request the copy of the source block device to the destination one
273
274 @note: This is a single-node call with a timeout of 1h 0m 0s
275 @type node: string
276 @param node: Node name
277
278 """
279 return (self._Call(_def, [node], [bdev_src, bdev_dest])[node])
280
281 - def call_blockdev_create(self, node, bdev, size, owner, on_primary,
282 info, exclusive_storage, _def=_CALLS['blockdev_create']):
283 """Wrapper for RPC call 'blockdev_create'
284
285 Request creation of a given block device
286
287 @note: This is a single-node call with a timeout of 15m 0s
288 @type node: string
289 @param node: Node name
290
291 """
292 return (self._Call(_def, [node], [bdev, size, owner, on_primary, info,
293 exclusive_storage])[node])
294
297 """Wrapper for RPC call 'blockdev_find'
298
299 Request identification of a given block device
300
301 @note: This is a single-node call with a timeout of 15m 0s
302 @type node: string
303 @param node: Node name
304
305 """
306 return (self._Call(_def, [node], [disk])[node])
307
310 """Wrapper for RPC call 'blockdev_getdimensions'
311
312 Returns size and spindles of the given disks
313
314 @note: This is a single-node call with a timeout of 15m 0s
315 @type node: string
316 @param node: Node name
317
318 """
319 return (self._Call(_def, [node], [disks])[node])
320
323 """Wrapper for RPC call 'blockdev_getmirrorstatus'
324
325 Request status of a (mirroring) device
326
327 @note: This is a single-node call with a timeout of 15m 0s
328 @type node: string
329 @param node: Node name
330
331 """
332 return (self._Call(_def, [node], [disks])[node])
333
336 """Wrapper for RPC call 'blockdev_getmirrorstatus_multi'
337
338 Request status of (mirroring) devices from multiple nodes
339
340 @note: This is a multi-node call with a timeout of 15m 0s
341 @type node_list: list of string
342 @param node_list: List of node names
343
344 """
345 return (self._Call(_def, node_list, [node_disks]))
346
349 """Wrapper for RPC call 'blockdev_grow'
350
351 Request growing of the given block device by a given amount
352
353 @note: This is a single-node call with a timeout of 15m 0s
354 @type node: string
355 @param node: Node name
356
357 """
358 return (self._Call(_def, [node], [cf_bdev, amount, dryrun,
359 backingstore, es_flag])[node])
360
363 """Wrapper for RPC call 'blockdev_image'
364
365 Request to dump an image with given size onto a block device
366
367 @note: This is a single-node call with a timeout of 1h 0m 0s
368 @type node: string
369 @param node: Node name
370
371 """
372 return (self._Call(_def, [node], [bdev, image, size])[node])
373
376 """Wrapper for RPC call 'blockdev_pause_resume_sync'
377
378 Request a pause/resume of given block device
379
380 @note: This is a single-node call with a timeout of 15m 0s
381 @type node: string
382 @param node: Node name
383
384 """
385 return (self._Call(_def, [node], [disks, pause])[node])
386
389 """Wrapper for RPC call 'blockdev_remove'
390
391 Request removal of a given block device
392
393 @note: This is a single-node call with a timeout of 15m 0s
394 @type node: string
395 @param node: Node name
396
397 """
398 return (self._Call(_def, [node], [bdev])[node])
399
402 """Wrapper for RPC call 'blockdev_removechildren'
403
404 Request removing a list of children from a (mirroring) device
405
406 @note: This is a single-node call with a timeout of 15m 0s
407 @type node: string
408 @param node: Node name
409
410 """
411 return (self._Call(_def, [node], [bdev, ndevs])[node])
412
415 """Wrapper for RPC call 'blockdev_rename'
416
417 Request rename of the given block devices
418
419 @note: This is a single-node call with a timeout of 15m 0s
420 @type node: string
421 @param node: Node name
422
423 """
424 return (self._Call(_def, [node], [devlist])[node])
425
428 """Wrapper for RPC call 'blockdev_setinfo'
429
430 Sets metadata information on a given block device
431
432 @note: This is a single-node call with a timeout of 15m 0s
433 @type node: string
434 @param node: Node name
435
436 """
437 return (self._Call(_def, [node], [disk, info])[node])
438
441 """Wrapper for RPC call 'blockdev_shutdown'
442
443 Request shutdown of a given block device
444
445 @note: This is a single-node call with a timeout of 15m 0s
446 @type node: string
447 @param node: Node name
448
449 """
450 return (self._Call(_def, [node], [disk])[node])
451
454 """Wrapper for RPC call 'blockdev_snapshot'
455
456 Export a given disk to another node
457
458 @note: This is a single-node call with a timeout of 15m 0s
459 @type node: string
460 @param node: Node name
461
462 """
463 return (self._Call(_def, [node], [cf_bdev, snap_name,
464 snap_size])[node])
465
468 """Wrapper for RPC call 'blockdev_wipe'
469
470 Request wipe at given offset with given size of a block device
471
472 @note: This is a single-node call with a timeout of 1h 0m 0s
473 @type node: string
474 @param node: Node name
475
476 """
477 return (self._Call(_def, [node], [bdev, offset, size])[node])
478
481 """Wrapper for RPC call 'bridges_exist'
482
483 Checks if a node has all the bridges given
484
485 @note: This is a single-node call with a timeout of 1m 0s
486 @type node: string
487 @param node: Node name
488 @param bridges_list: Bridges which must be present on remote node
489
490 """
491 return (self._Call(_def, [node], [bridges_list])[node])
492
495 """Wrapper for RPC call 'drbd_attach_net'
496
497 Connects the given DRBD devices
498
499 @note: This is a multi-node call with a timeout of 15m 0s
500 @type node_list: list of string
501 @param node_list: List of node names
502
503 """
504 return (self._Call(_def, node_list, [disks, instance_name,
505 multimaster]))
506
509 """Wrapper for RPC call 'drbd_disconnect_net'
510
511 Disconnects the network of the given drbd devices
512
513 @note: This is a multi-node call with a timeout of 15m 0s
514 @type node_list: list of string
515 @param node_list: List of node names
516
517 """
518 return (self._Call(_def, node_list, [disks]))
519
521 """Wrapper for RPC call 'drbd_helper'
522
523 Gets DRBD helper
524
525 @note: This is a multi-node call with a timeout of 1m 0s
526 @type node_list: list of string
527 @param node_list: List of node names
528
529 """
530 return (self._Call(_def, node_list, []))
531
534 """Wrapper for RPC call 'drbd_needs_activation'
535
536 Returns the drbd disks which need activation
537
538 @note: This is a single-node call with a timeout of 15m 0s
539 @type node: string
540 @param node: Node name
541
542 """
543 return (self._Call(_def, [node], [disks])[node])
544
547 """Wrapper for RPC call 'drbd_wait_sync'
548
549 Waits for the synchronization of drbd devices is complete
550
551 @note: This is a multi-node call with a timeout of 1h 0m 0s
552 @type node_list: list of string
553 @param node_list: List of node names
554
555 """
556 return (self._Call(_def, node_list, [disks]))
557
560 """Wrapper for RPC call 'etc_hosts_modify'
561
562 Modify hosts file with name
563
564 @note: This is a single-node call with a timeout of 15m 0s
565 @type node: string
566 @param node: Node name
567 @param mode: Mode to operate; currently L{constants.ETC_HOSTS_ADD} or
568 L{constants.ETC_HOSTS_REMOVE}
569 @param name: Hostname to be modified
570 @param ip: IP address (L{constants.ETC_HOSTS_ADD} only)
571
572 """
573 return (self._Call(_def, [node], [mode, name, ip])[node])
574
576 """Wrapper for RPC call 'export_info'
577
578 Queries the export information in a given path
579
580 @note: This is a single-node call with a timeout of 5m 0s
581 @type node: string
582 @param node: Node name
583
584 """
585 return (self._Call(_def, [node], [path])[node])
586
588 """Wrapper for RPC call 'export_list'
589
590 Gets the stored exports list
591
592 @note: This is a multi-node call with a timeout of 5m 0s
593 @type node_list: list of string
594 @param node_list: List of node names
595
596 """
597 return (self._Call(_def, node_list, []))
598
601 """Wrapper for RPC call 'export_remove'
602
603 Requests removal of a given export
604
605 @note: This is a single-node call with a timeout of 5m 0s
606 @type node: string
607 @param node: Node name
608
609 """
610 return (self._Call(_def, [node], [export])[node])
611
612 - def call_export_start(self, node, opts, host, port, instance,
613 component, source, _def=_CALLS['export_start']):
614 """Wrapper for RPC call 'export_start'
615
616 Starts an export daemon
617
618 @note: This is a single-node call with a timeout of 15m 0s
619 @type node: string
620 @param node: Node name
621 @param source: Export source
622
623 """
624 return (self._Call(_def, [node], [opts, host, port, instance,
625 component, source])[node])
626
629 """Wrapper for RPC call 'extstorage_diagnose'
630
631 Request a diagnose of ExtStorage Providers
632
633 @note: This is a multi-node call with a timeout of 5m 0s
634 @type node_list: list of string
635 @param node_list: List of node names
636
637 """
638 return (self._Call(_def, node_list, []))
639
642 """Wrapper for RPC call 'file_storage_dir_create'
643
644 Create the given file storage directory
645
646 @note: This is a single-node call with a timeout of 5m 0s
647 @type node: string
648 @param node: Node name
649 @param file_storage_dir: File storage directory
650
651 """
652 return (self._Call(_def, [node], [file_storage_dir])[node])
653
656 """Wrapper for RPC call 'file_storage_dir_remove'
657
658 Remove the given file storage directory
659
660 @note: This is a single-node call with a timeout of 5m 0s
661 @type node: string
662 @param node: Node name
663 @param file_storage_dir: File storage directory
664
665 """
666 return (self._Call(_def, [node], [file_storage_dir])[node])
667
670 """Wrapper for RPC call 'file_storage_dir_rename'
671
672 Rename file storage directory
673
674 @note: This is a single-node call with a timeout of 5m 0s
675 @type node: string
676 @param node: Node name
677 @param old_file_storage_dir: Old name
678 @param new_file_storage_dir: New name
679
680 """
681 return (self._Call(_def, [node], [old_file_storage_dir,
682 new_file_storage_dir])[node])
683
686 """Wrapper for RPC call 'finalize_export'
687
688 Request the completion of an export operation
689
690 @note: This is a single-node call with a timeout of 15m 0s
691 @type node: string
692 @param node: Node name
693
694 """
695 return (self._Call(_def, [node], [instance, snap_disks])[node])
696
699 """Wrapper for RPC call 'get_file_info'
700
701 Checks if a file exists and reports on it
702
703 @note: This is a single-node call with a timeout of 5m 0s
704 @type node: string
705 @param node: Node name
706
707 """
708 return (self._Call(_def, [node], [file_path])[node])
709
712 """Wrapper for RPC call 'get_watcher_pause'
713
714 Get watcher pause end
715
716 @note: This is a single-node call with a timeout of 1m 0s
717 @type node: string
718 @param node: Node name
719
720 """
721 return (self._Call(_def, [node], [])[node])
722
725 """Wrapper for RPC call 'hooks_runner'
726
727 Call the hooks runner
728
729 @note: This is a multi-node call with a timeout of 15m 0s
730 @type node_list: list of string
731 @param node_list: List of node names
732
733 """
734 return (self._Call(_def, node_list, [hpath, phase, env]))
735
738 """Wrapper for RPC call 'hotplug_device'
739
740 Hoplug a device to a running instance
741
742 @note: This is a single-node call with a timeout of 15m 0s
743 @type node: string
744 @param node: Node name
745 @param instance: Instance object
746 @param action: Hotplug Action
747 @param dev_type: Device type
748 @param device: Device dict
749 @param extra: Extra info for device (dev_path for disk)
750 @param seq: Device seq
751
752 """
753 return (self._Call(_def, [node], [instance, action, dev_type, device,
754 extra, seq])[node])
755
758 """Wrapper for RPC call 'hotplug_supported'
759
760 Check if hotplug is supported
761
762 @note: This is a single-node call with a timeout of 15m 0s
763 @type node: string
764 @param node: Node name
765 @param instance: Instance object
766
767 """
768 return (self._Call(_def, [node], [instance])[node])
769
772 """Wrapper for RPC call 'hypervisor_validate_params'
773
774 Validate hypervisor params
775
776 @note: This is a multi-node call with a timeout of 15m 0s
777 @type node_list: list of string
778 @param node_list: List of node names
779 @param hvname: Hypervisor name
780 @param hvfull: Parameters to be validated
781
782 """
783 return (self._Call(_def, node_list, [hvname, hvfull]))
784
787 """Wrapper for RPC call 'iallocator_runner'
788
789 Call an iallocator on a remote node
790
791 @note: This is a single-node call with a timeout of 15m 0s
792 @type node: string
793 @param node: Node name
794 @param name: Iallocator name
795 @param idata: JSON-encoded input string
796 @param default_iallocator_params: Additional iallocator parameters
797
798 """
799 return (self._Call(_def, [node], [name, idata,
800 default_iallocator_params])[node])
801
803 """Wrapper for RPC call 'impexp_abort'
804
805 Aborts an import or export
806
807 @note: This is a single-node call with a timeout of 15m 0s
808 @type node: string
809 @param node: Node name
810 @param name: Import/export name
811
812 """
813 return (self._Call(_def, [node], [name])[node])
814
817 """Wrapper for RPC call 'impexp_cleanup'
818
819 Cleans up after an import or export
820
821 @note: This is a single-node call with a timeout of 15m 0s
822 @type node: string
823 @param node: Node name
824 @param name: Import/export name
825
826 """
827 return (self._Call(_def, [node], [name])[node])
828
831 """Wrapper for RPC call 'impexp_status'
832
833 Gets the status of an import or export
834
835 @note: This is a single-node call with a timeout of 5m 0s
836 @type node: string
837 @param node: Node name
838 @param names: Import/export names
839
840 """
841 return (self._Call(_def, [node], [names])[node])
842
845 """Wrapper for RPC call 'import_start'
846
847 Starts an import daemon
848
849 @note: This is a single-node call with a timeout of 15m 0s
850 @type node: string
851 @param node: Node name
852 @param dest: Import destination
853
854 """
855 return (self._Call(_def, [node], [opts, instance, component,
856 dest])[node])
857
860 """Wrapper for RPC call 'instance_balloon_memory'
861
862 Modify the amount of an instance's runtime memory
863
864 @note: This is a single-node call with a timeout of 15m 0s
865 @type node: string
866 @param node: Node name
867 @param instance: Instance object
868
869 """
870 return (self._Call(_def, [node], [instance, memory])[node])
871
874 """Wrapper for RPC call 'instance_finalize_migration_dst'
875
876 Finalize any target-node migration specific operation
877
878 @note: This is a single-node call with a timeout of 15m 0s
879 @type node: string
880 @param node: Node name
881 @param instance: Instance object
882 @param info: Result for the call_migration_info call
883 @param success: Whether the migration was a success or failure
884
885 """
886 return (self._Call(_def, [node], [instance, info, success])[node])
887
890 """Wrapper for RPC call 'instance_finalize_migration_src'
891
892 Finalize the instance migration on the source node
893
894 @note: This is a single-node call with a timeout of 1h 0m 0s
895 @type node: string
896 @param node: Node name
897 @param instance: Instance object
898 @param success: Whether the migration succeeded or not
899 @param live: Whether the user requested a live migration or not
900
901 """
902 return (self._Call(_def, [node], [instance, success, live])[node])
903
906 """Wrapper for RPC call 'instance_get_migration_status'
907
908 Report migration status
909
910 @note: This is a single-node call with a timeout of 1h 0m 0s
911 @type node: string
912 @param node: Node name
913 @param instance: Instance object
914
915 """
916 return (self._Call(_def, [node], [instance])[node])
917
920 """Wrapper for RPC call 'instance_info'
921
922 Returns information about a single instance
923
924 @note: This is a single-node call with a timeout of 1m 0s
925 @type node: string
926 @param node: Node name
927 @param instance: Instance name
928 @param hname: Hypervisor type
929 @param hvparams: Hypervisor parameters
930
931 """
932 return (self._Call(_def, [node], [instance, hname, hvparams])[node])
933
936 """Wrapper for RPC call 'instance_list'
937
938 Returns the list of running instances on the given nodes
939
940 @note: This is a multi-node call with a timeout of 1m 0s
941 @type node_list: list of string
942 @param node_list: List of node names
943 @param hypervisor_list: Hypervisors to query for instances
944 @param hvparams: Hvparams of all hypervisors
945
946 """
947 return (self._Call(_def, node_list, [hypervisor_list, hvparams]))
948
962
965 """Wrapper for RPC call 'instance_migratable'
966
967 Checks whether the given instance can be migrated
968
969 @note: This is a single-node call with a timeout of 15m 0s
970 @type node: string
971 @param node: Node name
972 @param instance: Instance object
973
974 """
975 return (self._Call(_def, [node], [instance])[node])
976
979 """Wrapper for RPC call 'instance_migrate'
980
981 Migrate an instance
982
983 @note: This is a single-node call with a timeout of 1h 0m 0s
984 @type node: string
985 @param node: Node name
986 @param cluster_name: Cluster name
987 @param instance: Instance object
988 @param target: Target node name
989 @param live: Whether the migration should be done live or not
990
991 """
992 return (self._Call(_def, [node], [cluster_name, instance, target,
993 live])[node])
994
997 """Wrapper for RPC call 'instance_os_add'
998
999 Installs an operative system onto an instance
1000
1001 @note: This is a single-node call with a timeout of 1d 0h 0m 0s
1002 @type node: string
1003 @param node: Node name
1004 @param instance_osp: Tuple: (target instance, temporary OS parameters
1005 overriding configuration)
1006 @param reinstall: Whether the instance is being reinstalled
1007 @param debug: Debug level for the OS install script to use
1008
1009 """
1010 return (self._Call(_def, [node], [instance_osp, reinstall,
1011 debug])[node])
1012
1015 """Wrapper for RPC call 'instance_reboot'
1016
1017 Returns the list of running instances on the given nodes
1018
1019 @note: This is a single-node call with a timeout of 15m 0s
1020 @type node: string
1021 @param node: Node name
1022 @param inst: Instance object
1023 @param reason: The reason for the reboot
1024
1025 """
1026 return (self._Call(_def, [node], [inst, reboot_type, shutdown_timeout,
1027 reason])[node])
1028
1031 """Wrapper for RPC call 'instance_run_rename'
1032
1033 Run the OS rename script for an instance
1034
1035 @note: This is a single-node call with a timeout of 1h 0m 0s
1036 @type node: string
1037 @param node: Node name
1038 @param instance: Instance object
1039
1040 """
1041 return (self._Call(_def, [node], [instance, old_name, debug])[node])
1042
1045 """Wrapper for RPC call 'instance_shutdown'
1046
1047 Stops an instance
1048
1049 @note: This is a single-node call with a timeout of 15m 0s
1050 @type node: string
1051 @param node: Node name
1052 @param instance: Instance object
1053 @param reason: The reason for the shutdown
1054
1055 """
1056 return (self._Call(_def, [node], [instance, timeout, reason])[node])
1057
1060 """Wrapper for RPC call 'instance_start'
1061
1062 Starts an instance
1063
1064 @note: This is a single-node call with a timeout of 15m 0s
1065 @type node: string
1066 @param node: Node name
1067 @param reason: The reason for the startup
1068
1069 """
1070 return (self._Call(_def, [node], [instance_hvp_bep, startup_paused,
1071 reason])[node])
1072
1074 """Wrapper for RPC call 'lv_list'
1075
1076 Gets the logical volumes present in a given volume group
1077
1078 @note: This is a multi-node call with a timeout of 1m 0s
1079 @type node_list: list of string
1080 @param node_list: List of node names
1081
1082 """
1083 return (self._Call(_def, node_list, [vg_name]))
1084
1087 """Wrapper for RPC call 'migration_info'
1088
1089 Gather the information necessary to prepare an instance migration
1090
1091 @note: This is a single-node call with a timeout of 15m 0s
1092 @type node: string
1093 @param node: Node name
1094 @param instance: Instance object
1095
1096 """
1097 return (self._Call(_def, [node], [instance])[node])
1098
1113
1116 """Wrapper for RPC call 'node_crypto_tokens'
1117
1118 Handle crypto tokens of the node.
1119
1120 @note: This is a single-node call with a timeout of 1h 0m 0s
1121 @type node: string
1122 @param node: Node name
1123 @param token_request: List of tuples of requested crypto token types,
1124 actions
1125
1126 """
1127 return (self._Call(_def, [node], [token_request])[node])
1128
1131 """Wrapper for RPC call 'node_demote_from_mc'
1132
1133 Demote a node from the master candidate role
1134
1135 @note: This is a single-node call with a timeout of 5m 0s
1136 @type node: string
1137 @param node: Node name
1138
1139 """
1140 return (self._Call(_def, [node], [])[node])
1141
1144 """Wrapper for RPC call 'node_ensure_daemon'
1145
1146 Ensure daemon is running on the node.
1147
1148 @note: This is a multi-node call with a timeout of 1m 0s
1149 @type node_list: list of string
1150 @param node_list: List of node names
1151 @param daemon: Daemon name
1152 @param run: Whether the daemon should be running or stopped
1153
1154 """
1155 return (self._Call(_def, node_list, [daemon, run]))
1156
1159 """Wrapper for RPC call 'node_has_ip_address'
1160
1161 Checks if a node has the given IP address
1162
1163 @note: This is a single-node call with a timeout of 5m 0s
1164 @type node: string
1165 @param node: Node name
1166 @param address: IP address
1167
1168 """
1169 return (self._Call(_def, [node], [address])[node])
1170
1173 """Wrapper for RPC call 'node_info'
1174
1175 Return node information
1176
1177 @note: This is a multi-node call with a timeout of 1m 0s
1178 @type node_list: list of string
1179 @param node_list: List of node names
1180 @param storage_units: List of tuples '<storage_type>,<key>,[<param>]'
1181 to ask for disk space information; the parameter list varies
1182 depending on the storage_type
1183 @param hv_specs: List of hypervisor specification (name, hvparams) to
1184 ask for node information
1185
1186 """
1187 return (self._Call(_def, node_list, [storage_units, hv_specs]))
1188
1191 """Wrapper for RPC call 'node_powercycle'
1192
1193 Tries to powercycle a node
1194
1195 @note: This is a single-node call with a timeout of 15m 0s
1196 @type node: string
1197 @param node: Node name
1198 @param hypervisor: Hypervisor type
1199 @param hvparams: Hypervisor parameters
1200
1201 """
1202 return (self._Call(_def, [node], [hypervisor, hvparams])[node])
1203
1204 - def call_node_ssh_key_add(self, node_list, node_uuid, node_name,
1205 potential_master_candidates, to_authorized_keys, to_public_keys,
1206 get_public_keys, _def=_CALLS['node_ssh_key_add']):
1207 """Wrapper for RPC call 'node_ssh_key_add'
1208
1209 Distribute a new node's public SSH key on the cluster.
1210
1211 @note: This is a multi-node call with a timeout of 1m 0s
1212 @type node_list: list of string
1213 @param node_list: List of node names
1214 @param node_uuid: UUID of the node whose key is distributed
1215 @param node_name: Name of the node whose key is distributed
1216 @param potential_master_candidates: Potential master candidates
1217 @param to_authorized_keys: Whether the node's key should be added to
1218 all nodes' 'authorized_keys' file
1219 @param to_public_keys: Whether the node's key should be added to all
1220 nodes' public key file
1221 @param get_public_keys: Whether the node should get the other nodes'
1222 public keys
1223
1224 """
1225 return (self._Call(_def, node_list, [node_uuid, node_name,
1226 potential_master_candidates, to_authorized_keys, to_public_keys,
1227 get_public_keys]))
1228
1229 - def call_node_ssh_key_remove(self, node_list, node_uuid, node_name,
1230 master_candidate_uuids, potential_master_candidates,
1231 from_authorized_keys, from_public_keys, clear_authorized_keys,
1232 clear_public_keys, readd, _def=_CALLS['node_ssh_key_remove']):
1233 """Wrapper for RPC call 'node_ssh_key_remove'
1234
1235 Remove a node's SSH key from the other nodes' key files.
1236
1237 @note: This is a multi-node call with a timeout of 1m 0s
1238 @type node_list: list of string
1239 @param node_list: List of node names
1240 @param node_uuid: UUID of the node whose key is removed
1241 @param node_name: Name of the node whose key is removed
1242 @param master_candidate_uuids: List of UUIDs of master candidates.
1243 @param potential_master_candidates: Potential master candidates
1244 @param from_authorized_keys: If the key should be removed from the
1245 'authorized_keys' file.
1246 @param from_public_keys: If the key should be removed from the public
1247 key file.
1248 @param clear_authorized_keys: If the 'authorized_keys' file of the
1249 node should be cleared.
1250 @param clear_public_keys: If the 'ganeti_pub_keys' file of the node
1251 should be cleared.
1252 @param readd: Whether this is a readd operation.
1253
1254 """
1255 return (self._Call(_def, node_list, [node_uuid, node_name,
1256 master_candidate_uuids, potential_master_candidates,
1257 from_authorized_keys, from_public_keys, clear_authorized_keys,
1258 clear_public_keys, readd]))
1259
1260 - def call_node_ssh_keys_renew(self, node_list, node_uuids, node_names,
1261 master_candidate_uuids, potential_master_candidates,
1262 _def=_CALLS['node_ssh_keys_renew']):
1263 """Wrapper for RPC call 'node_ssh_keys_renew'
1264
1265 Renew all SSH key pairs of all nodes nodes.
1266
1267 @note: This is a multi-node call with a timeout of 4h 0m 0s
1268 @type node_list: list of string
1269 @param node_list: List of node names
1270 @param node_uuids: UUIDs of the nodes whose key is renewed
1271 @param node_names: Names of the nodes whose key is renewed
1272 @param master_candidate_uuids: List of UUIDs of master candidates.
1273 @param potential_master_candidates: Potential master candidates
1274
1275 """
1276 return (self._Call(_def, node_list, [node_uuids, node_names,
1277 master_candidate_uuids, potential_master_candidates]))
1278
1279 - def call_node_verify(self, node_list, checkdict, cluster_name,
1280 all_hvparams, node_groups, groups_cfg, _def=_CALLS['node_verify']):
1281 """Wrapper for RPC call 'node_verify'
1282
1283 Request verification of given parameters
1284
1285 @note: This is a multi-node call with a timeout of 15m 0s
1286 @type node_list: list of string
1287 @param node_list: List of node names
1288 @param checkdict: What to verify
1289 @param cluster_name: Cluster name
1290 @param all_hvparams: Dictionary mapping hypervisor names to hvparams
1291 @param node_groups: node names mapped to their group uuids
1292 @param groups_cfg: a dictionary mapping group uuids to their
1293 configuration
1294
1295 """
1296 return (self._Call(_def, node_list, [checkdict, cluster_name,
1297 all_hvparams, node_groups, groups_cfg]))
1298
1300 """Wrapper for RPC call 'node_volumes'
1301
1302 Gets all volumes on node(s)
1303
1304 @note: This is a multi-node call with a timeout of 5m 0s
1305 @type node_list: list of string
1306 @param node_list: List of node names
1307
1308 """
1309 return (self._Call(_def, node_list, []))
1310
1312 """Wrapper for RPC call 'os_diagnose'
1313
1314 Request a diagnose of OS definitions
1315
1316 @note: This is a multi-node call with a timeout of 5m 0s
1317 @type node_list: list of string
1318 @param node_list: List of node names
1319
1320 """
1321 return (self._Call(_def, node_list, []))
1322
1325 """Wrapper for RPC call 'os_export'
1326
1327 Export an OS for a given instance
1328
1329 @note: This is a single-node call with a timeout of 5m 0s
1330 @type node: string
1331 @param node: Node name
1332
1333 """
1334 return (self._Call(_def, [node], [instance, override_env])[node])
1335
1336 - def call_os_validate(self, node_list, required, name, checks, params,
1337 force_variant, _def=_CALLS['os_validate']):
1338 """Wrapper for RPC call 'os_validate'
1339
1340 Run a validation routine for a given OS
1341
1342 @note: This is a multi-node call with a timeout of 5m 0s
1343 @type node_list: list of string
1344 @param node_list: List of node names
1345
1346 """
1347 return (self._Call(_def, node_list, [required, name, checks, params,
1348 force_variant]))
1349
1352 """Wrapper for RPC call 'restricted_command'
1353
1354 Runs restricted command
1355
1356 @note: This is a multi-node call with a timeout of 1h 0m 0s
1357 @type node_list: list of string
1358 @param node_list: List of node names
1359 @param cmd: Command name
1360
1361 """
1362 return (self._Call(_def, node_list, [cmd]))
1363
1364 - def call_run_oob(self, node, oob_program, command, remote_node,
1365 timeout, _def=_CALLS['run_oob']):
1366 """Wrapper for RPC call 'run_oob'
1367
1368 Runs out-of-band command
1369
1370 @note: This is a single-node call with a timeout of 15m 0s
1371 @type node: string
1372 @param node: Node name
1373
1374 """
1375 return (self._Call(_def, [node], [oob_program, command, remote_node,
1376 timeout])[node])
1377
1380 """Wrapper for RPC call 'set_watcher_pause'
1381
1382 Set watcher pause end
1383
1384 @note: This is a multi-node call with a timeout of 1m 0s
1385 @type node_list: list of string
1386 @param node_list: List of node names
1387
1388 """
1389 return (self._Call(_def, node_list, [until]))
1390
1393 """Wrapper for RPC call 'storage_execute'
1394
1395 Executes an operation on a storage unit
1396
1397 @note: This is a single-node call with a timeout of 15m 0s
1398 @type node: string
1399 @param node: Node name
1400
1401 """
1402 return (self._Call(_def, [node], [su_name, su_args, name, op])[node])
1403
1406 """Wrapper for RPC call 'storage_list'
1407
1408 Get list of storage units
1409
1410 @note: This is a multi-node call with a timeout of 15m 0s
1411 @type node_list: list of string
1412 @param node_list: List of node names
1413
1414 """
1415 return (self._Call(_def, node_list, [su_name, su_args, name, fields]))
1416
1419 """Wrapper for RPC call 'storage_modify'
1420
1421 Modify a storage unit
1422
1423 @note: This is a single-node call with a timeout of 15m 0s
1424 @type node: string
1425 @param node: Node name
1426
1427 """
1428 return (self._Call(_def, [node], [su_name, su_args, name,
1429 changes])[node])
1430
1433 """Wrapper for RPC call 'test_delay'
1434
1435 Sleep for a fixed time on given node(s)
1436
1437 @note: This is a multi-node call
1438 @type node_list: list of string
1439 @param node_list: List of node names
1440
1441 """
1442 return (self._Call(_def, node_list, [duration]))
1443
1445 """Wrapper for RPC call 'vg_list'
1446
1447 Gets the volume group list
1448
1449 @note: This is a multi-node call with a timeout of 1m 0s
1450 @type node_list: list of string
1451 @param node_list: List of node names
1452
1453 """
1454 return (self._Call(_def, node_list, []))
1455
1458 """Wrapper for RPC call 'x509_cert_create'
1459
1460 Creates a new X509 certificate for SSL/TLS
1461
1462 @note: This is a single-node call with a timeout of 15m 0s
1463 @type node: string
1464 @param node: Node name
1465 @param validity: Validity in seconds
1466
1467 """
1468 return (self._Call(_def, [node], [validity])[node])
1469
1472 """Wrapper for RPC call 'x509_cert_remove'
1473
1474 Removes a X509 certificate
1475
1476 @note: This is a single-node call with a timeout of 15m 0s
1477 @type node: string
1478 @param node: Node name
1479 @param name: Certificate name
1480
1481 """
1482 return (self._Call(_def, [node], [name])[node])
1483
1484
1486
1487
1488
1489 _CALLS = rpc_defs.CALLS['RpcClientDnsOnly']
1490
1491 - def call_node_verify_light(self, node_list, checkdict, cluster_name,
1492 hvparams, node_groups, groups_cfg,
1493 _def=_CALLS['node_verify_light']):
1494 """Wrapper for RPC call 'node_verify_light'
1495
1496 Request verification of given parameters
1497
1498 @note: This is a multi-node call with a timeout of 15m 0s
1499 @type node_list: list of string
1500 @param node_list: List of node names
1501 @param checkdict: What to verify
1502 @param cluster_name: Cluster name
1503 @param hvparams: Dictionary mapping hypervisor names to hvparams
1504 @param node_groups: node names mapped to their group uuids
1505 @param groups_cfg: a dictionary mapping group uuids to their
1506 configuration
1507
1508 """
1509 return (self._Call(_def, node_list, [checkdict, cluster_name,
1510 hvparams, node_groups, groups_cfg]))
1511
1513 """Wrapper for RPC call 'version'
1514
1515 Query node version
1516
1517 @note: This is a multi-node call with a timeout of 1m 0s
1518 @type node_list: list of string
1519 @param node_list: List of node names
1520
1521 """
1522 return (self._Call(_def, node_list, []))
1523
1524
1526
1527
1528
1529 _CALLS = rpc_defs.CALLS['RpcClientJobQueue']
1530
1532 """Wrapper for RPC call 'jobqueue_purge'
1533
1534 Purge job queue
1535
1536 @note: This is a single-node call with a timeout of 15m 0s
1537 @type node: string
1538 @param node: Node name
1539
1540 """
1541 return (self._Call(_def, [node], [])[node])
1542
1545 """Wrapper for RPC call 'jobqueue_rename'
1546
1547 Rename job queue file
1548
1549 @note: This is a multi-node call with a timeout of 1m 0s
1550 @type node_list: list of string
1551 @param node_list: List of node names
1552
1553 """
1554 return (self._Call(_def, node_list, [rename]))
1555
1558 """Wrapper for RPC call 'jobqueue_set_drain_flag'
1559
1560 Set job queue drain flag
1561
1562 @note: This is a multi-node call with a timeout of 1m 0s
1563 @type node_list: list of string
1564 @param node_list: List of node names
1565
1566 """
1567 return (self._Call(_def, node_list, [flag]))
1568
1571 """Wrapper for RPC call 'jobqueue_update'
1572
1573 Update job queue file
1574
1575 @note: This is a multi-node call with a timeout of 1m 0s
1576 @type node_list: list of string
1577 @param node_list: List of node names
1578
1579 """
1580 return (self._Call(_def, node_list, [file_name, content]))
1581