ngine_io.vultr.vultr_firewall_group_info – Сбор информации о доступных группах брандмауэров Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_firewall_group_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 firewall groups information
ngine_io.vultr.vultr_firewall_group_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_firewall_group_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_firewall_group_info сложный | успех | Ответ от Vultr API | |
| date_created строка | успех | Дата создания группы брандмауэра Пример: 2017-08-26 12:47:48 | |
| date_modified строка | успех | Дата изменения группы брандмауэра Пример: 2017-08-26 12:47:48 | |
| description строка | успех | Название группы брандмауэра Пример: моя группа брандмауэра | |
| id строка | успех | ID группы брандмауэра Пример: 1234abcd | |
Авторы
- 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.10/collections/ngine_io/vultr/vultr_firewall_group_info_module.html
