Spec-Zone.ru › Ansible

Модуль community.proxmox.proxmox_vnet_info — получение информации об одной или нескольких виртуальных сетях SDN Proxmox VE.

Примечание

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

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

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

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

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

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

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

  • Получение информации об одной или нескольких виртуальных сетях SDN 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.

validate_certs

boolean

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

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

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

Допустимые значения:

  • false
  • true

vnet

string

Ограничить результаты указанной виртуальной сетью.

Атрибуты

Атрибут

Поддержка

Описание

action_group

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

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

check_mode

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

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

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

diff_mode

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

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

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

Примеры

- name: Get all vnet details
  community.proxmox.proxmox_vnet_info:
    api_user: "{{ proxmox.api_user }}"
    api_token_id: "{{ proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ proxmox.api_host }}"
    validate_certs: false

- name: Get details for vnet - test
  community.proxmox.proxmox_vnet_info:
    api_user: "{{ proxmox.api_user }}"
    api_token_id: "{{ proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ proxmox.api_host }}"
    vnet: test
    validate_certs: false

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

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

Ключ

Описание

vnets

list / elements=dictionary

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

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

Пример: [{"digest": "01505201eb33919888fb0cacba27d3aae803f6d2", "firewall_rules": [], "subnets": [{"cidr": "10.10.100.0/24", "dhcp-range": [], "digest": "47684c511d9b67e8eb41b93bc5c0b078786b0ee3", "id": "lab-10.10.100.0-24", "mask": "24", "network": "10.10.100.0", "snat": 1, "subnet": "lab-10.10.100.0-24", "type": "subnet", "vnet": "lab", "zone": "lab"}], "tag": 100, "type": "vnet", "vnet": "lab", "zone": "lab"}, {"digest": "01505201eb33919888fb0cacba27d3aae803f6d2", "firewall_rules": [{"action": "ACCEPT", "dest": "+sdn/test2-gateway", "digest": "36016a02a5387d4c1171d29be966d550216bc500", "enable": 1, "log": "nolog", "macro": "DNS", "pos": 0, "type": "forward"}, {"action": "ACCEPT", "digest": "36016a02a5387d4c1171d29be966d550216bc500", "enable": 1, "log": "nolog", "macro": "DHCPfwd", "pos": 1, "type": "forward"}], "subnets": [{"cidr": "10.10.0.0/24", "dhcp-range": [{"end-address": "10.10.0.50", "start-address": "10.10.0.5"}], "digest": "47684c511d9b67e8eb41b93bc5c0b078786b0ee3", "gateway": "10.10.0.1", "id": "test1-10.10.0.0-24", "mask": "24", "network": "10.10.0.0", "subnet": "test1-10.10.0.0-24", "type": "subnet", "vnet": "test2", "zone": "test1"}, {"cidr": "10.10.1.0/24", "dhcp-range": [{"end-address": "10.10.1.50", "start-address": "10.10.1.5"}], "digest": "47684c511d9b67e8eb41b93bc5c0b078786b0ee3", "gateway": "10.10.1.0", "id": "test1-10.10.1.0-24", "mask": "24", "network": "10.10.1.0", "subnet": "test1-10.10.1.0-24", "type": "subnet", "vnet": "test2", "zone": "test1"}], "type": "vnet", "vnet": "test2", "zone": "test1"}]

Авторы

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

Spec-Zone.ru

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