community.general.proxmox inventory – Proxmox inventory source
Note
This inventory plugin is part of the community.general collection (version 4.8.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.proxmox.
New in version 1.2.0: of community.general
Synopsis
Get inventory hosts from a Proxmox PVE cluster.
Uses a configuration file as an inventory source, it must end in
.proxmox.ymlor.proxmox.yamlWill retrieve the first network interface with an IP for Proxmox nodes.
Can retrieve LXC/QEMU configuration as facts.
Requirements
The below requirements are needed on the local controller node that executes this inventory.
requests >= 1.1
Parameters
Parameter |
Comments |
|---|---|
Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work. Choices:
Configuration:
|
|
Cache connection data or path, read cache plugin documentation for specifics. Configuration:
|
|
Cache plugin to use for the inventory’s source data. Default: “memory” Configuration:
|
|
Prefix to use for cache plugin files/tables Default: “ansible_inventory_” Configuration:
|
|
Cache duration in seconds Default: 3600 Configuration:
|
|
Create vars from jinja2 expressions. Default: {} |
|
Prefix to apply to LXC/QEMU config facts. Default: “proxmox_” |
|
A list of Jinja templates that allow filtering hosts. Default: [] |
|
Prefix to apply to Proxmox groups. Default: “proxmox_” |
|
Add hosts to group based on Jinja2 conditionals. Default: {} |
|
Add hosts to group based on the values of a variable. Default: [] |
|
The default value when the host variable’s value is an empty string. This option is mutually exclusive with |
|
The key from input dictionary used to generate groups |
|
parent group for keyed group |
|
A keyed group name will start with this prefix Default: “” |
|
separator used to build the keyed group name Default: “_” |
|
Set this option to False to omit the This option is mutually exclusive with Choices:
|
|
Use in conjunction with keyed_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is “” and the default separator is “_”. Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. Choices:
|
|
Proxmox authentication password. If the value is not specified in the inventory configuration, the value of environment variable Since community.general 4.7.0 you can also use templating to specify the value of the password. If you do not specify a password, you must set token_id and token_secret instead. Configuration:
|
|
The name of this plugin, it should always be set to Choices:
|
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. Choices:
|
|
Proxmox authentication token ID. If the value is not specified in the inventory configuration, the value of environment variable To use token authentication, you must also specify token_secret. If you do not specify token_id and token_secret, you must set a password instead. Make sure to grant explicit pve permissions to the token or disable ‘privilege separation’ to use the users’ privileges instead. Configuration:
|
|
Proxmox authentication token secret. If the value is not specified in the inventory configuration, the value of environment variable To use token authentication, you must also specify token_id. If you do not specify token_id and token_secret, you must set a password instead. Configuration:
|
|
URL to Proxmox cluster. If the value is not specified in the inventory configuration, the value of environment variable Since community.general 4.7.0 you can also use templating to specify the value of the url. Default: “http://localhost:8006” Configuration:
|
|
Merge extra vars into the available variables for composition (highest precedence). Choices:
Configuration:
|
|
Proxmox authentication user. If the value is not specified in the inventory configuration, the value of environment variable Since community.general 4.7.0 you can also use templating to specify the value of the user. Configuration:
|
|
Verify SSL certificate if using HTTPS. Choices:
|
|
Gather LXC/QEMU configuration facts. Choices:
|
|
Whether to set When set to This currently defaults to Choices:
|
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
user: ansible@pve
password: secure
# Note that this can easily give you wrong values as ansible_host. See further below for
# an example where this is set to `false` and where ansible_host is set with `compose`.
want_proxmox_nodes_ansible_host: true
# Instead of login with password, proxmox supports api token authentication since release 6.2.
plugin: community.general.proxmox
user: ci@pve
token_id: gitlab-1
token_secret: fa256e9c-26ab-41ec-82da-707a2c079829
# The secret can also be a vault string or passed via the environment variable TOKEN_SECRET.
token_secret: !vault |
$ANSIBLE_VAULT;1.1;AES256
62353634333163633336343265623632626339313032653563653165313262343931643431656138
6134333736323265656466646539663134306166666237630a653363623262636663333762316136
34616361326263383766366663393837626437316462313332663736623066656237386531663731
3037646432383064630a663165303564623338666131353366373630656661333437393937343331
32643131386134396336623736393634373936356332623632306561356361323737313663633633
6231313333666361656537343562333337323030623732323833
# 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
groups:
webservers: "'web' in (proxmox_tags_parsed|list)"
mailservers: "'mail' in (proxmox_tags_parsed|list)"
compose:
ansible_port: 2222
# Note that this can easily give you wrong values as ansible_host. See further below for
# an example where this is set to `false` and where ansible_host is set with `compose`.
want_proxmox_nodes_ansible_host: true
# Using the inventory to allow ansible to connect via the first IP address of the VM / Container
# (Default is connection by name of QEMU/LXC guests)
# Note: my_inv_var demonstrates how to add a string variable to every host used by the inventory.
# my.proxmox.yml
plugin: community.general.proxmox
url: http://pve.domain.com:8006
user: ansible@pve
password: secure
validate_certs: false
want_facts: true
want_proxmox_nodes_ansible_host: false
compose:
ansible_host: proxmox_ipconfig0.ip | default(proxmox_net0.ip) | ipaddr('address')
my_inv_var_1: "'my_var1_value'"
my_inv_var_2: >
"my_var_2_value"
# Specify the url, user and password using templating
# my.proxmox.yml
plugin: community.general.proxmox
url: "{{ lookup('ansible.builtin.ini', 'url', section='proxmox', file='file.ini') }}"
user: "{{ lookup('ansible.builtin.env','PM_USER') | default('ansible@pve') }}"
password: "{{ lookup('community.general.random_string', base64=True) }}"
# Note that this can easily give you wrong values as ansible_host. See further up for
# an example where this is set to `false` and where ansible_host is set with `compose`.
want_proxmox_nodes_ansible_host: true
Authors
Jeffrey van Pelt (@Thulium-Drake)
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication