f5networks.f5_bigip.bigiq_regkey_license (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 licenses in a BIG-IQ registration key pool.

Requirements

• BIG-IQ >= 5.3.0

Usage examples

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the regkey license in the pool on the system.
    - When C(present), guarantees the license exists in the pool.
    - When C(absent), removes the license from the pool.
    type: str

addon_keys:
    description:
    - The addon keys to put in the pool.
    elements: str
    type: list
    version_added: 1.7.0
    version_added_collection: f5networks.f5_bigip

accept_eula:
    description:
    - 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 C(state) is C(present).
    type: bool

description:
    description:
    - Description of the license.
    type: str

license_key:
    description:
    - The license key to put in the pool.
    required: true
    type: str

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

Outputs

description:
  description: The new description of the license key.
  returned: changed
  sample: My license for BIG-IP 1
  type: str