community.general.scaleway_volume_info – Сбор информации о доступных томах Scaleway.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: 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 information
community.general.scaleway_volume_info:
region: par1
register: result
- ansible.builtin.debug:
msg: "{{ result.scaleway_volume_info }}"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| scaleway_volume_info сложное | успех | Ответ от API Scaleway Пример: {'scaleway_volume_info': [{'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'}]} |
Авторы
- Янис Гюнане (@Spredzy)
- Реми Леон (@sieben)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_volume_info_module.html