community.general.scaleway_volume_info 模块 – 收集可用 Scaleway 卷的信息

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定： community.general.scaleway_volume_info。

概要

  • 收集可用 Scaleway 卷的信息。

参数

参数

注释

api_timeout

别名：timeout

整数

以秒为单位的 Scaleway API HTTP 超时时间。

默认值： 30

api_token

别名：oauth_token

字符串 / 必需

Scaleway OAuth 令牌。

api_url

别名：base_url

字符串

Scaleway API URL。

默认值： "https://api.scaleway.com"

query_parameters

字典

传递到查询字符串的参数列表。

默认值： {}

region

字符串 / 必需

要使用的 Scaleway 区域（例如 par1）。

选项

  • "ams1"

  • "EMEA-NL-EVS"

  • "par1"

  • "EMEA-FR-PAR1"

  • "par2"

  • "EMEA-FR-PAR2"

  • "waw1"

  • "EMEA-PL-WAW1"

validate_certs

布尔值

验证 Scaleway API 的 SSL 证书。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

此操作不会修改状态。

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持： N/A

此操作不会修改状态。

处于 diff 模式时，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

备注

注意

示例

- name: Gather Scaleway volumes information
  community.general.scaleway_volume_info:
    region: par1
  register: result

- ansible.builtin.debug:
    msg: "{{ result.scaleway_volume_info }}"

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段

键

描述

scaleway_volume_info

列表 / 元素=字典

来自 Scaleway API 的响应。

更多详情请参考：https://developers.scaleway.com/en/products/instance/api/。

返回：成功

示例： {"scaleway_volume_info": [{"creation_date": "2018-08-14T20:56:24.949660+00:00", "export_uri": null, "id": "b8d51a06-daeb-4fef-9539-a8aea016c1ba", "modification_date": "2018-08-14T20:56:24.949660+00:00", "name": "test-volume", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "server": null, "size": 50000000000, "state": "available", "volume_type": "l_ssd"}]}

作者

  • Yanis Guenane (@Spredzy)

  • Remy Leone (@remyleone)