Proxmox inventory source

An ansible plugin to source inventory from a Proxmox Cluster.

Installation

ansible-galaxy install mrsuicideparrot.proxmox_plugin

Similar projects

xezpeleta/Ansible-Proxmox-inventory is an inventory script. It offers definition of custom variables using Proxmox notes. However, ansible is deprecating inventory scripts. The new recomended way is to create an inventory plugin and package it as an Ansible Collection.

ansible-collections/community.general is an Ansible Collection that has an inventory plugin for Proxmox. This plugin doesn't support custom variables.

How to use it

If you want to use this plugin in your project, you first need to install it. Then, you need to create a new inventory. The file name needs to end with proxmox.yaml, for example my.proxmox.yaml.

The inventory must have the following content, filled with the appropriate credentials:

plugin: "mrsuicideparrot.proxmox_plugin.inventory"
url: https://localhost:8006
user: apiuser@pve
password: secure
validate_certs: True
group_tags: False

You should create a user with least privileges possible. You need the following privileges: VM.Audit, VM.Monitor, SDN.Audit, Sys.Audit, Pool.Audit, Datastore.Audit. For now, we don't support Proxmox API tokens, only passwords.

Finally, you activate the plugin by creating a galaxy.cfg in the repo directory.

[inventory]
enable_plugins = mrsuicideparrot.proxmox_plugin.inventory

You are now ready to source dynamically an inventory from your Proxmox Cluster.

You can check if everything is working by listing the inventory.

ansible-inventory --list -i my.proxmox.yml

You should see a list of nodes from your Proxmox Cluster.

Custom metadata

You can use the notes field in your Proxmox server to define variables. To leverage this feature, the notes should be a valid JSON.

This feature can also be used to assign groups to a machine.

{ "groups": ["windows", "utils"] }

If the VM has the qemu guest agent working or ,in the case of a container, it has a static IP configured, the variable ansible_host will be defined with the IP address of the machine.

A definition of multiple variables would be:

{ "groups": ["docker", "server"], "ansible_user":"root", "custom_variable":"things" }

Furthermore, if you enable group_tags you can use the tags you define for each virtual guest as ansible groups.

This feature requires at least Proxmox VE 7.3.

Requirements

None

---

Acknowledgments

This project was based on xezpeleta/Ansible-Proxmox-inventory.