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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

Для использования в playbook, укажите: community.general.proxmox_vm_info.

Новое в community.general 7.2.0

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

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

Получение информации об одной или нескольких виртуальных машинах Proxmox VE.

Требования

Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательно	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Можно использовать переменную окружения `PROXMOX_PASSWORD`.
api_port целое число добавлено в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Использует переменную окружения `PROXMOX_PORT`, если не указано.
api_token_id строка добавлено в community.general 1.3.0	Укажите ID токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлено в community.general 1.3.0	Укажите секретный ключ токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательно	Укажите пользователя для аутентификации.
config строка добавлено в community.general 8.1.0	Включать ли конфигурацию ВМ вместе со статусом ВМ. Если установлено в `none` (по умолчанию), конфигурация возвращаться не будет. Если установлено в `current`, будет возвращена текущая запущенная конфигурация. Если установлено в `pending`, будет возвращена конфигурация с примененными ожидающими изменениями. Варианты: `"none"` ← (по умолчанию) `"current"` `"pending"`
name строка	Ограничить результаты до определенной виртуальной машины(машин) по их имени. Если ВМ с указанным именем не существует в кластере, то результирующий список будет пустым.
network булево добавлено в community.general 9.1.0	Получать ли текущий статус сети. Требует включенного/запущенного qemu-guest-agent на qemu ВМ. Варианты: `false` ← (по умолчанию) `true`
node строка	Ограничить результаты до определенного узла Proxmox VE.
type строка	Ограничить результаты до определенного типа виртуальной машины(машин). Варианты: `"all"` ← (по умолчанию) `"qemu"` `"lxc"`
validate_certs булево	Если `false`, SSL-сертификаты проверяться не будут. Это следует использовать только на лично контролируемых сайтах, использующих самоподписанные сертификаты. Варианты: `false` ← (по умолчанию) `true`
vmid целое число	Ограничить результаты до определенной виртуальной машины по ее ID. Если ВМ с указанным vmid не существует в кластере, то результирующий список будет пустым.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.proxmox добавлен в community.general 9.0.0	Используйте `group/community.general.proxmox` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз статуса изменения без изменения целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	В режиме diff будет возвращена информация о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примеры

- name: List all existing virtual machines on node
  community.general.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.general.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.general.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.general.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 список / элементы=словарь	Список виртуальных машин. Возвращается: при успехе Пример: [{"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}]

Ключ

Описание

proxmox_vms

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

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

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

Пример: [{"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}]

Авторы

Сергей Антипов (@UnderGreen) <greendayonfire at gmail dot com>

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

© 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/community/general/proxmox_vm_info_module.html