infra-ovh-ansible-module

KO | EN

gitlite — search

#python #react #ai #go #machine-learning #rust #deep-learning #macos #java #awesome #cli #security #mcp #openai

infra-ovh-ansible-module

(★ 103)

An Ansible module that communicates with OVH API.

infra-ovh-ansible-module Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# An Ansible collection to talk with OVH API

## Requirements

Tested with:

- Python 3.9
- [Python-ovh 1.0](https://github.com/ovh/python-ovh)
- Ansible 2.12+
- flake8

## Collection

This module can be [installed as a collection](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-a-collection-from-a-git-repository)

```shell
ansible-galaxy collection install git+https://github.com/synthesio/infra-ovh-ansible-module
```

This collection provides the following modules:

```text
dedicated_nasha_manage_partition
dedicated_server_boot
dedicated_server_boot_wait
dedicated_server_compatible_templates
dedicated_server_display_name
dedicated_server_engagement_strategy
dedicated_server_hardware_info
dedicated_server_info
dedicated_server_installation
dedicated_server_install_wait
dedicated_server_intervention
dedicated_server_ip_info
dedicated_server_monitoring
dedicated_server_network_info
dedicated_server_networkinterfacecontroller
dedicated_server_rescuesshkey
dedicated_server_terminate
dedicated_server_vrack
domain
installation_template
ip_firewall
ip_firewall_rule
ip_info
ip_move
ip_reverse
me_sshkey
public_cloud_block_storage
public_cloud_block_storage_instance
public_cloud_flavorid_info
public_cloud_imageid_info
public_cloud_instance
public_cloud_instance_delete
public_cloud_instance_flavor_change
public_cloud_instance_id
public_cloud_instance_info
public_cloud_instance_interface
public_cloud_instance_shelving
public_cloud_monthly_billing
public_cloud_object_storage
public_cloud_object_storage_policy
public_cloud_private_network_info
public_cloud_sshkey
public_cloud_user_info
public_cloud_user_s3credentials_info
public_cloud_user_s3credentials
public_cloud_user
public_cloud_users_info
vps_display_name
vps_info
```

You can read the documentation of every modules with `ansible-doc synthesio.ovh.$modules`

An example for a custom template to install a dedicated server is present in `roles/ovhtemplate` folder

## Configuration

The collection path must be defined in your `ansible.cfg` :

```ini
[defaults]
collections_paths = collections/
```

In `/etc/ovh.conf`:

```ini
[default]
; general configuration: default endpoint
endpoint=ovh-eu

[ovh-eu]
; configuration specific to 'ovh-eu' endpoint
application_key=<YOUR APPLICATION KEY>
application_secret=<YOUR APPLICATIOM SECRET>
consumer_key=<YOUR CONSUMER KEY>
```

Alternatively, you can provide credentials as module attributes:

```yaml
- name: Add server to vrack
  synthesio.ovh.dedicated_server_vrack:
    endpoint: "ovh-eu"
    application_key: "<YOUR APPLICATION KEY>"
    application_secret: "<YOUR APPLICATIOM SECRET>"
    consumer_key: "<YOUR CONSUMER KEY>"
    vrack: "{{ vrackid }}"
    service_name: "{{ ovhname }}"
```

This allows you to store them in Ansible vault or to use any lookup plugin to retrieve them.

[Module defaults groups](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_module_defaults.html#module-defaults-groups) are supported as well:
```yaml
- hosts: all
  gather_facts: no
  module_defaults:
    group/synthesio.ovh.all:
      application_key: "<YOUR APPLICATION KEY>"
      application_secret: "<YOUR APPLICATIOM SECRET>"
      consumer_key: "<YOUR CONSUMER KEY>"
```

## Usage

Here are a few examples of what you can do. Please read the module for everything else, it most probably does it!

As this is a collection now you must declare it in each task.

A few examples:

### Add a host into the vrack

```yaml
- name: Add server to vrack
  synthesio.ovh.dedicated_server_vrack:
    service_name: "{{ ovhname }}"
    vrack: "{{ vrackid }}"
```

### Move IP to a given host

```yaml
- name: Move IP to a given host
  synthesio.ovh.ip_move:
    service_name: "{{ ovhname }}"
    ip: "{{ ip }}"
```

### Add a DNS entry for `internal.bar.example.com`

```yaml
- name: Add server IP to DNS
  synthesio.ovh.domain:
    domain: "example.com"
    value: "192.0.2.1"
    record_type: "A"
    name: "internal.bar"
    record_ttl: 10
    append: true

```

### Install a new dedicated server

```yaml
- name: Install new dedicated server
  synthesio.ovh.dedicated_server_installation:
    service_name: "ns12345.ip-1-2-3.eu"
    operating_system: "debian12_64"
    customizations:
      hostname: "server01.example.net"

- name: Wait for the server installation
  synthesio.ovh.dedicated_server_install_wait:
    service_name: "ns12345.ip-1-2-3.eu"
    max_retry: "240"
    sleep: "10"
```

### Install a new dedicated server with only 2 disks

```yaml
- name: Install new dedicated server
  synthesio.ovh.dedicated_server_install:
    service_name: "ns12345.ip-1-2-3.eu"
    hostname: "server01.example.net"
    template: "debian10_64"
    soft_raid_devices: "2"

```

### Install a public cloud instance

```yaml
- name: run a public cloud installation
  synthesio.ovh.public_cloud_instance:
    name: "{{ inventory_hostname }}"
    ssh_key_id: "{{ ssh_key_id }}"
    service_name: "{{ service_name }}"
    networks: "{{ networks }}"
    flavor_id: "{{ flavor_id }}"
    region: "{{ region }}"
    image_id: "{{ image_id }}"
```

infra-ovh-ansible-module

infra-ovh-ansible-module Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

infra-ovh-ansible-module

infra-ovh-ansible-module Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README