stephrobert.scaleway.lb_load_balancer module – Manage a Scaleway Load Balancer

Note

This module is part of the stephrobert.scaleway collection (version 0.7.0).

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 stephrobert.scaleway. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: stephrobert.scaleway.lb_load_balancer.

New in stephrobert.scaleway 0.1.0

Synopsis

  • Update the parameters of an existing Load Balancer, specified by its Load Balancer ID.

  • The module reads the resource first and writes the whole body, because this operation replaces the resource: fields you do not set keep the value the API returns. A second run reports no change.

Requirements

The below requirements are needed on the host that executes this module.

  • scaleway >= 2.9.0

Parameters

Parameter

Comments

access_key

string

Scaleway API access key.

api_allow_insecure

boolean

Allow the API endpoint to be reached without verifying its TLS certificate.

Falls back to the Scaleway configuration file, then to false.

Choices:

  • false

  • true

api_timeout

integer

Seconds allowed for a single API call, connection and read.

Without a limit a silent connection would hang the module forever: the Scaleway SDK issues its requests with no timeout at all.

This bounds a single call, not a whole wait. Modules that can wait for a state bound the overall wait separately.

Default: 60

api_url

string

URL of the Scaleway API endpoint.

Point it at a local emulator to exercise a playbook without credentials.

Falls back to the Scaleway configuration file, then to https://api.scaleway.com. It carries no module default on purpose: a default is never unset, so it would always override the profile.

config_file

path

Path to the Scaleway configuration file.

description

string / required

Load Balancer description.

lb_id

string / required

Load Balancer ID.

name

string / required

Load Balancer name.

organization_id

string

Default Organization ID used when an operation does not name one.

profile

string

Name of the profile to read in the Scaleway configuration file.

project_id

string

Default Project ID used when an operation does not name one.

secret_key

string

Scaleway API secret key.

ssl_compatibility_level

string

Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems (>= TLS1.2). Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility (= TLS1.3). Old is compatible with a small number of very old clients and should be used only as a last resort (>= TLS1.0).

Choices:

  • "ssl_compatibility_level_unknown"

  • "ssl_compatibility_level_intermediate"

  • "ssl_compatibility_level_modern"

  • "ssl_compatibility_level_old"

tags

list / elements=string

List of tags for the Load Balancer.

user_agent

string

Value of the User-Agent header sent to the API.

zone

string / required

The zone you want to target

Choices:

  • "fr-par-1"

  • "fr-par-2"

  • "nl-ams-1"

  • "nl-ams-2"

  • "nl-ams-3"

  • "pl-waw-1"

  • "pl-waw-2"

  • "pl-waw-3"

Attributes

Attribute

Support

Description

check_mode

Support: full

In check mode the module reads the resource and compares it, then reports what it would write without writing it.

diff_mode

Support: full

The module reports the fields that differ, read through the same projection the comparison uses.

Notes

Note

  • Every option can be set from its environment variable, respectively SCW_PROFILE, SCW_CONFIG_PATH, SCW_ACCESS_KEY, SCW_SECRET_KEY, SCW_API_URL, SCW_DEFAULT_ORGANIZATION_ID and SCW_DEFAULT_PROJECT_ID.

  • Module options take precedence over environment variables, which take precedence over the configuration file.

Examples

# The module reads the resource, compares, and writes only what
# differs: run it twice and the second run reports no change.
#
# Check mode compares without writing, and `--diff` shows what would
# change. A parameter you do not pass is a parameter the module does
# not touch.

- name: Update a Scaleway Load Balancer
  stephrobert.scaleway.lb_load_balancer:
    zone: fr-par-1
    lb_id: 11111111-2222-3333-4444-555555555555
    description: Managed by Ansible
    name: my-load-balancer
  register: result
- name: Preview the change on a Scaleway Load Balancer without writing
  stephrobert.scaleway.lb_load_balancer:
    zone: fr-par-1
    lb_id: 11111111-2222-3333-4444-555555555555
    description: Managed by Ansible
    name: my-load-balancer
  register: result
  check_mode: true
  diff: true

Return Values

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

Key

Description

resource

dictionary

Retrieve information about an existing Load Balancer, specified by its Load Balancer ID. Its full details, including name, status and IP address, are returned in the response object.

Returned: success

backend_count

integer

Number of backends the Load Balancer has.

Returned: when the API returns it

created_at

string

Date on which the Load Balancer was created. (RFC 3339 format)

Returned: when the API returns it

description

string

Load Balancer description.

Returned: when the API returns it

frontend_count

integer

Number of frontends the Load Balancer has.

Returned: when the API returns it

id

string

Underlying Instance ID.

Returned: when the API returns it

instances

list / elements=dictionary

List of underlying Instances.

Returned: when the API returns it

ip

list / elements=dictionary

List of IP addresses attached to the Load Balancer.

Returned: when the API returns it

name

string

Load Balancer name.

Returned: when the API returns it

organization_id

string

Scaleway Organization ID.

Returned: when the API returns it

private_network_count

integer

Number of Private Networks attached to the Load Balancer.

Returned: when the API returns it

project_id

string

Scaleway Project ID.

Returned: when the API returns it

region

string

The region the Load Balancer is in.

Deprecated by the Scaleway API contract.

Returned: when the API returns it

route_count

integer

Number of routes configured on the Load Balancer.

Returned: when the API returns it

ssl_compatibility_level

string

Determines the minimal SSL version which needs to be supported on client side.

Returned: when the API returns it

status

string

Load Balancer status.

Returned: when the API returns it

subscriber

dictionary

Subscriber information.

Returned: when the API returns it

tags

list / elements=string

Load Balancer tags.

Returned: when the API returns it

type

string

Load Balancer offer type.

Returned: when the API returns it

updated_at

string

Date on which the Load Balancer was last updated. (RFC 3339 format)

Returned: when the API returns it

zone

string

The zone the Load Balancer is in.

Returned: when the API returns it

Authors

  • Stéphane Robert (@stephrobert)