New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
force bool |
| When yes , will upload the file every time and replace the file on the device.When no , the file will only be uploaded if it does not already exist.Generally should be yes only in cases where you have reason to believe that the image was corrupted during upload. | |
image | 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. | ||
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 F5_PASSWORD .aliases: pass, pwd | ||
provider (added in 2.5) | Default: None | A dict object containing connection details. | |
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 ANSIBLE_NET_SSH_KEYFILE . | ||
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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
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 F5_USER . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 F5_PASSWORD .aliases: pass, pwd | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
state |
| When present , ensures that the image is uploaded.When absent , ensures that the image is removed. | |
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 F5_USER . | ||
validate_certs bool (added in 2.0) |
| 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 . |
Note
pip install f5-sdk
.- 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
Common return values are documented here, 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 int | 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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_software_image_module.html