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 8.6.4).
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.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 |
---|---|
Specify the target host of the Proxmox VE cluster. |
|
Specify the password to authenticate with. You can use |
|
Specify the token ID. Requires |
|
Specify the token secret. Requires |
|
Specify the user to authenticate with. |
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
List of Proxmox VE nodes. Returned: always, but can be empty |
|
Current CPU usage in fractional shares of this host’s total available CPU. Returned: on success |
|
Current local disk usage of this host. Returned: on success |
|
Identity of the node. Returned: on success |
|
Support level. Can be blank if not under a paid support contract. Returned: on success |
|
Total number of available CPUs on this host. Returned: on success |
|
Size of local disk in bytes. Returned: on success |
|
Memory size in bytes. Returned: on success |
|
Used memory in bytes. Returned: on success |
|
Short hostname of this node. Returned: on success |
|
SSL fingerprint of the node certificate. Returned: on success |
|
Node status. Returned: on success |
|
Object type being returned. Returned: on success |
|
Node uptime in seconds. Returned: on success |