Last updated on: 2024-01-16 03:25:50.

bigiq_regkey_license – Manages licenses in a BIG-IQ registration key pool

New in version 1.0.0.

Synopsis

  • Manages licenses in a BIG-IQ registration key pool.

Requirements

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

  • BIG-IQ >= 5.3.0

Parameters

Parameter Choices/Defaults Configuration Comments
accept_eula
boolean
    Choices:
  • no
  • yes
A key that signifies you accept the F5 EULA for this license.
A copy of the EULA can be found here https://askf5.f5.com/csp/article/K12902
This is required when state is present.
addon_keys
list / elements=string
added in 1.7.0
The addon keys to put in the pool.
description
string
Description of the license.
license_key
string / required
The license key to put in the pool.
regkey_pool
string / required
The registration key pool in which you want to place the license.
You must give your registration pools unique names. While BIG-IQ does not require this, this module does. If you do not, 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 license in the pool on the system.
When present, guarantees the license exists in the pool.
When absent, removes the license from the pool.

Examples

- name: Add a registration key license to a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    accept_eula: true

- name: Add a registration key license with addon keys to a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    addon_keys:
      - YYYY-YYY-YYY
      - ZZZZ-ZZZ-ZZZ
    accept_eula: true

- name: Remove a registration key license from a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
description
string
changed
The new description of the license key.

Sample:
My license for BIG-IP 1


Status

Authors

  • Wojciech Wypior (@wojtek0806)