Spec-Zone.ru › Ansible 2.9

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

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

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

Описание

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

Параметры

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

Примечания

Примечание

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

Примеры

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

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

- name: Include a username and password in the HTTP monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    target_username: monitor_user
    target_password: monitor_pass
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

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

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

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

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

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

Пример:
http
reverse
логическое значение
changed
Используется ли монитор в обратном режиме.

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

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

Пример:
10


Статус

  • Этот модуль не гарантирует обратную совместимость. [превью]
  • Этот модуль поддерживается партнёром 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.9/modules/bigip_monitor_http_module.html

Spec-Zone.ru

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