ansible.builtin.regex test – Does string match regular expression from the start

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 regex. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.regex 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 match or search functions.

Input

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

Parameter

Comments

Input

string / required

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.regex(key1=value1, key2=value2, ...) and input is not ansible.builtin.regex(key1=value1, key2=value2, ...)

Parameter

Comments

ignorecase

boolean

Use case insensitive matching.

Choices:

  • false ← (default)

  • true

match_type

string

Decide which function to be used to do the matching.

Choices:

  • "match"

  • "search" ← (default)

multiline

boolean

Match against multiple lines in string.

Choices:

  • false ← (default)

  • true

pattern

string / required

Regex to match against.

Examples

url: "https://example.com/users/foo/resources/bar"
foundmatch: url is regex("example\.com/\w+/foo")

Return Value

Key

Description

Return value

boolean

Returns True if there is a match, False otherwise.

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.