Модуль community.general.scaleway_volume — модуль управления томами Scaleway

Примечание

Этот модуль является частью коллекции community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.general.scaleway_volume.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль управляет томами в учётной записи Scaleway https://developer.scaleway.com.

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

PyYAML (если используется profile)

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout integer	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token string	Токен OAuth Scaleway. Это значение обязательно, если не указан `profile`.
api_url псевдонимы: base_url string	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
name string / обязательный	Имя, используемое для идентификации тома.
organization string	Идентификатор организации ScaleWay, которой принадлежит том.
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого следует загрузить токен OAuth Scaleway; используйте вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
project string добавлено в community.general 4.3.0	Идентификатор проекта Scaleway, которому принадлежит том.
query_parameters dictionary	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
region string / обязательный	Используемый регион Scaleway (например, par1). Допустимые значения: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
size integer	Размер тома в байтах.
state string	Желаемое состояние тома. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять SSL-сертификаты API Scaleway. Допустимые значения: `false` `true` ← (по умолчанию)
volume_type string	Тип тома (например, ‘l_ssd’).

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без внесения изменений на целевом узле.
diff_mode	Поддержка: отсутствует	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

См. также документацию API: https://developer.scaleway.com/.
Если 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 dictionary	Присутствует только при выполнении `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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_volume_module.html