Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

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

Для использования в книге задач, укажите: f5networks.f5_modules.bigip_wait.

Новое в версии 1.0.0: из f5networks.f5_modules

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
delay
целое число
Значение по умолчанию:
0
Количество секунд ожидания перед началом опроса.
msg
строка
Это переопределяет стандартное сообщение об ошибке при невозможности выполнения необходимых условий.
provider
словарь
добавлен в 1.0.0 f5networks.f5_modules
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem
логическое значение
    Варианты:
  • no
  • yes
Если 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
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удаленному устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен обладать административными привилегиями на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
логическое значение
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.
sleep
целое число
Значение по умолчанию:
1
Количество секунд ожидания между проверками. До версии 2.3 это значение было жестко задано в 1 секунду.
timeout
целое число
Значение по умолчанию:
7200
Максимальное время ожидания в секундах.
При использовании без других условий, это эквивалентно простому ожиданию.
Значение по умолчанию для таймаута намеренно установлено в 2 часа, так как нет отдельного REST API.
type
строка
    Варианты:
  • standard ←
  • vcmp
Тип 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_wait_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API