community.general.scaleway_volume 模块 – Scaleway 卷管理模块

注意

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

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

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

要在剧本中使用它，请指定： community.general.scaleway_volume。

概要 

此模块管理 Scaleway 帐户上的卷 https://developer.scaleway.com.

参数 

参数	注释
api_timeout 别名：timeout 整数	以秒为单位的 Scaleway API HTTP 超时时间。默认值： `30`
api_token 别名：oauth_token 字符串 / 必需	Scaleway OAuth 令牌。
api_url 别名：base_url 字符串	Scaleway API URL。默认值： `"https://api.scaleway.com"`
name 字符串 / 必需	用于标识卷的名称。
organization 字符串	卷所属的 ScaleWay 组织 ID。
project 字符串在 community.general 4.3.0 中添加	卷所属的 Scaleway 项目 ID。
query_parameters 字典	传递给查询字符串的参数列表。默认值： `{}`
region 字符串 / 必需	要使用的 Scaleway 地区（例如 par1）。选项 `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
size 整数	卷的大小（以字节为单位）。
state 字符串	指示所需的卷状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	验证 Scaleway API 的 SSL 证书。选项 `false` `true` ← (默认)
volume_type 字符串	卷的类型（例如“l_ssd”）。

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	处于 diff 模式时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

备注 

注意

另请参见 https://developer.scaleway.com/ 上的 API 文档。
如果模块中未设置 api_token，则可以使用以下环境变量，其优先级依次递减 SCW_TOKEN，SCW_API_KEY，SCW_OAUTH_TOKEN 或 SCW_API_TOKEN。
如果要使用不同的 api_url，还可以设置 SCW_API_URL 环境变量。

示例 

- name: Create 10GB volume
  community.general.scaleway_volume:
    name: my-volume
    state: present
    region: par1
    project: "{{ scw_org }}"
    "size": 10000000000
    volume_type: l_ssd
  register: server_creation_check_task

- name: Make sure volume deleted
  community.general.scaleway_volume:
    name: my-volume
    state: absent
    region: par1

返回值 

公共返回值已在此处记录此处，以下是此模块特有的字段

键	描述
data 字典	这仅在 `state=present` 时出现。返回值：当 `state=present` 示例： `{"volume": {"export_uri": null, "id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd", "name": "volume-0-3", "project": "000a115d-2852-4b0a-9ce8-47f1134ba95a", "server": null, "size": 10000000000, "volume_type": "l_ssd"}}`

作者

Henryk Konsek (@hekonsek)