FreeKB - Ansible register parameter (stdout stderr rc)
Ansible - register parameter (stdout stderr rc)

The register parameter can be used to store the standard output (stdout), standard error (stderr) and return code (rc) of a command. In this example, the stdout/stderr/rc of the ls (list) command will be stored in a variable named "out". 

- name: list command
  shell: "ls /tmp"
  register: out

 

You can then do something with the register, such as printing the output using the debug module, like this. Notice the double curley braces {{ ... }}. Jinja2 uses double curley braces for variables.

- name: standard out
  debug: 
    msg: "{{ out.stdout_lines }}"

- name: standard error
  debug: 
    msg: "{{ out.stderr_lines }}"

- name: return code
  debug: 
    msg: "{{ out.rc }}"

 

Running this playbook should return the following. In this example, standard out returns a file or directory in the /tmp directory named "foo", there was no standard error, and the return code is 0 (success).

TASK [list command]
ok: [server1.example.com]

TASK [standard out]
ok: [server1.example.com] => {
    "msg": "foo"
}

TASK [standard error]
ok: [server1.example.com] => {
    "msg": ""
}

TASK [return code]
ok: [server1.example.com] => {
    "msg": "0"
}

 



Add a Comment




We will never share your name or email with anyone. Enter your email if you would like to be notified when we respond to your comment.




Please enter 07d09 in the box below so that we can be sure you are a human.




Comments

Web design by yours truely - me, myself, and I   |   jeremy.canfield@freekb.net   |