ansible.builtin.ansible._protomatter.tagged_with test – does the value have the specified data tag

Note

This test plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name tagged_with. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.ansible._protomatter.tagged_with for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same test plugin name.

New in ansible._protomatter 2.19

Synopsis

  • Check if the provided value has the specified data tag.

Input

This describes the input of the test, the value before is ansible.builtin.ansible._protomatter.tagged_with or is not ansible.builtin.ansible._protomatter.tagged_with.

Parameter

Comments

Input

any

A value.

Examples

is_data_tagged: "{{ my_variable is ansible._protomatter.tagged_with('Origin') }}"

Return Value

Key

Description

Return value

boolean

Returns True if the value has the specified data tag, otherwise False.

Returned: success

Authors

  • Ansible Core

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.