Модуль vultr.cloud.firewall_group – управление группами брандмауэров в Vultr

Примечание

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

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

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

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

Добавлено в 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_results_per_page целое число добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: все ресурсы возвращаются с учётом других фильтров. Максимальное значение для Vultr API — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries целое число	Количество повторных попыток в случае, если Vultr API возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка между повторными попытками увеличивается экспоненциально до указанного максимального значения в секундах. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Тайм-аут HTTP-запросов к Vultr API. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
description псевдонимы: name строка / обязательный	Описание группы брандмауэров.
state строка	Состояние группы брандмауэров. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Проверять сертификаты SSL Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: ensure a firewall group is present
  vultr.cloud.firewall_group:
    description: my http firewall.

- name: ensure a firewall group is absent
  vultr.cloud.firewall_group:
    description: my http firewall.
    state: absent

Возвращаемые значения

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

Ключ	Описание
vultr_api словарь	Ответ Vultr API с несколькими дополнениями и изменениями. Возвращается: при успешном выполнении
api_endpoint строка	Конечная точка, используемая для запросов API. Возвращается: при успешном выполнении Пример: `"https://api.vultr.com/v2"`
api_results_per_page целое число	Количество результатов, возвращаемых за один вызов API. Возвращается: при успешном выполнении Пример: `100`
api_retries целое число	Максимальное количество повторных попыток для запросов API. Возвращается: при успешном выполнении Пример: `5`
api_retry_max_delay целое число	Максимальная экспоненциально увеличивающаяся задержка в секундах между повторными попытками. Возвращается: при успешном выполнении Пример: `12`
api_timeout целое число	Тайм-аут, используемый для запросов API. Возвращается: при успешном выполнении Пример: `60`
vultr_firewall_group словарь	Ответ Vultr API. Возвращается: при успешном выполнении
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"`

Авторы

René Moser (@resmo)

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

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