community.general.scaleway_volume_facts – Сбор фактов о доступных томах Scaleway.
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.scaleway_volume_facts.
УСТЕРЕГШИЙСЯ
- Удалено в
-
версии 3.0.0
- Почему
-
Устаревший в пользу модуля
_info. - Альтернатива
-
Используйте community.general.scaleway_volume_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 volumes facts
community.general.scaleway_volume_facts:
region: par1
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| scaleway_volume_facts сложный | успех | Ответ от API Scaleway Пример: {'scaleway_volume_facts': [{'creation_date': '2018-08-14T20:56:24.949660+00:00', 'export_uri': None, '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': None, 'size': 50000000000, '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_volume_facts_module.html