stephrobert.scaleway.lb_route_info module – Gather information about Scaleway Load Balancer routes

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

New in stephrobert.scaleway 0.1.0

Synopsis

• Retrieve information about an existing route, specified by its route ID. Its full details, origin frontend, target backend and match condition, are returned in the response object.

• List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).

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.
frontend_id string	Frontend ID to filter for, only Routes from this Frontend will be returned.
order_by string	Sort order of routes 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.
route_id string	Route ID.
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.
#
# `route_id` decides which of the two reads runs: given, the
# module returns that one resource; omitted, it lists them all,
# walking every page rather than returning the first one in silence.

- name: Get a route
  stephrobert.scaleway.lb_route_info:
    zone: fr-par-1
    route_id: 11111111-2222-3333-4444-555555555555
  register: result
- name: List all routes
  stephrobert.scaleway.lb_route_info:
    zone: fr-par-1
  register: result
- name: Filter Scaleway Load Balancer routes by frontend_id
  stephrobert.scaleway.lb_route_info:
    zone: fr-par-1
    frontend_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
result dictionary added in stephrobert.scaleway 0.4.0	Retrieve information about an existing route, specified by its route ID. Its full details, origin frontend, target backend and match condition, are returned in the response object. The API contract names no payload field for this operation: the response body is returned as is. Returned: when route_id is provided
backend_id string	ID of the target backend. Returned: when the API returns it
created_at string	Date on which the route was created. (RFC 3339 format) Returned: when the API returns it
frontend_id string	ID of the source frontend. Returned: when the API returns it
id string	Route ID. Returned: when the API returns it
match dictionary	Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. Returned: when the API returns it
updated_at string	Date on which the route was last updated. (RFC 3339 format) Returned: when the API returns it
routes list / elements=dictionary	List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header). Returned: when route_id is omitted
backend_id string	ID of the target backend. Returned: when the API returns it
created_at string	Date on which the route was created. (RFC 3339 format) Returned: when the API returns it
frontend_id string	ID of the source frontend. Returned: when the API returns it
id string	Route ID. Returned: when the API returns it
match dictionary	Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. Returned: when the API returns it
updated_at string	Date on which the route was last updated. (RFC 3339 format) Returned: when the API returns it

Authors

• Stéphane Robert (@stephrobert)

Collection links

• Issue Tracker
• Repository (Sources)