Модуль hetzner.hcloud.firewall — создание и управление межсетевыми экранами в Hetzner Cloud.

Примечание

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

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

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

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

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

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

Создание, обновление и управление межсетевыми экранами в Hetzner Cloud.

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

Требования

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

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	Конечная точка API Hetzner Cloud. Также можно задать этот параметр с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Конечная точка API Hetzner. Также можно задать этот параметр с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен для API Hetzner Cloud. Также можно задать этот параметр с помощью переменной окружения `HCLOUD_TOKEN`.
force логическое значение	Принудительно удалить межсетевой экран, если он всё ещё используется. Варианты: `false` ← (по умолчанию) `true`
id целое число	ID межсетевого экрана Hetzner Cloud, которым нужно управлять. Обязателен, только если не указан идентификатор межсетевого экрана `name`.
labels словарь	Метки, заданные пользователем (пары «ключ — значение»).
name строка	Имя межсетевого экрана Hetzner Cloud, которым нужно управлять. Обязательно, только если не указан идентификатор межсетевого экрана `id` или если межсетевой экран не существует.
rules список / элементы=словарь	Список правил межсетевого экрана.
description строка	Описание этого правила, заданное пользователем.
destination_ips список / элементы=строка	Список CIDR-диапазонов, разрешённых этим правилом. Используйте 0.0.0.0/0, чтобы разрешить все адреса IPv4, и ::/0, чтобы разрешить все адреса IPv6. Используется только, если `rules[].direction=out`. По умолчанию: `[]`
direction строка	Направление правила межсетевого экрана. Варианты: `"in"` `"out"`
port строка	Порт или диапазон портов, разрешённый этим правилом. Диапазон портов можно указать, разделив номера двух портов дефисом, например 1024-5000. Используется только, если `rules[].protocol=tcp` или `rules[].protocol=udp`.
protocol строка	Протокол правила межсетевого экрана. Варианты: `"icmp"` `"tcp"` `"udp"` `"esp"` `"gre"`
source_ips список / элементы=строка	Список CIDR-диапазонов, разрешённых этим правилом. Используйте 0.0.0.0/0, чтобы разрешить все адреса IPv4, и ::/0, чтобы разрешить все адреса IPv6. Используется только, если `rules[].direction=in`. По умолчанию: `[]`
state строка	Состояние межсетевого экрана. Варианты: `"absent"` `"present"` ← (по умолчанию)

См. также

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

Примеры

- name: Create a basic firewall
  hetzner.hcloud.firewall:
    name: my-firewall
    state: present

- name: Create a firewall with rules
  hetzner.hcloud.firewall:
    name: my-firewall
    rules:
      - description: allow icmp from everywhere
        direction: in
        protocol: icmp
        source_ips:
          - 0.0.0.0/0
          - ::/0
    state: present

- name: Create a firewall with labels
  hetzner.hcloud.firewall:
    name: my-firewall
    labels:
      key: value
      mylabel: 123
    state: present

- name: Ensure the firewall is absent (remove if needed)
  hetzner.hcloud.firewall:
    name: my-firewall
    state: absent

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

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

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

Авторы

Lukas Kaemmerling (@lkaemmerling)

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

© 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_module.html