f5networks.f5_modules.bigip_gtm_monitor_https модуль — Управляет мониторами HTTPS F5 BIG-IP GTM

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в playbook укажите: f5networks.f5_modules.bigip_gtm_monitor_https.

Новое в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управляет мониторами HTTPS F5 BIG-IP GTM (теперь BIG-IP DNS).

Параметры

Параметр	Комментарии
cipher_list строка	Указывает список шифров для этого монитора. Элементы в списке шифров разделены символом двоеточие `:`. При создании нового монитора, если этот параметр не указан, используется список по умолчанию `DEFAULT:+SHA:+3DES:+kEDH`.
client_cert строка	Указывает полный путь к клиенту сертификат, который монитор отправляет целевому SSL-серверу.
client_key строка	Указывает ключ для сертификата клиента, который монитор отправляет целевому SSL-серверу.
compatibility логическое	При включении устанавливает значение параметра SSL (в OpenSSL) на all. При создании нового монитора, если это значение не указано, по умолчанию используется `true`. Варианты: `false` `true`
ignore_down_response логическое	Указывает, что монитор разрешает более одной попытки зондирования в интервал. Если `true`, монитор игнорирует ответы о недоступности в течение времени ожидания монитора. После достижения времени ожидания монитора без получения ответа о доступности, система отмечает объект как недоступный. Если `false`, монитор сразу отмечает объект как недоступный при получении ответа о недоступности. При создании нового монитора, если этот параметр не указан, значение по умолчанию `false`. Варианты: `false` `true`
interval целое	Интервал, определяющий частоту выполнения монитора данного шаблона. Если при создании нового монитора этот параметр не указан, значение по умолчанию 30. Это значение должно быть меньше `timeout` значения.
ip строка	Часть IP-адреса в определении IP/порта. Если при создании нового монитора этот параметр не указан, значение по умолчанию — ‘*’. Если это значение — IP-адрес, необходимо указать значение типа `port`.
name строка / обязательно	Имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский элемент `https` на разделяемой `Common`. По умолчанию: `"/Common/https"`
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port строка	Адрес порта в определении IP/порта. Если при создании нового монитора этот параметр не указан, значение по умолчанию — ‘*’. Если указан IP-адрес, необходимо указать значение от 1 до 65535.
probe_timeout целое	Указывает количество секунд, после которого система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию `5`.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem логическое	Если `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно опустить, задав переменную окружения `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как её название вызывало недоразумения. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно опустить, задав переменную окружения `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или BIG-IQ. Этот параметр можно опустить, задав переменную окружения `F5_SERVER`.
server_port целое	Порт сервера BIG-IP. Этот параметр можно опустить, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`

timeout integer	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Выбираемые значения: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные права на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Выбираемые значения: `false` `true` ← (по умолчанию)
receive string	Строка приема для вызова монитора.
reverse boolean	Инструктирует систему отметить целевой ресурс как нерабочий, когда тест успешен. Эта настройка полезна, например, если содержимое домашней страницы вашего веб-сайта динамично и часто меняется, вы можете настроить обратный ECV-сервисный тест, который ищет строку «Error». Совпадение со строкой означает, что веб-сервер был недоступен. Чтобы использовать этот параметр, вы должны указать значения для `send` и `receive`. Выбираемые значения: `false` `true`
send string	Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `GET /\r\n`.
state string	Когда `present`, обеспечивает существование монитора. Когда `absent`, обеспечивает удаление монитора. Выбираемые значения: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если для целевого объекта требуется аутентификация.
target_username string	Указывает имя пользователя, если для целевого объекта требуется аутентификация.
timeout integer	Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается доступным. Если целевой объект не отвечает в установленный период времени, он считается недоступным. Вы можете изменить это значение на любое число, однако, оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию составляет 120.
transparent boolean	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующих членов пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному назначению (то есть он исследует комбинацию `ip`-`port`, указанную в мониторе). Если монитор не может успешно достичь алиасного назначения, член пула или узел, через который был отправлен трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, значение по умолчанию равно `false`. Выбираемые значения: `false` `true`
update_password string	`always` обновляет пароли, если указан `target_password`. `on_create` устанавливает пароль только для вновь созданных мониторов. Выбираемые значения: `"always"` ← (по умолчанию) `"on_create"`

Примечания

Примечание

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

Примеры

- 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
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

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

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

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

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_monitor_https_module.html