ganeti._generated_rpc.RpcClientDefault

class documentation

class RpcClientDefault(object):

Known subclasses: ganeti.rpc.node.RpcRunner

Undocumented

Method	`call_accept_instance`	Wrapper for RPC call 'accept_instance'
Method	`call_all_instances_info`	Wrapper for RPC call 'all_instances_info'
Method	`call_bdev_sizes`	Wrapper for RPC call 'bdev_sizes'
Method	`call_blockdev_addchildren`	Wrapper for RPC call 'blockdev_addchildren'
Method	`call_blockdev_assemble`	Wrapper for RPC call 'blockdev_assemble'
Method	`call_blockdev_close`	Wrapper for RPC call 'blockdev_close'
Method	`call_blockdev_convert`	Wrapper for RPC call 'blockdev_convert'
Method	`call_blockdev_create`	Wrapper for RPC call 'blockdev_create'
Method	`call_blockdev_find`	Wrapper for RPC call 'blockdev_find'
Method	`call_blockdev_getdimensions`	Wrapper for RPC call 'blockdev_getdimensions'
Method	`call_blockdev_getmirrorstatus`	Wrapper for RPC call 'blockdev_getmirrorstatus'
Method	`call_blockdev_getmirrorstatus_multi`	Wrapper for RPC call 'blockdev_getmirrorstatus_multi'
Method	`call_blockdev_grow`	Wrapper for RPC call 'blockdev_grow'
Method	`call_blockdev_image`	Wrapper for RPC call 'blockdev_image'
Method	`call_blockdev_open`	Wrapper for RPC call 'blockdev_open'
Method	`call_blockdev_pause_resume_sync`	Wrapper for RPC call 'blockdev_pause_resume_sync'
Method	`call_blockdev_remove`	Wrapper for RPC call 'blockdev_remove'
Method	`call_blockdev_removechildren`	Wrapper for RPC call 'blockdev_removechildren'
Method	`call_blockdev_rename`	Wrapper for RPC call 'blockdev_rename'
Method	`call_blockdev_setinfo`	Wrapper for RPC call 'blockdev_setinfo'
Method	`call_blockdev_shutdown`	Wrapper for RPC call 'blockdev_shutdown'
Method	`call_blockdev_snapshot`	Wrapper for RPC call 'blockdev_snapshot'
Method	`call_blockdev_wipe`	Wrapper for RPC call 'blockdev_wipe'
Method	`call_bridges_exist`	Wrapper for RPC call 'bridges_exist'
Method	`call_drbd_attach_net`	Wrapper for RPC call 'drbd_attach_net'
Method	`call_drbd_disconnect_net`	Wrapper for RPC call 'drbd_disconnect_net'
Method	`call_drbd_helper`	Wrapper for RPC call 'drbd_helper'
Method	`call_drbd_needs_activation`	Wrapper for RPC call 'drbd_needs_activation'
Method	`call_drbd_wait_sync`	Wrapper for RPC call 'drbd_wait_sync'
Method	`call_etc_hosts_modify`	Wrapper for RPC call 'etc_hosts_modify'
Method	`call_export_info`	Wrapper for RPC call 'export_info'
Method	`call_export_list`	Wrapper for RPC call 'export_list'
Method	`call_export_remove`	Wrapper for RPC call 'export_remove'
Method	`call_export_start`	Wrapper for RPC call 'export_start'
Method	`call_extstorage_diagnose`	Wrapper for RPC call 'extstorage_diagnose'
Method	`call_file_storage_dir_create`	Wrapper for RPC call 'file_storage_dir_create'
Method	`call_file_storage_dir_remove`	Wrapper for RPC call 'file_storage_dir_remove'
Method	`call_file_storage_dir_rename`	Wrapper for RPC call 'file_storage_dir_rename'
Method	`call_finalize_export`	Wrapper for RPC call 'finalize_export'
Method	`call_get_file_info`	Wrapper for RPC call 'get_file_info'
Method	`call_get_watcher_pause`	Wrapper for RPC call 'get_watcher_pause'
Method	`call_hooks_runner`	Wrapper for RPC call 'hooks_runner'
Method	`call_hotplug_device`	Wrapper for RPC call 'hotplug_device'
Method	`call_hotplug_supported`	Wrapper for RPC call 'hotplug_supported'
Method	`call_hypervisor_validate_params`	Wrapper for RPC call 'hypervisor_validate_params'
Method	`call_iallocator_runner`	Wrapper for RPC call 'iallocator_runner'
Method	`call_impexp_abort`	Wrapper for RPC call 'impexp_abort'
Method	`call_impexp_cleanup`	Wrapper for RPC call 'impexp_cleanup'
Method	`call_impexp_status`	Wrapper for RPC call 'impexp_status'
Method	`call_import_start`	Wrapper for RPC call 'import_start'
Method	`call_instance_balloon_memory`	Wrapper for RPC call 'instance_balloon_memory'
Method	`call_instance_finalize_migration_dst`	Wrapper for RPC call 'instance_finalize_migration_dst'
Method	`call_instance_finalize_migration_src`	Wrapper for RPC call 'instance_finalize_migration_src'
Method	`call_instance_get_migration_status`	Wrapper for RPC call 'instance_get_migration_status'
Method	`call_instance_info`	Wrapper for RPC call 'instance_info'
Method	`call_instance_list`	Wrapper for RPC call 'instance_list'
Method	`call_instance_metadata_modify`	Wrapper for RPC call 'instance_metadata_modify'
Method	`call_instance_migratable`	Wrapper for RPC call 'instance_migratable'
Method	`call_instance_migrate`	Wrapper for RPC call 'instance_migrate'
Method	`call_instance_os_add`	Wrapper for RPC call 'instance_os_add'
Method	`call_instance_reboot`	Wrapper for RPC call 'instance_reboot'
Method	`call_instance_run_rename`	Wrapper for RPC call 'instance_run_rename'
Method	`call_instance_shutdown`	Wrapper for RPC call 'instance_shutdown'
Method	`call_instance_start`	Wrapper for RPC call 'instance_start'
Method	`call_lv_list`	Wrapper for RPC call 'lv_list'
Method	`call_migration_info`	Wrapper for RPC call 'migration_info'
Method	`call_node_configure_ovs`	Wrapper for RPC call 'node_configure_ovs'
Method	`call_node_crypto_tokens`	Wrapper for RPC call 'node_crypto_tokens'
Method	`call_node_demote_from_mc`	Wrapper for RPC call 'node_demote_from_mc'
Method	`call_node_ensure_daemon`	Wrapper for RPC call 'node_ensure_daemon'
Method	`call_node_has_ip_address`	Wrapper for RPC call 'node_has_ip_address'
Method	`call_node_info`	Wrapper for RPC call 'node_info'
Method	`call_node_powercycle`	Wrapper for RPC call 'node_powercycle'
Method	`call_node_ssh_key_add`	Wrapper for RPC call 'node_ssh_key_add'
Method	`call_node_ssh_key_remove`	Wrapper for RPC call 'node_ssh_key_remove'
Method	`call_node_ssh_keys_renew`	Wrapper for RPC call 'node_ssh_keys_renew'
Method	`call_node_verify`	Wrapper for RPC call 'node_verify'
Method	`call_node_volumes`	Wrapper for RPC call 'node_volumes'
Method	`call_os_diagnose`	Wrapper for RPC call 'os_diagnose'
Method	`call_os_export`	Wrapper for RPC call 'os_export'
Method	`call_os_validate`	Wrapper for RPC call 'os_validate'
Method	`call_restricted_command`	Wrapper for RPC call 'restricted_command'
Method	`call_run_oob`	Wrapper for RPC call 'run_oob'
Method	`call_set_watcher_pause`	Wrapper for RPC call 'set_watcher_pause'
Method	`call_storage_execute`	Wrapper for RPC call 'storage_execute'
Method	`call_storage_list`	Wrapper for RPC call 'storage_list'
Method	`call_storage_modify`	Wrapper for RPC call 'storage_modify'
Method	`call_test_delay`	Wrapper for RPC call 'test_delay'
Method	`call_vg_list`	Wrapper for RPC call 'vg_list'
Method	`call_x509_cert_create`	Wrapper for RPC call 'x509_cert_create'
Method	`call_x509_cert_remove`	Wrapper for RPC call 'x509_cert_remove'
Constant	`_CALLS`	Undocumented

