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 6.6.9).

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

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

node

string / required

Node where to get tasks.

task

aliases: upid, name

string

Return specific task.

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

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

msg

string

Short message.

Returned: on failure

Sample: "Task: UPID:xyz:xyz does not exist on node: proxmoxnode"

proxmox_tasks

list / elements=dictionary

List of tasks.

Returned: on success

endtime

integer

Endtime of the task.

Returned: on success, can be absent

failed

boolean

If the task failed.

Returned: when status is defined

id

string

ID of the task.

Returned: on success

node

string

Node name.

Returned: on success

pid

integer

PID of the task.

Returned: on success

pstart

integer

pastart of the task.

Returned: on success

starttime

integer

Starting time of the task.

Returned: on success

status

string

Status of the task.

Returned: on success, can be absent

type

string

Type of the task.

Returned: on success

upid

string

UPID of the task.

Returned: on success

user

string

User that owns the task.

Returned: on success

Authors

  • Andreas Botzner (@paginabianca) <andreas at botzner dot com>