community / community.general / 8.5.0 / module / proxmox_vm_info Retrieve information about one or more Proxmox VE virtual machines | "added in version" 7.2.0 of community.general" Authors: Sergei Antipov (@UnderGreen) <greendayonfire at gmail dot com>community.general.proxmox_vm_info (8.5.0) — module
Install with ansible-galaxy collection install community.general:==8.5.0
collections: - name: community.general version: 8.5.0
Retrieve information about one or more Proxmox VE virtual machines.
- 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
name: description: - 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. type: str node: description: - Restrict results to a specific Proxmox VE node. type: str type: choices: - all - qemu - lxc default: all description: - Restrict results to a specific virtual machine(s) type. type: str vmid: description: - 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. type: int config: choices: - none - current - pending default: none description: - Whether to retrieve the VM configuration along with VM status. - If set to V(none) (default), no configuration will be returned. - If set to V(current), the current running configuration will be returned. - If set to V(pending), the configuration with pending changes applied will be returned. type: str version_added: 8.1.0 version_added_collection: community.general api_host: description: - Specify the target host of the Proxmox VE cluster. required: true type: str api_user: description: - Specify the user to authenticate with. required: true type: str api_password: description: - Specify the password to authenticate with. - You can use E(PROXMOX_PASSWORD) environment variable. type: str api_token_id: description: - Specify the token ID. - Requires C(proxmoxer>=1.1.0) to work. type: str version_added: 1.3.0 version_added_collection: community.general validate_certs: default: false description: - If V(false), SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates. type: bool api_token_secret: description: - Specify the token secret. - Requires C(proxmoxer>=1.1.0) to work. type: str version_added: 1.3.0 version_added_collection: community.general
proxmox_vms: description: List of virtual machines. elements: dict returned: on success sample: - 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 type: list