community.proxmox.proxmox_cluster module – Create and join Proxmox VE clusters

Note

This module is part of the community.proxmox collection (version 1.6.0).

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.proxmox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.proxmox.proxmox_cluster.

New in community.proxmox 1.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Create and join Proxmox VE clusters with PVE nodes.

Requirements

The below requirements are needed on the host that executes this module.

proxmoxer >= 2.0
requests

Parameters

Parameter	Comments
api_host string / required	Specify the target host of the Proxmox VE cluster. Uses the `PROXMOX_HOST` environment variable if not specified.
api_password string	Specify the password to authenticate with. Uses the `PROXMOX_PASSWORD` environment variable if not specified.
api_port integer	Specify the target port of the Proxmox VE cluster. Uses the `PROXMOX_PORT` environment variable if not specified.
api_timeout integer	Time limit for requests towards the Proxmox VE API. Default: `5`
api_token_id string	Specify the token ID. Uses the `PROXMOX_TOKEN_ID` environment variable if not specified.
api_token_secret string	Specify the token secret. Uses the `PROXMOX_TOKEN_SECRET` environment variable if not specified.
api_user string / required	Specify the user to authenticate with. Uses the `PROXMOX_USER` environment variable if not specified.
ca_path path	Path to a local certificate, which will be used to verify TLS connections. Ignored if `validate_certs=false`.
cluster_name string	The cluster name to use for cluster creation. Not used when joining a cluster.
fingerprint string	The fingerprint of the cluster master when joining the cluster.
link0 string	The first IP address to use for cluster communication.
link1 string	The second IP address to use for cluster communication.
master_api_password string	Specify the password to authenticate with the master node. Uses the api_password parameter if not specified.
master_ip string	The IP address of the cluster master when joining the cluster.
state string	Possible module state to perform the required steps within the Proxmox VE API. Choices: `"present"`
validate_certs boolean	Validate the TLS certificates used for the connection to the Proxmox VE API. Currently defaults to `false` and changes default to `true` with community.proxmox 2.0.0. Uses the `PROXMOX_VALIDATE_CERTS` environment variable if not specified. Choices: `false` `true`

Attributes

Attribute	Support	Description
action_group	Action group: community.proxmox.proxmox	Use `group/community.proxmox.proxmox` in `module_defaults` to set defaults for this module.
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Examples

- name: Create a Proxmox VE Cluster
  community.proxmox.proxmox_cluster:
    state: present
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    link0: 10.10.1.1
    link1: 10.10.2.1
    cluster_name: "devcluster"

- name: Join a Proxmox VE Cluster
  community.proxmox.proxmox_cluster:
    state: present
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    master_ip: "{{ primary_node }}"
    fingerprint: "{{ cluster_fingerprint }}"

- name: Join a Proxmox VE Cluster with different API password
  community.proxmox.proxmox_cluster:
    state: present
    api_host: proxmoxhost
    api_user: root@pam
    api_password: "{{ joining_node_api_password }}"
    master_api_password: "{{ master_node_api_password }}"
    master_ip: "{{ primary_node }}"
    fingerprint: "{{ cluster_fingerprint }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
cluster string	The name of the cluster that was created. Returned: success Sample: `"devcluster"`

Authors

Florian Paul Azim Hoberg (@gyptazy)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/proxmox/proxmox_cluster_module.html