community.general.proxmox_tasks_info 模块 – 获取一个或多个 Proxmox VE 任务的信息

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，请参阅需求获取详细信息。

要在剧本中使用它，请指定：community.general.proxmox_tasks_info。

community.general 3.8.0 中的新增功能

概要 

检索一个或多个 Proxmox VE 任务的信息。

需求 

在执行此模块的主机上需要以下需求。

proxmoxer
requests

参数 

参数	注释
api_host 字符串 / 必需	指定 Proxmox VE 集群的目标主机。
api_password 字符串	指定用于身份验证的密码。您可以使用 `PROXMOX_PASSWORD` 环境变量。
api_port 整数 community.general 9.1.0 中新增	指定 Proxmox VE 集群的目标端口。如果未指定，则使用 `PROXMOX_PORT` 环境变量。
api_token_id 字符串 community.general 1.3.0 中新增	指定令牌 ID。需要 `proxmoxer>=1.1.0` 才能工作。
api_token_secret 字符串 community.general 1.3.0 中新增	指定令牌密钥。需要 `proxmoxer>=1.1.0` 才能工作。
api_user 字符串 / 必需	指定用于身份验证的用户。
node 字符串 / 必需	获取任务的节点。
task 别名：upid，name 字符串	返回特定任务。
validate_certs 布尔值	如果为 `false`，则不会验证 SSL 证书。这仅应在使用自签名证书的个人控制站点上使用。选项 `false` ← (默认) `true`

属性 

属性	支持	描述
action_group	动作组： community.general.proxmox community.general 9.0.0 中新增	在 `module_defaults` 中使用 `group/community.general.proxmox` 为此模块设置默认值。
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 下运行并返回更改状态预测，而无需修改目标。
diff_mode	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- 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

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
msg 字符串	简短消息。返回：失败时示例：`"Task: UPID:xyz:xyz does not exist on node: proxmoxnode"`
proxmox_tasks 列表 / 元素=字典	任务列表。返回：成功时
endtime 整数	任务的结束时间。返回：成功时，可以不存在
failed 布尔值	如果任务失败。返回：定义状态时
id 字符串	任务的 ID。返回：成功时
node 字符串	节点名称。返回：成功时
pid 整数	任务的 PID。返回：成功时
pstart 整数	任务的 pstart。返回：成功时
starttime 整数	任务的开始时间。返回：成功时
status 字符串	任务的状态。返回：成功时，可以不存在
type 字符串	任务的类型。返回：成功时
upid 字符串	任务的 UPID。返回：成功时
user 字符串	拥有该任务的用户。返回：成功时

作者

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