Модуль community.hrobot.firewall_info — управление межсетевым экраном выделенного сервера Hetzner

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.7.2).

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

Для установки используйте: ansible-galaxy collection install community.hrobot.

Чтобы использовать коллекцию в плейбуке, укажите: community.hrobot.firewall_info.

Краткое описание
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление межсетевым экраном выделенного сервера Hetzner.

Параметры

Параметр	Комментарии
hetzner_password string / обязательный	Пароль пользователя веб-службы Robot.
hetzner_user string / обязательный	Имя пользователя веб-службы Robot.
rate_limit_retry_timeout integer добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Задайте `0`, чтобы отключить повторные попытки. Задайте отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
server_ip string	Основной IP-адрес сервера. Необходимо указать ровно один из параметров `server_ip` и `server_number`. Обратите внимание: Hetzner отказалась от идентификации межсетевого экрана сервера по его основному IP-адресу. Поэтому использование этого параметра может в любой момент перестать работать. Вместо него используйте `server_number`.
server_number integer добавлено в community.hrobot 1.8.0	Номер сервера. Необходимо указать ровно один из параметров `server_ip` и `server_number`.
timeout integer	Время ожидания (в секундах) настройки межсетевого экрана. По умолчанию: `180`
wait_delay integer	Задержка (в секундах) перед повторной проверкой настройки межсетевого экрана. По умолчанию: `10`
wait_for_configured boolean	Ожидать ли успешной настройки межсетевого экрана перед возвратом управления из модуля. Если межсетевой экран настраивается, API возвращает статус `in progress`. В этом случае модуль будет повторять попытки, пока статус не изменится на `active` или `disabled`. Обратите внимание, что число запросов ограничено. Если необходимо выполнить несколько обновлений, может быть лучше отключить ожидание и регулярно проверять статус с помощью community.hrobot.firewall_info. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hrobot.robot добавлено в community.hrobot 1.6.0	Используйте `group/community.hrobot.robot` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме сравнения будут возвращены сведения об изменениях (или о возможных изменениях в `check_mode`).
idempotent	Поддержка: полная Это действие не изменяет состояние.	При последовательном запуске дважды вне режима проверки с одинаковыми аргументами второй вызов указывает на отсутствие изменений. Предполагается, что система, управляемая или проверяемая модулем, не изменилась значимым образом.

См. также

Документация по межсетевому экрану: Документация Hetzner по межсетевому экрану без отслеживания состояния для выделенных серверов.
community.hrobot.firewall: Настройка межсетевого экрана.

Примеры

---
- name: Get firewall configuration for server with main IP 1.2.3.4
  community.hrobot.firewall_info:
    hetzner_user: foo
    hetzner_password: bar
    server_ip: 1.2.3.4
  register: result

- ansible.builtin.debug:
    msg: "{{ result.firewall }}"

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

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

Ключ	Описание
firewall dictionary	Конфигурация межсетевого экрана. Возвращается: success
allowlist_hos boolean добавлено в community.hrobot 1.2.0	Имеют ли службы Hetzner доступ. Возвращается: success Пример: `true`
filter_ipv6 boolean	Применяются ли правила межсетевого экрана также к IPv6. Возвращается: success Пример: `false`
port string	Порт коммутатора межсетевого экрана. `main` или `kvm`. Возвращается: success Пример: `"main"`
rules dictionary	Правила межсетевого экрана. Возвращается: success
input list / элементы=dictionary	Входящие правила межсетевого экрана. Возвращается: success
action string	Действие при совпадении с правилом. `accept` или `discard`. Возвращается: success Возможные возвращаемые значения: `"accept"` `"discard"` Пример: `"accept"`
dst_ip string	IP-адрес назначения или адрес подсети. Запись CIDR. Возвращается: success Пример: `"1.2.3.4/32"`
dst_port string	Порт назначения или диапазон портов. Возвращается: success Пример: `"443"`
ip_version string	Версия интернет-протокола. Если значение не задано, правило применяется и к IPv4, и к IPv6. Возвращается: success Пример: `"ipv4"`
name string	Имя правила межсетевого экрана. Возвращается: success Пример: `"Allow HTTP access to server"`
protocol string	Протокол сетевого уровня выше IP. Возвращается: success Пример: `"tcp"`
src_ip string	IP-адрес источника или адрес подсети. Запись CIDR. Возвращается: success
src_port string	Порт источника или диапазон портов. Возвращается: success
tcp_flags string	Флаги TCP или их логическая комбинация. Возвращается: success
output list / элементы=dictionary	Исходящие правила межсетевого экрана. Возвращается: success
action string	Действие при совпадении с правилом. `accept` или `discard`. Возвращается: success Возможные возвращаемые значения: `"accept"` `"discard"` Пример: `"accept"`
dst_ip string	IP-адрес назначения или адрес подсети. Запись CIDR. Возвращается: success Пример: `"1.2.3.4/32"`
dst_port string	Порт назначения или диапазон портов. Возвращается: success Пример: `"443"`
ip_version string	Версия интернет-протокола. Если значение не задано, правило применяется и к IPv4, и к IPv6. Возвращается: success
name string	Имя правила межсетевого экрана. Возвращается: success Пример: `"Allow HTTP access to server"`
protocol string	Протокол сетевого уровня выше IP. Возвращается: success Пример: `"tcp"`
src_ip string	IP-адрес источника или адрес подсети. Запись CIDR. Возвращается: success
src_port string	Порт источника или диапазон портов. Возвращается: success
tcp_flags string	Флаги TCP или их логическая комбинация. Возвращается: success
server_ip string	Основной IP-адрес сервера. Возвращается: success Пример: `"1.2.3.4"`
server_number integer	Внутренний номер сервера Hetzner. Возвращается: success Пример: `12345`
status string	Статус межсетевого экрана. `active` или `disabled`. Будет возвращено значение `in process`, если межсетевой экран в данный момент обновляется, а параметр `wait_for_configured` имеет значение `false` или `timeout` задан слишком малым. Возвращается: success Пример: `"active"`
whitelist_hos boolean	Имеют ли службы Hetzner доступ. Старое имя возвращаемого значения `allowlist_hos`; в конечном итоге будет удалено. Возвращается: success Пример: `true`

Авторы

Felix Fontein (@felixfontein)

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

© 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/community/hrobot/firewall_info_module.html