ganeti.rapi.client.GanetiRapiClient

class documentation

class GanetiRapiClient(object):

Ganeti RAPI client.

Method	`__init__`	Initializes this class.
Method	`ActivateInstanceDisks`	Activates an instance's disks.
Method	`AddClusterTags`	Adds tags to the cluster.
Method	`AddFilter`	Adds a filter rule
Method	`AddGroupTags`	Adds tags to a node group.
Method	`AddInstanceTags`	Adds tags to an instance.
Method	`AddNetworkTags`	Adds tags to a network.
Method	`AddNodeTags`	Adds tags to a node.
Method	`AssignGroupNodes`	Assigns nodes to a group.
Method	`CancelJob`	Cancels a job.
Method	`ConnectNetwork`	Connects a Network to a NodeGroup with the given netparams
Method	`CreateGroup`	Creates a new node group.
Method	`CreateInstance`	Creates a new instance.
Method	`CreateNetwork`	Creates a new network.
Method	`DeactivateInstanceDisks`	Deactivates an instance's disks.
Method	`DeleteClusterTags`	Deletes tags from the cluster.
Method	`DeleteFilter`	Deletes a filter rule
Method	`DeleteGroup`	Deletes a node group.
Method	`DeleteGroupTags`	Deletes tags from a node group.
Method	`DeleteInstance`	Deletes an instance.
Method	`DeleteInstanceTags`	Deletes tags from an instance.
Method	`DeleteNetwork`	Deletes a network.
Method	`DeleteNetworkTags`	Deletes tags from a network.
Method	`DeleteNodeTags`	Delete tags from a node.
Method	`DisconnectNetwork`	Connects a Network to a NodeGroup with the given netparams
Method	`EvacuateNode`	Evacuates instances from a Ganeti node.
Method	`ExportInstance`	Exports an instance.
Method	`FailoverInstance`	Does a failover of an instance.
Method	`GetClusterTags`	Gets the cluster tags.
Method	`GetFeatures`	Gets the list of optional features supported by RAPI server.
Method	`GetFilter`	Gets information about a filter rule.
Method	`GetFilters`	Gets all filter rules in the cluster.
Method	`GetGroup`	Gets information about a node group.
Method	`GetGroups`	Gets all node groups in the cluster.
Method	`GetGroupTags`	Gets tags for a node group.
Method	`GetInfo`	Gets info about the cluster.
Method	`GetInstance`	Gets information about an instance.
Method	`GetInstanceConsole`	Request information for connecting to instance's console.
Method	`GetInstanceInfo`	Gets information about an instance.
Method	`GetInstances`	Gets information about instances on the cluster.
Method	`GetInstanceTags`	Gets tags for an instance.
Method	`GetJobs`	Gets all jobs for the cluster.
Method	`GetJobStatus`	Gets the status of a job.
Method	`GetNetwork`	Gets information about a network.
Method	`GetNetworks`	Gets all networks in the cluster.
Method	`GetNetworkTags`	Gets tags for a network.
Method	`GetNode`	Gets information about a node.
Method	`GetNodeRole`	Gets the current role for a node.
Method	`GetNodes`	Gets all nodes in the cluster.
Method	`GetNodeStorageUnits`	Gets the storage units for a node.
Method	`GetNodeTags`	Gets the tags for a node.
Method	`GetOperatingSystems`	Gets the Operating Systems running in the Ganeti cluster.
Method	`GetVersion`	Gets the Remote API version running on the cluster.
Method	`GrowInstanceDisk`	Grows a disk of an instance.
Method	`InstanceAllocation`	Generates an instance allocation as used by multiallocate.
Method	`InstancesMultiAlloc`	Tries to allocate multiple instances.
Method	`MigrateInstance`	Migrates an instance.
Method	`MigrateNode`	Migrates all primary instances from a node.
Method	`ModifyCluster`	Modifies cluster parameters.
Method	`ModifyGroup`	Modifies a node group.
Method	`ModifyInstance`	Modifies an instance.
Method	`ModifyNetwork`	Modifies a network.
Method	`ModifyNode`	Modifies a node.
Method	`ModifyNodeStorageUnits`	Modifies parameters of storage units on the node.
Method	`PowercycleNode`	Powercycles a node.
Method	`PrepareExport`	Prepares an instance for an export.
Method	`Query`	Retrieves information about resources.
Method	`QueryFields`	Retrieves available fields for a resource.
Method	`RebootInstance`	Reboots an instance.
Method	`RecreateInstanceDisks`	Recreate an instance's disks.
Method	`RedistributeConfig`	Tells the cluster to redistribute its configuration files.
Method	`ReinstallInstance`	Reinstalls an instance.
Method	`RenameGroup`	Changes the name of a node group.
Method	`RenameInstance`	Changes the name of an instance.
Method	`RenameNetwork`	Changes the name of a network.
Method	`RepairNodeStorageUnits`	Repairs a storage unit on the node.
Method	`ReplaceFilter`	Replaces a filter rule, or creates one if it doesn't already exist
Method	`ReplaceInstanceDisks`	Replaces disks on an instance.
Method	`SetNodeRole`	Sets the role for a node.
Method	`ShutdownInstance`	Shuts down an instance.
Method	`StartupInstance`	Starts up an instance.
Method	`WaitForJobChange`	Waits for job changes.
Method	`WaitForJobCompletion`	Polls cluster for job status until completion.
Constant	`USER_AGENT`	Undocumented
Static Method	`_EncodeQuery`	Encode query values for RAPI URL.
Static Method	`_UpdateWithKwargs`	Updates the base with params from kwargs.
Method	`_CreateCurl`	Creates a cURL object.
Method	`_SendRequest`	Sends an HTTP request.
Class Variable	`_json_encoder`	Undocumented
Instance Variable	`_base_url`	Undocumented
Instance Variable	`_curl_config_fn`	Undocumented
Instance Variable	`_curl_factory`	Undocumented
Instance Variable	`_logger`	Undocumented
Instance Variable	`_password`	Undocumented
Instance Variable	`_username`	Undocumented

