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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: 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 options (в 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	Объект dict, содержащий сведения для подключения.
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 для вызова монитора.
reverse логическое значение	Указывает системе пометить целевой ресурс как недоступный, если проверка проходит успешно. Этот параметр полезен, например, если содержимое главной страницы вашего веб-сайта динамически и часто меняется: можно настроить обратную проверку службы ECV, которая ищет строку Error. Наличие этой строки означает, что веб-сервер недоступен. Чтобы использовать этот параметр, необходимо указать значения для `send` и `receive`. Варианты: `false` `true`
send строка	Строка send для вызова монитора. При создании монитора, если этот параметр не указан, используется значение по умолчанию `GET /\r\n`.
state строка	Если задано `present`, обеспечивает наличие монитора. Если задано `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password строка	Задает пароль, если для проверяемого целевого узла требуется аутентификация.
target_username строка	Задает имя пользователя, если для проверяемого целевого узла требуется аутентификация.
timeout целое число	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой узел отвечает в течение заданного периода, он считается доступным. Если целевой узел не отвечает в течение заданного периода, он считается недоступным. Можно задать любое значение, однако оно должно равняться трехкратному значению интервала в секундах плюс 1 секунда. Если при создании монитора этот параметр не указан, используется значение по умолчанию 120.
transparent логическое значение	Определяет, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через связанные с ним участники пула или узлы (обычно маршрутизатор или брандмауэр) к псевдонимному адресу назначения (то есть выполняет проверку комбинации `ip`-`port`, указанной в мониторе). Если монитор не может успешно связаться с псевдонимным адресом назначения, участник пула или узел, через который был отправлен трафик монитора, помечается как недоступный. При создании монитора, если этот параметр не указан, используется значение по умолчанию `false`. Варианты: `false` `true`
update_password строка	`always` обновляет пароли, если указан параметр `target_password`. `on_create` задает пароль только для вновь созданных мониторов. Варианты: `"always"` ← (по умолчанию) `"on_create"`

Примечания

Примечание

Дополнительные сведения об управлении устройствами F5 Networks с помощью Ansible см. на странице 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	Новое значение списка шифров. Возвращается: при изменении Пример: `"+3DES:+kEDH"`
client_cert string	Новое значение настройки сертификата клиента. Возвращается: при изменении Пример: `"/Common/default"`
client_key string	Новое значение настройки ключа клиента. Возвращается: при изменении Пример: `"/Common/default"`
compatibility boolean	Новое значение настройки совместимости SSL. Возвращается: при изменении Пример: `true`
ignore_down_response boolean	Следует ли игнорировать ответ о недоступности. Возвращается: при изменении Пример: `true`
interval integer	Новый интервал запуска проверки монитора. Возвращается: при изменении Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: при изменении Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: при изменении Пример: `"https"`
port string	Новый порт, на котором монитор проверяет ресурс. Возвращается: при изменении Пример: `"8080"`
probe_timeout integer	Новое время ожидания, по истечении которого система прерывает проверку монитора. Возвращается: при изменении Пример: `10`
receive string	Новая строка receive для этого монитора. Возвращается: при изменении Пример: `"tcp string to receive"`
reverse boolean	Новое значение параметра, определяющего, работает ли монитор в обратном режиме. Возвращается: при изменении Пример: `false`
send string	Новая строка send для этого монитора. Возвращается: при изменении Пример: `"tcp string to send"`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: при изменении Пример: `10`
transparent boolean	Новое значение параметра, определяющего, работает ли монитор в прозрачном режиме. Возвращается: при изменении Пример: `false`

Авторы

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