f5networks.f5_modules.bigip_monitor_ldap – Управляет мониторами BIG-IP LDAP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_ldap.
Новое в версии 1.0.0: of f5networks.f5_modules
Обзор
- Управляет мониторами BIG-IP LDAP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| base строка | Указывает местоположение в дереве LDAP, с которого монитор начинает проверку работоспособности. | ||
| chase_referrals логическое |
| При получении записи LDAP-перенаправления задаёт, следует ли целевой объект за этим перенаправлением. | |
| debug логическое |
| Определяет, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и обозначенный специально для этого монитора. | |
| description строка | Указывает описательный текст, идентифицирующий монитор. | ||
| filter строка | Задаёт LDAP-ключ, по которому монитор выполняет поиск. | ||
| interval целое число | Указывает частоту, в секундах, с которой система выполняет проверку монитора, когда ресурс не работает или статус ресурса неизвестен. | ||
| ip строка | IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. | ||
| mandatory_attributes логическое |
| Определяет, должен ли целевой объект включать атрибуты в свой ответ, чтобы считаться активным. | |
| manual_resume логическое |
| Определяет, автоматически ли система изменяет статус ресурса на enabled при следующей успешной проверке монитора. Если вы установили этот параметр в значение yes, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для подключений балансировки нагрузки.Когда yes, указывает, что вы должны вручную повторно включить ресурс после неудачной проверки монитора.Когда no, указывает, что система автоматически изменяет статус ресурса на enabled при следующей успешной проверке монитора. | |
| name строка / обязательно | Имя монитора. | ||
| parent строка | Значение по умолчанию: "/Common/ldap" | Родительская шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — ldap родительский на Common разделе. | |
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port строка | Адрес порта, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Обратите внимание, что если вы указываете IP-адрес, вы должны указать значение от 1 до 65535. | ||
| provider словарь добавлено в 1.0.0 of f5networks.f5_modules | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщик авторизации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логическое |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете пропустить этот параметр, задав переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете пропустить этот параметр, задав переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете пропустить этот параметр, задав переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете пропустить этот параметр, задав переменную среды F5_SERVER_PORT. | |
| 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 целое число | Указывает количество секунд, которые нужно подождать после того, как ресурс впервые корректно ответит на запрос монитора, прежде чем установить ресурс в состояние 'up'. В течение этого интервала все ответы от ресурса должны быть правильными. По истечении интервала ресурс помечается как 'up'. Значение 0 означает, что ресурс помечается как активный сразу после получения первого правильного ответа. | ||
| timeout целое число | Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора. Если целевой объект отвечает в установленный срок, он считается 'активным'. Если целевой объект не отвечает в установленный срок, он считается 'неактивным'. Когда это значение установлено в 0 (ноль), система использует интервал от родительского монитора. Обратите внимание, что timeout и time_until_up совместно управляют моментом, когда ресурс устанавливается в состояние '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 на диске, обязательно включите по крайней мере одну задачу, использующую модуль 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 логическое | изменён | Новое значение параметра Chase Referrals для ресурса. Пример: True |
| debug логическое | изменён | Новое значение параметра отладки для ресурса. Пример: True |
| description строка | изменён | Описание монитора. Пример: Important_Monitor |
| filter строка | изменён | Новое значение фильтра LDAP для ресурса. Пример: filter1 |
| interval целое число | изменён | Новый интервал для выполнения проверки монитора. Пример: 2 |
| ip строка | изменён | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| mandatory_attributes логическое | изменён | Новое значение параметра Mandatory Attributes для ресурса. |
| manual_resume логическое | изменён | Новое значение параметра Manual Resume для ресурса. |
| parent строка | изменён | Новый родительский шаблон монитора. Пример: ldap |
| security строка | изменён | Новое значение параметра Security для ресурса. Пример: ssl |
| time_until_up целое число | изменён | Новое время, через которое система будет считаться активной после первого успешного ответа. Пример: 2 |
| timeout целое число | изменён | Новый таймаут, через который удаленная система должна ответить на монитор. Пример: 10 |
Авторы
- 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.10/collections/f5networks/f5_modules/bigip_monitor_ldap_module.html
