bigip_iapplx_package – Manages Javascript iApp packages on a BIG-IP
bigip_iapplx_package – Manages Javascript iApp packages on a BIG-IP
New in version 2.5.
Synopsis
- Manages Javascript iApp packages on a BIG-IP. This module will allow you to deploy iAppLX 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
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
package - |
The iAppLX package that you want to upload or remove. When When | ||
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
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 | ||
timeout - |
Default: 10 |
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 - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / 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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state - |
|
Whether the iAppLX package should exist or not. | |
user - / 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 | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
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 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 versions earlier than that.
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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: Add an iAppLX package
bigip_iapplx_package:
package: MyApp-0.1.0-0001.noarch.rpm
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Add an iAppLX package stored in a role
bigip_iapplx_package:
package: "{{ roles_path }}/files/MyApp-0.1.0-0001.noarch.rpm'"
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove an iAppLX package
bigip_iapplx_package:
package: MyApp-0.1.0-0001.noarch.rpm
password: secret
server: lb.mydomain.com
state: absent
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_iapplx_package_module.html