Spec-Zone.ru › Ansible

Модуль community.proxmox.proxmox_firewall_info — управление правилами брандмауэра в Proxmox

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_firewall_info.

Добавлено в community.proxmox 1.4.0

  • Краткое описание
  • Требования
  • Параметры
  • Атрибуты
  • Примеры
  • Возвращаемые значения

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

  • Получение правил брандмауэра на уровне кластера/группы/vnet/узла/ВМ.
  • Получение групп безопасности брандмауэра на уровне кластера.
  • Получение псевдонимов на уровне кластера/ВМ.

Требования

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

  • proxmoxer >= 2.0
  • requests

Параметры

Параметр

Комментарии

api_host

string / обязательный

Укажите целевой хост кластера Proxmox VE.

Если параметр не указан, используется переменная среды PROXMOX_HOST.

api_password

string

Укажите пароль для аутентификации.

Если параметр не указан, используется переменная среды PROXMOX_PASSWORD.

api_port

integer

Укажите целевой порт кластера Proxmox VE.

Если параметр не указан, используется переменная среды PROXMOX_PORT.

api_timeout

integer

Ограничение времени для запросов к API Proxmox VE.

По умолчанию: 5

api_token_id

string

Укажите идентификатор токена.

Если параметр не указан, используется переменная среды PROXMOX_TOKEN_ID.

api_token_secret

string

Укажите секрет токена.

Если параметр не указан, используется переменная среды PROXMOX_TOKEN_SECRET.

api_user

string / обязательный

Укажите пользователя для аутентификации.

Если параметр не указан, используется переменная среды PROXMOX_USER.

ca_path

path

Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений.

Игнорируется, если validate_certs=false.

group

string

Имя группы, которой принадлежит правило.

Требуется только, если level=group.

level

string

Уровень, на котором применяется правило брандмауэра.

Варианты:

  • "cluster" ← (по умолчанию)
  • "group"
  • "vnet"
  • "node"
  • "vm"

node

string

Имя узла.

Требуется только, если level=node.

pos

integer

Позиция правила в списке.

validate_certs

boolean

Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE.

В настоящее время значение по умолчанию — false; в community.proxmox 2.0.0 значение по умолчанию изменится на true.

Если параметр не указан, используется переменная среды PROXMOX_VALIDATE_CERTS.

Варианты:

  • false
  • true

vmid

integer

Идентификатор ВМ, к которой применяется правило.

Требуется только, если level=vm.

vnet

string

Имя виртуальной сети для правила.

Требуется только, если level=vnet.

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.proxmox.proxmox

Используйте group/community.proxmox.proxmox в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Может выполняться в режиме check_mode и возвращать прогноз статуса изменений, не изменяя целевой объект.

diff_mode

Поддержка: Н/Д

Это действие не изменяет состояние.

В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в check_mode).

Примеры

- name: Get Cluster level firewall rules, aliases, and security groups
  community.proxmox.proxmox_firewall_info:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    level: cluster

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

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

Ключ

Описание

aliases

list / elements=dictionary

Список псевдонимов на заданном уровне.

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

Возвращается: при успехе

Пример: [{"cidr": "10.10.1.0/24", "digest": "978391f460484e8d4fb3ca785cfe5a9d16fe8b1f", "ipversion": 4, "name": "test1"}, {"cidr": "10.10.2.0/24", "digest": "978391f460484e8d4fb3ca785cfe5a9d16fe8b1f", "ipversion": 4, "name": "test2"}, {"cidr": "10.10.3.0/24", "digest": "978391f460484e8d4fb3ca785cfe5a9d16fe8b1f", "ipversion": 4, "name": "test3"}]

firewall_rules

list / elements=dictionary

Список правил брандмауэра на заданном уровне.

Возвращается: при успехе

Пример: [{"action": "ACCEPT", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "dport": "53", "enable": 1, "ipversion": 4, "log": "nolog", "pos": 0, "proto": "udp", "source": "192.168.1.0/24", "type": "in"}, {"action": "ACCEPT", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "dport": "53", "enable": 1, "ipversion": 4, "log": "nolog", "pos": 1, "proto": "tcp", "source": "192.168.1.0/24", "type": "in"}, {"action": "ACCEPT", "dest": "192.168.1.0/24", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "enable": 1, "ipversion": 4, "log": "nolog", "pos": 2, "type": "out"}, {"action": "ACCEPT", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "enable": 1, "ipversion": 4, "log": "nolog", "pos": 3, "source": "192.168.1.0/24", "type": "in"}, {"action": "ACCEPT", "dest": "+sdn/test2-gateway", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "enable": 1, "iface": "test2", "log": "nolog", "macro": "DNS", "pos": 4, "type": "in"}, {"action": "ACCEPT", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "enable": 1, "iface": "test2", "log": "nolog", "macro": "DHCPfwd", "pos": 5, "type": "in"}, {"action": "ACCEPT", "dest": "+sdn/test2-all", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "dport": "68", "enable": 1, "log": "nolog", "pos": 6, "proto": "udp", "source": "+sdn/test2-gateway", "sport": "67", "type": "out"}, {"action": "DROP", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "enable": 1, "log": "nolog", "pos": 7, "type": "in"}, {"action": "DROP", "digest": "b5ddaed23b415b9368706fc9edc83d037526aae9", "enable": 1, "log": "nolog", "pos": 8, "type": "out"}]

groups

list / elements=string

Список групп безопасности брандмауэра.

Этот список всегда возвращается для уровня кластера независимо от переданного уровня.

Группы безопасности брандмауэра доступны только на уровне кластера.

Возвращается: при успехе

Пример: ["test"]

ip_sets

list / elements=dictionary

Список наборов IP-адресов.

Поддерживаются только для level = cluster; другие входные данные игнорируются.

Возвращается: при успехе

Пример: [{"cidrs": [], "digest": "8c4a5e793355b2a877659315faaa78cbd0bc9f6c", "name": "emptytest"}, {"cidrs": [{"cidr": "192.168.1.10", "comment": "Proxmox pve-01", "digest": "ed830373d096f6b9f868e59c6182e0b2042e6bad", "nomatch": false}, {"cidr": "192.168.1.11", "comment": "Proxmox pve-02", "digest": "ed830373d096f6b9f868e59c6182e0b2042e6bad", "nomatch": true}], "comment": "PVE hosts", "digest": "8c4a5e793355b2a877659315faaa78cbd0bc9f6c", "name": "hypervisors"}, {"cidrs": [{"cidr": "10.10.1.0", "comment": "Proxmox pve-01", "digest": "f15cef67632375227d849ee0a449d845ab136677", "nomatch": false}], "comment": "PVE hosts", "digest": "8c4a5e793355b2a877659315faaa78cbd0bc9f6c", "name": "test"}]

Авторы

  • Jana Hoch

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Сообщить о проблеме
  • Связь

© 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/community/proxmox/proxmox_firewall_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API