ansible.builtin.command – Выполнение команд на целевых узлах

• Описание
• Параметры
• Примечания
• См. также
• Примеры
• Возвращаемые значения

Описание

• Модуль command принимает имя команды, за которым следует список аргументов, разделённых пробелами.
• Указанная команда будет выполнена на всех выбранных узлах.
• Команда(ы) не будут обрабатываться через оболочку, поэтому переменные, такие как $HOSTNAME, и операции, такие как "*", "<", ">", "|", ";" и "&", не будут работать. Используйте модуль ansible.builtin.shell, если вам нужны эти возможности.
• Для создания command задач, которые легче читать, чем те, которые используют аргументы, разделённые пробелами, передавайте параметры с помощью ключевого слова args task или используйте параметр cmd.
• Требуется либо команда в свободном формате, либо параметр cmd, см. примеры.
• Для целевых узлов Windows используйте модуль ansible.windows.win_command.

Параметры

Примечания

См. также

Примеры

- name: Return motd to registered var
  ansible.builtin.command: cat /etc/motd
  register: mymotd

# free-form (string) arguments, all arguments on one line
- name: Run command if /path/to/database does not exist (without 'args')
  ansible.builtin.command: /usr/bin/make_database.sh db_user db_name creates=/path/to/database

# free-form (string) arguments, some arguments on separate lines with the 'args' keyword
# 'args' is a task keyword, passed at the same level as the module
- name: Run command if /path/to/database does not exist (with 'args' keyword)
  ansible.builtin.command: /usr/bin/make_database.sh db_user db_name
  args:
    creates: /path/to/database

# 'cmd' is module parameter
- name: Run command if /path/to/database does not exist (with 'cmd' parameter)
  ansible.builtin.command:
    cmd: /usr/bin/make_database.sh db_user db_name
    creates: /path/to/database

- name: Change the working directory to somedir/ and run the command as db_owner if /path/to/database does not exist
  ansible.builtin.command: /usr/bin/make_database.sh db_user db_name
  become: yes
  become_user: db_owner
  args:
    chdir: somedir/
    creates: /path/to/database

# argv (list) arguments, each argument on a separate line, 'args' keyword not necessary
# 'argv' is a parameter, indented one level from the module
- name: Use 'argv' to send a command as a list - leave 'command' empty
  ansible.builtin.command:
    argv:
      - /usr/bin/make_database.sh
      - Username with whitespace
      - dbname with whitespace
    creates: /path/to/database

- name: Safely use templated variable to run command. Always use the quote filter to avoid injection issues
  ansible.builtin.command: cat {{ myfile|quote }}
  register: myoutput

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

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

Авторы

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