community.general.proxmox_tasks_info module – Retrieve information about one or more Proxmox VE tasks
Note
This module is part of the community.general collection (version 9.5.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.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_tasks_info
.
New in community.general 3.8.0
Synopsis
Retrieve information about one or more Proxmox VE tasks.
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 target port of the Proxmox VE cluster. Uses the |
|
Specify the token ID. Requires |
|
Specify the token secret. Requires |
|
Specify the user to authenticate with. |
|
Node where to get tasks. |
|
Return specific task. |
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Action group: community.general.proxmox added in community.general 9.0.0 |
Use |
|
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 tasks on node01
community.general.proxmox_tasks_info:
api_host: proxmoxhost
api_user: root@pam
api_password: '{{ password | default(omit) }}'
api_token_id: '{{ token_id | default(omit) }}'
api_token_secret: '{{ token_secret | default(omit) }}'
node: node01
register: result
- name: Retrieve information about specific tasks on node01
community.general.proxmox_tasks_info:
api_host: proxmoxhost
api_user: root@pam
api_password: '{{ password | default(omit) }}'
api_token_id: '{{ token_id | default(omit) }}'
api_token_secret: '{{ token_secret | default(omit) }}'
task: 'UPID:node01:00003263:16167ACE:621EE230:srvreload:networking:root@pam:'
node: node01
register: proxmox_tasks
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Short message. Returned: on failure Sample: |
|
List of tasks. Returned: on success |
|
Endtime of the task. Returned: on success, can be absent |
|
If the task failed. Returned: when status is defined |
|
ID of the task. Returned: on success |
|
Node name. Returned: on success |
|
PID of the task. Returned: on success |
|
pastart of the task. Returned: on success |
|
Starting time of the task. Returned: on success |
|
Status of the task. Returned: on success, can be absent |
|
Type of the task. Returned: on success |
|
UPID of the task. Returned: on success |
|
User that owns the task. Returned: on success |