f5networks.f5_bigip.bigiq_regkey_pool (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

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 C(bigiq_regkey_license) module.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - 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.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the regkey pool on the system.
    - When C(present), guarantees that the pool exists.
    - When C(absent), removes the pool, and the licenses it contains, from the system.
    type: str

description:
    description:
    - A description to attach to the pool.
    type: str

Outputs

description:
  description: New description of the regkey pool.
  returned: changed
  sample: My description
  type: str