Loading...

Watch: How to Run Only One Task in Ansible Playbook? - Ansible tags statement

How to select single or multiple tasks, include, import, play, block, and role in an Ansible Playbook using tags parameter of ansible-playbook command.

How to run only one task in an Ansible Playbook?

I'm going to show you a live Playbook with some simple Ansible code.

I'm Luca Berton and welcome to today's episode of Ansible Pilot.

How use tags statement in Ansible Playbook?

  • --tags all
  • --tags tag1
  • --tags [tag1, tag2]
  • --skip-tags [tag3, tag4]
  • --tags tagged
  • --tags untagged

Today we're talking about Ansible tags statement.

When your Ansible Playbook starts to grow up it's useful to define tags to allow a more granular execution.

You could define one or multiple tags at the individual task, include, import, play, block, role level.

Tags also could have tag inheritance properties.

The easiest way to run only one task in Ansible Playbook is using the tags statement parameter of the "ansible-playbook" command.

The default behavior is to execute all the tags in your Playbook with --tags all.

You could specify to execute a single tag with --tags tag1 or a list of tags --tags [tag1, tag2]

You could specify also and use the negate logic to exclude some tags--skip-tags [tag3, tag4].

Another convenient way is to execute only the code with tag --tags tagged or without --tags untagged.

Links

  • [Tags](https://docs.ansible.com/ansible/latest/user_guide/playbooks_tags.html)

## Playbook

How to run only one task in Ansible Playbook?

I'm going to show you one simple Ansible Playbook with two tasks and two tags and how to select one or another via the command line.

code

``yaml

---

  • name: tags Playbook

hosts: all

gather_facts: false

tasks:

- name: example 1

ansible.builtin.debug:

msg: "example 1"

tags: tag1

- name: example 2

ansible.builtin.debug:

msg: "example 2"

tags: tag2

`

execution default

`bash

$ ansible-playbook -i virtualmachines/demo/inventory variables/tags.yml

PLAY [tags Playbook] **

TASK [example 1] **

ok: [demo.example.com] => {

"msg": "example 1"

}

TASK [example 2] **

ok: [demo.example.com] => {

"msg": "example 2"

}

PLAY RECAP **

demo.example.com : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

``

execution

Read the full tutorial: How to Run Only One Task in Ansible Playbook? - Ansible tags statement