Модуль hetzner.hcloud.firewall_info – Сбор информации о брандмауэрах Hetzner Cloud.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Конечная точка API Hetzner Cloud. Вы также можете установить этот параметр, используя переменную среды `HCLOUD_ENDPOINT`. Значение по умолчанию: `"https://api.hetzner.cloud/v1"`
api_token строка / обязательно	Токен API Hetzner Cloud. Вы также можете установить этот параметр, используя переменную среды `HCLOUD_TOKEN`.
id целое число	Идентификатор брандмауэра, который нужно получить. Модуль завершится ошибкой, если предоставленный идентификатор недействителен.
label_selector строка	Селектор меток для брандмауэров, которые нужно получить.
name строка	Имя брандмауэра, который нужно получить.

См. также

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

Примеры

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

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

Значения возврата

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

Ключ	Описание
hcloud_firewall_info список / элементы=словарь	Список брандмауэров. Возвращается: всегда
applied_to список / элементы=словарь	Список ресурсов, к которым применяется брандмауэр. Возвращается: всегда
applied_to_resources список / элементы=словарь	Список ресурсов, к которым применяется селектор меток брандмауэра. Возвращается: если `hcloud_firewall_info[].applied_to[].type=label_selector`
server целое число	Идентификатор сервера. Возвращается: успех Пример: `12345`
type строка	Тип ресурса, на который ссылаются. Возвращается: успех Может возвращать только: `"server"` Пример: `"server"`
label_selector строка	Значение селектора меток. Возвращается: успех Пример: `"env=prod"`
server целое число	Идентификатор сервера. Возвращается: успех Пример: `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_info[].rules[].protocol=tcp` или `hcloud_firewall_info[].rules[].protocol=udp` Пример: `"80"`
protocol строка	Протокол правила брандмауэра. Возвращается: всегда Пример: `"tcp"`

source_ips

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

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

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

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

Авторы

Jonas Lammler (@jooola)

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

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