community.general.random_string lookup – Генерация случайной строки

Примечание

Этот плагин поиска является частью коллекции community.general collection (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.random_string.

Новое в community.general 3.2.0

Краткое описание
Параметры ключевых слов
Примеры
Возвращаемое значение

Краткое описание

Генерирует случайную строку на основе заданных ограничений.
Использует random.SystemRandom, поэтому должна быть достаточно надежной для криптографических целей.

Параметры ключевых слов

Здесь описываются параметры ключевых слов поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('community.general.random_string', key1=value1, key2=value2, ...) и query('community.general.random_string', key1=value1, key2=value2, ...)

Параметр	Комментарии
base64 boolean	Возвращает строку, закодированную в base64. Варианты: `false` ← (по умолчанию) `true`
ignore_similar_chars boolean добавлено в community.general 7.5.0	Игнорировать похожие символы, такие как `l` и `1`, или `O` и `0`. Эти символы могут быть настроены в `similar_chars`. Варианты: `false` ← (по умолчанию) `true`
length integer	Длина строки. Значение по умолчанию: `8`
lower boolean	Включать строчные буквы в строку. Варианты: `false` `true` ← (по умолчанию)
min_lower integer	Минимальное количество строчных букв в строке. Если установлено, переопределяет `lower=false`. Значение по умолчанию: `0`
min_numeric integer	Минимальное количество числовых символов в строке. Если установлено, переопределяет `numbers=false`. Значение по умолчанию: `0`
min_special integer	Минимальное количество специальных символов в строке. Значение по умолчанию: `0`
min_upper integer	Минимальное количество прописных букв в строке. Если установлено, переопределяет `upper=false`. Значение по умолчанию: `0`
numbers boolean	Включать числа в строку. Варианты: `false` `true` ← (по умолчанию)
override_all string	Переопределить все значения `numbers`, `upper`, `lower` и `special` заданным списком символов.
override_special string	Переопределить список специальных символов для использования в строке. Если установлено, `min_special` должно быть установлено в значение, отличное от значения по умолчанию.
similar_chars string добавлено в community.general 7.5.0	Переопределить список символов, которые не следует использовать в строке. Значение по умолчанию: `"il1LoO0"`
special boolean	Включать специальные символы в строку. Специальные символы берутся из стандартной библиотеки Python `string`. Смотрите документацию string.punctuation, какие символы будут использоваться. Выбор специальных символов можно изменить, установив `override_special`. Варианты: `false` `true` ← (по умолчанию)
upper boolean	Включать прописные буквы в строку. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Generate random string
  ansible.builtin.debug:
    var: lookup('community.general.random_string')
  # Example result: 'DeadBeeF'

- name: Generate random string with length 12
  ansible.builtin.debug:
    var: lookup('community.general.random_string', length=12)
  # Example result: 'Uan0hUiX5kVG'

- name: Generate base64 encoded random string
  ansible.builtin.debug:
    var: lookup('community.general.random_string', base64=True)
  # Example result: 'NHZ6eWN5Qk0='

- name: Generate a random string with 1 lower, 1 upper, 1 number and 1 special char (at least)
  ansible.builtin.debug:
    var: lookup('community.general.random_string', min_lower=1, min_upper=1, min_special=1, min_numeric=1)
  # Example result: '&Qw2|E[-'

- name: Generate a random string with all lower case characters
  ansible.builtin.debug:
    var: query('community.general.random_string', upper=false, numbers=false, special=false)
  # Example result: ['exolxzyz']

- name: Generate random hexadecimal string
  ansible.builtin.debug:
    var: query('community.general.random_string', upper=false, lower=false, override_special=hex_chars, numbers=false)
  vars:
    hex_chars: '0123456789ABCDEF'
  # Example result: ['D2A40737']

- name: Generate random hexadecimal string with override_all
  ansible.builtin.debug:
    var: query('community.general.random_string', override_all=hex_chars)
  vars:
    hex_chars: '0123456789ABCDEF'
  # Example result: ['D2A40737']

Значение возврата

Ключ	Описание
Значение возврата список / элементы=строка	Список из одного элемента, содержащий случайную строку Возвращено: успешно

Авторы

Abhijeet Kasurde (@Akasurde)

Подсказка

Элементы конфигурации для каждого типа имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/random_string_lookup.html