ngine_io.vultr.vultr_plan_info – Сбор информации о доступных планах Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в плейбуке укажите: ngine_io.vultr.vultr_plan_info.
Введено в версии 0.1.0: плагин ngine_io.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 Vultr API. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если определена. | |
| api_retries целое число | Количество попыток повторного выполнения запроса, если Vultr API возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 5 попыток, если не указано. | |
| api_retry_max_delay целое число | Задержка экспоненциального возврата (backoff) в секундах, максимальное значение. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 60 секунд, если не указано. | |
| validate_certs логическое значение |
| Проверять SSL-сертификаты Vultr API. |
Примечания
Примечание
- См. также документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Gather Vultr plans information
ngine_io.vultr.vultr_plan_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_plan_info
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный тип | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество повторов запросов API Пример: 5 | |
| api_retry_max_delay целое число | успех | Задержка экспоненциального возврата (backoff) в секундах между повторами запроса, до максимального значения. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_plan_info сложный тип | успех | Ответ от Vultr API | |
| plan список / элементы=строка | успех | Список доступных планов. Пример: [{'available_locations': [1], 'bandwidth': 40.0, 'bandwidth_gb': 40960, 'disk': 110, 'id': 118, 'name': '32768 МБ ОЗУ,110 ГБ SSD,40.00 ТБ пропускной способности', 'plan_type': 'DEDICATED', 'price_per_month': 240.0, 'ram': 32768, 'vcpu_count': 8, 'windows': False}] | |
Авторы
- Yanis Guenane (@Spredzy)
© 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/ngine_io/vultr/vultr_plan_info_module.html
