vultr_block_storage_facts – Сбор фактов о доступных томах хранилища блоков Vultr
Новая в версии 2.7.
УСТАРЕВШИЙ
| Удалено в Ansible: | |
|---|---|
| версия: 2.12 | |
| Почему: | Преобразован в модуль информации. |
| Альтернатива: | Используйте vultr_block_storage_info вместо этого. |
Описание
- Сбор фактов о томах хранилища блоков, доступных в Vultr.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account строка | Значение по умолчанию: "default" | Имя раздела ini в файле vultr.ini.Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если она определена. |
| api_endpoint строка | URL API-точки входа (без конечной косой черты). Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию - https://api.vultr.com, если не указано. | |
| api_key строка | API-ключ API Vultr. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток повторного выполнения в случае, если API Vultr возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию - 5 попыток, если не указано. | |
| api_retry_max_delay целое число добавлен в 2.9 | Задержка повторного выполнения в секундах экспоненциально увеличивается до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию - 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для API Vultr. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию - 60 секунд, если не указано. | |
| validate_certs булево |
| Проверка SSL-сертификатов API Vultr. |
Примечания
Примечание
- Также см. документацию API на https://www.vultr.com/api/.
Примеры
- name: Gather Vultr block storage volumes facts
local_action:
module: vultr_block_storage_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_block_storage_facts
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | успешно | Ответ от API Vultr с некоторыми дополнениями/изменениями | |
| api_account строка | успешно | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успешно | Точка входа, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успешно | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число добавлен в 2.9 | успешно | Задержка экспоненциального повторного выполнения в секундах между попытками до максимального значения задержки. Пример: 12 | |
| api_timeout целое число | успешно | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_block_storage_facts сложный | успешно | Ответ от API Vultr Пример: {'vultr_block_storage_facts': [{'attached_to_id': None, 'cost_per_month': 1.0, 'date_created': '2018-07-24 12:59:59', 'id': 17332323, 'name': 'ansible-test-volume', 'region': 'New Jersey', 'size': 10, 'status': 'active'}]} | |
Статус
- Этот модуль будет удален в версии 2.12. [устарел]
- Дополнительная информация см. в разделе УСТАРЕВШИЙ.
Авторы
- Yanis Guenane (@Spredzy)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_block_storage_facts_module.html
