community.general.scaleway_container_info module – Retrieve information on Scaleway Container
Note
This module is part of the community.general collection (version 8.6.4).
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_container_info
.
New in community.general 6.0.0
Synopsis
This module return information about a container on Scaleway account.
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Scaleway API in seconds. Default: |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: |
|
Name of the container. |
|
Container namespace identifier. |
|
List of parameters passed to the query string. Default: |
|
Scaleway region to use (for example Choices:
|
|
Validate SSL certs of the Scaleway API. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
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: Get a container info
community.general.scaleway_container_info:
namespace_id: '{{ scw_container_namespace }}'
region: fr-par
name: my-awesome-container
register: container_info_task
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The container information. Returned: always Sample: |