f5networks.f5_modules.bigip_wait модуль — Ожидание условия BIG-IP перед продолжением

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_wait.

Добавлен в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры

Обзор

С помощью этого модуля вы можете дождаться готовности BIG-IP, что означает готовность BIG-IP к приёму конфигурации.
Этот модуль может учитывать ситуации, когда устройство находится в процессе перезагрузки из-за изменения конфигурации.

Параметры

Параметр	Комментарии
delay целое число	Количество секунд ожидания перед началом опроса. По умолчанию: `0`
msg строка	Переопределяет стандартное сообщение об ошибке при невыполнении необходимых условий.
provider словарь Добавлен в f5networks.f5_modules 1.0.0	Объект типа dict, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem булево	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF` Ранее использовавшаяся переменная `F5_TEEM` устарела, так как ее название вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательный	Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
ssh_keyfile путь	Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
timeout целое число	Параметр, действующий при `transport` установленном на `rest` Устанавливает таймаут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное подключение для соединения с удалённым устройством. Варианты: `"cli"` `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs булево	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
sleep целое число	Количество секунд ожидания между проверками. До версии 2.3 это значение было жёстко задано в 1 секунду. По умолчанию: `1`
timeout целое число	Максимальное время ожидания в секундах. Когда используется без других условий, эквивалентно простому ожиданию. Таймаут по умолчанию намеренно установлен на 2 часа, так как нет отдельного REST API. По умолчанию: `7200`
type строка	Тип BIG-IP. По умолчанию `standard`, другой вариант `vcmp`. Этот выбор определяет, какой модуль или сервис Ansible ищет для подтверждения восстановления устройства, поэтому убедитесь, что выбрано правильное значение, особенно при работе с VCMP. Варианты: `"standard"` ← (по умолчанию) `"vcmp"`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Для указания timeout при установке transport в cli, используйте переменную окружения ANSIBLE_PERSISTENT_COMMAND_TIMEOUT или укажите значение в файле ansible.cfg, см. https://docs.ansible.com/ansible/latest/reference_appendices/config.html#persistent-command-timeout
Модули 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_wait_module.html