summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/match.yml
blob: ecb4ae6569eb7407973e3a86cca71b4c2fb3b56c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
DOCUMENTATION:
  name: match
  author: Ansible Core
  short_description: Does string match regular expression from the start
  description:
    - Compare string against regular expression using Python's match function,
      this means the regex is automatically anchored at the start of the string.
  options:
    _input:
      description: String to match.
      type: string
      required: True
    pattern:
      description: Regex to match against.
      type: string
      required: True
    ignorecase:
      description: Use case insenstive matching.
      type: boolean
      default: False
    multiline:
      description: Match against mulitple lines in string.
      type: boolean
      default: False
EXAMPLES: |
  url: "https://example.com/users/foo/resources/bar"
  foundmatch: url is match("https://example.com/users/.*/resources")
  nomatch: url is match("/users/.*/resources")
RETURN:
  _value:
    description: Returns C(True) if there is a match, C(False) otherwise.
    type: boolean