community.general.random_pet lookup – Generates random pet names

Note

This lookup plugin is part of the community.general collection (version 11.4.0).

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. You need further requirements to be able to use this lookup plugin, see Requirements for details.

To use it in a playbook, specify: community.general.random_pet.

New in community.general 3.1.0

Synopsis

  • Generates random pet names that can be used as unique identifiers for the resources.

Requirements

The below requirements are needed on the local controller node that executes this lookup.

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('community.general.random_pet', key1=value1, key2=value2, ...) and query('community.general.random_pet', key1=value1, key2=value2, ...)

Parameter

Comments

length

integer

The maximal length of every component of the pet name.

Values below 3 are set to 3 by petname.

Default: 6

prefix

string

A string to prefix with the name.

separator

string

The character to separate words in the pet name.

Default: "-"

words

integer

The number of words in the pet name.

Default: 2

Examples

- name: Generate pet name
  ansible.builtin.debug:
    var: lookup('community.general.random_pet')
  # Example result: 'loving-raptor'

- name: Generate pet name with 3 words
  ansible.builtin.debug:
    var: lookup('community.general.random_pet', words=3)
  # Example result: 'fully-fresh-macaw'

- name: Generate pet name with separator
  ansible.builtin.debug:
    var: lookup('community.general.random_pet', separator="_")
  # Example result: 'causal_snipe'

- name: Generate pet name with length
  ansible.builtin.debug:
    var: lookup('community.general.random_pet', length=7)
  # Example result: 'natural-peacock'

Return Value

Key

Description

Return value

list / elements=string

A one-element list containing a random pet name.

Returned: success

Authors

  • Abhijeet Kasurde (@Akasurde)