W3cubDocs

/Ansible

ovh_ip_loadbalancing_backend - Manage OVH IP LoadBalancing backends

New in version 2.2.

Synopsis

Manage OVH (French European hosting provider) LoadBalancing IP backends

Requirements (on host that executes module)

  • ovh > 0.3.5

Options

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

Examples

# 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

# 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

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 consummer key as described into https://eu.api.ovh.com/g934.first_step_with_api

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/ovh_ip_loadbalancing_backend_module.html