You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.ovh_ip_loadbalancing_backend module – Manage OVH IP LoadBalancing backends

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.ovh_ip_loadbalancing_backend.

Synopsis

• Manage OVH (French European hosting provider) LoadBalancing IP backends

Requirements

The below requirements are needed on the host that executes this module.

• ovh > 0.3.5

Parameters

Parameter	Comments
application_key string / required	The applicationKey to use
application_secret string / required	The application secret to use
backend string / required	The IP address of the backend to update / modify / delete
consumer_key string / required	The consumer key to use
endpoint string / required	The endpoint to use ( for instance ovh-eu)
name string / required	Name of the LoadBalancing internal name (ip-X.X.X.X)
probe string	Determines the type of probe to use for this backend Choices: none ← (default) http icmp oco
state string	Determines whether the backend is to be created/modified or deleted Choices: present ← (default) absent
timeout integer	The timeout in seconds used to wait for a task to be completed. Default: 120
weight integer	Determines the weight for this backend Default: 8

Notes

Note

• Uses the python OVH Api https://github.com/ovh/python-ovh. You have to create an application (a key and secret) with a consumer key as described into https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/

Examples

- name: Adds or modify the backend '212.1.1.1' to a loadbalancing 'ip-1.1.1.1'
  ovh_ip_loadbalancing:
    name: ip-1.1.1.1
    backend: 212.1.1.1
    state: present
    probe: none
    weight: 8
    endpoint: ovh-eu
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey

- name: Removes a backend '212.1.1.1' from a loadbalancing 'ip-1.1.1.1'
  ovh_ip_loadbalancing:
    name: ip-1.1.1.1
    backend: 212.1.1.1
    state: absent
    endpoint: ovh-eu
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey

Authors

• Pascal Heraud (@pascalheraud)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication