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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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 string добавлено в f5networks.f5_modules 1.3.0	Задаёт список шифров для этого монитора. Элементы списка шифров разделяются двоеточием `:`.
description string	Описание монитора.
interval integer	Интервал, задающий частоту запуска экземпляра монитора этого шаблона. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 5. Это значение должно быть меньше значения `timeout`.
ip string	IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию ‘*’.
name string / обязательный	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После задания это значение нельзя изменить. По умолчанию используется родительский шаблон `https` в разделе `Common`. По умолчанию: `"/Common/https"`
partition string	Раздел устройства, в котором управляются ресурсы. По умолчанию: `"Common"`
port string	Номер порта в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию ‘*’. При указании IP-адреса необходимо задать значение от 1 до 65535.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера 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	Строка Receive для запроса монитора.
receive_disable string	Этот параметр работает как `receive`, за исключением того, что система помечает узел или участника пула как отключённый, если его ответ соответствует строке `receive_disable`, но не `receive`. Чтобы использовать этот параметр, необходимо указать и `receive_disable`, и `receive`.
reverse boolean добавлено в f5networks.f5_modules 1.12.0	Указывает, работает ли монитор в обратном режиме. В обратном режиме успешное совпадение со строкой Receive помечает контролируемый объект как недоступный, а не как доступный. Этот режим можно использовать только при настройке параметра `receive`. Этот параметр несовместим с параметром `time_until_up`. Если указан `time_until_up`, он должен быть `0`. Если он уже существует, его значение должно быть `0`. Варианты: `false` `true`
send string	Строка Send для запроса монитора. При создании нового монитора, если это значение не указано, используется значение по умолчанию `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	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается доступным. Если целевой объект не отвечает в установленный период времени, он считается недоступным. Можно задать любое значение, однако рекомендуется указывать интервал, равный трём значениям параметра interval в секундах плюс одна секунда. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 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 string	Новое значение списка шифров. Возвращается: при изменении Пример: `"+3DES:+kEDH"`
description string	Описание монитора. Возвращается: при изменении Пример: `"Important Monitor"`
interval integer	Новый интервал запуска проверки монитора. Возвращается: при изменении Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: при изменении Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: при изменении Пример: `"https"`
reverse boolean	Указывает, работает ли монитор в обратном режиме. Возвращается: при изменении Пример: `true`
time_until_up integer	Новое время, по истечении которого система помечается как доступная после первого успешного ответа. Возвращается: при изменении Пример: `2`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: при изменении Пример: `10`
up_interval integer	Интервал, который система использует для проверки работоспособности ресурса, когда он доступен. Возвращается: при изменении Пример: `0`

Авторы

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

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

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