Last updated on: 2024-04-01 03:24:20.

bigip_software_image – Manage software images on a BIG-IP

New in version 1.1.0.

Synopsis

  • Manages software images on a BIG-IP. These images may include both base images and hotfix images.

Parameters

Parameter Choices/Defaults Configuration Comments
force
boolean
    Choices:
  • no ←
  • yes
When true, uploads the file every time and replaces the file on the device.
When false, the file is only uploaded if it does not already exist.
Generally should be true only in cases where you have reason to believe the image was corrupted during upload.
image
string / required
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.
state
string
    Choices:
  • absent
  • present ←
When present, ensures the image is uploaded.
When absent, ensures the image is removed.

Examples

- name: Upload relative image to the BIG-IP
  bigip_software_image:
    image: BIGIP-13.0.0.0.0.1645.iso

- name: Upload absolute image to the BIG-IP
  bigip_software_image:
    image: /path/to/images/BIGIP-13.0.0.0.0.1645.iso

- 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"

Return Values

The following are the fields unique to this module:

Key Returned Description
build
string
changed
Build version of the software contained in the image.

Sample:
0.0.3
checksum
string
changed
MD5 checksum of the ISO.

Sample:
8cdbd094195fab4b2b47ff4285577b70
file_size
integer
changed
Size of the uploaded image in MB.

Sample:
1948
image_type
string
changed
Whether the image is a release or hotfix image.

Sample:
release
version
string
changed
Version of the software contained in the image.

Sample:
13.1.0.8


Status

Authors

  • Wojciech Wypior (@wojtek0806)