Spec-Zone.ru › Ansible 2.6

shell — Выполнение команд в узлах.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Поддержка
    • Автор

Описание

  • Модуль shell принимает имя команды, за которым следует список аргументов, разделенных пробелами. Он почти идентичен модулю command, но запускает команду через оболочку (/bin/sh) на удалённом узле.
  • Для целевых систем Windows используйте модуль win_shell.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
chdir
Перейти в указанный каталог перед выполнением команды
creates
имя файла; если файл уже существует, этот шаг не будет выполнен.
executable
изменить оболочку, используемую для выполнения команды. Должен быть абсолютный путь к исполняемому файлу.
free_form
обязательно
Модуль оболочки принимает свободную форму команды для выполнения в виде строки. Фактически нет параметра «свободная форма». См. примеры!
removes
имя файла; если файл не существует, этот шаг не будет выполнен.
stdin
(добавлен в версии 2.4)
Установить стандартный ввод команды напрямую на указанное значение.
warn
bool

(добавлен в версии 1.8)
    Варианты:
  • no
  • yes ←
Если в ansible.cfg включены предупреждения о командах, не выводить предупреждение об этой строке, если значение равно no/false.

Примечания

Примечание

  • Если нужно выполнить команду безопасно и предсказуемо, лучше использовать модуль command. В лучших практиках при написании playbooks предпочтение отдаётся модулю command, если модуль shell не требуется явно. При выполнении ad-hoc команд полагайтесь на свой опыт.
  • Чтобы очистить любые переменные, переданные модулю оболочки, используйте «{{ var | quote }}», а не просто «{{ var }}», чтобы убедиться, что они не содержат вредных символов, например, точки с запятой.
  • Для целевых систем Windows используйте модуль win_shell.
  • Вместо использования здесь документов для создания многострочных скриптов внутри playbooks, используйте модуль script.

Примеры

- name: Execute the command in remote shell; stdout goes to the specified file on the remote.
  shell: somescript.sh >> somelog.txt

- name: Change the working directory to somedir/ before executing the command.
  shell: somescript.sh >> somelog.txt
  args:
    chdir: somedir/

# You can also use the 'args' form to provide the options.
- name: This command will change the working directory to somedir/ and will only run when somedir/somelog.txt doesn't exist.
  shell: somescript.sh >> somelog.txt
  args:
    chdir: somedir/
    creates: somelog.txt

- name: Run a command that uses non-posix shell-isms (in this example /bin/sh doesn't handle redirection and wildcards together but bash does)
  shell: cat < /tmp/*txt
  args:
    executable: /bin/bash

- name: Run a command using a templated variable (always use quote filter to avoid injection)
  shell: cat {{ myfile|quote }}

# You can use shell to run other executables to perform actions inline
- name: Run expect to wait for a successful PXE boot via out-of-band CIMC
  shell: |
    set timeout 300
    spawn ssh admin@{{ cimc_host }}

    expect "password:"
    send "{{ cimc_password }}\n"

    expect "\n{{ cimc_name }}"
    send "connect host\n"

    expect "pxeboot.n12"
    send "\n"

    exit 0
  args:
    executable: /usr/bin/expect
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
cmd
строка
всегда
Команда, выполненная задачей

Пример:
rabbitmqctl join_cluster rabbit@master
delta
строка
всегда
Время выполнения команды (разница)

Пример:
0:00:00.325771
end
строка
всегда
Время окончания выполнения команды

Пример:
2016-02-25 09:18:26.755339
msg
логический тип
всегда
изменено

Пример:
True
rc
целое число
всегда
Код возврата команды (0 означает успех)

start
строка
всегда
Время начала выполнения команды

Пример:
2016-02-25 09:18:26.429568
stderr
строка
всегда
Стандартная ошибка команды

Пример:
ls: cannot access foo: No such file or directory
stdout
строка
всегда
Стандартный вывод команды

Пример:
Clustering node rabbit@slave1 with rabbit@master ...
stdout_lines
список
всегда
Стандартный вывод команды, разделенный по строкам

Пример:
["u'Clustering node rabbit@slave1 with rabbit@master ...'"]


Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут внесены несовместимые с предыдущими версиями изменения в интерфейс.

Техническое обслуживание

Этот модуль помечен как core, что означает, что он поддерживается командой Ansible Core Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются командой Ansible Core Team, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний.

Автор

  • Команда Ansible Core
  • Michael DeHaan

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете изменить его, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/shell_module.html

Spec-Zone.ru

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