regex¶

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin

Synopsis¶

Compare string against regular expression using Python's match or search functions.

Parameter	Defaults / Choices	Comments
_input string required		String to match.
ignorecase boolean		Use case insensitive matching.
match_type string	Default: search Choices: match, search	Decide which function to be used to do the matching.
multiline boolean		Match against multiple lines in string.
pattern string required		Regex to match against.

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

Key	Data Type	Description	Returned
_value	boolean	Returns V(True) if there is a match, V(False) otherwise.