community.proxmox.proxmox_node_info module – Retrieve information about one or more Proxmox VE nodes

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

Synopsis

  • Retrieve information about one or more Proxmox VE 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_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 nodes
  community.proxmox.proxmox_node_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_nodes

Return Values

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

Key

Description

proxmox_nodes

list / elements=dictionary

List of Proxmox VE nodes.

Returned: always, but can be empty

cpu

float

Current CPU usage in fractional shares of this host’s total available CPU.

Returned: on success

disk

integer

Current local disk usage of this host.

Returned: on success

id

string

Identity of the node.

Returned: on success

level

string

Support level. Can be blank if not under a paid support contract.

Returned: on success

maxcpu

integer

Total number of available CPUs on this host.

Returned: on success

maxdisk

integer

Size of local disk in bytes.

Returned: on success

maxmem

integer

Memory size in bytes.

Returned: on success

mem

integer

Used memory in bytes.

Returned: on success

node

string

Short hostname of this node.

Returned: on success

ssl_fingerprint

string

SSL fingerprint of the node certificate.

Returned: on success

status

string

Node status.

Returned: on success

type

string

Object type being returned.

Returned: on success

uptime

integer

Node uptime in seconds.

Returned: on success

Authors

  • John Berninger (@jwbernin)

© 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_node_info_module.html