bigip_monitor_ldap – Управление мониторами BIG-IP LDAP
Новая версия 2.8.
Краткое описание
- Управление мониторами BIG-IP LDAP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| base строка | Указывает местоположение в дереве LDAP, с которого монитор начинает проверку работоспособности. | ||
| chase_referrals логическое значение |
| Указывает, следует ли монитору (или преследует) реферер, полученный в качестве записи реферала LDAP. | |
| debug логическое значение |
| Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. | |
| description строка | Указывает описательный текст, идентифицирующий монитор. | ||
| filter строка | Указывает LDAP-ключ, по которому монитор выполняет поиск. | ||
| interval целое число | Указывает частоту проверки монитором системы в секундах, когда ресурс недоступен или статус ресурса неизвестен. | ||
| ip строка | Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. | ||
| mandatory_attributes логическое значение |
| Указывает, должен ли целевой ресурс включать атрибуты в своём ответе, чтобы считаться доступным. | |
| manual_resume логическое значение |
| Указывает, автоматически ли система изменяет состояние ресурса на включено при следующей успешной проверке монитора. Если вы установите это значение в yes, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.Когда yes, указывает, что вы должны вручную повторно включить ресурс после неудачной проверки монитора.Когда no, указывает, что система автоматически изменяет состояние ресурса на включено при следующей успешной проверке монитора. | |
| name строка / обязательно | Имя монитора. | ||
| parent строка | Значение по умолчанию: "/Common/ldap" | Шаблон родителя для данного шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это значение является ldap родителем на Common разделе. | |
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port строка | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, необходимо указать значение от 1 до 65535. | ||
| provider словарь добавлено в 2.5 | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| password строка / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа, который используется для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспортов cli. Можно опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт, прежде чем операция будет завершена, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное подключение, используемое при подключении к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, с использованием самозаверяющих сертификатов.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| security строка |
| Указывает тип защищённого протокола для связи с целевым устройством. | |
| state строка |
| Когда 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 будет устанавливать пароль только для вновь созданных мониторов. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать, что конфигурация BIG-IP сохранится на диске, необходимо включить по крайней мере одну задачу, использующую модуль 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 строка | changed | Новое значение базы LDAP для ресурса. Пример: base |
| chase_referrals логический тип | changed | Новое значение Chase Referrals для ресурса. Пример: True |
| debug логический тип | changed | Новое значение параметра Debug для ресурса. Пример: True |
| description строка | changed | Описание монитора. Пример: Important_Monitor |
| filter строка | changed | Новое значение фильтра LDAP для ресурса. Пример: filter1 |
| interval целое число | changed | Новый интервал для проверки монитора. Пример: 2 |
| ip строка | changed | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| mandatory_attributes логический тип | changed | Новое значение Mandatory Attributes для ресурса. |
| manual_resume логический тип | changed | Новое значение Manual Resume для ресурса. |
| parent строка | changed | Новый шаблон родителя для монитора. Пример: ldap |
| security строка | changed | Новое значение Security для ресурса. Пример: ssl |
| time_until_up целое число | changed | Новое время, через которое система будет считаться активной после первого успешного ответа. Пример: 2 |
| timeout целое число | changed | Новый таймаут, в течение которого удаленная система должна ответить на монитор. Пример: 10 |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
- Greg Crosby (@crosbygw)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_monitor_ldap_module.html
