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

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Таймаут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательный	Токен Scaleway OAuth.
api_url псевдонимы: 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-сертификатов Scaleway API. Варианты: `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 snapshots information
  community.general.scaleway_snapshot_info:
    region: par1
  register: result

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

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

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

Ключ	Описание
scaleway_snapshot_info список / элементы=словарь	Ответ от API Scaleway. Для получения дополнительной информации, пожалуйста, обратитесь к: https://developers.scaleway.com/en/products/instance/api/. Возвращается: успех Пример: {"scaleway_snapshot_info": [{"base_volume": {"id": "68386fae-4f55-4fbf-aabb-953036a85872", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42"}, "creation_date": "2018-08-14T22:34:35.299461+00:00", "id": "b61b4b03-a2e9-4da5-b5ea-e462ac0662d2", "modification_date": "2018-08-14T22:34:54.520560+00:00", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "size": 25000000000, "state": "available", "volume_type": "l_ssd"}]}

Ключ

Описание

scaleway_snapshot_info

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

Ответ от API Scaleway.

Для получения дополнительной информации, пожалуйста, обратитесь к: https://developers.scaleway.com/en/products/instance/api/.

Возвращается: успех

Пример: {"scaleway_snapshot_info": [{"base_volume": {"id": "68386fae-4f55-4fbf-aabb-953036a85872", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42"}, "creation_date": "2018-08-14T22:34:35.299461+00:00", "id": "b61b4b03-a2e9-4da5-b5ea-e462ac0662d2", "modification_date": "2018-08-14T22:34:54.520560+00:00", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "size": 25000000000, "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_snapshot_info_module.html