f5networks.f5_modules.bigip_lx_package module – Manages Javascript LX packages on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: f5networks.f5_modules.bigip_lx_package
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages Javascript LX packages on a BIG-IP. This module allows you to deploy LX packages to the BIG-IP and manage their lifecycle.
Requirements
The below requirements are needed on the host that executes this module.
Requires BIG-IP >= 12.1.0
The ‘rpm’ tool installed on the Ansible controller
Parameters
Parameter |
Comments |
---|---|
The LX package that you want to upload or remove. When When |
|
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 or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ 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: |
|
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 or the BIG-IQ. 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:
|
|
Specifies whether the install file should be deleted on successful installation of the package. Choices:
|
|
Whether the LX package should exist or not. Choices:
|
Notes
Note
Requires the RPM tool be installed on the host. This can be accomplished in different ways on each platform. On Debian based systems with
apt
;apt-get install rpm
. On Mac withbrew
;brew install rpm
. This command is already present on RedHat based systems.Requires BIG-IP >= 12.1.0, because the required functionality is missing on prior versions.
The module name
bigip_iapplx_package
has been deprecated in favor ofbigip_lx_package
.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: Install AS3
bigip_lx_package:
package: f5-appsvcs-3.5.0-3.noarch.rpm
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add an LX package stored in a role
bigip_lx_package:
package: "{{ roles_path }}/files/MyApp-0.1.0-0001.noarch.rpm'"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove an LX package
bigip_lx_package:
package: MyApp-0.1.0-0001.noarch.rpm
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Install AS3 and don't delete package file
bigip_lx_package:
package: f5-appsvcs-3.5.0-3.noarch.rpm
retain_package_file: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost