ansible.builtin.search test – Does string match a regular expression
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
search
.
However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.search
for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same test plugin name.
Synopsis
Compare string against regular expression using Python’s
search
function.
Aliases: formerly_core_masked_test, formerly_core_test
Input
This describes the input of the test, the value before is ansible.builtin.search
or is not ansible.builtin.search
.
Parameter |
Comments |
---|---|
String to match. |
Keyword parameters
This describes keyword parameters of the test. These are the values key1=value1
, key2=value2
and so on in the following
examples: input is ansible.builtin.search(key1=value1, key2=value2, ...)
and input is not ansible.builtin.search(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
Use case insensitive matching. Choices:
|
|
Match against multiple lines in string. Choices:
|
|
Regex to match against. |
Examples
url: "https://example.com/users/foo/resources/bar"
foundmatch: url is search("https://example.com/users/.*/resources")
alsomatch: url is search("users/.*/resources")
Return Value
Key |
Description |
---|---|
Returns Returned: success |