def call_accept_instance(self, node, instance, info, target, _def=_CALLS['accept_instance']): ¶

Wrapper for RPC call 'accept_instance'

Prepare a node to accept an instance

Parameters
node:string	Node name
instance	Instance object
info	Result for the call_migration_info call
target	Target hostname (usually an IP address)
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_all_instances_info(self, node_list, hypervisor_list, all_hvparams, _def=_CALLS['all_instances_info']): ¶

Wrapper for RPC call 'all_instances_info'

Returns information about all instances on the given nodes

Parameters
node_list:list of string	List of node names
hypervisor_list	Hypervisors to query for instances
all_hvparams	Dictionary mapping hypervisor names to hvparams
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_bdev_sizes(self, node_list, devices, _def=_CALLS['bdev_sizes']): ¶

Wrapper for RPC call 'bdev_sizes'

Gets the sizes of requested block devices present on a node

Parameters
node_list:list of string	List of node names
devices	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_blockdev_addchildren(self, node, bdev, ndevs, _def=_CALLS['blockdev_addchildren']): ¶

Wrapper for RPC call 'blockdev_addchildren'

Request adding a list of children to a (mirroring) device

Parameters
node:string	Node name
bdev	Undocumented
ndevs	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_assemble(self, node, disk, instance, on_primary, idx, _def=_CALLS['blockdev_assemble']): ¶

