community.general.proxmox_vm_info module – Retrieve information about one or more Proxmox VE virtual machines
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.proxmox_vm_info
.
New in community.general 7.2.0
Synopsis
Retrieve information about one or more Proxmox VE virtual machines.
Requirements
The below requirements are needed on the host that executes this module.
proxmoxer
requests
Parameters
Parameter |
Comments |
---|---|
Specify the target host of the Proxmox VE cluster. |
|
Specify the password to authenticate with. You can use |
|
Specify the token ID. Requires |
|
Specify the token secret. Requires |
|
Specify the user to authenticate with. |
|
Whether to retrieve the VM configuration along with VM status. If set to If set to If set to Choices:
|
|
Restrict results to a specific virtual machine(s) by using their name. If VM(s) with the specified name do not exist in a cluster then the resulting list will be empty. |
|
Restrict results to a specific Proxmox VE node. |
|
Restrict results to a specific virtual machine(s) type. Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
|
Restrict results to a specific virtual machine by using its ID. If VM with the specified vmid does not exist in a cluster then resulting list will be empty. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of virtual machines. Returned: on success Sample: |