f5networks.f5_modules.bigip_monitor_ldap модуль — Управляет мониторами BIG-IP LDAP

Примечание

Этот модуль входит в коллекцию 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_ldap.

Добавлена в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
base строка	Указывает расположение в дереве LDAP, с которого монитор начинает проверку работоспособности.
chase_referrals логическое значение	При получении записи LDAP-пересылки, указывает, следует ли целевому узлу за пересылкой. Варианты: `false` `true`
debug логическое значение	Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Варианты: `false` `true`
description строка	Указывает описательный текст, идентифицирующий монитор.
filter строка	Указывает LDAP-ключ, по которому ищет монитор.
interval целое число	Указывает частоту, в секундах, с которой система выполняет проверку монитора, когда ресурс недоступен или статус ресурса неизвестен.
ip строка	Часть IP-адреса определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно «*».
mandatory_attributes логическое значение	Указывает, должны ли целевые узлы включать атрибуты в ответ, чтобы считаться доступными. Варианты: `false` `true`
manual_resume логическое значение	Указывает, автоматически ли система изменяет статус ресурса на включен при следующей успешной проверке монитора. Если вы установите это значение в `true`, вы должны вручную снова включить ресурс, прежде чем система сможет использовать его для подключений балансировки нагрузки. Когда `true`, указывает, что вы должны вручную снова включить ресурс после неудачной проверки монитора. Когда `false`, указывает, что система автоматически изменяет статус ресурса на включен при следующей успешной проверке монитора. Варианты: `false` `true`
name строка / обязательный	Имя монитора.
parent строка	Родительская шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение равно родительскому `ldap` на разделяемом `Common` разделе. По умолчанию: `"/Common/ldap"`
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` ← (по умолчанию)
security строка	Указывает тип защищенного протокола для связи с целевым устройством. Варианты: `"none"` `"ssl"` `"tls"`
state строка	Если `present`, гарантирует существование монитора. Если `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password строка	Указывает пароль, если контролируемый объект требует аутентификации.
target_username строка	Указывает имя пользователя, если контролируемый объект требует аутентификации.
time_until_up целое число	Указывает количество секунд, которые нужно подождать после того, как ресурс впервые корректно отреагировал на монитор, прежде чем установить состояние ресурса в ‘включено’. В течение этого интервала все ответы от ресурса должны быть корректными. По истечении интервала ресурс помечается как ‘включён’. Значение 0 означает, что ресурс помечается как «включён» сразу после получения первого корректного ответа.
timeout целое число	Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается «включённым». Если целевой объект не отвечает в течение заданного периода времени, он считается «выключенным». Когда это значение установлено в 0 (ноль), система использует интервал из родительского монитора. Обратите внимание, что `timeout` и `time_until_up` совместно управляют тем, когда ресурс устанавливается в состояние «включён».
up_interval целое число	Указывает интервал, который система должна использовать для проверки состояния, когда ресурс включён. Когда `0`, система использует интервал, указанный в `interval`, для проверки состояния ресурса. При любом другом значении вы можете указать другой интервал для проверки состояния включённого ресурса.
update_password строка	`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 LDAP monitor
  bigip_monitor_ldap:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
base строка	Новое значение базового параметра LDAP ресурса. Возвращено: изменено Пример: `"base"`
chase_referrals булево	Новое значение параметра «Преследование ссылок» ресурса. Возвращено: изменено Пример: `true`
debug булево	Новое значение параметра «Отладка» ресурса. Возвращено: изменено Пример: `true`
description строка	Описание монитора. Возвращено: изменено Пример: `"Important_Monitor"`
filter строка	Новое значение фильтра LDAP ресурса. Возвращено: изменено Пример: `"filter1"`
interval целое число	Новый интервал для проверки монитора. Возвращено: изменено Пример: `2`
ip строка	Новый IP-адрес для определения IP/порт. Возвращено: изменено Пример: `"10.12.13.14"`
mandatory_attributes булево	Новое значение параметра «Обязательные атрибуты» ресурса. Возвращено: изменено Пример: `false`
manual_resume булево	Новое значение параметра «Ручная возобновляемость» ресурса. Возвращено: изменено Пример: `false`
parent строка	Новый родительский шаблон монитора. Возвращено: изменено Пример: `"ldap"`
security строка	Новое значение параметра «Безопасность» ресурса. Возвращено: изменено Пример: `"ssl"`
time_until_up целое число	Новое время, в течение которого система отмечается как активная после первого успешного ответа. Возвращено: изменено Пример: `2`
timeout целое число	Новый интервал ожидания, в течение которого удаленная система должна ответить монитору. Возвращено: изменено Пример: `10`

Авторы

Tim Rupp (@caphrim007)
Greg Crosby (@crosbygw)

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

© 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_ldap_module.html