def __init__(self, host, port=GANETI_RAPI_PORT, username=None, password=None, logger=logging, curl_config_fn=None, curl_factory=None): ¶

Initializes this class.

Parameters
host:string	the ganeti cluster master to interact with
port:int	the port on which the RAPI is running (default is 5080)
username:string	the username to connect with
password:string	the password to connect with
logger	Logging object
curl_config_fn:callable	Function to configure `pycurl.Curl` object
curl_factory	Undocumented

def ActivateInstanceDisks(self, instance, ignore_size=None, reason=None): ¶

Activates an instance's disks.

Parameters
instance:string	Instance name
ignore_size:bool	Whether to ignore recorded size
reason:string	the reason for executing this operation
Returns
string	job id

def AddClusterTags(self, tags, dry_run=False, reason=None): ¶

Adds tags to the cluster.

Parameters
tags:list of str	tags to add to the cluster
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def AddFilter(self, priority, predicates, action, reason_trail=None): ¶

Adds a filter rule

Parameters
priority	Undocumented
predicates	Undocumented
action	Undocumented
reason_trail:list of (str, str, int) triples	the reason trail for executing this operation, or None
Returns
string	filter UUID of the added filter

def AddGroupTags(self, group, tags, dry_run=False, reason=None): ¶

Adds tags to a node group.

Parameters
group:str	group to add tags to
tags:list of string	tags to add to the group
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def AddInstanceTags(self, instance, tags, dry_run=False, reason=None): ¶

Adds tags to an instance.

Parameters
instance:str	instance to add tags to
tags:list of str	tags to add to the instance
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def AddNetworkTags(self, network, tags, dry_run=False, reason=None): ¶

