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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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 перейдёт в состояние «готов», то есть будет готов принимать конфигурацию.
Этот модуль учитывает ситуации, когда устройство перезагружается из-за изменения конфигурации.

Параметры

Параметр	Комментарии
delay integer	Количество секунд ожидания перед началом опроса. По умолчанию: `0`
msg string	Заменяет стандартное сообщение об ошибке, возникающей при невыполнении требуемых условий.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с данными для подключения.
auth_provider string	Настраивает поставщика аутентификации, который используется для получения токенов аутентификации от удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
ssh_keyfile path	Путь к файлу ключа SSH, используемому для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Этот параметр можно не указывать, задав переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
timeout integer	Параметр действует, когда `transport` имеет значение `rest` Задаёт время ожидания в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"cli"` `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами ресурсах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
sleep integer	Количество секунд ожидания между проверками. До версии 2.3 это значение было жёстко задано и составляло 1 секунду. По умолчанию: `1`
timeout integer	Максимальное время ожидания в секундах. При использовании без других условий этот параметр эквивалентен простому ожиданию. По умолчанию время ожидания намеренно установлено равным 2 часам, поскольку отдельного REST API нет. По умолчанию: `7200`
type string	Тип 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 или задайте 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_wait_module.html