summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/to_uuid.yml
blob: 266bf05fca69059ee80729830d31ccb2267a2a77 (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
DOCUMENTATION:
  name: to_uuid
  version_added: "2.9"
  short_description: namespaced UUID generator
  description:
    - Use to generate namespeced Universal Unique ID.
  positional: _input, namespace
  options:
    _input:
      description: String to use as base fo the UUID.
      type: str
      required: true
    namespace:
      description: UUID namespace to use.
      type: str
      default: 361E6D51-FAEC-444A-9079-341386DA8E2E

EXAMPLES: |

  # To create a namespaced UUIDv5
  uuid: "{{ string | to_uuid(namespace='11111111-2222-3333-4444-555555555555') }}"


  # To create a namespaced UUIDv5 using the default Ansible namespace '361E6D51-FAEC-444A-9079-341386DA8E2E'
  uuid: "{{ string | to_uuid }}"

RETURN:
  _value:
    description: Generated UUID.
    type: string