Модуль community.hrobot.firewall_info – Управление брандмауэром выделенного сервера Hetzner

Примечание

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

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

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

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

Обзор
Параметры
Атрибуты
См. также
Примеры
Значения возврата

Обзор

Управление брандмауэром выделенного сервера Hetzner.

Параметры

Параметр	Комментарии
hetzner_password строка / обязательно	Пароль пользователя Robot веб-сервиса.
hetzner_user строка / обязательно	Имя пользователя пользователя Robot веб-сервиса.
server_ip строка	Основной IP-адрес сервера. Должен быть указан только один из `server_ip` и `server_number`. Обратите внимание, что Hetzner устарел способ идентификации брандмауэра сервера по основному IP-адресу. Использование этого параметра может перестать работать в будущем. Используйте `server_number` вместо него.
server_number целое число добавлен в community.hrobot 1.8.0	Номер сервера. Должен быть указан только один из `server_ip` и `server_number`.
timeout целое число	Таймаут (в секундах) ожидания настройки брандмауэра. По умолчанию: `180`
wait_delay целое число	Задержка ожидания (в секундах) перед повторной проверкой состояния настройки брандмауэра. По умолчанию: `10`
wait_for_configured логическое	Ожидать завершения успешной настройки брандмауэра перед возвратом из модуля. 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`).

См. также

Документация по брандмауэру: Документация 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 словарь	Настройка брандмауэра. Возвращаемое значение: success
allowlist_hos логическое значение добавлен в community.hrobot 1.2.0	Разрешён ли доступ к услугам Hetzner. Возвращаемое значение: success Пример: `true`
filter_ipv6 логическое значение	Применяются ли правила брандмауэра к IPv6. Возвращаемое значение: success Пример: `false`
port строка	Порт коммутатора брандмауэра. `main` или `kvm`. Возвращаемое значение: success Пример: `"main"`
rules словарь	Правила брандмауэра. Возвращаемое значение: success

dst_port string	Порт назначения или диапазон портов. Возвращаемое значение: успех Пример: `"443"`
ip_version string	Версия интернет-протокола. Отсутствие значения означает, что правило применяется как к IPv4, так и к IPv6. Возвращаемое значение: успех
name string	Имя правила брандмауэра. Возвращаемое значение: успех Пример: `"Allow HTTP access to server"`
protocol string	Протокол над уровнем IP. Возвращаемое значение: успех Пример: `"tcp"`
src_ip string	Адрес источника IP или подсеть. Использование CIDR-нотации. Возвращаемое значение: успех
src_port string	Порт источника или диапазон портов. Возвращаемое значение: успех
tcp_flags string	Флаги TCP или логическое сочетание флагов. Возвращаемое значение: успех
server_ip string	Основной IP-адрес сервера. Возвращаемое значение: успех Пример: `"1.2.3.4"`
server_number integer	Внутренний номер сервера Hetzner. Возвращаемое значение: успех Пример: `12345`
status string	Статус брандмауэра. `active` или `disabled`. Будет `in process`, если брандмауэр в данный момент обновляется, и `wait_for_configured` установлено на `false` или `timeout` имеет слишком маленькое значение. Возвращаемое значение: успех Пример: `"active"`
whitelist_hos boolean	Имеют ли Hetzner-сервисы доступ. Старое название возвращаемого значения `allowlist_hos`, в будущем будет удалено. Возвращаемое значение: успех Пример: `true`

Авторы

Felix Fontein (@felixfontein)

Ссылки на сборку

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