secure_hash

Note

Always use the FQCN (Fully Qualified Collection Name) arista.avd.secure_hash when using this plugin.

Generate an EOS supported hash digest.

Synopsis

This filter generates an EOS supported hash digest. The algorithm for the hash is defined with the hash_type key. sha512_password can be used with the hash_type key to create a SHA-512 password hash from a cleartext password for a local user. By default, the secure_hash filter will use hash_type="sha512_password".

Each user should use a unique salt value to ensure that even if multiple users share the same password, their hashes will be unique.

Parameters

Argument	Type	Required	Default	Value Restrictions	Description
_input	string	True	None	-	The cleartext input to be hashed.
salt	string	optional	None	-	The salt value to be used when creating a password hash. The salt value can only contain the characters ./, digits 0-9, and uppercase or lowercase letters A-Z a-z. The salt value should not be greater than 16 characters long.
hash_type	string	optional	None	Valid values: - sha512_password	The hashing algorithm used will be based on the value of the hash_type key. Currently, only sha512_password is supported with hash_type and is set by default. sha512_password will generate a SHA-512 password hash from a cleartext password for a local user.

Examples

---
local_users:
  # Create a sha512 password hash with a user defined salt value (recommended). The hash_type will default to sha512_password.
  - name: cvpadmin
    sha512_password: "{{ 'securepassword' | arista.avd.secure_hash(salt='Yar49ahkzKddRVYS')}}"

    # Create a sha512 password hash with a user defined salt value and specifying the hash_type as a sha512_password.
  - name: cvpuser
    sha512_password: "{{ 'newpassword' | arista.avd.secure_hash(salt='Kte5paJ3czRQczbk', hash_type='sha512_password')}}"

Return Values

Name	Type	Description
_value	string	The hash digest

Authors

• Arista Ansible Team (@aristanetworks)