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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ignore_down_response boolean		Варианты: нет да	Указывает, что монитор позволяет более одной попытки зондирования в интервал. Когда `yes`, указывает, что монитор игнорирует ответы о неработоспособности в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о работоспособности, система помечает объект как неработоспособный. Когда `no`, указывает, что монитор сразу помечает объект как неработоспособный, когда получает ответ о неработоспособности. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
interval целое число			Интервал, определяющий частоту выполнения монитора данного шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, то необходимо указать число `port`.
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/tcp"	Родительский шаблон этого шаблона монитора. После установки этого значения, его нельзя изменить. По умолчанию это родительский шаблон `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 строка			Строка отправления для вызова монитора.
server строка / обязательно			Хост BIG-IP. Можно опустить этот параметр, задав переменную окружения `F5_SERVER`.
server_port целое число добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Можно опустить этот параметр, задав переменную окружения `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
timeout целое число			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается работоспособным. Если целевой объект не отвечает в установленный период времени, он считается неработоспособным. Вы можете изменить это число на любое значение, однако оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
transparent boolean		Варианты: нет да	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через ассоциированные члены пула или узлы (обычно маршрутизатор или брандмауэр) к целевому адресу (то есть, он зондирует `ip`-`port` комбинацию, указанную в мониторе). Если монитор не может успешно достичь целевого адреса, член пула или узел, через который направлялся трафик монитора, помечается как неработоспособный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.

пользователь строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs булево добавлено в 2.0		Варианты: нет да ←	Если `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 TCP monitor
  bigip_gtm_monitor_tcp:
    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 TCP Monitor
  bigip_gtm_monitor_tcp:
    name: my_monitor
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

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

Ключ	Возвращаемое значение	Описание
ignore_down_response булево	изменено	Игнорировать ли ответ о недоступности. Пример: True
interval целое число	изменено	Новый интервал для проверки мониторинга. Пример: 2
ip строка	изменено	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	изменено	Новая родительская шаблон мониторинга. Пример: tcp
port строка	изменено	Новый порт, на котором мониторинг проверяет ресурс. Пример: 8080
probe_timeout целое число	изменено	Новый таймаут, в течение которого система будет ожидать ответа от датчика мониторинга. Пример: 10
receive строка	изменено	Новая строка приема для этого мониторинга. Пример: tcp строка для приема
reverse булево	изменено	Новое значение для указания, работает ли монитор в обратном режиме.
send строка	изменено	Новая строка отправки для этого мониторинга. Пример: tcp строка для отправки
timeout целое число	изменено	Новый таймаут, в течение которого удаленная система должна ответить на запрос мониторинга. Пример: 10
transparent булево	изменено	Новое значение для указания, работает ли монитор в прозрачном режиме.

Статус

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