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" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| port строка | Адрес порта части определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535. | ||
| provider словарь добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| 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 целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логический |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяемые сертификаты.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| security строка |
| Указывает тип защищенного протокола для связи с целевым объектом. | |
| server строка / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлено в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| 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 будет устанавливать пароль только для вновь созданных мониторов. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверяющимися сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 | Описание монитора. Пример: Важный_монитор |
| filter строка | changed | Новое значение параметра LDAP Filter для ресурса. Пример: 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)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_monitor_ldap_module.html
