From 2d6816e11e1672df5b2aa485e8af9eaa45d7c5be Mon Sep 17 00:00:00 2001 From: Ajpantuso Date: Tue, 31 Aug 2021 04:21:53 -0400 Subject: [PATCH] proxmox inventory plugin - Update examples documentation (#3299) * Initial commit * Update plugins/inventory/proxmox.py Co-authored-by: Felix Fontein --- plugins/inventory/proxmox.py | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/plugins/inventory/proxmox.py b/plugins/inventory/proxmox.py index 33a564f333..f52f0f1bb3 100644 --- a/plugins/inventory/proxmox.py +++ b/plugins/inventory/proxmox.py @@ -88,13 +88,24 @@ DOCUMENTATION = ''' ''' EXAMPLES = ''' +# Minimal example which will not gather additional facts for QEMU/LXC guests +# By not specifying a URL the plugin will attempt to connect to the controller host on port 8006 # my.proxmox.yml plugin: community.general.proxmox -url: http://localhost:8006 user: ansible@pve password: secure -validate_certs: no + +# More complete example demonstrating the use of 'want_facts' and the constructed options +# Note that using facts returned by 'want_facts' in constructed options requires 'want_facts=true' +# my.proxmox.yml +plugin: community.general.proxmox +url: http://pve.domain.com:8006 +user: ansible@pve +password: secure +validate_certs: false +want_facts: true keyed_groups: + # proxmox_tags_parsed is an example of a fact only returned when 'want_facts=true' - key: proxmox_tags_parsed separator: "" prefix: group