Adds tags to a network.

Parameters
network:str	network to add tags to
tags:list of string	tags to add to the network
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def AddNodeTags(self, node, tags, dry_run=False, reason=None): ¶

Adds tags to a node.

Parameters
node:str	node to add tags to
tags:list of str	tags to add to the node
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def AssignGroupNodes(self, group, nodes, force=False, dry_run=False, reason=None): ¶

Assigns nodes to a group.

Parameters
group:string	Node group name
nodes:list of strings	List of nodes to assign to the group
force	Undocumented
dry_run	Undocumented
reason:string	the reason for executing this operation
Returns
string	job id

def CancelJob(self, job_id, dry_run=False): ¶

Cancels a job.

Parameters
job_id:string	id of the job to delete
dry_run:bool	whether to perform a dry run
Returns
tuple	tuple containing the result, and a message (bool, string)

def ConnectNetwork(self, network_name, group_name, mode, link, vlan='', dry_run=False, reason=None): ¶

Connects a Network to a NodeGroup with the given netparams

def CreateGroup(self, name, alloc_policy=None, dry_run=False, reason=None): ¶

Creates a new node group.

Parameters
name:str	the name of node group to create
alloc_policy:str	the desired allocation policy for the group, if any
dry_run:bool	whether to peform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def CreateInstance(self, mode, name, disk_template, disks, nics, reason=None, **kwargs): ¶

Creates a new instance.

More details for parameters can be found in the RAPI documentation.

Parameters
mode:string	Instance creation mode
name:string	Hostname of the instance to create
disk_template:string	Disk template for instance (e.g. plain, diskless, file, or drbd)
disks:list of dicts	List of disk definitions
nics:list of dicts	List of NIC definitions
reason:string	the reason for executing this operation
**kwargs	Undocumented
dry_run:bool	whether to perform a dry run
Returns
string	job id

def CreateNetwork(self, network_name, network, gateway=None, network6=None, gateway6=None, mac_prefix=None, add_reserved_ips=None, tags=None, dry_run=False, reason=None): ¶

Creates a new network.

Parameters
network_name:str	the name of network to create
network	Undocumented
gateway	Undocumented
network6	Undocumented
gateway6	Undocumented
mac_prefix	Undocumented
add_reserved_ips	Undocumented
tags	Undocumented
dry_run:bool	whether to peform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeactivateInstanceDisks(self, instance, reason=None, force=False): ¶

Deactivates an instance's disks.

Parameters
instance:string	Instance name
reason:string	the reason for executing this operation
force	Undocumented
Returns
string	job id

def DeleteClusterTags(self, tags, dry_run=False, reason=None): ¶

Deletes tags from the cluster.

Parameters
tags:list of str	tags to delete
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeleteFilter(self, uuid): ¶

Deletes a filter rule

Returns
None

def DeleteGroup(self, group, dry_run=False, reason=None): ¶

Deletes a node group.

Parameters
group:str	the node group to delete
dry_run:bool	whether to peform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeleteGroupTags(self, group, tags, dry_run=False, reason=None): ¶

Deletes tags from a node group.

Parameters
group:str	group to delete tags from
tags:list of string	tags to delete
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeleteInstance(self, instance, dry_run=False, reason=None, **kwargs): ¶

Deletes an instance.

Parameters
instance:str	the instance to delete
dry_run	Undocumented
reason:string	the reason for executing this operation
**kwargs	Undocumented
Returns
string	job id

def DeleteInstanceTags(self, instance, tags, dry_run=False, reason=None): ¶

Deletes tags from an instance.

Parameters
instance:str	instance to delete tags from
tags:list of str	tags to delete
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeleteNetwork(self, network, dry_run=False, reason=None): ¶

Deletes a network.

Parameters
network:str	the network to delete
dry_run:bool	whether to peform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeleteNetworkTags(self, network, tags, dry_run=False, reason=None): ¶

