This repository has been archived on 2022-11-09. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
2021-09-07 20:59:56 +02:00
playbook-example Added a playbook example 2016-11-23 09:55:00 +01:00
.gitignore Add backwards compatability with openvz on Proxmox ver3 2017-03-05 18:51:30 +00:00 Update 2021-09-07 20:59:56 +02:00
proxmox.json.dist Addition of JSON config sample 2017-03-17 12:30:30 +01:00 Check if template key exists in api result 2021-07-24 08:41:46 +08:00 Changelog moved to 2021-05-09 20:10:51 +02:00 Fix typo in URL 2016-11-23 09:50:40 +01:00



Proxmox dynamic inventory for Ansible. Based on original plugin from Mathieu Gauthier-Lafaye

How does it work?

It will generate an inventory on the fly with all your VMs stored in your ProxmoxVE. Therefore, Ansible will be able to connect to all your VM.


Resolvable VM names: the inventory script collects the VM names (and not IP addresses!). That's why your computer must be able to resolve these names; either with the DNS server or your /etc/hosts


  • ProxmoxVE cluster: if your have a ProxmoxVE cluster, it will gather the whole VM list from your cluster
  • Advanced filtering: you can filter the VM list based in their status or a custom tag included in the Notes field


Download to /etc/ansible/ directory:

cd /etc/ansible
sudo wget
sudo chmod +x

Let's test it:

python /etc/ansible/ \
  --url=https://<your-proxmox-url>:8006/ \
  --username=<proxmox-username> \
  --password=<proxmox-password> \
  --trust-invalid-certs \
  --list --pretty

If you get a list with all the VM in your Proxmox cluster, everything is ok.

I suggest you to use environment variables to store Proxmox credentials:

# You also can do that using the file
# Run the command: "source"
export PROXMOX_USERNAME=apiuser@pve
export PROXMOX_PASSWORD=apiuser1234

You may also save your settings in a JSON file with the same name of the Python script, in its same folder (e.g.: if the downloaded script is /etc/ansible/, the configuration file will be /etc/ansible/proxmox.json):

    "url": "",
    "username": "apiuser@pve",
    "password": "apiuser1234",
    "validateCert": false

So now you can check it again without credential parameters:

python /etc/ansible/ --list --pretty

Once you get this working, you can include the dynamic inventory in your ansible commands:

# Ping: connect to all VM in Proxmox using root user
ansible -i /etc/ansible/ all -m ping -u root


If you prefer, you can limit the commands to the group "running":

# Run a playbook in every running VM in Proxmox
ansible-playbook -i /etc/ansible/ --limit='running' playbook-example/playbook.yml

Thanks to Matt Harris, you can now use the Notes field in Proxmox to add a host to a group:

Added support for Proxmox VE 4.x Added support for using the Notes field of a VM to define groups and variables: A well-formatted JSON object in the Notes field will be added to the _meta section for that VM. In addition, the "groups" key of this JSON object may be used to specify group membership:

{ "groups": ["utility", "databases"], "a": false, "b": true }

For instance, you can use the following JSON code in a VM host:

{ "groups": ["windows"] }

So if you want to exclude Windows machines, you could do the following:

# Run a playbook in every running Linux machine in Proxmox
ansible-playbook -i /etc/ansible/ --limit='running,!windows' playbook-example/playbook.yml


Show Linux distribution version for every VM in Proxmox cluster:

 ansible all -i /etc/ansible/ --limit 'running,!windows' -m setup -u root -a 'filter=ansible_distribution_*'

Check more info about Ansible setup module