bigip_wait - Ожидание условия BIG-IP перед продолжением
Новое в версии 2.5.
Обзор
- Можно дождаться, пока BIG-IP будет «готов». Под «готовностью» подразумевается готовность BIG-IP принимать конфигурацию.
- Этот модуль учитывает ситуации, когда устройство находится в процессе перезагрузки из-за изменения конфигурации.
Требования
Ниже приведены требования, которые необходимы на хосте, выполняющем этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| delay | По умолчанию: 0 | Количество секунд ожидания перед началом опроса. | |
| msg | Заменяет стандартное сообщение об ошибке при невыполнении необходимых условий. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | По умолчанию: None | Объект dict, содержащий данные подключения. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами. Можно опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| sleep | По умолчанию: 1 | Количество секунд ожидания между проверками. До версии 2.3 это было жёстко задано в 1 секунду. | |
| timeout | По умолчанию: 7200 | Максимальное время ожидания в секундах. Без дополнительных условий, эквивалентно простому ожиданию. Значение по умолчанию равно 2 часам, так как нет отдельного API REST. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами. Можно опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Wait for BIG-IP to be ready to take configuration
bigip_wait:
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
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
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_wait_module.html