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.13.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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
Parameters
Parameter |
Comments |
---|---|
Declares whether you accept the BIG-IP EULA or not. By default, this value is The EULA can be found here; https://support.f5.com/csp/article/K12902. This parameter is not required when Choices:
|
|
The list of addon keys to use to in conjunction with the base license. This parameter will be ignored if no This parameter is not required when |
|
Declares whether to force license renewal. By default, this value is This parameter is not required and will be ignored if it is provided. Choices:
|
|
The registration key to use to license the BIG-IP. This parameter is required if the This parameter is not required when |
|
The F5 license server to use when getting a license and validating a dossier. This parameter is required if the This parameter is not required when Default: “activate.f5.com” |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable |
|
The BIG-IP host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: 443 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
The state of the license on the system. When When When When Choices:
|
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)