community.general.proxmox_tasks_info – Retrieve information about one or more Proxmox VE tasks

Note

This plugin is part of the community.general collection (version 3.8.1).

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.

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

New in version 3.8.0: of community.general

Synopsis
Requirements
Parameters
Examples
Return Values

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	Choices/Defaults	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 1.3.0 of community.general		Specify the token ID.
api_token_secret string added in 1.3.0 of community.general		Specify the token secret.
api_user string / required		Specify the user to authenticate with.
node string / required		Node where to get tasks.
task string		Return specific task. aliases: upid, name
validate_certs boolean	Choices: no ← yes	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: List tasks on node01
  community.general.proxmox_task_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_task_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		Returned	Description
msg string		on failure	Short message. Sample: Task: UPID:xyz:xyz does not exist on node: proxmoxnode
proxmox_tasks list / elements=dictionary		on success	List of tasks.
	endtime integer	on success, can be absent	Endtime of the task.
	failed boolean	when status is defined	If the task failed.
	id string	on success	ID of the task.
	node string	on success	Node name.
	pid integer	on success	PID of the task.
	pstart integer	on success	pastart of the task.
	starttime integer	on success	Starting time of the task.
	status string	on success, can be absent	Status of the task.
	type string	on success	Type of the task.
	upid string	on success	UPID of the task.
	user string	on success	User that owns the task.

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/proxmox_tasks_info_module.html