ngine_io.vultr.vultr_firewall_group_info – Сбор информации о доступных группах брандмауэров Vultr.
Примечание
Этот плагин является частью коллекции ngine_io.vultr (версия 1.1.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 строка | успешно | Название группы брандмауэра Пример: my firewall group | |
| id строка | успешно | ID группы брандмауэра Пример: 1234abcd | |
Авторы
- 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_firewall_group_info_module.html
