community.general.ovh_ip_loadbalancing_backend module – Manage OVH IP LoadBalancing backends
Note
This module is part of the community.general collection (version 8.6.4).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.ovh_ip_loadbalancing_backend
.
Synopsis
Manage OVH (French European hosting provider) LoadBalancing IP backends
Aliases: cloud.ovh.ovh_ip_loadbalancing_backend
Requirements
The below requirements are needed on the host that executes this module.
ovh > 0.3.5
Parameters
Parameter |
Comments |
---|---|
The applicationKey to use |
|
The application secret to use |
|
The IP address of the backend to update / modify / delete |
|
The consumer key to use |
|
The endpoint to use ( for instance ovh-eu) |
|
Name of the LoadBalancing internal name (ip-X.X.X.X) |
|
Determines the type of probe to use for this backend Choices:
|
|
Determines whether the backend is to be created/modified or deleted Choices:
|
|
The timeout in seconds used to wait for a task to be completed. Default: |
|
Determines the weight for this backend Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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