bigip_lx_package – Manages Javascript LX packages on a BIG-IP — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_lx_package – Manages Javascript LX packages on a BIG-IP

New in version 2.5.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Manages Javascript LX packages on a BIG-IP. This module will allow you to deploy LX packages to the BIG-IP and manage their lifecycle.

Aliases: bigip_iapplx_package

## 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 | Choices/Defaults | Comments
--- | --- | ---
package path |  | The LX package that you want to upload or remove. When `state` is `present`, and you intend to use this module in a `role`, it is recommended that you use the `{{ role_path }}` variable. An example is provided in the `EXAMPLES` section. When `state` is `absent`, it is not necessary for the package to exist on the Ansible controller. If the full path to the package is provided, the filename will specifically be cherry picked from it to properly remove the package.
provider dictionary added in 2.5 |  | 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.
| 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`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| 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: cli 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: present ← absent | Whether the LX package should exist or not.

## Notes

Note

- Requires the rpm tool be installed on the host. This can be accomplished through different ways on each platform. On Debian based systems with `apt`; `apt-get install rpm`. On Mac with `brew`; `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 versions earlier than that.
- The module name `bigip_iapplx_package` has been deprecated in favor of `bigip_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 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.