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

Note

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

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.

Default: []

validate_certs

boolean

Validate SSL certs of the Scaleway API.

Choices:

  • false

  • true ← (default)

wait

boolean

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

Choices:

  • false ← (default)

  • true

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

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

scaleway_lb

dictionary

The load-balancer object.

Returned: success

Sample: {"backend_count": 0, "description": "Description of my load-balancer", "frontend_count": 0, "id": "00000000-0000-0000-0000-000000000000", "instances": [{"id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.1", "region": "fr-par", "status": "ready"}, {"id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.2", "region": "fr-par", "status": "ready"}], "ip": [{"id": "00000000-0000-0000-0000-000000000000", "ip_address": "192.168.0.1", "lb_id": "00000000-0000-0000-0000-000000000000", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "reverse": ""}], "name": "lb_ansible_test", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "status": "ready", "tags": ["first_tag", "second_tag"]}

Authors

  • Remy Leone (@remyleone)