community.proxmox.proxmox_cluster_join_info module – Retrieve the join information of the Proxmox VE cluster

Note

This module is part of the community.proxmox collection (version 1.3.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_join_info.

New in community.proxmox 1.0.0

Synopsis

  • Retrieve the join information of the Proxmox VE cluster.

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_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.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Uses the PROXMOX_VALIDATE_CERTS environment variable if not specified.

Choices:

  • false ← (default)
  • 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

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: List existing Proxmox VE cluster join information
  community.proxmox.proxmox_cluster_join_info:
    api_host: proxmox1
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_cluster_join

Return Values

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

Key

Description

cluster_join

list / elements=dictionary

List of Proxmox VE nodes including the join information within the cluster.

Returned: always, but can be empty

config_digest

string

Digest of the cluster configuration.

Returned: success

Sample: "aef68412f7976505ed083e6173b96274a281da25"

nodelist

list / elements=dictionary

List of nodes in the cluster.

Returned: success

name

string

Node name.

Returned: success

Sample: "pve2"

nodeid

string

Node ID.

Returned: success

Sample: "1"

pve_addr

string

Proxmox VE address.

Returned: success

Sample: "10.10.10.159"

pve_fp

string

Proxmox VE fingerprint.

Returned: success

Sample: "08:B5:B2:F9:EC:01:0B:D0:..."

quorum_votes

string

Quorum votes assigned to the node.

Returned: success

Sample: "1"

ring0_addr

string

Address for ring0.

Returned: success

Sample: "vmbr0"

preferred_node

string

The preferred cluster node.

Returned: success

Sample: "pve2"

totem

dictionary

Totem protocol configuration.

Returned: success

cluster_name

string

Cluster name from totem.

Returned: success

Sample: "devcluster"

config_version

string

Config version.

Returned: success

Sample: "1"

interface

dictionary

Interface configuration.

Returned: success

ip_version

string

IP version.

Returned: success

Sample: "ipv4-6"

string

Link mode.

Returned: success

Sample: "passive"

secauth

string

Whether secure authentication is on.

Returned: success

Sample: "on"

version

string

Totem protocol version.

Returned: success

Sample: "2"

Authors

  • Florian Paul Azim Hoberg (@gyptazy)

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