Модуль hetzner.hcloud.firewall – Создание и управление брандмауэрами на Hetzner Cloud.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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_token строка / обязательно	API-ключ для Hetzner Cloud. Вы также можете установить этот параметр, используя переменную среды `HCLOUD_TOKEN`.
force логический тип	Принудительно удалить брандмауэр, даже если он используется. Варианты: `false` ← (по умолчанию) `true`
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 Cloud: Полное руководство по API Hetzner Cloud.

Примеры

- 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"`

END_OF_DOCUMENT_MARKER

source_ips

список / элементы=строка

Список исходных CIDR, разрешённых в данном правиле.

Возвращается: всегда

Пример: ["0.0.0.0/0", "::/0"]

Авторы

Lukas Kaemmerling (@lkaemmerling)

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

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