containers.podman.podman_pod_info – Gather info about podman pods¶
Note
This plugin is part of the containers.podman collection (version 1.5.0).
To install it use: ansible-galaxy collection install containers.podman
.
To use it in a playbook, specify: containers.podman.podman_pod_info
.
New in version 1.0.0: of containers.podman
Requirements¶
The below requirements are needed on the host that executes this module.
Podman installed on host
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
executable
string
|
Default: "podman"
|
Path to
podman executable if it is not in the $PATH on the machine running podman |
name
string
|
Name of the pod
|
Examples¶
- name: Gather info about all present pods
containers.podman.podman_pod_info:
- name: Gather info about specific pods
containers.podman.podman_pod_info:
name: special_pod
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Sagi Shnaidman (@sshnaidm)