Модуль 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. Если значение не указано, используется переменная окружения |
api_password string | Укажите пароль для аутентификации. Если значение не указано, используется переменная окружения |
api_port integer | Укажите целевой порт кластера Proxmox VE. Если значение не указано, используется переменная окружения |
api_timeout integer | Ограничение времени для запросов к API Proxmox VE. По умолчанию: |
api_token_id string | Укажите идентификатор токена. Если значение не указано, используется переменная окружения |
api_token_secret string | Укажите секретный ключ токена. Если значение не указано, используется переменная окружения |
api_user string / обязательный | Укажите пользователя для аутентификации. Если значение не указано, используется переменная окружения |
ca_path path | Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если |
config string | Нужно ли получать конфигурацию виртуальной машины вместе с её состоянием. Если задано значение Если задано значение Если задано значение Варианты:
|
name string | Ограничить результаты указанными именами виртуальных машин. Если виртуальных машин с указанным именем в кластере нет, возвращаемый список будет пустым. |
network boolean | Нужно ли получать текущее состояние сети. Для виртуальных машин qemu требуется включённый и работающий qemu-guest-agent. Варианты:
|
node string | Ограничить результаты указанным узлом Proxmox VE. |
type string | Ограничить результаты указанным типом виртуальной машины. Варианты:
|
validate_certs boolean | Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию задано Если значение не указано, используется переменная окружения Варианты:
|
vmid integer | Ограничить результаты указанным идентификатором виртуальной машины. Если виртуальной машины с указанным vmid в кластере нет, возвращаемый список будет пустым. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.proxmox.proxmox | Используйте |
check_mode | Поддержка: полная Это действие не изменяет состояние. | Может выполняться в |
diff_mode | Поддержка: Н/Д Это действие не изменяет состояние. | В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, потребуется изменить в |
Примеры
- 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 | Список виртуальных машин. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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