Wrapper for RPC call 'blockdev_assemble'

Request assembling of a given block device

Parameters
node:string	Node name
disk	Undocumented
instance	Undocumented
on_primary	Undocumented
idx	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_close(self, node, instance_name, disks, _def=_CALLS['blockdev_close']): ¶

Wrapper for RPC call 'blockdev_close'

Closes the given block devices

Parameters
node:string	Node name
instance_name	Undocumented
disks	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_convert(self, node, bdev_src, bdev_dest, _def=_CALLS['blockdev_convert']): ¶

Wrapper for RPC call 'blockdev_convert'

Request the copy of the source block device to the destination one

Parameters
node:string	Node name
bdev_src	Undocumented
bdev_dest	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_blockdev_create(self, node, bdev, size, owner, on_primary, info, exclusive_storage, _def=_CALLS['blockdev_create']): ¶

Wrapper for RPC call 'blockdev_create'

Request creation of a given block device

Parameters
node:string	Node name
bdev	Undocumented
size	Undocumented
owner	Undocumented
on_primary	Undocumented
info	Undocumented
exclusive_storage	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_find(self, node, disk, _def=_CALLS['blockdev_find']): ¶

Wrapper for RPC call 'blockdev_find'

Request identification of a given block device

Parameters
node:string	Node name
disk	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_getdimensions(self, node, disks, _def=_CALLS['blockdev_getdimensions']): ¶

Wrapper for RPC call 'blockdev_getdimensions'

Returns size and spindles of the given disks

Parameters
node:string	Node name
disks	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_getmirrorstatus(self, node, disks, _def=_CALLS['blockdev_getmirrorstatus']): ¶

Wrapper for RPC call 'blockdev_getmirrorstatus'

Request status of a (mirroring) device

Parameters
node:string	Node name
disks	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_getmirrorstatus_multi(self, node_list, node_disks, _def=_CALLS['blockdev_getmirrorstatus_multi']): ¶

Wrapper for RPC call 'blockdev_getmirrorstatus_multi'

Request status of (mirroring) devices from multiple nodes

Parameters
node_list:list of string	List of node names
node_disks	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_blockdev_grow(self, node, cf_bdev, amount, dryrun, backingstore, es_flag, _def=_CALLS['blockdev_grow']): ¶

Wrapper for RPC call 'blockdev_grow'

Request growing of the given block device by a given amount

Parameters
node:string	Node name
cf_bdev	Undocumented
amount	Undocumented
dryrun	Undocumented
backingstore	Undocumented
es_flag	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_image(self, node, bdev, image, size, _def=_CALLS['blockdev_image']): ¶

Wrapper for RPC call 'blockdev_image'

Request to dump an image with given size onto a block device

Parameters
node:string	Node name
bdev	Undocumented
image	Undocumented
size	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_blockdev_open(self, node, instance_name, disks, exclusive, _def=_CALLS['blockdev_open']): ¶

Wrapper for RPC call 'blockdev_open'

Opens the given block devices in required mode

Parameters
node:string	Node name
instance_name	Undocumented
disks	Undocumented
exclusive	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_pause_resume_sync(self, node, disks, pause, _def=_CALLS['blockdev_pause_resume_sync']): ¶

Wrapper for RPC call 'blockdev_pause_resume_sync'

Request a pause/resume of given block device

Parameters
node:string	Node name
disks	Undocumented
pause	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_remove(self, node, bdev, _def=_CALLS['blockdev_remove']): ¶

Wrapper for RPC call 'blockdev_remove'

Request removal of a given block device

Parameters
node:string	Node name
bdev	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_removechildren(self, node, bdev, ndevs, _def=_CALLS['blockdev_removechildren']): ¶

Wrapper for RPC call 'blockdev_removechildren'

Request removing a list of children from a (mirroring) device

Parameters
node:string	Node name
bdev	Undocumented
ndevs	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_rename(self, node, devlist, _def=_CALLS['blockdev_rename']): ¶

