f5networks.f5_modules.bigip_software_install – Install software images on a BIG-IP
f5networks.f5_modules.bigip_software_install – Install software images on a BIG-IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_software_install
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Install new software images on a BIG-IP system.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
block_device_image string added in 1.2.0 of f5networks.f5_modules |
Image to install on the remote device. In the case of a VCMP guest, ensure this image is present on the VCMP host and is referenced from there, and not from the VCMP guest. An ISO image directly uploaded to the VCMP guest will not work. | ||
image string |
Image to install on the remote device. | ||
provider dictionary added in 1.0.0 of f5networks.f5_modules |
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. | ||
no_f5_teem boolean |
|
If You may omit this option by setting the environment variable | |
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 |
|
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
state string |
|
When When | |
type string added in 1.2.0 of f5networks.f5_modules |
|
The type of the BIG-IP. Defaults to | |
volume string |
The volume on which to install the software image. |
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: Ensure an existing image is installed in specified volume
bigip_software_install:
image: BIGIP-13.0.0.0.0.1645.iso
volume: HD1.2
state: installed
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Ensure an existing image is activated in specified volume
bigip_software_install:
image: BIGIP-13.0.0.0.0.1645.iso
state: activated
volume: HD1.2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Ensure an existing image is activated in specified volume in a VCMP guest
bigip_software_install:
block_device_image: BIGIP-13.0.0.0.0.1645.iso
type: vcmp
state: activated
volume: HD1.2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Authors
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
- Nitin Khanna (@nitinthewiz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_software_install_module.html