Ansible Module command: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 16: Line 16:
- name: A command example
- name: A command example
   command: some-command arg1 arg2
   command: some-command arg1 arg2
    argv: ... # Passes the command as a list rather than a string
    cmd: ... # The command to run
    chdir: ... # Change into this directory before running the command
    stdin: ...
    stdin_add_newline: ...
    warn: ...
    creates: ...
   become: true
   become: true
   become_user: root
   become_user: root
Line 21: Line 28:
     chdir: /somedir/
     chdir: /somedir/
</syntaxhighlight>
</syntaxhighlight>
 
Also see: {{Internal|Ansible Privilege Escalation|Ansible Privilege Escalation}}
"become" and "become_user" are optional. Also see: {{Internal|Ansible Privilege Escalation|Ansible Privilege Escalation}}


=Registering Variables as Results of Command Execution=
=Registering Variables as Results of Command Execution=

Revision as of 05:50, 4 July 2021

External

Internal

Overview

The command module takes the command name followed by a list of space-delimited arguments.

A command will NOT be interpreted by a shell, so variables like $HOME and operations like "<", ">", "|", ";" and "&" will not work. Use the shelll module for that.

- name: A command example
  command: some-command arg1 arg2
    argv: ... # Passes the command as a list rather than a string
    cmd: ... # The command to run
    chdir: ... # Change into this directory before running the command
    stdin: ... 
    stdin_add_newline: ...
    warn: ...
    creates: ...
  become: true
  become_user: root
  args:
    chdir: /somedir/

Also see:

Ansible Privilege Escalation

Registering Variables as Results of Command Execution

This sets a variable:

- name: Read requested Java version
  command: "sh -c \"grep ^JAVA_VERSION {{ansible_env.HOME}}/config.txt | sed -e 's/.*=//'\""
  register: java_version
  changed_when: false

Setting Command Output as a Fact

Set the command output as a fact (see set_fact):

- name: Get Homebrew installation directory
  command: "sh -c \"brew --prefix\""
  register: brew_prefix_cmd
  changed_when: false

- name: Set Homebrew installation directory
  set_fact:
    pkg_manager_install_dir: "{{ brew_prefix_cmd.stdout }}"