Spec-Zone.ru › Ansible 2.9

bigip_monitor_https – Управляет F5 BIG-IP LTM мониторами https

Новое в версии 2.5.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Управляет F5 BIG-IP LTM мониторами https.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
строка
добавлен в 2.7
Описание монитора.
interval
целое число
Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout.
ip
строка
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name
строка / обязательно
Имя монитора.
parent
строка
Значение по умолчанию:
"/Common/https"
Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение является https родительским на Common разбиение.
partition
строка
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
port
строка
Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, необходимо указать значение от 1 до 65535.
provider
словарь
добавлен в 2.5
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщик авторизации для получения маркеров аутентификации с удалённого устройства.
Этот параметр действительно используется при работе с устройствами BIG-IQ.
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.
receive
строка
Строка приёма для вызова монитора.
receive_disable
строка
Эта настройка работает как receive, за исключением того, что система помечает узел или члена пула как отключённый, когда его ответ соответствует строке receive_disable, но не receive. Чтобы использовать эту настройку, необходимо указать как receive_disable, так и receive.
send
строка
Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, будет использовано значение по умолчанию GET /\\r\\n.
ssl_profile
строка
добавлен в 2.8
Указывает профиль SSL для использования монитором HTTPS.
Определение профилей SSL позволяет уточнить настройку атрибутов SSL для монитора HTTPS.
Этот параметр поддерживается только в версиях BIG-IP 13.x и более поздних.
state
строка
добавлен в 2.5
    Варианты:
  • present ←
  • absent
Если present, гарантирует, что монитор существует.
Если absent, гарантирует удаление монитора.
target_password
строка
Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username
строка
Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
time_until_up
целое число
Указывает количество времени в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 заставит узел быть помеченным как активным сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0.
timeout
целое число
Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается активным. Если целевой объект не отвечает в заданный период времени, он считается неактивным. Вы можете изменить это число на любое число, но оно должно быть в 3 раза больше числа интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16.
up_interval
целое число
добавлен в 2.8
Указывает интервал, который система использует для проверки работоспособности, когда ресурс активен.
Если 0, указывает, что система использует интервал, указанный в interval, для проверки работоспособности ресурса.
При любом другом числе, разрешает указание другого интервала для проверки работоспособности ресурса, который активен.

Примечания

Примечание

  • Требуется версия ПО BIG-IP >= 12
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 манипулируют только рабочей конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, необходимо включить как минимум одну задачу, использующую модуль bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create HTTPS Monitor
  bigip_monitor_https:
    name: my_http_monitor
    state: present
    ip: 10.10.10.10
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove HTTPS Monitor
  bigip_monitor_https:
    name: my_http_monitor
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
description
строка
changed
Описание монитора.

Пример:
Важный монитор
interval
целое число
changed
Новый интервал, в котором нужно выполнять проверку монитора.

Пример:
2
ip
строка
changed
Новый IP адрес для определения IP/порта.

Пример:
10.12.13.14
parent
строка
changed
Новая родительская шаблон монитора.

Пример:
https
time_until_up
целое число
changed
Новое время, в течение которого система будет отмечена как активная после первого успешного ответа.

Пример:
2
timeout
целое число
changed
Новый тайм-аут, в течение которого удалённая система должна ответить на запрос монитора.

Пример:
10
up_interval
целое число
changed
Интервал, используемый системой для проверки работоспособности при активном состоянии ресурса.



Статус

  • Гарантии обратной совместимости данного модуля нет. [preview]
  • Этот модуль поддерживается партнёром Ansible. [certified]

Авторы

  • 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.9/modules/bigip_monitor_https_module.html

Spec-Zone.ru

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