Wrapper for RPC call 'blockdev_rename'

Request rename of the given block devices

Parameters
node:string	Node name
devlist	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_setinfo(self, node, disk, info, _def=_CALLS['blockdev_setinfo']): ¶

Wrapper for RPC call 'blockdev_setinfo'

Sets metadata information on a given block device

Parameters
node:string	Node name
disk	Undocumented
info	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_shutdown(self, node, disk, _def=_CALLS['blockdev_shutdown']): ¶

Wrapper for RPC call 'blockdev_shutdown'

Request shutdown of a given block device

Parameters
node:string	Node name
disk	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_snapshot(self, node, cf_bdev, snap_name, snap_size, _def=_CALLS['blockdev_snapshot']): ¶

Wrapper for RPC call 'blockdev_snapshot'

Export a given disk to another node

Parameters
node:string	Node name
cf_bdev	Undocumented
snap_name	Undocumented
snap_size	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_blockdev_wipe(self, node, bdev, offset, size, _def=_CALLS['blockdev_wipe']): ¶

Wrapper for RPC call 'blockdev_wipe'

Request wipe at given offset with given size of a block device

Parameters
node:string	Node name
bdev	Undocumented
offset	Undocumented
size	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_bridges_exist(self, node, bridges_list, _def=_CALLS['bridges_exist']): ¶

Wrapper for RPC call 'bridges_exist'

Checks if a node has all the bridges given

Parameters
node:string	Node name
bridges_list	Bridges which must be present on remote node
_def	Undocumented
Note
This is a single-node call with a timeout of 1m 0s

def call_drbd_attach_net(self, node_list, disks, multimaster, _def=_CALLS['drbd_attach_net']): ¶

Wrapper for RPC call 'drbd_attach_net'

Connects the given DRBD devices

Parameters
node_list:list of string	List of node names
disks	Undocumented
multimaster	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_drbd_disconnect_net(self, node_list, disks, _def=_CALLS['drbd_disconnect_net']): ¶

Wrapper for RPC call 'drbd_disconnect_net'

Disconnects the network of the given drbd devices

Parameters
node_list:list of string	List of node names
disks	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_drbd_helper(self, node_list, _def=_CALLS['drbd_helper']): ¶

Wrapper for RPC call 'drbd_helper'

Gets DRBD helper

Parameters
node_list:list of string	List of node names
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_drbd_needs_activation(self, node, disks, _def=_CALLS['drbd_needs_activation']): ¶

Wrapper for RPC call 'drbd_needs_activation'

Returns the drbd disks which need activation

Parameters
node:string	Node name
disks	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_drbd_wait_sync(self, node_list, disks, _def=_CALLS['drbd_wait_sync']): ¶

Wrapper for RPC call 'drbd_wait_sync'

Waits for the synchronization of drbd devices is complete

Parameters
node_list:list of string	List of node names
disks	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 1h 0m 0s

def call_etc_hosts_modify(self, node, mode, name, ip, _def=_CALLS['etc_hosts_modify']): ¶

Wrapper for RPC call 'etc_hosts_modify'

Modify hosts file with name

Parameters
node:string	Node name
mode	Mode to operate; currently `constants.ETC_HOSTS_ADD` or `constants.ETC_HOSTS_REMOVE`
name	Hostname to be modified
ip	IP address (`constants.ETC_HOSTS_ADD` only)
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_export_info(self, node, path, _def=_CALLS['export_info']): ¶

Wrapper for RPC call 'export_info'

Queries the export information in a given path

Parameters
node:string	Node name
path	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_export_list(self, node_list, _def=_CALLS['export_list']): ¶

Wrapper for RPC call 'export_list'

Gets the stored exports list

Parameters
node_list:list of string	List of node names
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_export_remove(self, node, export, _def=_CALLS['export_remove']): ¶

Wrapper for RPC call 'export_remove'

Requests removal of a given export

Parameters
node:string	Node name
export	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_export_start(self, node, opts, host, port, instance, component, source, _def=_CALLS['export_start']): ¶

Wrapper for RPC call 'export_start'

Starts an export daemon

Parameters
node:string	Node name
opts	Undocumented
host	Undocumented
port	Undocumented
instance	Undocumented
component	Undocumented
source	Export source
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_extstorage_diagnose(self, node_list, _def=_CALLS['extstorage_diagnose']): ¶

Wrapper for RPC call 'extstorage_diagnose'

Request a diagnose of ExtStorage Providers

Parameters
node_list:list of string	List of node names
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_file_storage_dir_create(self, node, file_storage_dir, _def=_CALLS['file_storage_dir_create']): ¶

