stephrobert.scaleway.lb_load_balancer_private_network_info module – Gather information about Scaleway Load Balancer private networks

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

New in stephrobert.scaleway 0.1.0

Synopsis

  • List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network.

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.

lb_id

string / required

Load Balancer ID.

order_by

string

Sort order of Private Network objects in the response.

Choices:

  • "created_at_asc"

  • "created_at_desc"

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.

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

This module only reads, so check mode changes nothing about how it runs.

diff_mode

Support: none

This module changes nothing, so it has no difference to report.

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

# This module only reads: it never changes anything, and check mode
# is native.

- name: List Private Networks attached to a Load Balancer
  stephrobert.scaleway.lb_load_balancer_private_network_info:
    zone: fr-par-1
    lb_id: 11111111-2222-3333-4444-555555555555
  register: result

Return Values

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

Key

Description

private_network

list / elements=dictionary

List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network.

Returned: success

created_at

string

Date on which the Private Network was created. (RFC 3339 format)

Returned: when the API returns it

dhcp_config

dictionary

Object containing DHCP-assigned IP addresses.

Deprecated by the Scaleway API contract.

Returned: when the API returns it

ipam_ids

list / elements=string

IPAM IDs of the booked IP addresses. (UUID format)

Returned: when the API returns it

lb

dictionary

Load Balancer object which is attached to the Private Network.

Returned: when the API returns it

private_network_id

string

Private Network ID.

Returned: when the API returns it

static_config

dictionary

Object containing an array of a local IP address for the Load Balancer on this Private Network.

Deprecated by the Scaleway API contract.

Returned: when the API returns it

status

string

Status of Private Network connection.

Returned: when the API returns it

updated_at

string

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

Returned: when the API returns it

Authors

  • Stéphane Robert (@stephrobert)