ngine_io.vultr.vultr_server_info – Сбор информации о доступных серверах Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в плейбуке укажите: ngine_io.vultr.vultr_server_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 целое число | Задержка отката при повторных попытках в секундах, экспоненциально увеличивающаяся до этого максимального значения. Переменная среды 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 servers information
ngine_io.vultr.vultr_server_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_server_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | успех | Ответ от Vultr API с несколькими дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Точка входа, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Количество максимальных попыток повторного запроса API Пример: 5 | |
| api_retry_max_delay целое число | успех | Задержка экспоненциального повторного запроса в секундах между попытками до максимального значения этой задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_server_info сложный | успех | Ответ от Vultr API | |
| allowed_bandwidth_gb целое число | успех | Разрешённая пропускная способность в ГБ Пример: 1000 | |
| auto_backup_enabled логическое значение | успех | Включены ли автоматические резервные копии | |
| cost_per_month вещественное число | успех | Стоимость за месяц за сервер Пример: 5.0 | |
| current_bandwidth_gb целое число | успех | Текущая пропускная способность, используемая для сервера | |
| date_created строка | успех | Дата создания сервера Пример: 2017-08-26 12:47:48 | |
| default_password строка | успех | Пароль для входа в систему root на сервере Пример: !p3EWYJm$qDWYaFr | |
| disk строка | успех | Информация о диске Пример: Виртуальные 25 ГБ | |
| firewall_group строка | успех и доступно | Группа брандмауэра, к которой назначен сервер Пример: CentOS 6 x64 | |
| id строка | успех | ID сервера Пример: 10194376 | |
| internal_ip строка | успех | Внутренний IP | |
| kvm_url строка | успех | URL для VNC Пример: https://my.vultr.com/subs/vps/novnc/api.php?data=xyz | |
| name строка | успех | Имя (метка) сервера Пример: ansible-test-vm | |
| os строка | успех | Операционная система, используемая для сервера Пример: CentOS 6 x64 | |
| pending_charges вещественное число | успех | Неоплаченные платежи Пример: 0.01 | |
| plan строка | успех | Используемый план для сервера Пример: 1024 МБ ОЗУ, 25 ГБ SSD, 1,00 ТБ пропускной способности | |
| power_status строка | успех | Состояние питания сервера Пример: работает | |
| ram строка | успех | Информация о размере ОЗУ Пример: 1024 МБ | |
| region строка | успех | Регион, в который был развернут сервер Пример: Амстердам | |
| server_state строка | успех | Состояние сервера Пример: ok | |
| status строка | успех | Состояние развертывания сервера Пример: активный | |
| tag строка | успех | Ожидается | |
| v4_gateway строка | успех | IPv4 шлюз Пример: 45.32.232.1 | |
| v4_main_ip строка | успех | Основной IPv4 Пример: 45.32.233.154 | |
| v4_netmask строка | успех | Маска сети IPv4 Пример: 255.255.254.0 | |
| v6_main_ip строка | успех | Основной IPv6 | |
| v6_network строка | успех | Сеть IPv6 | |
| v6_network_size строка | успех | Размер сети IPv6 | |
| v6_networks список / элементы=строка | успех | Сети IPv6 | |
| vcpu_count целое число | успех | Количество виртуальных процессоров Пример: 1 | |
Авторы
- Янис Гуэнан (@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_server_info_module.html