Wrapper for RPC call 'file_storage_dir_create'

Create the given file storage directory

Parameters
node:string	Node name
file_storage_dir	File storage directory
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_file_storage_dir_remove(self, node, file_storage_dir, _def=_CALLS['file_storage_dir_remove']): ¶

Wrapper for RPC call 'file_storage_dir_remove'

Remove the given file storage directory

Parameters
node:string	Node name
file_storage_dir	File storage directory
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_file_storage_dir_rename(self, node, old_file_storage_dir, new_file_storage_dir, _def=_CALLS['file_storage_dir_rename']): ¶

Wrapper for RPC call 'file_storage_dir_rename'

Rename file storage directory

Parameters
node:string	Node name
old_file_storage_dir	Old name
new_file_storage_dir	New name
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_finalize_export(self, node, instance, snap_disks, _def=_CALLS['finalize_export']): ¶

Wrapper for RPC call 'finalize_export'

Request the completion of an export operation

Parameters
node:string	Node name
instance	Undocumented
snap_disks	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_get_file_info(self, node, file_path, _def=_CALLS['get_file_info']): ¶

Wrapper for RPC call 'get_file_info'

Checks if a file exists and reports on it

Parameters
node:string	Node name
file_path	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_get_watcher_pause(self, node, _def=_CALLS['get_watcher_pause']): ¶

Wrapper for RPC call 'get_watcher_pause'

Get watcher pause end

Parameters
node:string	Node name
_def	Undocumented
Note
This is a single-node call with a timeout of 1m 0s

def call_hooks_runner(self, node_list, hpath, phase, env, _def=_CALLS['hooks_runner']): ¶

Wrapper for RPC call 'hooks_runner'

Call the hooks runner

Parameters
node_list:list of string	List of node names
hpath	Undocumented
phase	Undocumented
env	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_hotplug_device(self, node, instance, action, dev_type, device, extra, seq, _def=_CALLS['hotplug_device']): ¶

Wrapper for RPC call 'hotplug_device'

Hoplug a device to a running instance

Parameters
node:string	Node name
instance	Instance object
action	Hotplug Action
dev_type	Device type
device	Device dict
extra	Extra info for device (dev_path for disk)
seq	Device seq
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_hotplug_supported(self, node, instance, _def=_CALLS['hotplug_supported']): ¶

Wrapper for RPC call 'hotplug_supported'

Check if hotplug is supported

Parameters
node:string	Node name
instance	Instance object
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_hypervisor_validate_params(self, node_list, hvname, hvfull, _def=_CALLS['hypervisor_validate_params']): ¶

Wrapper for RPC call 'hypervisor_validate_params'

Validate hypervisor params

Parameters
node_list:list of string	List of node names
hvname	Hypervisor name
hvfull	Parameters to be validated
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_iallocator_runner(self, node, name, idata, default_iallocator_params, _def=_CALLS['iallocator_runner']): ¶

Wrapper for RPC call 'iallocator_runner'

Call an iallocator on a remote node

Parameters
node:string	Node name
name	Iallocator name
idata	JSON-encoded input string
default_iallocator_params	Additional iallocator parameters
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_impexp_abort(self, node, name, _def=_CALLS['impexp_abort']): ¶

Wrapper for RPC call 'impexp_abort'

Aborts an import or export

Parameters
node:string	Node name
name	Import/export name
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_impexp_cleanup(self, node, name, _def=_CALLS['impexp_cleanup']): ¶

Wrapper for RPC call 'impexp_cleanup'

Cleans up after an import or export

Parameters
node:string	Node name
name	Import/export name
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_impexp_status(self, node, names, _def=_CALLS['impexp_status']): ¶

Wrapper for RPC call 'impexp_status'

Gets the status of an import or export

Parameters
node:string	Node name
names	Import/export names
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_import_start(self, node, opts, instance, component, dest, _def=_CALLS['import_start']): ¶

Wrapper for RPC call 'import_start'

Starts an import daemon

Parameters
node:string	Node name
opts	Undocumented
instance	Undocumented
component	Undocumented
dest	Import destination
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_instance_balloon_memory(self, node, instance, memory, _def=_CALLS['instance_balloon_memory']): ¶

Wrapper for RPC call 'instance_balloon_memory'

Modify the amount of an instance's runtime memory

Parameters
node:string	Node name
instance	Instance object
memory	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_instance_finalize_migration_dst(self, node, instance, info, success, _def=_CALLS['instance_finalize_migration_dst']): ¶

Wrapper for RPC call 'instance_finalize_migration_dst'

Finalize any target-node migration specific operation

