ngine_io.vultr.vultr_network_info – Сбор информации о доступных сетях Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Чтобы использовать его в книге задач, укажите: ngine_io.vultr.vultr_network_info.
Новое в версии 0.1.0: плагина ngine_io.vultr
Обзор
- Сбор информации о доступных сетях 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 networks information
ngine_io.vultr.vultr_network_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_network_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложное | success | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | success | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число | success | Экспоненциально возрастающая задержка повторной попытки в секундах между повторами до этого максимального значения задержки. Пример: 12 | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_network_info сложное | success | Ответ от Vultr API | |
| date_created строка | success | Дата создания сети Пример: 2018-08-02 08:54:52 | |
| id строка | success | ID сети Пример: net5b62c6dc63ef5 | |
| name строка | success | Имя (метка) сети Пример: mynetwork | |
| region строка | success | Регион развертывания сети Пример: Амстердам | |
| v4_subnet строка | success | Адрес сети IPv4 Пример: 192.168.42.0 | |
| v4_subnet_mask целое число | success | Маска сети IPv4 Пример: 24 | |
Авторы
- 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_network_info_module.html
