From d6cf98c1dc626d9d2350296f755579c2c4703d61 Mon Sep 17 00:00:00 2001 From: Xabi Date: Fri, 23 Feb 2018 16:25:23 +0100 Subject: [PATCH] Added how does it work section (fixes #4) Added some info about how does it work, requirements and features --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f02466..7ac9ed8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,22 @@ Proxmox dynamic inventory for Ansible. Based on [original plugin](https://raw.githubusercontent.com/ansible/ansible/devel/contrib/inventory/proxmox.py) from Mathieu Gauthier-Lafaye -Changelog: +### 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. + +### Requirements + +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* + + +### Features + +- **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 + + +### Changelog: - Added option to ignore invalid SSL certificate (by @bmillemathias) [PR](https://github.com/ansible/ansible/pull/17247) - Compatible with a Proxmox cluster (by @xezpeleta) - Added group 'running' (by @xezpeleta)