OVH Compute Driver Documentation¶
OVH is an Internet Service Provider providing dedicated servers, shared and cloud hosting, domain registration, and VOIP telephony services.

OVH driver uses a REST API, for more information about that, please refer to API console.
Instantiating a driver¶
When you instantiate a driver you need to pass the following arguments to the driver constructor:
key
- Application keysecret
- Application secretex_project_id
- Project IDex_consumer_key
- Consumer key
For get application key and secret, you must register an application at https://eu.api.ovh.com/createApp/. Next step, create a consumer key with following command:
curl -X POST \
-H 'X-Ovh-Application: youApplicationKey' \
-H 'Content-Type: application/json' \
-d '{
"accessRules":
[
{"method":"GET","path":"/*"},
{"method":"POST","path":"/*"},
{"method":"DELETE","path":"/*"},
{"method":"PUT","path":"/*"}
],
"redirection":"http://ovh.com"
}' \
https://eu.api.ovh.com/1.0/auth/credential
This will answer a JSON like below with inside your Consumer Key and
validationUrl
. Follow this link for valid your key.
{
"validationUrl":"https://eu.api.ovh.com/auth/?credentialToken=fIDK6KCVHfEMuSTP3LV84D3CsHTq4T3BhOrmEEdd2hQ0CNcfVgGVWZRqIlolDJ3W",
"consumerKey":"y7epYeHCIqoO17BzBgxluvB4XLedpba9",
"state":"pendingValidation"
}
Secondly, you must create a cloud project and retrieve its ID, from URL for example.
Now you have and can use you credentials with Libcloud.
Examples¶
Create node¶
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
Ovh = get_driver(Provider.OVH)
driver = Ovh("yourAppKey", "yourAppSecret", "yourProjectId", "yourConsumerKey")
location = [loc for loc in driver.list_locations() if loc.id == "SBG1"][0]
image = [i for i in driver.list_images() if "Debian 8" == i.name][0]
size = [s for s in driver.list_sizes() if s.name == "vps-ssd-1"][0]
node = driver.create_node(name="yournode", size=size, image=image, location=location)
Create and attach a volume to a node¶
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
Ovh = get_driver(Provider.OVH)
driver = Ovh("yourAppKey", "yourAppSecret", "youProjectId", "yourConsumerKey")
location = [loc for loc in driver.list_locations() if loc.id == "SBG1"][0]
node = driver.list_nodes()[0]
volume = driver.create_volume(size=10, location=location)
driver.attach_volume(node=node, volume=volume)
API Docs¶
- class libcloud.compute.drivers.ovh.OvhNodeDriver(key, secret, ex_project_id, ex_consumer_key=None, region=None)[source]¶
Libcloud driver for the Ovh API
For more information on the Ovh API, read the official reference:
Instantiate the driver with the given API credentials.
- Parameters:
key (
str
) – Your application key (required)secret (
str
) – Your application secret (required)ex_project_id (
str
) – Your project IDex_consumer_key (
str
) – Your consumer key (required)region (
str
) – The datacenter to connect to (optional)
- Return type:
None
- attach_volume(node, volume, device=None)[source]¶
Attach a volume to a node.
- Parameters:
node (
Node
) – Node where to attach volumevolume (
StorageVolume
) – The ID of the volumedevice – Unsed parameter
- Returns:
True or False representing operation successful
- Return type:
bool
- connectionCls¶
alias of
OvhConnection
- 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: Node, name: str, description: Optional[str] = None) List[NodeImage] ¶
Creates an image from a node object.
- 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, image, size, location, ex_keyname=None)[source]¶
Create a new node
- Parameters:
name (
str
) – Name of created nodeimage (
NodeImage
) – Image used for nodesize (
NodeSize
) – Size (flavor) used for nodelocation (
NodeLocation
) – Location (region) where to create nodeex_keyname (
str
) – Name of SSH key used
- Returns:
Created node
:rtype :
Node
- create_volume(size, name, location, snapshot=None, ex_volume_type='classic', ex_description=None)[source]¶
Create a volume.
- Parameters:
size (
int
) – Size of volume to create (in GB).name (
str
) – Name of volume to createlocation (
NodeLocation
orNone
) – Location to create the volume insnapshot (
VolumeSnapshot
) – Snapshot from which to create the new volume. (optional)ex_volume_type (
str
) –'classic'
or'high-speed'
ex_description (str) – Optionnal description of volume
- Returns:
Storage Volume object
- Return type:
StorageVolume
- create_volume_snapshot(volume, name=None, ex_description=None)[source]¶
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)
- Return type:
VolumeSnapshot
- delete_image(node_image: NodeImage) bool ¶
Deletes a node image from a provider.
- Parameters:
node_image (
NodeImage
) – Node image object.- Returns:
True
if delete_image was successful,False
otherwise.- Return type:
bool
- delete_key_pair(key_pair)[source]¶
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)[source]¶
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)[source]¶
Destroys a storage volume.
- Parameters:
volume (
StorageVolume
) – Volume to be destroyed- Return type:
bool
- destroy_volume_snapshot(snapshot)[source]¶
Destroys a snapshot.
- Parameters:
snapshot (
VolumeSnapshot
) – The snapshot to delete- Return type:
- detach_volume(volume, ex_node=None)[source]¶
Detach a volume to a node.
- Parameters:
volume (
StorageVolume
) – The ID of the volumeex_node (
Node
) – Node to detach from (optionnal if volume is attached to only one node)
- Returns:
True or False representing operation successful
- Return type:
bool
- Raises:
Exception: If
ex_node
is not provided and more than one node is attached to the volume
- ex_get_node(node_id)[source]¶
Get a individual node.
- Parameters:
node_id (
str
) – Node’s ID- Returns:
Created node
:rtype :
Node
- ex_get_size(size_id)[source]¶
Get an individual size (flavor).
- Parameters:
size_id (
str
) – Size’s ID- Returns:
Size
- Return type:
NodeSize
- ex_get_volume(volume_id)[source]¶
Return a Volume object based on a volume ID.
- Parameters:
volume_id (
int
) – The ID of the volume- Returns:
A StorageVolume object for the volume
- Return type:
StorageVolume
- ex_get_volume_snapshot(snapshot_id)[source]¶
Returns a single volume snapshot.
- Parameters:
snapshot_id (
str
) – Node to run the task on.
:rtype
VolumeSnapshot
: :return: Volume snapshot.
- ex_list_snapshots(location=None)[source]¶
List all snapshots.
- Parameters:
location (
NodeLocation
orNone
) – Location used to filter- Return type:
list
ofVolumeSnapshot
- features: Dict[str, List[str]] = {'create_node': ['ssh_key']}¶
- 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)[source]¶
Returns a single node image from a provider.
- Parameters:
image_id (
str
) – Node to run the task on.
:rtype
NodeImage
: :return: NodeImage instance on success.
- get_key_pair(name, ex_location=None)[source]¶
Get an individual SSH public key by its name and location.
- Parameters:
name (
str
) – Name of the key pair to retrieve.ex_location (
NodeLocation
) – Key’s region
- Returns:
Public key
- Return type:
KeyPair
- 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, ex_location)[source]¶
Import a new public key from string.
- Parameters:
name (
str
) – Key pair name.key_material (
str
) – Public key material.ex_location (
NodeLocation
) – Location where to store the key
- Returns:
Imported key pair object.
- Return type:
KeyPair
- list_images(location=None, ex_size=None)[source]¶
List available images
- Parameters:
location (
NodeLocation
) – Location (region) used as filterex_size (
NodeImage
) – Exclude images which are uncompatible with given size
- Returns:
List of images
:rtype :
list
ofNodeImage
- list_key_pairs(ex_location=None)[source]¶
List available SSH public keys.
- Parameters:
ex_location (
NodeLocation
) – Location (region) used as filter- Returns:
Public keys
- Return type:
``list``of
KeyPair
- list_locations()[source]¶
List data centers for a provider
- Returns:
list of node location objects
- Return type:
list
ofNodeLocation
- list_nodes(location=None)[source]¶
List all nodes.
- Parameters:
location (
NodeLocation
) – Location (region) used as filter- Returns:
List of node objects
- Return type:
list
ofNode
- list_sizes(location=None)[source]¶
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)[source]¶
List snapshots for a storage volume.
- Return type:
list
ofVolumeSnapshot
- list_volumes(ex_location=None)[source]¶
Return a list of volumes.
- Parameters:
ex_location (
NodeLocation
orNone
) – Location used to filter- Returns:
A list of volume objects.
- Return type:
list
ofStorageVolume
- reboot_node(node: Node) bool ¶
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: Node) bool ¶
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: Node) bool ¶
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