f5networks.f5_modules.bigip_device_license – Manage license installation and activation on BIG-IP devices

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_device_license.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manage license installation and activation on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
accept_eula
boolean
    Choices:
  • no ←
  • yes
Declares whether you accept the BIG-IP EULA or not. By default, this value is no. 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 state is absent and will be ignored if it is provided.
addon_keys
list / elements=string
added in 1.2.0 of f5networks.f5_modules
The list of addon keys to use to in conjunction with the base license.
This parameter will be ignored if no license_key is provided.
This parameter is not required when state is absent and will be ignored if it is provided.
force
boolean
    Choices:
  • no ←
  • yes
Declares whether to force license renewal. By default, this value is no.
This parameter is not required and will be ignored if it is provided.
license_key
string
The registration key to use to license the BIG-IP.
This parameter is required if the state is equal to present or latest.
This parameter is not required when state is absent and will be ignored if it is provided.
license_server
string
Default:
"activate.f5.com"
The F5 license server to use when getting a license and validating a dossier.
This parameter is required if the state is equal to present or latest.
This parameter is not required when state is absent and will be ignored if it is provided.
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
A dict object containing connection details.
auth_provider
string
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
no_f5_teem
boolean
    Choices:
  • no
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
timeout
integer
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.
transport
string
    Choices:
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If 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 F5_VALIDATE_CERTS.
state
string
    Choices:
  • absent
  • latest
  • present ←
  • revoked
The state of the license on the system.
When present, only guarantees that a license exists.
When absent, removes the license on the system.
When latest, ensures that the license is always valid. This is not idempotent state since re-run can modify result.
When revoked, removes the license on the system and revokes its future usage on the F5 license servers.

Notes

Note

  • This module can be used to license BIG-IPs that do not have access to internet.

  • Only the Ansible Controller needs internet access as the license activation is done on the Ansible Controller from which the module is running.

  • For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.

  • Requires BIG-IP software version >= 12.

  • The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- 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

- 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

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

Authors

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)

  • Andrey Kashcheev (@andreykashcheev)