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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

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

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

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

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Таймаут HTTP для API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательно	Токен OAuth Scaleway.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
name строка / обязательно	Имя, используемое для идентификации тома.
organization строка	ID организации ScaleWay, которой принадлежит том.
project строка добавлено в community.general 4.3.0	ID проекта Scaleway, которому принадлежит том.
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 булево	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)
volume_type строка	Тип тома (например, ‘l_ssd’).

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз статуса изменений без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Будет возвращать подробную информацию о том, что изменилось (или что, возможно, нужно изменить в режиме `check_mode`), когда находится в режиме diff.

Примечания

Примечание

См. также документацию по 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 словарь	Это присутствует только тогда, когда `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"}}`

Авторы

Генрик Консек (@hekonsek)

Ссылки на сборку

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