Parameters
node:string	Node name
instance	Instance object
info	Result for the call_migration_info call
success	Whether the migration was a success or failure
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_instance_finalize_migration_src(self, node, instance, success, live, _def=_CALLS['instance_finalize_migration_src']): ¶

Wrapper for RPC call 'instance_finalize_migration_src'

Finalize the instance migration on the source node

Parameters
node:string	Node name
instance	Instance object
success	Whether the migration succeeded or not
live	Whether the user requested a live migration or not
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_instance_get_migration_status(self, node, instance, _def=_CALLS['instance_get_migration_status']): ¶

Wrapper for RPC call 'instance_get_migration_status'

Report migration status

Parameters
node:string	Node name
instance	Instance object
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_instance_info(self, node, instance, hname, hvparams, _def=_CALLS['instance_info']): ¶

Wrapper for RPC call 'instance_info'

Returns information about a single instance

Parameters
node:string	Node name
instance	Instance name
hname	Hypervisor type
hvparams	Hypervisor parameters
_def	Undocumented
Note
This is a single-node call with a timeout of 1m 0s

def call_instance_list(self, node_list, hypervisor_list, hvparams, _def=_CALLS['instance_list']): ¶

Wrapper for RPC call 'instance_list'

Returns the list of running instances on the given nodes

Parameters
node_list:list of string	List of node names
hypervisor_list	Hypervisors to query for instances
hvparams	Hvparams of all hypervisors
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_instance_metadata_modify(self, node, instance, _def=_CALLS['instance_metadata_modify']): ¶

Wrapper for RPC call 'instance_metadata_modify'

Modify instance metadata

Parameters
node:string	Node name
instance	Instance object
_def	Undocumented
Note
This is a single-node call with a timeout of 1m 0s

def call_instance_migratable(self, node, instance, _def=_CALLS['instance_migratable']): ¶

Wrapper for RPC call 'instance_migratable'

Checks whether the given instance can be migrated

Parameters
node:string	Node name
instance	Instance object
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_instance_migrate(self, node, cluster_name, instance, target, live, _def=_CALLS['instance_migrate']): ¶

Wrapper for RPC call 'instance_migrate'

Migrate an instance

Parameters
node:string	Node name
cluster_name	Cluster name
instance	Instance object
target	Target node name
live	Whether the migration should be done live or not
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_instance_os_add(self, node, instance_osp, reinstall, debug, _def=_CALLS['instance_os_add']): ¶

Wrapper for RPC call 'instance_os_add'

Installs an operative system onto an instance

Parameters
node:string	Node name
instance_osp	Tuple: (target instance, temporary OS parameters overriding configuration)
reinstall	Whether the instance is being reinstalled
debug	Debug level for the OS install script to use
_def	Undocumented
Note
This is a single-node call with a timeout of 1d 0h 0m 0s

def call_instance_reboot(self, node, inst, reboot_type, shutdown_timeout, reason, _def=_CALLS['instance_reboot']): ¶

Wrapper for RPC call 'instance_reboot'

Returns the list of running instances on the given nodes

Parameters
node:string	Node name
inst	Instance object
reboot_type	Undocumented
shutdown_timeout	Undocumented
reason	The reason for the reboot
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_instance_run_rename(self, node, instance, old_name, debug, _def=_CALLS['instance_run_rename']): ¶

Wrapper for RPC call 'instance_run_rename'

Run the OS rename script for an instance

Parameters
node:string	Node name
instance	Instance object
old_name	Undocumented
debug	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_instance_shutdown(self, node, instance, timeout, reason, _def=_CALLS['instance_shutdown']): ¶

Wrapper for RPC call 'instance_shutdown'

Stops an instance

Parameters
node:string	Node name
instance	Instance object
timeout	Undocumented
reason	The reason for the shutdown
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_instance_start(self, node, instance_hvp_bep, startup_paused, reason, _def=_CALLS['instance_start']): ¶

Wrapper for RPC call 'instance_start'

Starts an instance

Parameters
node:string	Node name
instance_hvp_bep	Undocumented
startup_paused	Undocumented
reason	The reason for the startup
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_lv_list(self, node_list, vg_name, _def=_CALLS['lv_list']): ¶

Wrapper for RPC call 'lv_list'

Gets the logical volumes present in a given volume group

Parameters
node_list:list of string	List of node names
vg_name	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_migration_info(self, node, instance, _def=_CALLS['migration_info']): ¶

Wrapper for RPC call 'migration_info'

Gather the information necessary to prepare an instance migration

Parameters
node:string	Node name
instance	Instance object
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_node_configure_ovs(self, node, ovs_name, ovs_link, _def=_CALLS['node_configure_ovs']): ¶