Deletes tags from a network.

Parameters
network:str	network to delete tags from
tags:list of string	tags to delete
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DeleteNodeTags(self, node, tags, dry_run=False, reason=None): ¶

Delete tags from a node.

Parameters
node:str	node to remove tags from
tags:list of str	tags to remove from the node
dry_run:bool	whether to perform a dry run
reason:string	the reason for executing this operation
Returns
string	job id

def DisconnectNetwork(self, network_name, group_name, dry_run=False, reason=None): ¶

Connects a Network to a NodeGroup with the given netparams

def EvacuateNode(self, node, iallocator=None, remote_node=None, dry_run=False, early_release=None, mode=None, accept_old=False, reason=None): ¶

Evacuates instances from a Ganeti node.

Parameters
node:str	node to evacuate
iallocator:str or None	instance allocator to use
remote_node:str	node to evaucate to
dry_run:bool	whether to perform a dry run
early_release:bool	whether to enable parallelization
mode:string	Node evacuation mode
accept_old:bool	Whether caller is ready to accept old-style (pre-2.5) results
reason:string	the reason for executing this operation
Returns
string, or a list for pre-2.5 results	Job ID or, if `accept_old` is set and server is pre-2.5, list of (job ID, instance name, new secondary node); if dry_run was specified, then the actual move jobs were not submitted and the job IDs will be `None`
Raises
`GanetiApiError`	if an iallocator and remote_node are both specified

def ExportInstance(self, instance, mode, destination, shutdown=None, remove_instance=None, x509_key_name=None, destination_x509_ca=None, compress=None, reason=None): ¶

Exports an instance.

Parameters
instance:string	Instance name
mode:string	Export mode
destination	Undocumented
shutdown	Undocumented
remove_instance	Undocumented
x509_key_name	Undocumented
destination_x509_ca	Undocumented
compress	Undocumented
reason:string	the reason for executing this operation
Returns
string	Job ID

def FailoverInstance(self, instance, iallocator=None, ignore_consistency=None, target_node=None, reason=None): ¶

Does a failover of an instance.

Parameters
instance:string	Instance name
iallocator:string	Iallocator for deciding the target node for shared-storage instances
ignore_consistency:bool	Whether to ignore disk consistency
target_node:string	Target node for shared-storage instances
reason:string	the reason for executing this operation
Returns
string	job id

def GetClusterTags(self, reason=None): ¶

Gets the cluster tags.

Parameters
reason:string	the reason for executing this operation
Returns
list of str	cluster tags

def GetFeatures(self): ¶

Gets the list of optional features supported by RAPI server.

Returns
list	List of optional features

def GetFilter(self, filter_uuid): ¶

Gets information about a filter rule.

Parameters
filter_uuid:str	UUID of the filter whose info to return
Returns
dict	info about the filter

def GetFilters(self, bulk=False): ¶

Gets all filter rules in the cluster.

Parameters
bulk:bool	whether to return all information about the networks
Returns
list of dict or str	if bulk is true, a list of dictionaries with info about all filter rules in the cluster, else a list of UUIDs of those filters

def GetGroup(self, group, reason=None): ¶

Gets information about a node group.

Parameters
group:str	name of the node group whose info to return
reason:string	the reason for executing this operation
Returns
dict	info about the node group

def GetGroups(self, bulk=False, reason=None): ¶

Gets all node groups in the cluster.

Parameters
bulk:bool	whether to return all information about the groups
reason:string	the reason for executing this operation
Returns
list of dict or str	if bulk is true, a list of dictionaries with info about all node groups in the cluster, else a list of names of those node groups

def GetGroupTags(self, group, reason=None): ¶

Gets tags for a node group.

Parameters
group:string	Node group whose tags to return
reason:string	the reason for executing this operation
Returns
list of strings	tags for the group

def GetInfo(self, reason=None): ¶

Gets info about the cluster.

