community.general.ovh_ip_failover (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

• ovh >= 0.4.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Route an IP address 1.1.1.1 to the service ns666.ovh.net
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- community.general.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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- community.general.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

Inputs

    
name:
    description:
    - The IP address to manage (can be a single IP like 1.1.1.1 or a block like 1.1.1.1/28
      )
    required: true
    type: str

service:
    description:
    - The name of the OVH service this IP address should be routed
    required: true
    type: str

timeout:
    default: 120
    description:
    - The timeout in seconds used to wait for a task to be completed. Default is 120 seconds.
    required: false
    type: int

endpoint:
    description:
    - The endpoint to use ( for instance ovh-eu)
    required: true
    type: str

consumer_key:
    description:
    - The consumer key to use
    required: true
    type: str

application_key:
    description:
    - The applicationKey to use
    required: true
    type: str

wait_completion:
    default: true
    description:
    - 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
    required: false
    type: bool

application_secret:
    description:
    - The application secret to use
    required: true
    type: str

wait_task_completion:
    default: 0
    description:
    - 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)
    required: false
    type: int