Wrapper for RPC call 'node_configure_ovs'

This will create and setup the OpenvSwitch

Parameters
node:string	Node name
ovs_name	Name of the OpenvSwitch to create
ovs_link	Link of the OpenvSwitch to the outside
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_node_crypto_tokens(self, node, token_request, _def=_CALLS['node_crypto_tokens']): ¶

Wrapper for RPC call 'node_crypto_tokens'

Handle crypto tokens of the node.

Parameters
node:string	Node name
token_request	List of tuples of requested crypto token types, actions
_def	Undocumented
Note
This is a single-node call with a timeout of 1h 0m 0s

def call_node_demote_from_mc(self, node, _def=_CALLS['node_demote_from_mc']): ¶

Wrapper for RPC call 'node_demote_from_mc'

Demote a node from the master candidate role

Parameters
node:string	Node name
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_node_ensure_daemon(self, node_list, daemon, run, _def=_CALLS['node_ensure_daemon']): ¶

Wrapper for RPC call 'node_ensure_daemon'

Ensure daemon is running on the node.

Parameters
node_list:list of string	List of node names
daemon	Daemon name
run	Whether the daemon should be running or stopped
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_node_has_ip_address(self, node, address, _def=_CALLS['node_has_ip_address']): ¶

Wrapper for RPC call 'node_has_ip_address'

Checks if a node has the given IP address

Parameters
node:string	Node name
address	IP address
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_node_info(self, node_list, storage_units, hv_specs, _def=_CALLS['node_info']): ¶

Wrapper for RPC call 'node_info'

Return node information

Parameters
node_list:list of string	List of node names
storage_units	List of tuples '<storage_type>,<key>,[<param>]' to ask for disk space information; the parameter list varies depending on the storage_type
hv_specs	List of hypervisor specification (name, hvparams) to ask for node information
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_node_powercycle(self, node, hypervisor, hvparams, _def=_CALLS['node_powercycle']): ¶

Wrapper for RPC call 'node_powercycle'

Tries to powercycle a node

Parameters
node:string	Node name
hypervisor	Hypervisor type
hvparams	Hypervisor parameters
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_node_ssh_key_add(self, node_list, node_uuid, node_name, potential_master_candidates, to_authorized_keys, to_public_keys, get_public_keys, _def=_CALLS['node_ssh_key_add']): ¶

Wrapper for RPC call 'node_ssh_key_add'

Distribute a new node's public SSH key on the cluster.

Parameters
node_list:list of string	List of node names
node_uuid	UUID of the node whose key is distributed
node_name	Name of the node whose key is distributed
potential_master_candidates	Potential master candidates
to_authorized_keys	Whether the node's key should be added to all nodes' 'authorized_keys' file
to_public_keys	Whether the node's key should be added to all nodes' public key file
get_public_keys	Whether the node should get the other nodes' public keys
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_node_ssh_key_remove(self, node_list, node_uuid, node_name, master_candidate_uuids, potential_master_candidates, from_authorized_keys, from_public_keys, clear_authorized_keys, clear_public_keys, readd, _def=_CALLS['node_ssh_key_remove']): ¶

Wrapper for RPC call 'node_ssh_key_remove'

Remove a node's SSH key from the other nodes' key files.

Parameters
node_list:list of string	List of node names
node_uuid	UUID of the node whose key is removed
node_name	Name of the node whose key is removed
master_candidate_uuids	List of UUIDs of master candidates.
potential_master_candidates	Potential master candidates
from_authorized_keys	If the key should be removed from the 'authorized_keys' file.
from_public_keys	If the key should be removed from the public key file.
clear_authorized_keys	If the 'authorized_keys' file of the node should be cleared.
clear_public_keys	If the 'ganeti_pub_keys' file of the node should be cleared.
readd	Whether this is a readd operation.
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_node_ssh_keys_renew(self, node_list, node_uuids, node_names, master_candidate_uuids, potential_master_candidates, old_key_type, new_key_type, new_key_bits, _def=_CALLS['node_ssh_keys_renew']): ¶

Wrapper for RPC call 'node_ssh_keys_renew'

Renew all SSH key pairs of all nodes nodes.

Parameters
node_list:list of string	List of node names
node_uuids	UUIDs of the nodes whose key is renewed
node_names	Names of the nodes whose key is renewed
master_candidate_uuids	List of UUIDs of master candidates.
potential_master_candidates	Potential master candidates
old_key_type	The type of key previously used
new_key_type	The type of key to generate
new_key_bits	The length of the key to generate
_def	Undocumented
Note
This is a multi-node call with a timeout of 4h 0m 0s

