Модуль hetzner.hcloud.firewall_info — сбор сведений о брандмауэрах Hetzner Cloud.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.firewall_info.

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

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

Сбор сведений о ваших брандмауэрах Hetzner Cloud.

Псевдонимы: hcloud_firewall_info

Требования

Следующие требования должны быть выполнены на узле, где запускается этот модуль.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint string	Конечная точка API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner string	Конечная точка API Hetzner. Это значение также можно задать с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token string / обязательный	Токен для API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
id integer	Идентификатор брандмауэра, сведения о котором требуется получить. Модуль завершится с ошибкой, если указанный идентификатор недействителен.
label_selector string	Селектор меток для брандмауэров, сведения о которых требуется получить.
name string	Имя брандмауэра, сведения о котором требуется получить.

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Gather hcloud Firewall infos
  hetzner.hcloud.firewall_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

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

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

Ключ	Описание
hcloud_firewall_info list / элементы=dictionary	Список брандмауэров. Возвращается: всегда
applied_to list / элементы=dictionary	Список ресурсов, к которым применяется брандмауэр. Возвращается: всегда
applied_to_resources list / элементы=dictionary	Список ресурсов, к которым применяется селектор меток брандмауэра. Возвращается: если `hcloud_firewall_info[].applied_to[].type=label_selector`
server integer	Идентификатор сервера. Возвращается: при успешном выполнении Пример: `12345`
type string	Тип связанного ресурса. Возвращается: при успешном выполнении Возможные значения: `"server"` Пример: `"server"`
label_selector string	Значение селектора меток. Возвращается: при успешном выполнении Пример: `"env=prod"`
server integer	Идентификатор сервера. Возвращается: при успешном выполнении Пример: `12345`
type string	Тип ресурса. Возвращается: при успешном выполнении Возможные значения: `"server"` `"label_selector"` Пример: `"label_selector"`
id integer	Числовой идентификатор брандмауэра. Возвращается: всегда Пример: `1937415`
labels dictionary	Метки, заданные пользователем (пары ключ-значение). Возвращается: всегда
name string	Имя брандмауэра. Возвращается: всегда Пример: `"my-firewall"`
rules list / элементы=dictionary	Список правил брандмауэра. Возвращается: всегда
description string	Описание этого правила, заданное пользователем. Возвращается: всегда Пример: `"allow http from anywhere"`
destination_ips list / элементы=string	Список CIDR-адресов назначения, разрешённых этим правилом. Возвращается: всегда Пример: `[]`
direction string	Направление правила брандмауэра. Возвращается: всегда Пример: `"in"`
port string	Порт или диапазон портов, разрешённый этим правилом. Возвращается: если `hcloud_firewall_info[].rules[].protocol=tcp` или `hcloud_firewall_info[].rules[].protocol=udp` Пример: `"80"`
protocol string	Протокол правила брандмауэра. Возвращается: всегда Пример: `"tcp"`
source_ips list / элементы=string	Список CIDR-адресов источника, разрешённых этим правилом. Возвращается: всегда Пример: `["0.0.0.0/0", "::/0"]`

Авторы

Jonas Lammler (@jooola)

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

© 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/hetzner/hcloud/firewall_info_module.html