community.general.pids 模块 – 获取正在运行进程的进程 ID 列表,否则返回空列表

注意

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

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

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

要在 playbook 中使用它,请指定:community.general.pids

概要

  • 在 Ansible 控制器/受控机器中检索给定进程名称的 PID 列表。如果不存在该名称的进程,则返回空列表。

要求

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

  • psutil(Python 模块)

参数

参数

注释

ignore_case

布尔值

在 community.general 3.0.0 中添加

如果使用 pattern 选项,则忽略模式中的大小写。

选项

  • false ← (默认)

  • true

name

字符串

您想要获取 PID 的进程的名称。

pattern

字符串

在 community.general 3.0.0 中添加

用于匹配您想要获取 PID 的进程的模式(正则表达式)。

属性

属性

支持

描述

check_mode

支持:完全支持

可以在 check_mode 中运行,并在不修改目标的情况下返回更改状态预测。

diff_mode

支持:不支持

在差异模式下,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息。

示例

# Pass the process name
- name: Getting process IDs of the process
  community.general.pids:
      name: python
  register: pids_of_python

- name: Printing the process IDs obtained
  ansible.builtin.debug:
    msg: "PIDS of python:{{pids_of_python.pids|join(',')}}"

- name: Getting process IDs of processes matching pattern
  community.general.pids:
    pattern: python(2(\.7)?|3(\.6)?)?\s+myapp\.py
  register: myapp_pids

返回值

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

描述

pids

列表 / 元素=字符串

给定进程的进程 ID

返回:零个、一个或多个进程 ID 的列表

示例:[100, 200]

作者

  • Saranya Sridharan (@saranyasridharan)