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

Note

This module is part of the community.general collection (version 9.4.0).

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

To use it in a playbook, specify: community.general.proxmox_node_info.

New in community.general 8.2.0

Synopsis

  • Retrieve information about one or more Proxmox VE nodes.

Requirements

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

  • proxmoxer

  • requests

Parameters

Parameter

Comments

api_host

string / required

Specify the target host of the Proxmox VE cluster.

api_password

string

Specify the password to authenticate with.

You can use PROXMOX_PASSWORD environment variable.

api_port

integer

added in community.general 9.1.0

Specify the target port of the Proxmox VE cluster.

Uses the PROXMOX_PORT environment variable if not specified.

api_token_id

string

added in community.general 1.3.0

Specify the token ID.

Requires proxmoxer>=1.1.0 to work.

api_token_secret

string

added in community.general 1.3.0

Specify the token secret.

Requires proxmoxer>=1.1.0 to work.

api_user

string / required

Specify the user to authenticate with.

validate_certs

boolean

If false, SSL certificates will not be validated.

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

Choices:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

action_group

Action group: community.general.proxmox

added in community.general 9.0.0

Use group/community.general.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.general.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)