Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • podman

Параметры

Параметр

Комментарии

argv

список / элементы=строка

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

Требуется один из параметров: command или args.

command

строка

Команда, которая должна быть выполнена в контейнере.

Требуется один из параметров: command или args.

detach

логическое

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

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

Варианты:

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

env

словарь

Установить переменные окружения.

executable

строка

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

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

name

строка / обязательно

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

privileged

логическое

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

Варианты:

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

tty

логическое

Выделить псевдо-TTY.

Варианты:

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

user

строка

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

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

workdir

строка

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

Примечания

Примечание

  • Подробную информацию о 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

строка

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

Возвращается: при успехе и detach=true

Пример: "f99002e34c1087fd1aa08d5027e455bf7c2d6b74f019069acf6462a96ddf2a47"

rc

целое число

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

Возвращается: при успехе

Пример: 0

stderr

строка

Стандартный поток ошибок (stderr) команды, выполненной в контейнере.

Возвращается: при успехе

stdout

строка

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

Возвращается: при успехе

Авторы

  • Takuya Nishimura (@nishipy)

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

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

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

Spec-Zone.ru

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