-
-

containers.podman.podman – Interact with an existing podman container

+
+

containers.podman.podman connection – Interact with an existing podman container

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This connection plugin is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.podman.

- -
-

Synopsis

+ +
+

Synopsis

  • Run commands or put/fetch files to an existing container using podman tool.

+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+

podman_executable

+

string

+

Executable for podman command.

+

Default: "podman"

+

Configuration:

+ +
+

podman_extra_args

+

string

+

Extra arguments to pass to the podman command line.

+

Default: ""

+

Configuration:

+
    +

  • INI entry:

    +
    [defaults]
+podman_extra_args = ""
+
    +
    +
    • +

  • Environment variable: ANSIBLE_PODMAN_EXTRA_ARGS

    • +

  • Variable: ansible_podman_extra_args

    • +
+
+

remote_addr

+

string

+

The ID of the container you want to access.

+

Default: "inventory_hostname"

+

Configuration:

+
    +

  • Variable: ansible_host

    • +

  • Variable: inventory_hostname

    • +

  • Variable: ansible_podman_host

    • +
+
+

remote_user

+

string

+

User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set ANSIBLE_REMOTE_TMP to a path that exits inside the container and is writable by Ansible.

+

Configuration:

+
    +

  • INI entry:

    +
    [defaults]
+remote_user = VALUE
+
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterChoices/DefaultsConfigurationComments
    -
    - podman_executable - -
    - string -
    -     		- Default:
    "podman"
    -     		-
    - env:ANSIBLE_PODMAN_EXECUTABLE -
    -
    - var: ansible_podman_executable -
    -     		-
    Executable for podman command.
    -
    -
    - podman_extra_args - -
    - string -
    -     		- Default:
    ""
    -     		-
    ini entries: -

    - [defaults]
    podman_extra_args = -

    -
    -
    - env:ANSIBLE_PODMAN_EXTRA_ARGS -
    -
    - var: ansible_podman_extra_args -
    -     		-
    Extra arguments to pass to the podman command line.
    -
    -
    - remote_addr - -
    - string -
    -     		- Default:
    "inventory_hostname"
    -     		-
    - var: ansible_host -
    -
    - var: inventory_hostname -
    -
    - var: ansible_podman_host -
    -     		-
    The ID of the container you want to access.
    -
    -
    - remote_user - -
    - string -
    -     		- -
    ini entries: -

    - [defaults]
    remote_user = None -

    -
    -
    - env:ANSIBLE_REMOTE_USER -
    -
    - var: ansible_user -
    -     		-
    User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set ANSIBLE_REMOTE_TMP to a path that exits inside the container and is writable by Ansible.
    -
    -
    +
    • +

  • Environment variable: ANSIBLE_REMOTE_USER

    • +

  • Variable: ansible_user

    • +
+
+

Authors

  • Tomas Tomecek (@TomasTomecek)

+
+

Hint

+

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

-
-
+ + + +