summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/b64decode.yml
blob: 30565fa9c887e95e69efb2385ad9f4f52966bfec (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: b64decode
  author: ansible core team
  version_added: 'historical'
  short_description: Decode a base64 string
  description:
    - Base64 decoding function.
    - The return value is a string.
    - Trying to store a binary blob in a string most likely corrupts the binary. To base64 decode a binary blob,
      use the ``base64`` command  and pipe the encoded data through standard input. 
      For example, in the ansible.builtin.shell`` module, ``cmd="base64 --decode > myfile.bin" stdin="{{ encoded }}"``.
  positional: _input
  options:
    _input:
      description: A base64 string to decode.
      type: string
      required: true

EXAMPLES: |
  # b64 decode a string
  lola: "{{ 'bG9sYQ==' | b64decode }}"

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

RETURN:
  _value:
    description: The contents of the base64 encoded string.
    type: string