def call_node_verify(self, node_list, checkdict, cluster_name, all_hvparams, _def=_CALLS['node_verify']): ¶

Wrapper for RPC call 'node_verify'

Request verification of given parameters

Parameters
node_list:list of string	List of node names
checkdict	What to verify
cluster_name	Cluster name
all_hvparams	Dictionary mapping hypervisor names to hvparams
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_node_volumes(self, node_list, _def=_CALLS['node_volumes']): ¶

Wrapper for RPC call 'node_volumes'

Gets all volumes on node(s)

Parameters
node_list:list of string	List of node names
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_os_diagnose(self, node_list, _def=_CALLS['os_diagnose']): ¶

Wrapper for RPC call 'os_diagnose'

Request a diagnose of OS definitions

Parameters
node_list:list of string	List of node names
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_os_export(self, node, instance, override_env, _def=_CALLS['os_export']): ¶

Wrapper for RPC call 'os_export'

Export an OS for a given instance

Parameters
node:string	Node name
instance	Undocumented
override_env	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 5m 0s

def call_os_validate(self, node_list, required, name, checks, params, force_variant, _def=_CALLS['os_validate']): ¶

Wrapper for RPC call 'os_validate'

Run a validation routine for a given OS

Parameters
node_list:list of string	List of node names
required	Undocumented
name	Undocumented
checks	Undocumented
params	Undocumented
force_variant	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 5m 0s

def call_restricted_command(self, node_list, cmd, _def=_CALLS['restricted_command']): ¶

Wrapper for RPC call 'restricted_command'

Runs restricted command

Parameters
node_list:list of string	List of node names
cmd	Command name
_def	Undocumented
Note
This is a multi-node call with a timeout of 1h 0m 0s

def call_run_oob(self, node, oob_program, command, remote_node, timeout, _def=_CALLS['run_oob']): ¶

Wrapper for RPC call 'run_oob'

Runs out-of-band command

Parameters
node:string	Node name
oob_program	Undocumented
command	Undocumented
remote_node	Undocumented
timeout	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_set_watcher_pause(self, node_list, until, _def=_CALLS['set_watcher_pause']): ¶

Wrapper for RPC call 'set_watcher_pause'

Set watcher pause end

Parameters
node_list:list of string	List of node names
until	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_storage_execute(self, node, su_name, su_args, name, op, _def=_CALLS['storage_execute']): ¶

Wrapper for RPC call 'storage_execute'

Executes an operation on a storage unit

Parameters
node:string	Node name
su_name	Undocumented
su_args	Undocumented
name	Undocumented
op	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_storage_list(self, node_list, su_name, su_args, name, fields, _def=_CALLS['storage_list']): ¶

Wrapper for RPC call 'storage_list'

Get list of storage units

Parameters
node_list:list of string	List of node names
su_name	Undocumented
su_args	Undocumented
name	Undocumented
fields	Undocumented
_def	Undocumented
Note
This is a multi-node call with a timeout of 15m 0s

def call_storage_modify(self, node, su_name, su_args, name, changes, _def=_CALLS['storage_modify']): ¶

Wrapper for RPC call 'storage_modify'

Modify a storage unit

Parameters
node:string	Node name
su_name	Undocumented
su_args	Undocumented
name	Undocumented
changes	Undocumented
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_test_delay(self, node_list, duration, _def=_CALLS['test_delay']): ¶

Wrapper for RPC call 'test_delay'

Sleep for a fixed time on given node(s)

Parameters
node_list:list of string	List of node names
duration	Undocumented
_def	Undocumented
Note
This is a multi-node call

def call_vg_list(self, node_list, _def=_CALLS['vg_list']): ¶

Wrapper for RPC call 'vg_list'

Gets the volume group list

Parameters
node_list:list of string	List of node names
_def	Undocumented
Note
This is a multi-node call with a timeout of 1m 0s

def call_x509_cert_create(self, node, validity, _def=_CALLS['x509_cert_create']): ¶

Wrapper for RPC call 'x509_cert_create'

Creates a new X509 certificate for SSL/TLS

Parameters
node:string	Node name
validity	Validity in seconds
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

def call_x509_cert_remove(self, node, name, _def=_CALLS['x509_cert_remove']): ¶

Wrapper for RPC call 'x509_cert_remove'

Removes a X509 certificate

Parameters
node:string	Node name
name	Certificate name
_def	Undocumented
Note
This is a single-node call with a timeout of 15m 0s

_CALLS = ¶

Undocumented

Value

rpc_defs.CALLS['RpcClientDefault']