f5networks.f5_modules.bigip_wait – Ожидание условия BIG-IP перед продолжением
Примечание
Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_wait.
Новое в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- С помощью этого модуля вы можете дождаться, пока BIG-IP будет «готов», то есть готов принять конфигурацию.
- Этот модуль может учитывать ситуации, когда устройство находится в процессе перезагрузки из-за изменения конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| delay целое число | Значение по умолчанию: 0 | Количество секунд ожидания перед началом опроса. | |
| msg строка | Это переопределяет стандартное сообщение об ошибке при невозможности выполнения необходимых условий. | ||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логическое значение |
| Если yes, данные телеметрии TEEM не отправляются на F5.Вы можете опустить этот параметр, установив переменную окружения F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.Псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| sleep целое число | Значение по умолчанию: 1 | Количество секунд ожидания между проверками. До версии 2.3 это значение было жестко задано в 1 секунду. | |
| timeout целое число | Значение по умолчанию: 7200 | Максимальное время ожидания в секундах. При использовании без других условий эквивалентно простому ожиданию. Значение таймаута по умолчанию преднамеренно установлено в 2 часа, поскольку нет отдельного REST API. | |
| type строка |
| Тип BIG-IP. По умолчанию standard, другой вариант vcmp.Этот выбор определяет, какой модуль или служба Ansible ищет, чтобы установить, что устройство восстановилось, поэтому убедитесь, что выбрали правильный вариант, особенно при выполнении этого действия против VCMP. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP ≥ 12.
- Модули F5 манипулируют только активной конфигурацией продукта F5. Чтобы убедиться, что BIG-IP-специфическая конфигурация сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения активной конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- 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
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_wait_module.html
