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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: f5networks.f5_modules.bigip_monitor_https.

Новая функция в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
cipher_list строка добавлено в f5networks.f5_modules 1.3.0	Указывает список шифров для данного монитора. Элементы в списке шифров разделены двоеточием `:`.
description строка	Описание монитора.
interval целое число	Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 5. Это значение должно быть меньше значения `timeout`.
ip строка	Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно ‘*’.
name строка / обязательно	Имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это значение является `https` родителем на `Common` раздела. Значение по умолчанию: `"/Common/https"`
partition строка	Раздел устройства для управления ресурсами. Значение по умолчанию: `"Common"`
port строка	Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно ‘*’. При указании IP-адреса необходимо указать значение от 1 до 65535.
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 целое число	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение, которое следует использовать при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs логическое	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
receive строка	Строка «Принять» для вызова монитора.

receive_disable string	Это свойство работает как `receive`, за исключением того, что система помечает узел или члена пула как отключённый, когда его ответ соответствует строке `receive_disable`, но не `receive`. Для использования этого параметра необходимо указать как `receive_disable`, так и `receive`.
reverse boolean добавлен в f5networks.f5_modules 1.12.0	Указывает, работает ли монитор в обратном режиме. Когда монитор работает в обратном режиме, совпадение целевой строки успешно помечает контролируемый объект как отключённый, а не как включённый. Этот режим можно использовать только при настройке опции `receive`. Этот параметр несовместим с параметром `time_until_up`. Если `time_until_up` указан, он должен быть `0`. Или, если он уже существует, он должен быть `0`. Варианты: `false` `true`
send string	Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, используется значение по умолчанию `GET /\\r\\n`.
ssl_profile string	Указывает профиль SSL для использования монитором HTTPS. Определение профилей SSL позволяет уточнить настройку атрибутов SSL для монитора HTTPS. Этот параметр поддерживается только на версиях BIG-IP 13.x и выше.
state string	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username string	Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
time_until_up integer	Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 заставляет узел быть помеченным как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 0.
timeout integer	Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше значения интервала плюс 1 секунду. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 16.
up_interval integer	Указывает интервал, используемый системой для проверки состояния, когда ресурс активен. При указании `0`, система использует интервал, указанный в `interval`, для проверки работоспособности ресурса. При любом другом числе вы можете указать другой интервал для проверки работоспособности активного ресурса.

Примечания

Примечание

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

Примеры

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

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

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

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

Ключ	Описание
cipher_list строка	Новое значение для списка шифров. Возвращено: изменено Пример: `"+3DES:+kEDH"`
description строка	Описание монитора. Возвращено: изменено Пример: `"Important Monitor"`
interval целое число	Новое значение интервала, с которым следует проводить проверку монитора. Возвращено: изменено Пример: `2`
ip строка	Новый IP-адрес определения IP/порта. Возвращено: изменено Пример: `"10.12.13.14"`
parent строка	Новая родительская шаблон монитора. Возвращено: изменено Пример: `"https"`
reverse булево	Работает ли монитор в обратном режиме. Возвращено: изменено Пример: `true`
time_until_up целое число	Новое время, в течение которого система будет помечена как активная после первого успешного ответа. Возвращено: изменено Пример: `2`
timeout целое число	Новый таймаут, в течение которого удаленная система должна ответить на монитор. Возвращено: изменено Пример: `10`
up_interval целое число	Интервал, который система использует для проверки работоспособности, когда ресурс активен. Возвращено: изменено Пример: `0`

Авторы

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_monitor_https_module.html