summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/password_hash.yml
blob: d12efb4c6a662bd9a971f26f492d34d9025719cb (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
31
32
33
34
35
36
37
DOCUMENTATION:
  name: password_hash
  version_added: "historical"
  short_description: convert input password into password_hash
  description:
    - Returns a password_hash of a secret.
  positional: _input
  notes:
    - Algorithms available might be restricted by the system.
  options:
    _input:
      description: Secret to hash.
      type: string
      required: true
    hashtype:
      description: Hashing algorithm to use.
      type: string
      default: sha512
      choices: [ md5, blowfish, sha256, sha512 ]
    salt:
      description: Secret string that is used for the hashing, if none is provided a random one can be generated.
      type: int
    rounds:
      description: Number of encryption rounds, default varies by algorithm used.
      type: int
    ident:
      description: Algorithm identifier.
      type: string

EXAMPLES: |
    # pwdhash => "$6$/bQCntzQ7VrgVcFa$VaMkmevkY1dqrx8neaenUDlVU.6L/.ojRbrnI4ID.yBHU6XON1cB422scCiXfUL5wRucMdLgJU0Fn38uoeBni/"
    pwdhash: "{{ 'testing' | password_hash }}"

RETURN:
  _value:
    description: The resulting password hash.
    type: string