community.proxmox.proxmox_cluster_status_info module – Retrieve Proxmox VE cluster status information

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

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Retrieve status information about the Proxmox VE cluster.
Returns information about both the cluster itself and the nodes within it.

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`.
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 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: Get cluster status
  community.proxmox.proxmox_cluster_status_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: cluster_status

- name: Display cluster quorum status
  ansible.builtin.debug:
    msg: "Cluster has quorum: {{ cluster_status.cluster_status | selectattr('type', 'equalto', 'cluster') | map(attribute='quorate') | first }}"

Return Values

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

Key	Description
cluster_status list / elements=dictionary	List containing cluster and node status information. Returned: always, but can be empty
id string	Unique identifier for the entry. Returned: always
ip string	IP address of the resolved nodename. Returned: when type is ‘node’
level string	Proxmox VE Subscription level, indicates if eligible for enterprise support. Returned: when type is ‘node’
local boolean	Indicates if this is the responding node. Returned: when type is ‘node’
name string	Name of the cluster or node. Returned: always
nodeid integer	ID of the node from the corosync configuration. Returned: when type is ‘node’
nodes integer	Total count of nodes in the cluster, including offline nodes. Returned: when type is ‘cluster’
online boolean	Indicates if the node is online or offline. Returned: when type is ‘node’
quorate boolean	Indicates if there is a majority of nodes online to make decisions. Returned: when type is ‘cluster’
type string	Type of entry, either ‘cluster’ or ‘node’. Returned: always
version integer	Current version of the corosync configuration file. Returned: when type is ‘cluster’

Authors

Michael Dombek (@michaelwdombek)

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_status_info_module.html