bigip_gtm_monitor_https - Управление мониторами F5 BIG-IP GTM https

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

f5-sdk >= 3.0.9

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
cipher_list			Указывает список шифров для данного монитора. Элементы в списке шифров разделяются символом двоеточие `:`. При создании нового монитора, если этот параметр не указан, используется список по умолчанию `DEFAULT:+SHA:+3DES:+kEDH`.
client_cert			Указывает полное имя пути к клиенту сертификату, который монитор отправляет целевому серверу SSL.
client_key			Указывает ключ для сертификата клиента, который монитор отправляет целевому серверу SSL.
compatibility bool		Варианты: no yes	Указывает, при включении, что параметр SSL options (в OpenSSL) установлен на all. При создании нового монитора, если значение не указано, используется значение по умолчанию `yes`.
ignore_down_response bool		Варианты: no yes	Указывает, что монитор допускает более одной попытки зондирования за интервал. При `yes`, указывает, что монитор игнорирует ответы о состоянии "недоступен" в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о состоянии "доступен", система помечает объект как "недоступен". При `no`, указывает, что монитор сразу же помечает объект как "недоступен" при получении ответа "недоступен". При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
interval			Интервал, определяющий частоту запуска экземпляра монитора этого шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение - IP-адрес, то необходимо указать значение типа `port`.
name обязательно			Имя монитора.
parent		По умолчанию: "/Common/https"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение - родительский шаблон `tcp` на разделе `Common`.
partition		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
password обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_PASSWORD` установлена. псевдонимы: pass, pwd
port			Часть адреса порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, необходимо указать значение от 1 до 65535.
probe_timeout			Указывает количество секунд, по истечении которых система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `5`.
provider (добавлено в 2.5)			Объект dict, содержащий данные подключения.
	password обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_PASSWORD` установлена. псевдонимы: pass, pwd
	server обязательно		Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_SERVER` установлена.
	server_port	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_SERVER_PORT` установлена.
	user обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения `F5_USER` установлена.
	validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` установлена.
	timeout	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
receive			Строка приема для вызова монитора.
reverse bool		Варианты: no yes	Инструктирует систему отмечать целевой ресурс как недоступный, когда тест завершается успешно. Эта настройка полезна, например, если содержимое домашней страницы вашего веб-сайта динамическое и часто меняется, вы можете настроить обратный ECV-проверка сервиса, который ищет строку Error. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра, необходимо указать значения для `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 bool		Варианты: no yes	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующие члены пула или узлы (обычно маршрутизатор или брандмауэр) к указанному целевому объекту (то есть зондирует комбинацию `ip`-`port`, указанную в мониторе). Если монитор не может успешно достичь указанного целевого объекта, член пула или узел, через который отправляется трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
update_password		Варианты: always ← on_create	`always` обновит пароли, если `target_password` указано. `on_create` установит пароль только для вновь созданных мониторов.
user обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения `F5_USER` установлена.

validate_certs

bool

(added in 2.0)

Choices:

no
yes ←

Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.

Примечания

Примечание

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

Примеры

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

- name: Remove HTTPS Monitor
  bigip_gtm_monitor_https:
    name: my_monitor
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
  delegate_to: localhost

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

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

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

Ключ	Возвращаемое значение	Описание
cipher_list string	changed	Новое значение для списка шифров. Пример: +3DES:+kEDH
client_cert string	changed	Новое значение настройки клиентского сертификата. Пример: /Common/default
client_key string	changed	Новое значение настройки клиентского ключа. Пример: /Common/default
compatibility bool	changed	Новое значение настройки совместимости SSL. Пример: True
ignore_down_response bool	changed	Игнорировать ли ответ "down"? Пример: True
interval int	changed	Новый интервал для проверки монитора. Пример: 2
ip string	changed	Новый IP адрес для определения IP/порта. Пример: 10.12.13.14
parent string	changed	Новая родительская шаблон монитора. Пример: https
port string	changed	Новый порт для проверки ресурса монитором. Пример: 8080
probe_timeout int	changed	Новый интервал таймаута для запроса монитора. Пример: 10
receive string	changed	Новая строка приема для этого монитора. Пример: tcp string to receive
reverse bool	changed	Новое значение для режима работы монитора в обратном направлении.
send string	changed	Новая строка отправки для этого монитора. Пример: tcp string to send
timeout int	changed	Новый интервал таймаута для ответа удалённой системы монитору. Пример: 10
transparent bool	changed	Новое значение для режима работы монитора в прозрачном режиме.

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/bigip_gtm_monitor_https_module.html