W3cubDocs

/Ansible 2.11

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

Note

This plugin is part of the community.general collection (version 2.0.1).

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 Choices/Defaults Comments
api_timeout
integer
Default:
30
HTTP timeout to Scaleway API in seconds.

aliases: timeout
api_token
string / required
Scaleway OAuth token.

aliases: oauth_token
api_url
string
Default:
"https://api.scaleway.com"
Scaleway API URL.

aliases: base_url
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
Default:
{}
List of parameters passed to the query string.
region
string / required
    Choices:
  • nl-ams
  • fr-par
  • pl-waw
Scaleway zone
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the instance.
tags
list / elements=string
List of tags to apply to the load-balancer
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Scaleway API.
wait
boolean
    Choices:
  • no ←
  • yes
Wait for the load-balancer to reach its desired state before returning.
wait_sleep_time
integer
Default:
3
Time to wait before every attempt to check the state of the load-balancer
wait_timeout
integer
Default:
300
Time to wait for the load-balancer to reach the expected state

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 (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_lb_module.html