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

支持:

当处于 diff 模式时,将返回有关已更改的内容(或可能需要在 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

列表 / elements=string

给定进程的进程 ID

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

示例: [100, 200]

作者

  • Saranya Sridharan (@saranyasridharan)