community.proxmox Ansible Collection

A community-maintained collection containing plugins for interacting with Proxmox products such as Proxmox Virtual Environment (PVE). This collection serves as the new home for Proxmox-related content from community.general, as well as any new plugins/components.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

Requirements

Supported Ansible/Proxmox Versions

We aim to maintain a high level of compatibility between different versions of ansible-core, this collection and the Proxmox software releases. We currently test and support the following combinations:

Collection Version	ansible-core version	Proxmox Versions
0.1.z	2.15 and 2.16	PVE: 7.0 and newer

To run plugins from this collection, you will need a version of Python listed as compatible with your collection version in the table below.

Python

In addition to the control-node requirements from ansible-core see here, we also require a the following Python versions on target nodes:

Collection Version	Target Node Python
0.1.z	Python 3.7 or newer

Proxmoxer

Many of the plugins in this collection depend on the proxmoxer Python libary. The supported versions can vary between plugins, but in general we require at least proxmoxer=>2.0

Included content

Modules

See the modules directory for an up-to-date list of modules

Inventory Plugins

See the inventory directory for an up-to-date list of inventory plugins

Using this collection

Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install community.proxmox

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: community.proxmox

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install community.proxmox --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 0.1.0:

ansible-galaxy collection install community.proxmox:==0.1.0

See using Ansible collections for more details.

Installing Proxmoxer

Many plugins in this collection rely on the proxmoxer Python libary. You can check the Proxmoxer section in this README to find a supported version.

Once you know which version to install, you can run run:

# Recommended: use a virtualenv
pip install 'proxmoxer==<version>'

Or, using a requirements.txt file like below and install it with pip install -r requirements.txt

# requirements.txt contents:
proxmoxer==2.0.1

Communication

Communication related to the development of this collection mainly happens through the issues and pull requests in this repository. If you would like to raise an issue with us, this is the best way to get in touch!

We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a collection developer, be sure you are subscribed.

Join us on the Ansible forum in the Proxmox Collection Group

We take part in the global Ansible contributor summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible communication guide.

Contributing to this collection

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software. We are actively accepting new contributors and all types of contributions are very welcome.

The primary way to contribute to this collection is via issues and PRs opened against this repository. See the Contributing Guide for mode details.

In addition to the collection-specific guide, you may also want to refer to the following Ansible and Ansible-Community guides:

• Ansible community guide!
• Quick-start development guide.
• Collection review checklist
• Ansible development guide
• Ansible collection development guide

Collection maintenance

The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain/become a maintainer of this collection, refer to the Maintainer guidelines.

It is necessary for maintainers of this collection to be subscribed to:

• The collection itself (the Watch button -> All Activity in the upper right corner of the repository's homepage).
• The news-for-maintainers repository.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

Release notes

See the changelog.

More information

• Ansible user guide
• Ansible developer guide
• Ansible collections requirements
• Ansible community Code of Conduct
• The Bullhorn (the Ansible contributor newsletter)
• Important announcements for maintainers

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.