/ansible-collection-proxmox-fork

A collection for managing Proxmox VE hosts and their guests

Primary LanguagePython

maxhoesel.proxmox

Release Build Status License

A collection for managing Proxmox VE and Backup Server hosts. Contains roles for managing the PVE/PBS ecosystem, as well as modules to manage PBS configuration. With this collection, you can:

  • Perform basic setup of your PVE servers (configuring PVE repositories, root user access, CPU governor)
  • Configure a PBS server (including smart monitoring, etc.)
  • Install and configure the Proxmox Backup Client on supported systems
  • Manage Proxmox Backup Server users, repositories and permissions

Components

📘 Documentation

  • For role documentation, see their README.mds or the online docs here
  • For modules documentation, see the online docs here

Roles

  • lxc_container: Create and bootstrap LXC containers on Proxmox for Ansible access
  • lxc_container_to_ostemplate: Generate ostemplate (LXC container) images from existing LXC containers
  • pve: Perform basic system-level setup tasks on PVE nodes
  • pbs: Perform basic system-level setup tasks on Proxmox Backup Server hosts
  • pbs_client: Install and configure the Proxmox Backup Client

Modules

Proxmox VE

  • proxmox_ha: Manage High Availability settings for a VM/Container

Proxmox Backup Server

Installation

Dependencies

  • A recent release of Ansible. This collection officially supports the 2 most recent Ansible releases. Older versions might still work, but are not supported
  • Python 3.6 or newer on the target host
  • For module usage, the proxmoxer and requests python modules are required on the controller host

Individual roles or modules may have additional dependencies, please check their respective documentation.

Install

Via ansible-galaxy (recommended):

ansible-galaxy collection install maxhoesel.proxmox

Alternatively, you can download a collection archive from a previous release.

You can also clone this repository directly if you want a slightly more up-to-date (and potentially buggy) version.

ansible-galaxy collection install git+https://github.com/maxhoesel-ansible/ansible-collection-proxmox

License & Author

Created & Maintained by Max Hösel (@maxhoesel) and Contributors

Licensed under the GPL 3.0 or later