Spec-Zone.ru › Ansible

Модуль community.proxmox.proxmox_node_network_info — получение сведений о сетевых интерфейсах узлов Proxmox VE

Примечание

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

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

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

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

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

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

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

  • Получение сведений о сетевых интерфейсах узлов Proxmox VE.
  • Этот модуль не вносит изменений в систему.

Требования

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

  • 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.

check_changes

boolean

Проверять ли наличие ожидающих применения изменений конфигурации сети.

Если параметр включён, модуль возвращает только сведения о подготовленных изменениях, ожидающих применения.

Если параметр отключён (по умолчанию), модуль возвращает сведения о сетевых интерфейсах.

Этот параметр нельзя использовать одновременно с параметрами iface или iface_type, поскольку проверка ожидающих изменений выполняется на уровне узла.

Варианты:

  • false ← (по умолчанию)
  • true

iface

string

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

Если параметр не указан, возвращаются сведения обо всех интерфейсах.

iface_type

string

Фильтровать результаты по типу интерфейса.

Варианты:

  • "bridge"
  • "bond"
  • "eth"
  • "vlan"
  • "OVSBridge"
  • "OVSBond"
  • "OVSPort"
  • "OVSIntPort"

node

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

Узел Proxmox, сведения о сетевых интерфейсах которого нужно получить.

validate_certs

boolean

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

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

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

Варианты:

  • false
  • true

Атрибуты

Атрибут

Поддержка

Описание

action_group

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

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

check_mode

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

Режим проверки поддерживается полностью.

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

diff_mode

Поддержка: нет

Это информационный модуль, который не вносит изменений.

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

См. также

См. также

community.proxmox.proxmox_node_network

Управление сетевыми интерфейсами узлов Proxmox.

Настройка сети Proxmox

Документация по настройке сети Proxmox VE.

Документация API Proxmox

Документация API Proxmox VE.

Примеры

- name: Get all network interfaces on a node
  community.proxmox.proxmox_node_network_info:
    api_host: proxmox.example.com
    api_user: root@pam
    api_password: secret
    node: pve01

- name: Get information about a specific network interface
  community.proxmox.proxmox_node_network_info:
    api_host: proxmox.example.com
    api_user: root@pam
    api_password: secret
    node: pve01
    iface: vmbr0

- name: Get all bridge interfaces on a node
  community.proxmox.proxmox_node_network_info:
    api_host: proxmox.example.com
    api_user: root@pam
    api_password: secret
    node: pve01
    iface_type: bridge

- name: Check only for pending changes
  community.proxmox.proxmox_node_network_info:
    api_host: proxmox.example.com
    api_user: root@pam
    api_password: secret
    node: pve01
    check_changes: true

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

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

Ключ

Описание

has_pending_changes

boolean

Наличие ожидающих применения изменений конфигурации сети

Возвращается: при успешном выполнении, если check_changes имеет значение true

Пример: true

pending_changes

string

Ожидающие применения изменения конфигурации сети

Возвращается: при успешном выполнении, если check_changes имеет значение true

Пример: "--- /etc/network/interfaces\n+++ /etc/network/interfaces\n@@ -10,6 +10,12 @@\n # The primary network interface\n auto eth0\n iface eth0 inet dhcp\n+\n+# Bridge interface\n+auto vmbr1\n+iface vmbr1 inet static\n+        address 192.168.2.1/24\n+        bridge_ports eth1\n"

proxmox_node_networks

list / элементы=dictionary

Список сетевых интерфейсов узла

Возвращается: при успешном выполнении, если check_changes имеет значение false или не указан

Пример: [{"active": true, "address": "192.168.1.1", "autostart": true, "bridge_ports": "eth0", "cidr": "192.168.1.1/24", "exists": true, "families": ["inet"], "gateway": "192.168.1.254", "iface": "vmbr0", "method": "static", "mtu": 1500, "netmask": "255.255.255.0", "type": "bridge"}, {"active": true, "autostart": true, "bond-primary": "eth1", "bond_mode": "active-backup", "exists": true, "families": ["inet"], "iface": "bond0", "method": "manual", "mtu": 1500, "slaves": "eth1 eth2", "type": "bond"}]

Авторы

  • aleskxyz (@aleskxyz)

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

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

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

Spec-Zone.ru

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