Last updated on: 2024-04-01 03:24:20.
bigip_software_update – Manage the software update settings of a BIG-IP¶
New in version 1.0.0.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments | |
---|---|---|---|---|
auto_check
boolean
|
|
Specifies whether to automatically check for updates on the F5 Networks downloads server.
|
||
auto_phone_home
boolean
|
|
Specifies whether to automatically send phone home data to the F5 Networks PhoneHome server.
|
||
frequency
string
|
|
Specifies the schedule for the automatic update check.
|
||
provider
dictionary
added in 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. |
||
password
string
/ required
|
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
F5_PASSWORD .aliases: pass, pwd |
|||
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER . |
|||
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
||
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 or the BIG-IQ. 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 . |
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: true
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: false
auto_phone_home: false
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
auto_check
boolean
|
changed |
Whether the system automatically checks for updates.
Sample:
True
|
auto_phone_home
boolean
|
changed |
Whether the system automatically sends phone home data.
Sample:
True
|
frequency
string
|
changed |
Frequency of auto update checks.
Sample:
weekly
|