Spec-Zone.ru › Ansible

Модуль containers.podman.podman_container_exec — выполняет команду в работающем контейнере.

Примечание

Этот модуль входит в коллекцию containers.podman (версия 1.20.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install containers.podman. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: containers.podman.podman_container_exec.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Выполняет команду в работающем контейнере.

Требования

На хосте, где выполняется этот модуль, необходимы следующие компоненты.

  • podman

Параметры

Параметр

Описание

argv

list / elements=string

Передаёт команду в виде списка, а не строки.

Необходимо указать один из параметров command или args.

command

string

Команда для выполнения в контейнере.

Необходимо указать один из параметров command или args.

detach

boolean

Если значение равно true, команда выполняется в фоновом режиме.

Сеанс exec автоматически удаляется после завершения.

Варианты:

  • false ← (по умолчанию)
  • true

env

dictionary

Задаёт переменные окружения.

executable

string

Путь к исполняемому файлу podman.

По умолчанию: "podman"

name

string / обязательный

Имя контейнера, в котором выполняется команда.

privileged

boolean

Предоставляет контейнеру расширенные привилегии.

Варианты:

  • false ← (по умолчанию)
  • true

tty

boolean

Выделяет псевдотерминал (TTY).

Варианты:

  • false ← (по умолчанию)
  • true

user

string

Имя пользователя или UID, а также, при необходимости, имя группы или GID для указанной команды.

И пользователь, и группа могут быть заданы символьным именем или числовым идентификатором.

workdir

string

Рабочий каталог внутри контейнера.

Примечания

Примечание

  • Подробные сведения о podman-exec(1) см. в документации Podman.

Примеры

- name: Execute a command with workdir
  containers.podman.podman_container_exec:
    name: ubi8
    command: "cat redhat-release"
    workdir: /etc

- name: Execute a command with a list of args and environment variables
  containers.podman.podman_container_exec:
    name: test_container
    argv:
      - /bin/sh
      - -c
      - echo $HELLO $BYE
    env:
      HELLO: hello world
      BYE: goodbye world

- name: Execute command in background by using detach
  containers.podman.podman_container_exec:
    name: detach_container
    command: "cat redhat-release"
    detach: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

exec_id

string

Идентификатор сеанса exec.

Возвращается: при успешном выполнении и detach=true

Пример: "f99002e34c1087fd1aa08d5027e455bf7c2d6b74f019069acf6462a96ddf2a47"

rc

integer

Код завершения команды, выполненной в контейнере.

Возвращается: при успешном выполнении

Пример: 0

stderr

string

Стандартный вывод команды, выполненной в контейнере.

Возвращается: при успешном выполнении

stdout

string

Стандартный вывод команды, выполненной в контейнере.

Возвращается: при успешном выполнении

Авторы

  • Takuya Nishimura (@nishipy)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/containers/podman/podman_container_exec_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API