summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/url.yml
blob: 36b6c7706e4cf5fbb3a72eeff8716823000badee (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
DOCUMENTATION:
  name: url
  author: Ansible Core
  version_added: "2.14"
  short_description: is the string a valid URL
  description:
    - Validates a string to conform to the URL standard.
  options:
    _input:
      description: Possible URL.
      type: string
      required: True
    schemes:
      description: Subset of URI schemas to validate against, otherwise B(any) scheme is considered valid.
      type: list
      elements: string
EXAMPLES: |
  # simple URL
  {{ 'http://example.com' is url }}
  # looking only for file transfers URIs
  {{ 'mailto://nowone@example.com' is not uri(schemes=['ftp', 'ftps', 'sftp', 'file']) }}
  #  but it is according to standard
  {{ 'mailto://nowone@example.com' is not uri }}
  # more complex URL
  {{ 'ftp://admin:secret@example.com/path/to/myfile.yml' is url }}
RETURN:
  _value:
    description: Returns C(false) if the string is not a URL, C(true) otherwise.
    type: boolean