Модуль community.general.scaleway_volume_info — Сбор информации о доступных томах Scaleway

Примечание

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

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

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

Для использования в книге задач укажите: community.general.scaleway_volume_info.

Обзор
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор информации о доступных томах Scaleway.

Параметры

Параметр	Комментарии
api_timeout aliases: timeout целое число	Таймаут HTTP-запросов к API Scaleway в секундах. По умолчанию: `30`
api_token aliases: oauth_token строка / обязательно	Токен Scaleway OAuth.
api_url aliases: base_url строка	URL API Scaleway. По умолчанию: `"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 логическое значение	Проверка SSL-сертификатов API Scaleway. Доступные значения: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
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: Gather Scaleway volumes information
  community.general.scaleway_volume_info:
    region: par1
  register: result

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

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе, ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
scaleway_volume_info список / элементы=словарь	Ответ от API Scaleway. Для получения дополнительной информации обратитесь к: 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"}]}`

Ключ

Описание

scaleway_volume_info

список / элементы=словарь

Ответ от API Scaleway.

Для получения дополнительной информации обратитесь к: 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)

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

© 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_info_module.html