f5networks.f5_modules.bigip_wait module – Wait for a BIG-IP condition before continuing
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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_wait
.
New in f5networks.f5_modules 1.0.0
Synopsis
With this module, you can wait for BIG-IP to be “ready”, meaning the BIG-IP is ready to accept configuration.
This module can take into account situations where the device is in the middle of rebooting due to a configuration change.
Parameters
Parameter |
Comments |
---|---|
Number of seconds to wait before starting to poll. Default: |
|
This overrides the normal error message from a failure to meet the required conditions. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable |
|
The BIG-IP host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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 |
|
Parameter in effect when 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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Number of seconds to sleep between checks. Before version 2.3 this was hardcoded to 1 second. Default: |
|
Maximum number of seconds to wait. When used without other conditions, it is equivalent of just sleeping. The default timeout is deliberately set to 2 hours because there is no individual REST API. Default: |
|
The type of the BIG-IP. Defaults to This choice defines which module or service Ansible looks for to establish that the device has recovered, so ensure to specify the correct choice, especially when running this against VCMP. Choices:
|
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.
To specify
timeout
whentransport
is set tocli
, use theANSIBLE_PERSISTENT_COMMAND_TIMEOUT
environment variable or specify acommand_timeout
in the ansible.cfg file, see https://docs.ansible.com/ansible/latest/reference_appendices/config.html#persistent-command-timeoutThe 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: Wait for BIG-IP to be ready to take configuration
bigip_wait:
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Wait a maximum of 300 seconds for BIG-IP to be ready to take configuration
bigip_wait:
timeout: 300
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Wait for BIG-IP to be ready, don't start checking for 10 seconds
bigip_wait:
delay: 10
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost