stephrobert.scaleway.instance_dashboard_info module – Gather information about Scaleway Instance dashboards

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

New in stephrobert.scaleway 0.1.0

Synopsis

  • Return the Instance dashboard of one zone: the resource counts the API keeps for an Organization or a Project, such as `servers_count`, `running_servers_count`, `volumes_count`, `images_count`, `snapshots_count`, `ips_count`, `ips_unused` and `security_groups_count`.

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.

organization

string

Organization ID whose dashboard is returned.

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

Project ID whose dashboard is returned.

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"

  • "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.

- name: Read a Scaleway Instance dashboard
  stephrobert.scaleway.instance_dashboard_info:
    zone: fr-par-1
  register: result

Return Values

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

Key

Description

dashboard

dictionary

Return the Instance dashboard of one zone: the resource counts the API keeps for an Organization or a Project, such as `servers_count`, `running_servers_count`, `volumes_count`, `images_count`, `snapshots_count`, `ips_count`, `ips_unused` and `security_groups_count`.

Returned: success

images_count

integer

Count of images.

Returned: when the API returns it

ips_count

integer

Count of IPs.

Returned: when the API returns it

ips_unused

integer

Count of unused IP addresses.

Returned: when the API returns it

placement_groups_count

integer

Count of placement groups.

Returned: when the API returns it

private_nics_count

integer

Count of private NICs.

Returned: when the API returns it

running_servers_count

integer

Count of running servers.

Returned: when the API returns it

security_groups_count

integer

Count of security groups.

Returned: when the API returns it

servers_by_types

dictionary

Count of servers per type.

Returned: when the API returns it

servers_count

integer

Count of servers.

Returned: when the API returns it

snapshots_count

integer

Count of snapshots.

Returned: when the API returns it

volumes_b_ssd_count

integer

Count of volumes b ssd.

Deprecated by the Scaleway API contract.

Returned: when the API returns it

volumes_b_ssd_total_size

integer

(in bytes)

Deprecated by the Scaleway API contract.

Returned: when the API returns it

volumes_count

integer

Count of volumes.

Returned: when the API returns it

volumes_l_ssd_count

integer

Count of volumes l ssd.

Returned: when the API returns it

volumes_l_ssd_total_size

integer

(in bytes)

Returned: when the API returns it

volumes_scratch_count

integer

Count of volumes scratch.

Returned: when the API returns it

Authors

  • Stéphane Robert (@stephrobert)