Spec-Zone.ru › Ansible 2.8

bigip_gtm_monitor_http – Управляет мониторами F5 BIG-IP GTM http

Новая в версии 2.6.

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ignore_down_response
boolean
    Варианты:
  • нет
  • да
Указывает, что монитор допускает более одной попытки зондирования в интервал.
Когда yes, указывает, что монитор игнорирует ответы о недоступности на время таймаута монитора. После достижения таймаута монитора без получения ответа о доступности система помечает объект как недоступный.
Когда no, указывает, что монитор немедленно помечает объект как недоступный при получении ответа о недоступности.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no.
interval
целое число
Интервал, определяющий частоту выполнения экземпляра монитора данного шаблона.
Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30.
Это значение должно быть меньше значения timeout.
ip
строка
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
Если это значение — IP-адрес, то необходимо указать port число.
name
строка / обязательно
Имя монитора.
parent
строка
Значение по умолчанию:
"/Common/http"
Родительский шаблон для этого шаблона монитора. После установки это значение изменить нельзя. По умолчанию это значение — родительский tcp на Common разделяемой области.
partition
строка
Значение по умолчанию:
"Common"
Разделяемая область устройства для управления ресурсами.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
port
строка
Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, необходимо указать значение от 1 до 65535.
probe_timeout
целое число
Указывает количество секунд, после которого система отменяет запрос зондирования к системе.
При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 5.
provider
словарь
добавлено в 2.5
Объект словаря, содержащий сведения о подключении.
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
целое число
Значение по умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное подключение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную окружения F5_USER.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.
Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS.
receive
строка
Строка приема для вызова монитора.
reverse
boolean
    Варианты:
  • нет
  • да
Инструктирует систему помечать целевой ресурс как недоступный, когда тест проходит успешно. Эта настройка полезна, например, если контент на домашней странице вашего веб-сайта динамический и часто меняется, вы можете настроить обратную проверку ECV-сервиса, которая ищет строку Ошибка.
Совпадение с этой строкой означает, что веб-сервер был недоступен.
Чтобы использовать этот параметр, необходимо указать значения для send и receive.
send
строка
Строка отправки для вызова монитора.
При создании нового монитора, если этот параметр не указан, будет использоваться значение по умолчанию — GET /\r\n.
server
строка / обязательно
Хост BIG-IP.
Этот параметр можно опустить, установив переменную окружения F5_SERVER.
server_port
целое число
добавлено в 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT.
state
строка
    Варианты:
  • present ←
  • absent
Когда present, гарантирует, что монитор существует.
Когда absent, гарантирует удаление монитора.
target_password
строка
Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username
строка
Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
timeout
целое число
Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается доступным. Если целевой объект не отвечает в заданный период времени, он считается недоступным. Вы можете изменить это число на любое, но оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда.
Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
transparent
boolean
    Выбираемые значения:
  • no
  • yes
Указывает, работает ли монитор в прозрачном режиме.
Монитор в прозрачном режиме перенаправляет трафик через соответствующих членов пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он исследует комбинацию ip-port , указанную в мониторе).
Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был перенаправлен трафик монитора, помечаются как нерабочие.
При создании нового монитора, если этот параметр не указан, используется значение по умолчанию no.
update_password
string
    Выбираемые значения:
  • always ←
  • on_create
always будет обновлять пароли, если указан target_password.
on_create будет устанавливать пароль только для вновь созданных мониторов.
user
string / required
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную окружения F5_USER.
validate_certs
boolean
добавлено в 2.0
    Выбираемые значения:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте только на сайтах под личным контролем, использующих самозаверенные сертификаты.
Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS.

Примечания

Примечание

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

Примеры

- name: Create a GTM HTTP monitor
  bigip_gtm_monitor_http:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove HTTP Monitor
  bigip_gtm_monitor_http:
    name: my_monitor
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add HTTP monitor for all addresses, port 514
  bigip_gtm_monitor_http:
    name: my_monitor
    port: 514
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
ignore_down_response
boolean
изменено
Учитывать или игнорировать ответ о недоступности.

Пример:
True
interval
целое число
изменено
Новый интервал для выполнения проверки монитора.

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

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

Пример:
http
port
строка
изменено
Новый порт, на котором монитор проверяет ресурс.

Пример:
8080
probe_timeout
целое число
изменено
Новый интервал ожидания для проверки монитора.

Пример:
10
receive
строка
изменено
Новая строка приема для данного монитора.

Пример:
tcp string to receive
reverse
boolean
изменено
Новое значение, определяющее, работает ли монитор в обратном режиме.

send
строка
изменено
Новая строка отправки для данного монитора.

Пример:
tcp string to send
timeout
целое число
изменено
Новый интервал ожидания ответа от удаленного устройства для монитора.

Пример:
10
transparent
boolean
изменено
Новое значение, определяющее, работает ли монитор в прозрачном режиме.



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

  • 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.8/modules/bigip_gtm_monitor_http_module.html

Spec-Zone.ru

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