community.general.scaleway_snapshot_facts – Сбор фактов о доступных снимках Scaleway.
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.scaleway_snapshot_facts.
УСТАРЕВШЕ
- Удалено в
-
версии 3.0.0
- Почему
-
Заменено модулем
_info. - Альтернатива
-
Используйте community.general.scaleway_snapshot_info вместо этого.
Описание
- Сбор фактов о доступных снимках Scaleway.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | По умолчанию: 30 | Таймаут HTTP-запроса к API Scaleway в секундах. Псевдонимы: timeout |
| api_token строка / обязательный | Токен Scaleway OAuth. Псевдонимы: oauth_token | |
| api_url строка | По умолчанию: "https://api.scaleway.com" | URL API Scaleway. Псевдонимы: base_url |
| query_parameters словарь | По умолчанию: {} | Список параметров, передаваемых в строку запроса. |
| region строка / обязательный |
| Регион Scaleway для использования (например, par1). |
| validate_certs булево |
| Проверять SSL-сертификаты API Scaleway. |
Примечания
Примечание
- Также см. документацию 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 facts
community.general.scaleway_snapshot_facts:
region: par1
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| scaleway_snapshot_facts сложный | успех | Ответ от API Scaleway Пример: {'scaleway_snapshot_facts': [{'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'}]} |
Статус
- Этот модуль будет удален в версии 3.0.0. [устарел]
- Дополнительную информацию см. в разделе УСТАРЕВШЕ.
Авторы
- Yanis Guenane (@Spredzy)
- Remy Leone (@sieben)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/scaleway_snapshot_facts_module.html