ovh_ip_failover – Manage OVH IP failover address¶
New in version 2.8.
Synopsis¶
Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an ip failover (or failover block) between services
Requirements¶
The below requirements are needed on the host that executes this module.
ovh >= 0.4.8
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
application_key
-
/ required
|
The applicationKey to use
|
|
|
application_secret
-
/ required
|
The application secret to use
|
|
|
consumer_key
-
/ required
|
The consumer key to use
|
|
|
endpoint
-
/ required
|
The endpoint to use ( for instance ovh-eu)
|
|
|
name
-
/ required
|
The IP address to manage (can be a single IP like 1.1.1.1 or a block like 1.1.1.1/28 )
|
|
|
service
-
/ required
|
The name of the OVH service this IP address should be routed
|
|
|
timeout
-
|
Default: 120
|
The timeout in seconds used to wait for a task to be completed. Default is 120 seconds.
|
|
wait_completion
boolean
|
|
If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned in module output
|
|
wait_task_completion
-
|
Default: 0
|
If not 0, the module will wait for this task id to be completed. Use wait_task_completion if you want to wait for completion of a previously executed task with wait_completion=false. You can execute this module repeatedly on a list of failover IPs using wait_completion=false (see examples)
|
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
Examples¶
# Route an IP address 1.1.1.1 to the service ns666.ovh.net
- ovh_ip_failover:
name: 1.1.1.1
service: ns666.ovh.net
endpoint: ovh-eu
application_key: yourkey
application_secret: yoursecret
consumer_key: yourconsumerkey
- ovh_ip_failover:
name: 1.1.1.1
service: ns666.ovh.net
endpoint: ovh-eu
wait_completion: false
application_key: yourkey
application_secret: yoursecret
consumer_key: yourconsumerkey
register: moved
- ovh_ip_failover:
name: 1.1.1.1
service: ns666.ovh.net
endpoint: ovh-eu
wait_task_completion: "{{moved.taskId}}"
application_key: yourkey
application_secret: yoursecret
consumer_key: yourconsumerkey
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]