Parameters
reason:string	the reason for executing this operation
Returns
dict	information about the cluster

def GetInstance(self, instance, reason=None): ¶

Gets information about an instance.

Parameters
instance:str	instance whose info to return
reason:string	the reason for executing this operation
Returns
dict	info about the instance

def GetInstanceConsole(self, instance, reason=None): ¶

Request information for connecting to instance's console.

Parameters
instance:string	Instance name
reason:string	the reason for executing this operation
Returns
dict	dictionary containing information about instance's console

def GetInstanceInfo(self, instance, static=None, reason=None): ¶

Gets information about an instance.

Parameters
instance:string	Instance name
static	Undocumented
reason:string	the reason for executing this operation
Returns
string	Job ID

def GetInstances(self, bulk=False, reason=None): ¶

Gets information about instances on the cluster.

Parameters
bulk:bool	whether to return all information about all instances
reason:string	the reason for executing this operation
Returns
list of dict or list of str	if bulk is True, info about the instances, else a list of instances

def GetInstanceTags(self, instance, reason=None): ¶

Gets tags for an instance.

Parameters
instance:str	instance whose tags to return
reason:string	the reason for executing this operation
Returns
list of str	tags for the instance

def GetJobs(self, bulk=False): ¶

Gets all jobs for the cluster.

Parameters
bulk:bool	Whether to return detailed information about jobs.
Returns
list of int	List of job ids for the cluster or list of dicts with detailed information about the jobs if bulk parameter was true.

def GetJobStatus(self, job_id): ¶

Gets the status of a job.

Parameters
job_id:string	job id whose status to query
Returns
dict	job status

def GetNetwork(self, network, reason=None): ¶

Gets information about a network.

Parameters
network:str	name of the network whose info to return
reason:string	the reason for executing this operation
Returns
dict	info about the network

def GetNetworks(self, bulk=False, reason=None): ¶

Gets all networks in the cluster.

Parameters
bulk:bool	whether to return all information about the networks
reason	Undocumented
Returns
list of dict or str	if bulk is true, a list of dictionaries with info about all networks in the cluster, else a list of names of those networks

def GetNetworkTags(self, network, reason=None): ¶

Gets tags for a network.

Parameters
network:string	Node group whose tags to return
reason:string	the reason for executing this operation
Returns
list of strings	tags for the network

def GetNode(self, node, reason=None): ¶

Gets information about a node.

Parameters
node:str	node whose info to return
reason:string	the reason for executing this operation
Returns
dict	info about the node

def GetNodeRole(self, node, reason=None): ¶

Gets the current role for a node.

Parameters
node:str	node whose role to return
reason:string	the reason for executing this operation
Returns
str	the current role for a node

def GetNodes(self, bulk=False, reason=None): ¶

Gets all nodes in the cluster.

Parameters
bulk:bool	whether to return all information about all instances
reason:string	the reason for executing this operation
Returns
list of dict or str	if bulk is true, info about nodes in the cluster, else list of nodes in the cluster

def GetNodeStorageUnits(self, node, storage_type, output_fields, reason=None): ¶

Gets the storage units for a node.

Parameters
node:str	the node whose storage units to return
storage_type:str	storage type whose units to return
output_fields:str	storage type fields to return
reason:string	the reason for executing this operation
Returns
string	job id where results can be retrieved

def GetNodeTags(self, node, reason=None): ¶

Gets the tags for a node.

Parameters
node:str	node whose tags to return
reason:string	the reason for executing this operation
Returns
list of str	tags for the node

def GetOperatingSystems(self, reason=None): ¶

Gets the Operating Systems running in the Ganeti cluster.

Parameters
reason:string	the reason for executing this operation
Returns
list of str	operating systems

def GetVersion(self): ¶

Gets the Remote API version running on the cluster.

Returns
int	Ganeti Remote API version

def GrowInstanceDisk(self, instance, disk, amount, wait_for_sync=None, reason=None): ¶

