Note
This filter plugin is part of the community.general collection (version 10.7.3).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.hashids_encode.
New in community.general 3.0.0
This describes the input of the filter, the value before | community.general.hashids_encode.
Parameter | Comments |
|---|---|
Input list / elements=integer / required | A list of integers. |
This describes keyword parameters of the filter. These are the values key1=value1, key2=value2 and so on in the following example: input | community.general.hashids_encode(key1=value1, key2=value2, ...)
Parameter | Comments |
|---|---|
alphabet list / elements=string | String of 16 or more unique characters to produce a hash. |
min_length integer | Minimum length of hash produced. |
salt string | String to use as salt when hashing. Default: |
- name: Convert list of integers to hash
ansible.builtin.debug:
msg: "{{ [1, 2, 3] | community.general.hashids_encode }}"
# Produces: 'o2fXhV'
Key | Description |
|---|---|
Return value string | A YouTube-like hash. Returned: success |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/hashids_encode_filter.html