Steampunk Ansible Documentation - f5networks.f5_modules.bigip_device_license (1.28.0) - module - Manage license installation and activation on BIG-IP devices

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manage license installation and activation on a BIG-IP.

Usage examples

Scanned by Steampunk Spotter

- name: License BIG-IP using a key
  bigip_device_license:
    license_key: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
    provider:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: License BIG-IP using a key
  bigip_device_license:
    license_key: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
    provider:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Remove the license from the system
  bigip_device_license:
    state: "absent"
    provider:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
  delegate_to: localhost

Inputs

force:
default: false
description:
- Declares whether to force license renewal. By default, this value is C(false).
- This parameter is not required and will be ignored if it is provided.
type: bool

state:
choices:
- absent
- latest
- present
- revoked
default: present
description:
- The state of the license on the system.
- When C(present), only guarantees that a license exists.
- When C(absent), removes the license on the system.
- When C(latest), ensures that the license is always valid. This is not idempotent
state since re-run can modify result.
- When C(revoked), removes the license on the system and revokes its future usage
on the F5 license servers.
type: str

provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device for
either connecting or sending commands. If the timeout is exceeded before the
operation is completed, the module will error.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates are not validated. Use this only on personally controlled
sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules

addon_keys:
description:
- The list of addon keys to use to in conjunction with the base license.
- This parameter will be ignored if no C(license_key) is provided.
- This parameter is not required when C(state) is C(absent) and will be ignored if
it is provided.
elements: str
type: list
version_added: 1.2.0
version_added_collection: f5networks.f5_modules

accept_eula:
default: false
description:
- Declares whether you accept the BIG-IP EULA or not. By default, this value is C(false).
You must specifically declare you have viewed and accepted the license. This module
does not present you with the EULA, so it is incumbent on you to read it.
- The EULA can be found here; https://support.f5.com/csp/article/K12902.
- This parameter is not required when C(state) is C(absent) and will be ignored if
it is provided.
type: bool

license_key:
description:
- The registration key to use to license the BIG-IP.
- This parameter is required if the C(state) is equal to C(present) or C(latest).
- This parameter is not required when C(state) is C(absent) and will be ignored if
it is provided.
type: str

license_server:
default: activate.f5.com
description:
- The F5 license server to use when getting a license and validating a dossier.
- This parameter is required if the C(state) is equal to C(present) or C(latest).
- This parameter is not required when C(state) is C(absent) and will be ignored if
it is provided.
type: str