Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

config

string

Нужно ли получать конфигурацию виртуальной машины вместе с её состоянием.

Если задано значение none (по умолчанию), конфигурация не возвращается.

Если задано значение current, возвращается текущая конфигурация работающей виртуальной машины.

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

Варианты:

  • "none" ← (по умолчанию)
  • "current"
  • "pending"

name

string

Ограничить результаты указанными именами виртуальных машин.

Если виртуальных машин с указанным именем в кластере нет, возвращаемый список будет пустым.

network

boolean

Нужно ли получать текущее состояние сети.

Для виртуальных машин qemu требуется включённый и работающий qemu-guest-agent.

Варианты:

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

node

string

Ограничить результаты указанным узлом Proxmox VE.

type

string

Ограничить результаты указанным типом виртуальной машины.

Варианты:

  • "all" ← (по умолчанию)
  • "qemu"
  • "lxc"

validate_certs

boolean

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

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

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

Варианты:

  • false
  • true

vmid

integer

Ограничить результаты указанным идентификатором виртуальной машины.

Если виртуальной машины с указанным vmid в кластере нет, возвращаемый список будет пустым.

Атрибуты

Атрибут

Поддержка

Описание

action_group

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

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

check_mode

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

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

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

diff_mode

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

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

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

Примеры

- name: List all existing virtual machines on node
  community.proxmox.proxmox_vm_info:
    api_host: proxmoxhost
    api_user: root@pam
    api_token_id: '{{ token_id | default(omit) }}'
    api_token_secret: '{{ token_secret | default(omit) }}'
    node: node01

- name: List all QEMU virtual machines on node
  community.proxmox.proxmox_vm_info:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: '{{ password | default(omit) }}'
    node: node01
    type: qemu

- name: Retrieve information about specific VM by ID
  community.proxmox.proxmox_vm_info:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: '{{ password | default(omit) }}'
    node: node01
    type: qemu
    vmid: 101

- name: Retrieve information about specific VM by name and get current configuration
  community.proxmox.proxmox_vm_info:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: '{{ password | default(omit) }}'
    node: node01
    type: lxc
    name: lxc05.home.arpa
    config: current

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

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

Ключ

Описание

proxmox_vms

list / elements=dictionary

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

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

Пример: [{"cpu": 0.258944410905281, "cpus": 1, "disk": 0, "diskread": 0, "diskwrite": 0, "id": "qemu/100", "maxcpu": 1, "maxdisk": 34359738368, "maxmem": 4294967296, "mem": 35158379, "name": "pxe.home.arpa", "netin": 99715803, "netout": 14237835, "node": "pve", "pid": 1947197, "status": "running", "template": false, "type": "qemu", "uptime": 135530, "vmid": 100}, {"cpu": 0, "cpus": 1, "disk": 0, "diskread": 0, "diskwrite": 0, "id": "qemu/101", "maxcpu": 1, "maxdisk": 0, "maxmem": 536870912, "mem": 0, "name": "test1", "netin": 0, "netout": 0, "node": "pve", "status": "stopped", "template": false, "type": "qemu", "uptime": 0, "vmid": 101}]

Авторы

  • Sergei Antipov (@UnderGreen) <greendayonfire at gmail dot com>

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

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

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

Spec-Zone.ru

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