community.general.pids – Retrieves process IDs list if the process is running otherwise return empty list

From Get docs
Ansible/docs/2.11/collections/community/general/pids module


community.general.pids – Retrieves process IDs list if the process is running otherwise return empty list

Note

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

To install it use: ansible-galaxy collection install community.general.

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


Synopsis

  • Retrieves a list of PIDs of given process name in Ansible controller/controlled machines.Returns an empty list if no process in that name exists.

Requirements

The below requirements are needed on the host that executes this module.

  • psutil(python module)

Parameters

Parameter Choices/Defaults Comments

name

string / required

the name of the process you want to get PID for.



Examples

# 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(',')}}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

pids

list / elements=string

list of none, one, or more process IDs

Process IDs of the given process


Sample:

[100, 200]




Authors

  • Saranya Sridharan (@saranyasridharan)

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