community.general.scaleway_lb module – Scaleway load-balancer management module
Note
This module is part of the community.general collection (version 9.5.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 |
---|---|
HTTP timeout to Scaleway API in seconds. Default: |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: |
|
Description of the load-balancer. |
|
Name of the load-balancer. |
|
Organization identifier. |
|
List of parameters passed to the query string. Default: |
|
Scaleway zone. Choices:
|
|
Indicate desired state of the instance. Choices:
|
|
List of tags to apply to the load-balancer. Default: |
|
Validate SSL certs of the Scaleway API. Choices:
|
|
Wait for the load-balancer to reach its desired state before returning. Choices:
|
|
Time to wait before every attempt to check the state of the load-balancer. Default: |
|
Time to wait for the load-balancer to reach the expected state. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 precedenceSCW_TOKEN
,SCW_API_KEY
,SCW_OAUTH_TOKEN
orSCW_API_TOKEN
.If one wants to use a different
api_url
one can also set theSCW_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