Grows a disk of an instance.

More details for parameters can be found in the RAPI documentation.

Parameters
instance:string	Instance name
disk:integer	Disk index
amount:integer	Grow disk by this amount (MiB)
wait_for_sync:bool	Wait for disk to synchronize
reason:string	the reason for executing this operation
Returns
string	job id

def InstanceAllocation(self, mode, name, disk_template, disks, nics, **kwargs): ¶

Generates an instance allocation as used by multiallocate.

More details for parameters can be found in the RAPI documentation. It is the same as used by CreateInstance.

Parameters
mode:string	Instance creation mode
name:string	Hostname of the instance to create
disk_template:string	Disk template for instance (e.g. plain, diskless, file, or drbd)
disks:list of dicts	List of disk definitions
nics:list of dicts	List of NIC definitions
**kwargs	Undocumented
Returns
A dict with the generated entry

def InstancesMultiAlloc(self, instances, reason=None, **kwargs): ¶

Tries to allocate multiple instances.

More details for parameters can be found in the RAPI documentation.

Parameters
instances	A list of `InstanceAllocation` results
reason	Undocumented
**kwargs	Undocumented

def MigrateInstance(self, instance, mode=None, cleanup=None, target_node=None, reason=None): ¶

Migrates an instance.

Parameters
instance:string	Instance name
mode:string	Migration mode
cleanup:bool	Whether to clean up a previously failed migration
target_node:string	Target Node for externally mirrored instances
reason:string	the reason for executing this operation
Returns
string	job id

def MigrateNode(self, node, mode=None, dry_run=False, iallocator=None, target_node=None, reason=None): ¶

Migrates all primary instances from a node.

Parameters
node:str	node to migrate
mode:string	if passed, it will overwrite the live migration type, otherwise the hypervisor default will be used
dry_run:bool	whether to perform a dry run
iallocator:string	instance allocator to use
target_node:string	Target node for shared-storage instances
reason:string	the reason for executing this operation
Returns
string	job id

def ModifyCluster(self, reason=None, **kwargs): ¶

Modifies cluster parameters.

More details for parameters can be found in the RAPI documentation.

Parameters
reason:string	the reason for executing this operation
**kwargs	Undocumented
Returns
string	job id

def ModifyGroup(self, group, reason=None, **kwargs): ¶

Modifies a node group.

More details for parameters can be found in the RAPI documentation.

Parameters
group:string	Node group name
reason:string	the reason for executing this operation
**kwargs	Undocumented
Returns
string	job id

def ModifyInstance(self, instance, reason=None, **kwargs): ¶

Modifies an instance.

More details for parameters can be found in the RAPI documentation.

Parameters
instance:string	Instance name
reason:string	the reason for executing this operation
**kwargs	Undocumented
Returns
string	job id

def ModifyNetwork(self, network, reason=None, **kwargs): ¶

Modifies a network.

More details for parameters can be found in the RAPI documentation.

Parameters
network:string	Network name
reason:string	the reason for executing this operation
**kwargs	Undocumented
Returns
string	job id

def ModifyNode(self, node, reason=None, **kwargs): ¶

Modifies a node.

More details for parameters can be found in the RAPI documentation.

Parameters
node:string	Node name
reason:string	the reason for executing this operation
**kwargs	Undocumented
Returns
string	job id

def ModifyNodeStorageUnits(self, node, storage_type, name, allocatable=None, reason=None): ¶

Modifies parameters of storage units on the node.

Parameters
node:str	node whose storage units to modify
storage_type:str	storage type whose units to modify
name:str	name of the storage unit
allocatable:bool or None	Whether to set the "allocatable" flag on the storage unit (None=no modification, True=set, False=unset)
reason:string	the reason for executing this operation
Returns
string	job id

def PowercycleNode(self, node, force=False, reason=None): ¶

Powercycles a node.

