Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

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

Описание

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

Параметры

Параметр

Комментарии

base

string

Указывает расположение в дереве LDAP, с которого монитор начинает проверку работоспособности.

chase_referrals

boolean

При получении записи перенаправления LDAP указывает, следует ли целевому объекту переходить по этому перенаправлению.

Варианты:

  • false
  • true

debug

boolean

Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный специально для этого монитора.

Варианты:

  • false
  • true

description

string

Указывает описательный текст, идентифицирующий монитор.

filter

string

Указывает ключ LDAP, который ищет монитор.

interval

integer

Указывает частоту в секундах, с которой система выполняет проверку монитора, если ресурс не работает или его состояние неизвестно.

ip

string

IP-адрес в определении IP-адреса/порта. Если этот параметр не указан при создании нового монитора, используется значение по умолчанию «*».

mandatory_attributes

boolean

Указывает, должен ли целевой объект включать атрибуты в ответ, чтобы считаться доступным.

Варианты:

  • false
  • true

manual_resume

boolean

Указывает, автоматически ли система меняет состояние ресурса на включено при следующей успешной проверке монитора.

Если для этого параметра задано значение true, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки соединений.

Если задано значение true, необходимо вручную повторно включить ресурс после неудачной проверки монитора.

Если задано значение false, система автоматически меняет состояние ресурса на включено при следующей успешной проверке монитора.

Варианты:

  • false
  • true

name

string / обязательный

Имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить.

По умолчанию используется родительский объект ldap в разделе Common.

По умолчанию: "/Common/ldap"

partition

string

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

port

string

Номер порта в определении IP-адреса/порта. Если этот параметр не указан при создании нового монитора, используется значение по умолчанию «*».

Обратите внимание: при указании IP-адреса необходимо задать значение от 1 до 65535.

provider

dictionary

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

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если задано значение yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, так как её название вводило в заблуждение.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истекает до завершения операции, модуль выдаёт ошибку.

transport

string

Настраивает транспортное соединение для подключения к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

boolean

Если задано значение no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

security

string

Указывает тип защищённого протокола для связи с целевым объектом.

Варианты:

  • "none"
  • "ssl"
  • "tls"

state

string

Если задано значение present, гарантирует, что монитор существует.

Если задано значение absent, гарантирует, что монитор удалён.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

target_password

string

Указывает пароль, если для проверяемого целевого объекта требуется аутентификация.

target_username

string

Указывает имя пользователя, если для проверяемого целевого объекта требуется аутентификация.

time_until_up

integer

Указывает, сколько секунд ожидать после первого правильного ответа ресурса на запрос монитора, прежде чем установить для ресурса состояние «работает».

В течение этого интервала все ответы ресурса должны быть правильными.

По истечении интервала ресурс помечается как работающий.

Значение 0 означает, что ресурс помечается как работающий сразу после получения первого правильного ответа.

timeout

integer

Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора.

Если целевой объект отвечает в течение заданного времени, он считается доступным. Если целевой объект не отвечает в течение заданного времени, он считается недоступным. Если для этого параметра задано значение 0 (ноль), система использует интервал родительского монитора.

Обратите внимание: параметры timeout и time_until_up совместно определяют, когда ресурс переводится в состояние «работает».

up_interval

integer

Указывает интервал, который система использует для проверки работоспособности ресурса, когда он доступен.

Если задано значение 0, система использует для проверки работоспособности ресурса интервал, указанный в interval.

При указании любого другого числа можно задать отдельный интервал для проверки работоспособности доступного ресурса.

update_password

string

Параметр 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

string

Новое значение параметра Base LDAP для ресурса.

Возвращается: изменено

Пример: "base"

chase_referrals

boolean

Новое значение параметра Chase Referrals для ресурса.

Возвращается: изменено

Пример: true

debug

boolean

Новое значение параметра Debug для ресурса.

Возвращается: изменено

Пример: true

description

string

Описание монитора.

Возвращается: изменено

Пример: "Important_Monitor"

filter

string

Новое значение параметра Filter LDAP для ресурса.

Возвращается: изменено

Пример: "filter1"

interval

integer

Новый интервал между проверками монитора.

Возвращается: изменено

Пример: 2

ip

string

Новый IP-адрес в определении IP/порта.

Возвращается: изменено

Пример: "10.12.13.14"

mandatory_attributes

boolean

Новое значение параметра Mandatory Attributes для ресурса.

Возвращается: изменено

Пример: false

manual_resume

boolean

Новое значение параметра Manual Resume для ресурса.

Возвращается: изменено

Пример: false

parent

string

Новый родительский шаблон монитора.

Возвращается: изменено

Пример: "ldap"

security

string

Новое значение параметра Security для ресурса.

Возвращается: изменено

Пример: "ssl"

time_until_up

integer

Новое время, по истечении которого система считается доступной после первого успешного ответа.

Возвращается: изменено

Пример: 2

timeout

integer

Новый тайм-аут, в течение которого удалённая система должна ответить монитору.

Возвращается: изменено

Пример: 10

Авторы

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

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API