community.general.scaleway_lb module – Scaleway load-balancer management module

Note

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

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.scaleway_lb.

Synopsis

  • This module manages load-balancers on Scaleway.

Parameters

Parameter

Comments

api_timeout

aliases: timeout

integer

HTTP timeout to Scaleway API in seconds.

Default: 30

api_token

aliases: oauth_token

string / required

Scaleway OAuth token.

api_url

aliases: base_url

string

Scaleway API URL.

Default: “https://api.scaleway.com”

description

string / required

Description of the load-balancer

name

string / required

Name of the load-balancer

organization_id

string / required

Organization identifier

query_parameters

dictionary

List of parameters passed to the query string.

Default: {}

region

string / required

Scaleway zone

Choices:

  • nl-ams

  • fr-par

  • pl-waw

state

string

Indicate desired state of the instance.

Choices:

  • present ← (default)

  • absent

tags

list / elements=string

List of tags to apply to the load-balancer

validate_certs

boolean

Validate SSL certs of the Scaleway API.

Choices:

  • no

  • yes ← (default)

wait

boolean

Wait for the load-balancer to reach its desired state before returning.

Choices:

  • no ← (default)

  • yes

wait_sleep_time

integer

Time to wait before every attempt to check the state of the load-balancer

Default: 3

wait_timeout

integer

Time to wait for the load-balancer to reach the expected state

Default: 300

Notes

Note

  • Also see the API documentation on https://developer.scaleway.com/

  • If api_token is not set within the module, the following environment variables can be used in decreasing order of precedence SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN or SCW_API_TOKEN.

  • If one wants to use a different api_url one can also set the SCW_API_URL environment variable.

Examples

- name: Create a load-balancer
  community.general.scaleway_lb:
    name: foobar
    state: present
    organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42
    region: fr-par
    tags:
      - hello

- name: Delete a load-balancer
  community.general.scaleway_lb:
    name: foobar
    state: absent
    organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42
    region: fr-par

Authors

  • Remy Leone (@remyleone)