Spec-Zone.ru › Ansible 2.5

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

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

  • Краткое описание
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Краткое описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
interval
Интервал, определяющий частоту запуска монитора этого шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение обязательно должно быть меньше timeout.
ip
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name
обязательно
Имя монитора.
parent По умолчанию:
/Common/http
Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это http родительский шаблон в Common раздела.
partition
(добавлено в 2.5)
По умолчанию:
Common
Раздел устройства для управления ресурсами.
password
обязательно
Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.

псевдонимы: pass, pwd
port
Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если вы указываете IP-адрес, значение должно быть между 1 и 65535.
provider
(добавлено в 2.5)
По умолчанию:
None
Объект словаря, содержащий данные подключения.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена.
server_port По умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
password
обязательно
Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.

псевдонимы: pass, pwd
validate_certs
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах с самозаверяющимися сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удалённому устройству.
receive
Строка приёма для вызова монитора.
receive_disable
Эта настройка работает как receive, за исключением того, что система помечает узел или члена пула как отключённый, когда его ответ соответствует строке receive_disable, но не receive. Для использования этой настройки необходимо указать как receive_disable, так и receive.
send
Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, будет использовано значение по умолчанию GET /\r\n.
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена.
server_port
(добавлено в 2.2)
По умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
state
(добавлено в 2.5)
    Варианты:
  • present ←
  • absent
При present, гарантирует, что монитор существует.
При absent, гарантирует удаление монитора.
target_password
Указывает пароль, если мониторируемый целевой объект требует аутентификации.
target_username
Указывает имя пользователя, если мониторируемый целевой объект требует аутентификации.
time_until_up
Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения валидного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0.
timeout
Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое значение, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунду. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
(добавлено в 2.0)
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах с самозаверяющимися сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.

Примечания

Примечание

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

Примеры

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

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

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

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

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

Ключ Возвращаемое Описание
interval
int
изменённое
Новый интервал, в котором необходимо выполнить проверку монитора.

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

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

Пример:
http
time_until_up
int
изменённое
Новое время, в течение которого система отмечается как активная после первого успешного ответа.

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

Пример:
10


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Автор

  • Tim Rupp (@caphrim007)

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_monitor_http_module.html

Spec-Zone.ru

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