summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/urn.yml
blob: 81a66863afac2e101a9ed7fda6ee09fedbbfc765 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: urn
  author: Ansible Core
  version_added: "2.14"
  short_description: is the string a valid URN
  description:
    - Validates that the input string conforms to the URN standard.
  options:
    _input:
      description: Possible URN.
      type: string
      required: True
EXAMPLES: |
  # ISBN in URN format
  {{ 'urn:isbn:9780302376463' is urn }}
  # this is URL/URI but not URN
  {{ 'mailto://nowone@example.com' is not urn }}
RETURN:
  _value:
    description: Returns C(true) if the string is a URN and C(false) if  it is not.
    type: boolean