You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

f5networks.f5_modules.bigip_software_update module – Manage the software update settings of a BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.25.0).

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_update.

New in f5networks.f5_modules 1.0.0

Synopsis

• Manage the software update settings of a BIG-IP.

Parameters

Parameter	Comments
auto_check boolean	Specifies whether to automatically check for updates on the F5 Networks downloads server. Choices: false true
auto_phone_home boolean	Specifies whether to automatically send phone home data to the F5 Networks PhoneHome server. Choices: false true
frequency string	Specifies the schedule for the automatic update check. Choices: "daily" "monthly" "weekly"
provider dictionary added in f5networks.f5_modules 1.0.0	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 yes, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable F5_TELEMETRY_OFF. Previously used variable F5_TEEM is deprecated as its name was confusing. Choices: false ← (default) true
password aliases: pass, pwd 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 F5_PASSWORD.
server string / required	The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER.
server_port integer	The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT. Default: 443
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. Choices: "rest" ← (default)
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 F5_USER.
validate_certs boolean	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. Choices: false true ← (default)

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: Enable automatic update checking
  bigip_software_update:
    auto_check: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Disable automatic update checking and phoning home
  bigip_software_update:
    auto_check: no
    auto_phone_home: no
    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
auto_check boolean	Whether the system automatically checks for updates. Returned: changed Sample: true
auto_phone_home boolean	Whether the system automatically sends phone home data. Returned: changed Sample: true
frequency string	Frequency of auto update checks. Returned: changed Sample: "weekly"

Authors

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

Collection links

Issue Tracker Homepage Repository (Sources)