Last updated on: 2024-04-01 03:24:20.

bigiq_regkey_pool – Manages registration key pools on BIG-IQ

New in version 1.0.0.

Synopsis

  • Manages registration key (regkey) pools on a BIG-IQ. These pools function as a container in-which you will add lists of registration keys. To add registration keys, use the bigiq_regkey_license module.

Parameters

Parameter Choices/Defaults Configuration Comments
description
string
A description to attach to the pool.
name
string / required
Specifies the name of the registration key pool.
You must be mindful to name your registration pools unique names. While BIG-IQ does not require this, this module does. If you do not do this, the behavior of the module is undefined and you may end up putting licenses in the wrong registration key pool.
state
string
    Choices:
  • absent
  • present ←
The state of the regkey pool on the system.
When present, guarantees that the pool exists.
When absent, removes the pool, and the licenses it contains, from the system.

Examples

- name: Create a registration key (regkey) pool to hold individual device licenses
  bigiq_regkey_pool:
    name: foo-pool
    state: present

Return Values

The following are the fields unique to this module:

Key Returned Description
description
string
changed
New description of the regkey pool.

Sample:
My description


Status

Authors

  • Wojciech Wypior (@wojtek0806)