Модуль vultr.cloud.firewall_group_info – Сбор информации о группах брандмауэров Vultr

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать её в плейбуке, укажите: vultr.cloud.firewall_group_info.

Новая в vultr.cloud 1.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Сбор информации о доступных группах брандмауэров.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без конечного слеша). Альтернативная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. Альтернативная переменная окружения `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторной обработки в случае возврата Vultr API кода HTTP ошибки, например: - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания шлюза истекло Альтернативная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка повторной обработки в секундах, экспоненциально возрастает до максимального значения. Альтернативная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Время ожидания HTTP для Vultr API. Альтернативная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs булево	Проверять SSL-сертификаты Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API на https://www.vultr.com/api/.

Примеры

- name: Gather Vultr firewall groups information
  vultr.cloud.firewall_group_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_firewall_group_info

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: успешно
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: успешно Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Количество максимальных попыток повторных запросов API. Возвращено: успешно Пример: `5`
api_retry_max_delay целое число	Время экспоненциальной задержки в секундах между повторными попытками до достижения этого максимального значения задержки. Возвращено: успешно Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: успешно Пример: `60`
vultr_firewall_group_info список / элементы=строка	Ответ от API Vultr в виде списка. Возвращено: успешно
date_created строка	Дата создания группы правил брандмауэра. Возвращено: успешно Пример: `"2020-10-10T01:56:20+00:00"`
date_modified строка	Дата изменения группы правил брандмауэра. Возвращено: успешно Пример: `"2020-10-10T01:56:20+00:00"`
description строка	Название группы правил брандмауэра. Возвращено: успешно Пример: `"my firewall group"`
id строка	Идентификатор группы правил брандмауэра. Возвращено: успешно Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`

Авторы

Yanis Guenane (@Spredzy)
René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/firewall_group_info_module.html