Parameters
node:string	Node name
force:bool	Whether to force the operation
reason:string	the reason for executing this operation
Returns
string	job id

def PrepareExport(self, instance, mode, reason=None): ¶

Prepares an instance for an export.

Parameters
instance:string	Instance name
mode:string	Export mode
reason:string	the reason for executing this operation
Returns
string	Job ID

def Query(self, what, fields, qfilter=None, reason=None): ¶

Retrieves information about resources.

Parameters
what:string	Resource name, one of `constants.QR_VIA_RAPI`
fields:list of string	Requested fields
qfilter:None or list	Query filter
reason:string	the reason for executing this operation
Returns
string	job id

def QueryFields(self, what, fields=None, reason=None): ¶

Retrieves available fields for a resource.

Parameters
what:string	Resource name, one of `constants.QR_VIA_RAPI`
fields:list of string	Requested fields
reason:string	the reason for executing this operation
Returns
string	job id

def RebootInstance(self, instance, reboot_type=None, ignore_secondaries=None, dry_run=False, reason=None, **kwargs): ¶

Reboots an instance.

Parameters
instance:str	instance to reboot
reboot_type:str	one of: hard, soft, full
ignore_secondaries:bool	if True, ignores errors for the secondary node while re-assembling disks (in hard-reboot mode only)
dry_run:bool	whether to perform a dry run
reason:string	the reason for the reboot
**kwargs	Undocumented
Returns
string	job id

def RecreateInstanceDisks(self, instance, disks=None, nodes=None, reason=None, iallocator=None): ¶

Recreate an instance's disks.

Parameters
instance:string	Instance name
disks:list of int	List of disk indexes
nodes:list of string	New instance nodes, if relocation is desired
reason:string	the reason for executing this operation
iallocator:str or None	instance allocator plugin to use
Returns
string	job id

def RedistributeConfig(self, reason=None): ¶

Tells the cluster to redistribute its configuration files.

Parameters
reason:string	the reason for executing this operation
Returns
string	job id

def ReinstallInstance(self, instance, os=None, no_startup=False, osparams=None, reason=None): ¶

Reinstalls an instance.

Parameters
instance:str	The instance to reinstall
os:str or None	The operating system to reinstall. If None, the instance's current operating system will be installed again
no_startup:bool	Whether to start the instance automatically
osparams	Undocumented
reason:string	the reason for executing this operation
Returns
string	job id

def RenameGroup(self, group, new_name, reason=None): ¶

Changes the name of a node group.

Parameters
group:string	Node group name
new_name:string	New node group name
reason:string	the reason for executing this operation
Returns
string	job id

def RenameInstance(self, instance, new_name, ip_check=None, name_check=None, reason=None): ¶

Changes the name of an instance.

Parameters
instance:string	Instance name
new_name:string	New instance name
ip_check:bool	Whether to ensure instance's IP address is inactive
name_check:bool	Whether to ensure instance's name is resolvable
reason:string	the reason for executing this operation
Returns
string	job id

def RenameNetwork(self, network, new_name, reason=None): ¶

Changes the name of a network.

Parameters
network:string	Network name
new_name:string	New network name
reason:string	the reason for executing this operation
Returns
string	job id

def RepairNodeStorageUnits(self, node, storage_type, name, reason=None): ¶

Repairs a storage unit on the node.

Parameters
node:str	node whose storage units to repair
storage_type:str	storage type to repair
name:str	name of the storage unit to repair
reason:string	the reason for executing this operation
Returns
string	job id

def ReplaceFilter(self, uuid, priority, predicates, action, reason_trail=None): ¶

Replaces a filter rule, or creates one if it doesn't already exist

Parameters
uuid	Undocumented
priority	Undocumented
predicates	Undocumented
action	Undocumented
reason_trail:list of (str, str, int) triples	the reason trail for executing this operation, or None
Returns
string	filter UUID of the replaced/added filter

