stephrobert.scaleway.instance_image_info module – Gather information about Scaleway Instance images

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

New in stephrobert.scaleway 0.1.0

Synopsis

  • Get details of an image with the specified ID.

  • List all existing Instance images.

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.

arch

string

Filter images by CPU architecture.

config_file

path

Path to the Scaleway configuration file.

image_id

string

UUID of the image you want to get.

name

string

Filter images by name.

organization

string

List only images of this Organization ID.

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

string

List only images of this Project ID.

project_id

string

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

public

boolean

Filter images on their public flag.

Choices:

  • false

  • true

secret_key

string

Scaleway API secret key.

tags

string

List images with these exact tags.

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"

  • "fr-par-3"

  • "nl-ams-1"

  • "nl-ams-2"

  • "nl-ams-3"

  • "pl-waw-1"

  • "pl-waw-2"

  • "pl-waw-3"

  • "it-mil-1"

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.
#
# `image_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 an Instance image
  stephrobert.scaleway.instance_image_info:
    zone: fr-par-1
    image_id: 11111111-2222-3333-4444-555555555555
  register: result
- name: List Instance images
  stephrobert.scaleway.instance_image_info:
    zone: fr-par-1
  register: result
- name: Filter Scaleway Instance images by tags
  stephrobert.scaleway.instance_image_info:
    zone: fr-par-1
    tags:
    - production
  register: result

Return Values

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

Key

Description

image

dictionary

Get details of an image with the specified ID.

Returned: when image_id is provided

arch

string

CPU architecture of the image.

Returned: when the API returns it

creation_date

string

(RFC 3339 format)

Returned: when the API returns it

default_bootscript

dictionary

Default bootscript of the image.

Deprecated by the Scaleway API contract.

Returned: when the API returns it

extra_volumes

dictionary

Extra volumes of the image.

Returned: when the API returns it

from_server

string

Server the image comes from.

Returned: when the API returns it

id

string

Unique ID of the image.

Returned: when the API returns it

modification_date

string

(RFC 3339 format)

Returned: when the API returns it

name

string

Name of the image.

Returned: when the API returns it

organization

string

Organization ID of the image.

Returned: when the API returns it

project

string

Project ID of the image.

Returned: when the API returns it

public

boolean

Whether the image is public.

Returned: when the API returns it

root_volume

dictionary

UUID of the snapshot.

Returned: when the API returns it

state

string

State of the image.

Returned: when the API returns it

tags

list / elements=string

Tags of the image.

Returned: when the API returns it

zone

string

The zone you want to target

Returned: when the API returns it

images

list / elements=dictionary

List all existing Instance images.

Returned: when image_id is omitted

arch

string

CPU architecture of the image.

Returned: when the API returns it

creation_date

string

(RFC 3339 format)

Returned: when the API returns it

default_bootscript

dictionary

Default bootscript of the image.

Deprecated by the Scaleway API contract.

Returned: when the API returns it

extra_volumes

dictionary

Extra volumes of the image.

Returned: when the API returns it

from_server

string

Server the image comes from.

Returned: when the API returns it

id

string

Unique ID of the image.

Returned: when the API returns it

modification_date

string

(RFC 3339 format)

Returned: when the API returns it

name

string

Name of the image.

Returned: when the API returns it

organization

string

Organization ID of the image.

Returned: when the API returns it

project

string

Project ID of the image.

Returned: when the API returns it

public

boolean

Whether the image is public.

Returned: when the API returns it

root_volume

dictionary

UUID of the snapshot.

Returned: when the API returns it

state

string

State of the image.

Returned: when the API returns it

tags

list / elements=string

Tags of the image.

Returned: when the API returns it

zone

string

The zone you want to target

Returned: when the API returns it

Authors

  • Stéphane Robert (@stephrobert)