Rackspace Compute Driver Documentation¶
Rackspace is a public and private cloud provider based in San Antonio, Texas with data centers in United States, United Kingdom, China and Australia.

Rackspace driver supports working with legacy, first-gen cloud servers and next-gen OpenStack based cloud servers.
Rackspace driver is based on the OpenStack driver so for more information about that and OpenStack specific documentation, please refer to OpenStack Compute Driver Documentation page.
Instantiating a driver¶
When you instantiate a driver you need to pass the following arguments to the driver constructor:
username
- your Rackspace Cloud usernameapi_key
- your Rackspace Cloud API keyregion
- Which region to use. Supported regions depend on the driver type (next-gen vs first-gen).
Instantiating a next-gen driver¶
Supported regions: dfw
, ord
, iad
, lon
, syd
, hkg
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
cls = get_driver(Provider.RACKSPACE)
driver = cls("username", "api key", region="iad")
Instantiating a first-gen driver¶
Keep in mind that first-gen cloud servers have been deprecated and you are strongly encouraged to use next-gen cloud servers.
Supported regions: us
, uk
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
cls = get_driver(Provider.RACKSPACE_FIRST_GEN)
driver_us = cls("username", "api key", region="us")
driver_uk = cls("username", "api key", region="uk")
Examples¶
1. Working with ‘performance’ cloud server flavors¶
Rackspace recently announced new ‘performance’ flavors of their cloud servers. The example below shows how to use this new flavors.
Keep in mind that this new flavors are currently only supported in the following
regions: iad
, ord
, lon
.
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
cls = get_driver(Provider.RACKSPACE)
driver = cls("username", "api key", region="iad")
sizes = driver.list_sizes()
performance_sizes = [size for size in sizes if "performance" in size.id]
for size in performance_sizes:
print(size)
API Docs¶
- class libcloud.compute.drivers.rackspace.RackspaceNodeDriver(key, secret=None, secure=True, host=None, port=None, api_version='1.1', **kwargs)[source]¶
@inherits:
NodeDriver.__init__
- Parameters:
region (
str
) – ID of the region which should be used.
- attach_volume(node, volume, device='auto')¶
Attaches volume to node.
- Parameters:
node (
Node
) – Node to attach volume to.volume (
StorageVolume
) – Volume to attach.device (
str
) – Where the device is exposed, e.g. ‘/dev/sdb’
- Rytpe:
bool
- connectionCls¶
alias of
RackspaceConnection
- copy_image(source_region: str, node_image: NodeImage, name: str, description: Optional[str] = None) NodeImage ¶
Copies an image from a source region to the current region.
- create_image(node, name, metadata=None)¶
Creates a new image.
- Parameters:
node (
Node
) – Nodename (
str
) – The name for the new image.metadata (
dict
) – Key and value pairs for metadata.
- Return type:
NodeImage
- create_key_pair(name)¶
Create a new key pair object.
- Parameters:
name (
str
) – Key pair name.- Return type:
KeyPair
object
- create_node(name, size, image=None, ex_keyname=None, ex_userdata=None, ex_config_drive=None, ex_security_groups=None, ex_metadata=None, ex_files=None, networks=None, ex_disk_config=None, ex_admin_pass=None, ex_availability_zone=None, ex_blockdevicemappings=None, ex_os_scheduler_hints=None)¶
Create a new node
@inherits:
NodeDriver.create_node
- Parameters:
ex_keyname (
str
) – The name of the key pairex_userdata (
str
) – String containing user data see https://help.ubuntu.com/community/CloudInitex_config_drive (
bool
) – Enable config drive see http://docs.openstack.org/grizzly/openstack-compute/admin/content/config-drive.htmlex_security_groups (
list
ofOpenStackSecurityGroup
) – List of security groups to assign to the nodeex_metadata (
dict
) – Key/Value metadata to associate with a nodeex_files (
dict
) – File Path => File contents to create on the nodenetworks (
list
ofOpenStackNetwork
) – The server is launched into a set of Networks.ex_disk_config (
str
) – Name of the disk configuration. Can be eitherAUTO
orMANUAL
.ex_config_drive – If True enables metadata injection in a server through a configuration drive.
ex_admin_pass (
str
) – The root password for the nodeex_availability_zone (
str
) – Nova availability zone for the nodeex_blockdevicemappings (
dict
) – Enables fine grained control of the block device mapping for an instance.ex_os_scheduler_hints (
dict
) – The dictionary of data to send to the scheduler.
- create_volume(size, name, location=None, snapshot=None, ex_volume_type=None)¶
Create a new volume.
- Parameters:
size (
int
) – Size of volume in gigabytes (required)name (
str
) – Name of the volume to be createdlocation (
NodeLocation
) – Which data center to create a volume in. If empty, undefined behavior will be selected. (optional)snapshot (
VolumeSnapshot
) – Snapshot from which to create the new volume. (optional)ex_volume_type (
str
) – What kind of volume to create. (optional)
- Returns:
The newly created volume.
- Return type:
StorageVolume
- create_volume_snapshot(volume, name=None, ex_description=None, ex_force=True)¶
Create snapshot from volume
- Parameters:
volume (StorageVolume) – Instance of StorageVolume
name (str | NoneType) – Name of snapshot (optional)
ex_description (str | NoneType) – Description of the snapshot (optional)
ex_force (bool) – Specifies if we create a snapshot that is not in state available. For example in-use. Defaults to True. (optional)
- Return type:
VolumeSnapshot
- delete_image(image)¶
Delete a NodeImage
@inherits:
NodeDriver.delete_image
- Parameters:
image (
NodeImage
) – image witch should be used- Return type:
bool
- delete_key_pair(key_pair)¶
Delete a KeyPair.
- Parameters:
keypair (
OpenStackKeyPair
) – KeyPair to delete- Return type:
bool
- deploy_node(deploy: Deployment, ssh_username: str = 'root', ssh_alternate_usernames: Optional[List[str]] = None, ssh_port: int = 22, ssh_timeout: int = 10, ssh_key: Optional[T_Ssh_key] = None, ssh_key_password: Optional[str] = None, auth: T_Auth = None, timeout: int = 300, max_tries: int = 3, ssh_interface: str = 'public_ips', at_exit_func: Callable = None, wait_period: int = 5, **create_node_kwargs) Node ¶
Create a new node, and start deployment.
In order to be able to SSH into a created node access credentials are required.
A user can pass either a
NodeAuthPassword
orNodeAuthSSHKey
to theauth
argument. If thecreate_node
implementation supports that kind if credential (as declared inself.features['create_node']
) then it is passed on tocreate_node
. Otherwise it is not passed on tocreate_node
and it is only used for authentication.If the
auth
parameter is not supplied but the driver declares it supportsgenerates_password
then the password returned bycreate_node
will be used to SSH into the server.Finally, if the
ssh_key_file
is supplied that key will be used to SSH into the server.This function may raise a
DeploymentException
, if a create_node call was successful, but there is a later error (like SSH failing or timing out). This exception includes a Node object which you may want to destroy if incomplete deployments are not desirable.>>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> from libcloud.compute.deployment import ScriptDeployment >>> from libcloud.compute.deployment import MultiStepDeployment >>> from libcloud.compute.base import NodeAuthSSHKey >>> driver = DummyNodeDriver(0) >>> key = NodeAuthSSHKey('...') # read from file >>> script = ScriptDeployment("yum -y install emacs strace tcpdump") >>> msd = MultiStepDeployment([key, script]) >>> def d(): ... try: ... driver.deploy_node(deploy=msd) ... except NotImplementedError: ... print ("not implemented for dummy driver") >>> d() not implemented for dummy driver
Deploy node is typically not overridden in subclasses. The existing implementation should be able to handle most such.
- Parameters:
deploy (
Deployment
) – Deployment to run once machine is online and available to SSH.ssh_username (
str
) – Optional name of the account which is used when connecting to SSH server (default is root)ssh_alternate_usernames (
list
) – Optional list of ssh usernames to try to connect with if using the default one failsssh_port (
int
) – Optional SSH server port (default is 22)ssh_timeout (
float
) – Optional SSH connection timeout in seconds (default is 10)auth (
NodeAuthSSHKey
orNodeAuthPassword
) – Initial authentication information for the node (optional)ssh_key (
str
orlist
ofstr
) – A path (or paths) to an SSH private key with which to attempt to authenticate. (optional)ssh_key_password (
str
) – Optional password used for encrypted keys.timeout (
int
) – How many seconds to wait before timing out. (default is 600)max_tries (
int
) – How many times to retry if a deployment fails before giving up (default is 3)ssh_interface (
str
) – The interface to wait for. Default is ‘public_ips’, other option is ‘private_ips’.at_exit_func (
func
) –Optional atexit handler function which will be registered and called with created node if user cancels the deploy process (e.g. CTRL+C), after the node has been created, but before the deploy process has finished.
This method gets passed in two keyword arguments:
driver -> node driver in question
node -> created Node object
Keep in mind that this function will only be called in such scenario. In case the method finishes (this includes throwing an exception), at exit handler function won’t be called.
wait_period (
int
) – How many seconds to wait between each iteration while waiting for node to transition into running state and have IP assigned. (default is 5)
- destroy_node(node)¶
Destroy a node.
Depending upon the provider, this may destroy all data associated with the node, including backups.
- Parameters:
node (
Node
) – The node to be destroyed- Returns:
True if the destroy was successful, False otherwise.
- Return type:
bool
- destroy_volume(volume)¶
Destroys a storage volume.
- Parameters:
volume (
StorageVolume
) – Volume to be destroyed- Return type:
bool
- destroy_volume_snapshot(snapshot)¶
Destroys a snapshot.
- Parameters:
snapshot (
VolumeSnapshot
) – The snapshot to delete- Return type:
- detach_volume(volume, ex_node=None)¶
Detaches a volume from a node.
- Parameters:
volume (
StorageVolume
) – Volume to be detached- Return type:
bool
- ex_attach_floating_ip_to_node(node, ip)¶
Attach the floating IP to the node
- Parameters:
node (
Node
) – nodeip (
str
orOpenStack_1_1_FloatingIpAddress
) – floating IP to attach
- Return type:
bool
- ex_confirm_resize(node)¶
Confirms a pending resize action.
- Parameters:
node (
Node
) – Node to resize.- Return type:
bool
- ex_create_floating_ip(ip_pool=None)¶
Create new floating IP. The ip_pool attribute is optional only if your infrastructure has only one IP pool available.
- Parameters:
ip_pool (
str
) – name of the floating IP pool- Return type:
OpenStack_1_1_FloatingIpAddress
- ex_create_keypair(name)¶
Create a new KeyPair
- Parameters:
name (
str
) – Name of the new KeyPair- Return type:
OpenStackKeyPair
- ex_create_network(name, cidr)¶
Create a new Network
- Parameters:
name (
str
) – Name of network which should be usedcidr (
str
) – cidr of network which should be used
- Return type:
OpenStackNetwork
- ex_create_security_group(name, description)¶
Create a new Security Group
- Parameters:
name (
str
) – Name of the new Security Groupdescription (
str
) – Description of the new Security Group
- Return type:
OpenStackSecurityGroup
- ex_create_security_group_rule(security_group, ip_protocol, from_port, to_port, cidr=None, source_security_group=None)¶
Create a new Rule in a Security Group
- Parameters:
security_group (
OpenStackSecurityGroup
) – Security Group in which to add the ruleip_protocol (
str
) – Protocol to which this rule applies Examples: tcp, udp, …from_port (
int
) – First port of the port rangeto_port (
int
) – Last port of the port rangecidr (
str
) – CIDR notation of the source IP range for this rulesource_security_group (L{OpenStackSecurityGroup) – Existing Security Group to use as the source (instead of CIDR)
- Return type:
OpenStackSecurityGroupRule
- ex_create_snapshot(volume, name, description=None, force=False)¶
Create a snapshot based off of a volume.
- Parameters:
volume (
StorageVolume
) – volumename (
str
) – New name for the volume snapshotdescription (
str
) – Description of the snapshot (optional)force (
bool
) – Whether to force creation (optional)
- Return type:
VolumeSnapshot
- ex_delete_floating_ip(ip)¶
Delete specified floating IP
- Parameters:
ip (
OpenStack_1_1_FloatingIpAddress
) – floating IP to remove- Return type:
bool
- ex_delete_keypair(keypair)¶
Delete a KeyPair.
- Parameters:
keypair (
OpenStackKeyPair
) – KeyPair to delete- Return type:
bool
- ex_delete_network(network)¶
Delete a Network
- Parameters:
network (
OpenStackNetwork
) – Network which should be used- Return type:
bool
- ex_delete_security_group(security_group)¶
Delete a Security Group.
- Parameters:
security_group (
OpenStackSecurityGroup
) – Security Group should be deleted- Return type:
bool
- ex_delete_security_group_rule(rule)¶
Delete a Rule from a Security Group.
- Parameters:
rule (
OpenStackSecurityGroupRule
) – Rule should be deleted- Return type:
bool
- ex_delete_snapshot(snapshot)¶
Delete a VolumeSnapshot
- Parameters:
snapshot (
VolumeSnapshot
) – snapshot- Return type:
bool
- ex_detach_floating_ip_from_node(node, ip)¶
Detach the floating IP from the node
- Parameters:
node (
Node
) – nodeip (
str
orOpenStack_1_1_FloatingIpAddress
) – floating IP to remove
- Return type:
bool
- ex_get_console_output(node, length=None)¶
Get console output
- Parameters:
node (
Node
) – nodelength (
int
) – Optional number of lines to fetch from the console log
- Returns:
Dictionary with the output
- Return type:
dict
- ex_get_floating_ip(ip)¶
Get specified floating IP
- Parameters:
ip (
str
) – floating IP to get- Return type:
OpenStack_1_1_FloatingIpAddress
- ex_get_metadata(node)¶
Get a Node’s metadata.
- Parameters:
node (
Node
) – Node- Returns:
Key/Value metadata associated with node.
- Return type:
dict
- ex_get_metadata_for_node(node)¶
Return the metadata associated with the node.
- Parameters:
node (
Node
) – Node instance- Returns:
A dictionary or other mapping of strings to strings, associating tag names with tag values.
- ex_get_network(network_id)¶
Retrieve the Network with the given ID
- Parameters:
networkId (
str
) – ID of the network
:rtype
OpenStackNetwork
- ex_get_node_details(node_id)¶
Lists details of the specified server.
- Parameters:
node_id (
str
) – ID of the node which should be used- Return type:
Node
- ex_get_node_security_groups(node)¶
Get Security Groups of the specified server.
- Return type:
list
ofOpenStackSecurityGroup
- ex_get_size(size_id)¶
Get a NodeSize
- Parameters:
size_id (
str
) – ID of the size which should be used- Return type:
NodeSize
- ex_get_size_extra_specs(size_id)¶
Get the extra_specs field of a NodeSize
- Parameters:
size_id (
str
) – ID of the size which should be used- Return type:
dict
- ex_hard_reboot_node(node)¶
Hard reboots the specified server
- Parameters:
node (
Node
) – node- Return type:
bool
- ex_import_keypair(name, keyfile)¶
Import a KeyPair from a file
- Parameters:
name (
str
) – Name of the new KeyPairkeyfile (
str
) – Path to the public key file (in OpenSSH format)
- Return type:
OpenStackKeyPair
- ex_import_keypair_from_string(name, key_material)¶
Import a KeyPair from a string
- Parameters:
name (
str
) – Name of the new KeyPairkey_material (
str
) – Public key (in OpenSSH format)
- Return type:
OpenStackKeyPair
- ex_list_floating_ip_pools()¶
List available floating IP pools
- Return type:
list
ofOpenStack_1_1_FloatingIpPool
- ex_list_floating_ips()¶
List floating IPs
- Return type:
list
ofOpenStack_1_1_FloatingIpAddress
- ex_list_keypairs()¶
Get a list of KeyPairs that are available.
- Return type:
list
ofOpenStackKeyPair
- ex_list_networks()¶
Get a list of Networks that are available.
- Return type:
list
ofOpenStackNetwork
- ex_list_security_groups()¶
Get a list of Security Groups that are available.
- Return type:
list
ofOpenStackSecurityGroup
- ex_rebuild(node, image, **kwargs)¶
Rebuild a Node.
- Parameters:
node (
Node
) – Node to rebuild.image (
NodeImage
) – New image to use.ex_metadata (
dict
) – Key/Value metadata to associate with a nodeex_files (
dict
) – File Path => File contents to create on the nodeex_keyname (
str
) – Name of existing public key to inject into instanceex_userdata (
str
) – String containing user data see https://help.ubuntu.com/community/CloudInitex_security_groups (
list
ofOpenStackSecurityGroup
) – List of security groups to assign to the nodeex_disk_config (
str
) – Name of the disk configuration. Can be eitherAUTO
orMANUAL
.ex_config_drive (
bool
) – If True enables metadata injection in a server through a configuration drive.
- Return type:
bool
- ex_rescue(node, password=None)¶
Rescue a node
- Parameters:
node (
Node
) – nodepassword (
str
) – password
- Return type:
Node
- ex_resize(node, size)¶
Change a node size.
- Parameters:
node (
Node
) – Node to resize.size (
NodeSize
) – New size to use.
- Return type:
bool
- ex_revert_resize(node)¶
Cancels and reverts a pending resize action.
- Parameters:
node (
Node
) – Node to resize.- Return type:
bool
- ex_set_metadata(node, metadata)¶
Sets the Node’s metadata.
- Parameters:
node (
Node
) – Nodemetadata (
dict
) – Key/Value metadata to associate with a node
- Return type:
dict
- ex_set_password(node, password)¶
Changes the administrator password for a specified server.
- Parameters:
node (
Node
) – Node to rebuild.password (
str
) – The administrator password.
- Return type:
bool
- ex_set_server_name(node, name)¶
Sets the Node’s name.
- Parameters:
node (
Node
) – Nodename (
str
) – The name of the server.
- Return type:
Node
- ex_soft_reboot_node(node)¶
Soft reboots the specified server
- Parameters:
node (
Node
) – node- Return type:
bool
- ex_unrescue(node)¶
Unrescue a node
- Parameters:
node (
Node
) – node- Return type:
bool
- ex_update_node(node, **node_updates)¶
Update the Node’s editable attributes. The OpenStack API currently supports editing name and IPv4/IPv6 access addresses.
The driver currently only supports updating the node name.
- Parameters:
node (
Node
) – Nodename (
str
) – New name for the server
- Return type:
Node
- features: Dict[str, List[str]] = {'create_node': ['generates_password']}¶
- List of available features for a driver.
libcloud.compute.base.NodeDriver.create_node()
ssh_key: Supports
NodeAuthSSHKey
as an authentication method for nodes.password: Supports
NodeAuthPassword
as an authentication method for nodes.generates_password: Returns a password attribute on the Node object returned from creation.
- get_image(image_id)¶
Get a NodeImage
@inherits:
NodeDriver.get_image
- Parameters:
image_id (
str
) – ID of the image which should be used- Return type:
NodeImage
- get_key_pair(name)¶
Retrieve a single key pair.
- Parameters:
name (
str
) – Name of the key pair to retrieve.- Return type:
- import_key_pair_from_file(name: str, key_file_path: str) KeyPair ¶
Import a new public key from string.
- Parameters:
name (
str
) – Key pair name.key_file_path (
str
) – Path to the public key file.
- Return type:
KeyPair
object
- import_key_pair_from_string(name, key_material)¶
Import a new public key from string.
- Parameters:
name (
str
) – Key pair name.key_material (
str
) – Public key material.
- Return type:
KeyPair
object
- list_images(location=None, ex_only_active=True)¶
Lists all active images
@inherits:
NodeDriver.list_images
- Parameters:
ex_only_active (
bool
) – True if list only active (optional)
- list_locations()¶
List data centers for a provider
- Returns:
list of node location objects
- Return type:
list
ofNodeLocation
- list_nodes(ex_all_tenants=False)¶
List the nodes in a tenant
- Parameters:
ex_all_tenants (
bool
) – List nodes for all the tenants. Note: Your user must have admin privileges for this functionality to work.
- list_sizes(location=None)¶
List sizes on a provider
- Parameters:
location (
NodeLocation
) – The location at which to list sizes- Returns:
list of node size objects
- Return type:
list
ofNodeSize
- list_volume_snapshots(volume)¶
List snapshots for a storage volume.
- Return type:
list
ofVolumeSnapshot
- list_volumes()¶
List storage volumes.
- Return type:
list
ofStorageVolume
- openstack_connection_kwargs()¶
Returns certain
ex_*
parameters for this connection.- Return type:
dict
- reboot_node(node)¶
Reboot a node.
- Parameters:
node (
Node
) – The node to be rebooted- Returns:
True if the reboot was successful, otherwise False
- Return type:
bool
- start_node(node)¶
Start a node.
- Parameters:
node (
Node
) – The node to be started- Returns:
True if the start was successful, otherwise False
- Return type:
bool
- stop_node(node)¶
Stop a node
- Parameters:
node (
Node
) – The node to be stopped.- Returns:
True if the stop was successful, otherwise False
- Return type:
bool
- wait_until_running(nodes: List[Node], wait_period: float = 5, timeout: int = 600, ssh_interface: str = 'public_ips', force_ipv4: bool = True, ex_list_nodes_kwargs: Optional[Dict] = None) List[Tuple[Node, List[str]]] ¶
Block until the provided nodes are considered running.
Node is considered running when it’s state is “running” and when it has at least one IP address assigned.
- Parameters:
nodes (
list
ofNode
) – List of nodes to wait for.wait_period (
int
) – How many seconds to wait between each loop iteration. (default is 3)timeout (
int
) – How many seconds to wait before giving up. (default is 600)ssh_interface (
str
) – Which attribute on the node to use to obtain an IP address. Valid options: public_ips, private_ips. Default is public_ips.force_ipv4 (
bool
) – Ignore IPv6 addresses (default is True).ex_list_nodes_kwargs (
dict
) – Optional driver-specific keyword arguments which are passed to thelist_nodes
method.
- Returns:
[(Node, ip_addresses)]
list of tuple of Node instance and list of ip_address on success.- Return type:
list
oftuple
- class libcloud.compute.drivers.rackspace.RackspaceFirstGenNodeDriver(key, secret=None, secure=True, host=None, port=None, api_version='1.1', **kwargs)[source]¶
@inherits:
NodeDriver.__init__
- Parameters:
region (
str
) – Region ID which should be used
- attach_volume(node, volume, device='auto')¶
Attaches volume to node.
- Parameters:
node (
Node
) – Node to attach volume to.volume (
StorageVolume
) – Volume to attach.device (
str
) – Where the device is exposed, e.g. ‘/dev/sdb’
- Rytpe:
bool
- connectionCls¶
alias of
RackspaceFirstGenConnection
- copy_image(source_region: str, node_image: NodeImage, name: str, description: Optional[str] = None) NodeImage ¶
Copies an image from a source region to the current region.
- create_image(node, name, description=None, reboot=True)¶
Create an image for node.
@inherits:
NodeDriver.create_image
- Parameters:
node (
Node
) – node to use as a base for imagename (
str
) – name for new image
- Return type:
NodeImage
- create_key_pair(name: str) KeyPair ¶
Create a new key pair object.
- Parameters:
name (
str
) – Key pair name.- Return type:
KeyPair
object
- create_node(name, size, image, ex_metadata=None, ex_files=None, ex_shared_ip_group=None, ex_shared_ip_group_id=None)¶
Create a new node
@inherits:
NodeDriver.create_node
- Parameters:
ex_metadata (
dict
) – Key/Value metadata to associate with a nodeex_files (
dict
) – File Path => File contents to create on the nodeex_shared_ip_group_id (
str
) – The server is launched into that shared IP group
- create_volume(size, name, location=None, snapshot=None, ex_volume_type=None)¶
Create a new volume.
- Parameters:
size (
int
) – Size of volume in gigabytes (required)name (
str
) – Name of the volume to be createdlocation (
NodeLocation
) – Which data center to create a volume in. If empty, undefined behavior will be selected. (optional)snapshot (
VolumeSnapshot
) – Snapshot from which to create the new volume. (optional)ex_volume_type (
str
) – What kind of volume to create. (optional)
- Returns:
The newly created volume.
- Return type:
StorageVolume
- create_volume_snapshot(volume: StorageVolume, name: Optional[str] = None) VolumeSnapshot ¶
Creates a snapshot of the storage volume.
- Parameters:
volume (
StorageVolume
) – The StorageVolume to create a VolumeSnapshot fromname (str) – Name of created snapshot (optional)
- Return type:
VolumeSnapshot
- delete_image(image)¶
Delete an image for node.
@inherits:
NodeDriver.delete_image
- Parameters:
image (
NodeImage
) – the image to be deleted- Return type:
bool
- delete_key_pair(key_pair: KeyPair) bool ¶
Delete an existing key pair.
- Parameters:
key_pair (
KeyPair
) – Key pair object.- Return type:
bool
- deploy_node(deploy: Deployment, ssh_username: str = 'root', ssh_alternate_usernames: Optional[List[str]] = None, ssh_port: int = 22, ssh_timeout: int = 10, ssh_key: Optional[T_Ssh_key] = None, ssh_key_password: Optional[str] = None, auth: T_Auth = None, timeout: int = 300, max_tries: int = 3, ssh_interface: str = 'public_ips', at_exit_func: Callable = None, wait_period: int = 5, **create_node_kwargs) Node ¶
Create a new node, and start deployment.
In order to be able to SSH into a created node access credentials are required.
A user can pass either a
NodeAuthPassword
orNodeAuthSSHKey
to theauth
argument. If thecreate_node
implementation supports that kind if credential (as declared inself.features['create_node']
) then it is passed on tocreate_node
. Otherwise it is not passed on tocreate_node
and it is only used for authentication.If the
auth
parameter is not supplied but the driver declares it supportsgenerates_password
then the password returned bycreate_node
will be used to SSH into the server.Finally, if the
ssh_key_file
is supplied that key will be used to SSH into the server.This function may raise a
DeploymentException
, if a create_node call was successful, but there is a later error (like SSH failing or timing out). This exception includes a Node object which you may want to destroy if incomplete deployments are not desirable.>>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> from libcloud.compute.deployment import ScriptDeployment >>> from libcloud.compute.deployment import MultiStepDeployment >>> from libcloud.compute.base import NodeAuthSSHKey >>> driver = DummyNodeDriver(0) >>> key = NodeAuthSSHKey('...') # read from file >>> script = ScriptDeployment("yum -y install emacs strace tcpdump") >>> msd = MultiStepDeployment([key, script]) >>> def d(): ... try: ... driver.deploy_node(deploy=msd) ... except NotImplementedError: ... print ("not implemented for dummy driver") >>> d() not implemented for dummy driver
Deploy node is typically not overridden in subclasses. The existing implementation should be able to handle most such.
- Parameters:
deploy (
Deployment
) – Deployment to run once machine is online and available to SSH.ssh_username (
str
) – Optional name of the account which is used when connecting to SSH server (default is root)ssh_alternate_usernames (
list
) – Optional list of ssh usernames to try to connect with if using the default one failsssh_port (
int
) – Optional SSH server port (default is 22)ssh_timeout (
float
) – Optional SSH connection timeout in seconds (default is 10)auth (
NodeAuthSSHKey
orNodeAuthPassword
) – Initial authentication information for the node (optional)ssh_key (
str
orlist
ofstr
) – A path (or paths) to an SSH private key with which to attempt to authenticate. (optional)ssh_key_password (
str
) – Optional password used for encrypted keys.timeout (
int
) – How many seconds to wait before timing out. (default is 600)max_tries (
int
) – How many times to retry if a deployment fails before giving up (default is 3)ssh_interface (
str
) – The interface to wait for. Default is ‘public_ips’, other option is ‘private_ips’.at_exit_func (
func
) –Optional atexit handler function which will be registered and called with created node if user cancels the deploy process (e.g. CTRL+C), after the node has been created, but before the deploy process has finished.
This method gets passed in two keyword arguments:
driver -> node driver in question
node -> created Node object
Keep in mind that this function will only be called in such scenario. In case the method finishes (this includes throwing an exception), at exit handler function won’t be called.
wait_period (
int
) – How many seconds to wait between each iteration while waiting for node to transition into running state and have IP assigned. (default is 5)
- destroy_node(node)¶
Destroy a node.
Depending upon the provider, this may destroy all data associated with the node, including backups.
- Parameters:
node (
Node
) – The node to be destroyed- Returns:
True if the destroy was successful, False otherwise.
- Return type:
bool
- destroy_volume(volume)¶
Destroys a storage volume.
- Parameters:
volume (
StorageVolume
) – Volume to be destroyed- Return type:
bool
- destroy_volume_snapshot(snapshot: VolumeSnapshot) bool ¶
Destroys a snapshot.
- Parameters:
snapshot (
VolumeSnapshot
) – The snapshot to delete- Return type:
- detach_volume(volume, ex_node=None)¶
Detaches a volume from a node.
- Parameters:
volume (
StorageVolume
) – Volume to be detached- Return type:
bool
- ex_confirm_resize(node)¶
Confirm a resize request which is currently in progress. If a resize request is not explicitly confirmed or reverted it’s automatically confirmed after 24 hours.
For more info refer to the API documentation: http://goo.gl/zjFI1
- Parameters:
node (
Node
) – node for which the resize request will be confirmed.- Return type:
bool
- ex_create_ip_group(group_name, node_id=None)¶
Creates a shared IP group.
- Parameters:
group_name (
str
) – group name which should be usednode_id (
str
) – ID of the node which should be used
- Return type:
bool
- ex_delete_ip_group(group_id)¶
Deletes the specified shared IP group.
- Parameters:
group_id (
str
) – group id which should be used- Return type:
bool
- ex_get_node_details(node_id)¶
Lists details of the specified server.
- Parameters:
node_id (
str
) – ID of the node which should be used- Return type:
Node
- ex_hard_reboot_node(node)¶
Hard reboots the specified server
- Parameters:
node (
Node
) – node- Return type:
bool
- ex_limits()¶
Extra call to get account’s limits, such as rates (for example amount of POST requests per day) and absolute limits like total amount of available RAM to be used by servers.
- Returns:
dict with keys ‘rate’ and ‘absolute’
- Return type:
dict
- ex_list_ip_addresses(node_id)¶
List all server addresses.
- Parameters:
node_id (
str
) – ID of the node which should be used- Return type:
OpenStack_1_0_NodeIpAddresses
- ex_list_ip_groups(details=False)¶
Lists IDs and names for shared IP groups. If details lists all details for shared IP groups.
- Parameters:
details (
bool
) – True if details is required- Return type:
list
ofOpenStack_1_0_SharedIpGroup
- ex_rebuild(node_id, image_id)¶
Rebuilds the specified server.
- Parameters:
node_id (
str
) – ID of the node which should be usedimage_id (
str
) – ID of the image which should be used
- Return type:
bool
- ex_resize(node, size)¶
NOTE: This method is here for backward compatibility reasons.
You should use
ex_resize_node
instead.
- ex_resize_node(node, size)¶
Change an existing server flavor / scale the server up or down.
- Parameters:
node (
Node
) – node to resize.size (
NodeSize
) – new size.
- Return type:
bool
- ex_revert_resize(node)¶
Revert a resize request which is currently in progress. All resizes are automatically confirmed after 24 hours if they have not already been confirmed explicitly or reverted.
For more info refer to the API documentation: http://goo.gl/AizBu
- Parameters:
node (
Node
) – node for which the resize request will be reverted.- Return type:
bool
- ex_set_password(node, password)¶
Sets the Node’s root password.
This will reboot the instance to complete the operation.
Node.extra['password']
will be set to the new value if the operation was successful.- Parameters:
node (
Node
) – node to set passwordpassword (
str
) – new password.
- Return type:
bool
- ex_set_server_name(node, name)¶
Sets the Node’s name.
This will reboot the instance to complete the operation.
- Parameters:
node (
Node
) – node to set namename (
str
) – new name
- Return type:
bool
Shares an IP address to the specified server.
- Parameters:
group_id (
str
) – group id which should be usednode_id (
str
) – ID of the node which should be usedip (
str
) – ip which should be usedconfigure_node (
bool
) – configure node
- Return type:
bool
- ex_soft_reboot_node(node)¶
Soft reboots the specified server
- Parameters:
node (
Node
) – node- Return type:
bool
Removes a shared IP address from the specified server.
- Parameters:
node_id (
str
) – ID of the node which should be usedip (
str
) – ip which should be used
- Return type:
bool
- features: Dict[str, List[str]] = {'create_node': ['generates_password']}¶
- List of available features for a driver.
libcloud.compute.base.NodeDriver.create_node()
ssh_key: Supports
NodeAuthSSHKey
as an authentication method for nodes.password: Supports
NodeAuthPassword
as an authentication method for nodes.generates_password: Returns a password attribute on the Node object returned from creation.
- get_image(image_id)¶
Get an image based on an image_id
@inherits:
NodeDriver.get_image
- Parameters:
image_id (
str
) – Image identifier- Returns:
A NodeImage object
- Return type:
NodeImage
- get_key_pair(name: str) KeyPair ¶
Retrieve a single key pair.
- Parameters:
name (
str
) – Name of the key pair to retrieve.- Return type:
- import_key_pair_from_file(name: str, key_file_path: str) KeyPair ¶
Import a new public key from string.
- Parameters:
name (
str
) – Key pair name.key_file_path (
str
) – Path to the public key file.
- Return type:
KeyPair
object
- import_key_pair_from_string(name: str, key_material: str) KeyPair ¶
Import a new public key from string.
- Parameters:
name (
str
) – Key pair name.key_material (
str
) – Public key material.
- Return type:
KeyPair
object
- list_images(location=None, ex_only_active=True)¶
Lists all active images
@inherits:
NodeDriver.list_images
- Parameters:
ex_only_active (
bool
) – True if list only active (optional)
- list_key_pairs() List[KeyPair] ¶
List all the available key pair objects.
- Return type:
list
ofKeyPair
objects
- list_locations()[source]¶
Lists available locations
Locations cannot be set or retrieved via the API, but currently there are two locations, DFW and ORD.
@inherits:
OpenStack_1_0_NodeDriver.list_locations
- list_nodes(ex_all_tenants=False)¶
List the nodes in a tenant
- Parameters:
ex_all_tenants (
bool
) – List nodes for all the tenants. Note: Your user must have admin privileges for this functionality to work.
- list_sizes(location=None)¶
List sizes on a provider
- Parameters:
location (
NodeLocation
) – The location at which to list sizes- Returns:
list of node size objects
- Return type:
list
ofNodeSize
- list_volume_snapshots(volume: StorageVolume) List[VolumeSnapshot] ¶
List snapshots for a storage volume.
- Return type:
list
ofVolumeSnapshot
- list_volumes()¶
List storage volumes.
- Return type:
list
ofStorageVolume
- openstack_connection_kwargs()¶
Returns certain
ex_*
parameters for this connection.- Return type:
dict
- reboot_node(node)¶
Reboot a node.
- Parameters:
node (
Node
) – The node to be rebooted- Returns:
True if the reboot was successful, otherwise False
- Return type:
bool
- start_node(node)¶
Start a node.
- Parameters:
node (
Node
) – The node to be started- Returns:
True if the start was successful, otherwise False
- Return type:
bool
- stop_node(node)¶
Stop a node
- Parameters:
node (
Node
) – The node to be stopped.- Returns:
True if the stop was successful, otherwise False
- Return type:
bool
- wait_until_running(nodes: List[Node], wait_period: float = 5, timeout: int = 600, ssh_interface: str = 'public_ips', force_ipv4: bool = True, ex_list_nodes_kwargs: Optional[Dict] = None) List[Tuple[Node, List[str]]] ¶
Block until the provided nodes are considered running.
Node is considered running when it’s state is “running” and when it has at least one IP address assigned.
- Parameters:
nodes (
list
ofNode
) – List of nodes to wait for.wait_period (
int
) – How many seconds to wait between each loop iteration. (default is 3)timeout (
int
) – How many seconds to wait before giving up. (default is 600)ssh_interface (
str
) – Which attribute on the node to use to obtain an IP address. Valid options: public_ips, private_ips. Default is public_ips.force_ipv4 (
bool
) – Ignore IPv6 addresses (default is True).ex_list_nodes_kwargs (
dict
) – Optional driver-specific keyword arguments which are passed to thelist_nodes
method.
- Returns:
[(Node, ip_addresses)]
list of tuple of Node instance and list of ip_address on success.- Return type:
list
oftuple