def ReplaceInstanceDisks(self, instance, disks=None, mode=REPLACE_DISK_AUTO, remote_node=None, iallocator=None, reason=None, early_release=None): ¶

Replaces disks on an instance.

Parameters
instance:str	instance whose disks to replace
disks:list of ints	Indexes of disks to replace
mode:str	replacement mode to use (defaults to replace_auto)
remote_node:str or None	new secondary node to use (for use with replace_new_secondary mode)
iallocator:str or None	instance allocator plugin to use (for use with replace_auto mode)
reason:string	the reason for executing this operation
early_release:bool	whether to release locks as soon as possible
Returns
string	job id

def SetNodeRole(self, node, role, force=False, auto_promote=None, reason=None): ¶

Sets the role for a node.

Parameters
node:str	the node whose role to set
role:str	the role to set for the node
force:bool	whether to force the role change
auto_promote:bool	Whether node(s) should be promoted to master candidate if necessary
reason:string	the reason for executing this operation
Returns
string	job id

def ShutdownInstance(self, instance, dry_run=False, no_remember=False, reason=None, **kwargs): ¶

Shuts down an instance.

Parameters
instance:str	the instance to shut down
dry_run:bool	whether to perform a dry run
no_remember:bool	if true, will not record the state change
reason:string	the reason for the shutdown
**kwargs	Undocumented
Returns
string	job id

def StartupInstance(self, instance, dry_run=False, no_remember=False, reason=None): ¶

Starts up an instance.

Parameters
instance:str	the instance to start up
dry_run:bool	whether to perform a dry run
no_remember:bool	if true, will not record the state change
reason:string	the reason for the startup
Returns
string	job id

def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial): ¶

Waits for job changes.

Parameters
job_id:string	Job ID for which to wait
fields	Undocumented
prev_job_info	Undocumented
prev_log_serial	Undocumented
Returns
dict	`None` if no changes have been detected and a dict with two keys, `job_info` and `log_entries` otherwise.

def WaitForJobCompletion(self, job_id, period=5, retries=-1): ¶

Polls cluster for job status until completion.

Completion is defined as any of the following states listed in JOB_STATUS_FINALIZED.

Parameters
job_id:string	job id to watch
period:int	how often to poll for status (optional, default 5s)
retries:int	how many time to poll before giving up (optional, default -1 means unlimited)
Returns
bool	`True` if job succeeded or `False` if failed/status timeout
Unknown Field: deprecated
It is recommended to use `WaitForJobChange` wherever possible; `WaitForJobChange` returns immediately after a job changed and does not use polling

USER_AGENT: str = ¶

Undocumented

Value

'Ganeti RAPI Client'

@staticmethod
def _EncodeQuery(query): ¶

Encode query values for RAPI URL.

Parameters
query:list of two-tuples	Query arguments
Returns
list	Query list with encoded values

@staticmethod
def _UpdateWithKwargs(base, **kwargs): ¶

Updates the base with params from kwargs.

Parameters
base	The base dict, filled with required fields
**kwargs	Undocumented
Note
This is an inplace update of base

def _CreateCurl(self): ¶

Creates a cURL object.

def _SendRequest(self, method, path, query, content): ¶

Sends an HTTP request.

This constructs a full URL, encodes and decodes HTTP bodies, and handles invalid responses in a pythonic way.

Parameters
method:string	HTTP method to use
path:string	HTTP URL path
query:list of two-tuples	query arguments to pass to urlencode
content:str or None	HTTP body content
Returns
str	JSON-Decoded response
Raises
`CertificateError`	If an invalid SSL certificate is found
`GanetiApiError`	If an invalid response is returned

_json_encoder = ¶

Undocumented

_base_url = ¶

Undocumented

_curl_config_fn = ¶

Undocumented

_curl_factory = ¶

Undocumented

_logger = ¶

Undocumented

_password = ¶

Undocumented

_username = ¶

Undocumented