f5networks.f5_modules.bigip_software_image module – Manage software images on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.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
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_software_image
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages software images on a BIG-IP. These images may include both base images and hotfix images.
Parameters
Parameter |
Comments |
---|---|
When When Generally should be Choices:
|
|
The image to put on the remote device. This may be an absolute or relative location on the Ansible controller. Image names, whether they are base ISOs or hotfix ISOs, must be unique. |
|
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:
|
|
When When Choices:
|
Notes
Note
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: Upload relative image to the BIG-IP
bigip_software_image:
image: BIGIP-13.0.0.0.0.1645.iso
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Upload absolute image to the BIG-IP
bigip_software_image:
image: /path/to/images/BIGIP-13.0.0.0.0.1645.iso
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Upload image in a role to the BIG-IP
bigip_software_image:
image: "{{ role_path }}/files/BIGIP-13.0.0.0.0.1645.iso"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build version of the software contained in the image. Returned: changed Sample: |
|
MD5 checksum of the ISO. Returned: changed Sample: |
|
Size of the uploaded image in MB. Returned: changed Sample: |
|
Whether the image is a release or hotfix image. Returned: changed Sample: |
|
Version of the software contained in the image. Returned: changed Sample: |