W3cubDocs

/Ansible

f5networks.f5_modules.license_hopper lookup – Return random license from list

Note

This lookup plugin is part of the f5networks.f5_modules collection (version 1.37.1).

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 f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.license_hopper.

New in f5networks.f5_modules 1.0.0

Synopsis

  • Select a random license key from a file and remove it from future lookups.
  • Can optionally remove the key if remove=True is specified.

Examples

- name: Get a regkey license from a stash without deleting it
  bigiq_regkey_license:
    key: "{{ lookup('license_hopper', 'filename=/path/to/licenses.txt') }}"
    state: present
    pool: regkey1

- name: Get a regkey license from a stash and delete the key from the file
  bigiq_regkey_license:
    key: "{{ lookup('license_hopper', 'filename=/path/to/licenses.txt', remove=True) }}"
    state: present
    pool: regkey1

Return Value

Key

Description

Return value

string

random item

Returned: success

Authors

  • Tim Rupp (@caphrim007)

© 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/f5networks/f5_modules/license_hopper_lookup.html