summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/b64encode.yml
blob: 14676e515d2404fcdf95d2788e9fd2de599ca3b4 (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
DOCUMENTATION:
  name: b64encode
  author: ansible core team
  version_added: 'historical'
  short_description: Encode a string as base64
  description:
    - Base64 encoding function.
  positional: _input
  options:
    _input:
      description: A string to encode.
      type: string
      required: true

EXAMPLES: |
  # b64 encode a string
  b64lola: "{{ 'lola'|b64encode }}"

  # b64 encode the content of 'stuff' variable
  b64stuff: "{{ stuff|b64encode }}"

RETURN:
  _value:
    description: A base64 encoded string.
    type: string