Spec-Zone.ru › Ansible 2.11

f5networks.f5_modules.bigip_monitor_smtp – Управление мониторами SMTP на BIG-IP

Примечание

Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.7.1).

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в книге задач, укажите: f5networks.f5_modules.bigip_monitor_smtp.

Добавлена в версии 1.1.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
app_service
строка
Сервис iApp, который необходимо связать с этим профилем. Если сервис не указан, используется значение по умолчанию None.
debug
логический тип
    Варианты:
  • no
  • yes
Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в создаваемый и именованный специально для этого монитора файл журнала.
При значении yes система перенаправляет сообщения об ошибках и дополнительную информацию в файл /var/log/monitors/<monitor_name>-<node_name>-<port>.log.
description
строка
Описание монитора.
domain
строка
Указывает доменное имя для проверки.
interval
целое число
Интервал, определяющий частоту выполнения монитора данного шаблона.
Это значение должно быть меньше значения timeout.
При создании нового монитора, если этот параметр не указан, используется значение по умолчанию 5.
ip
строка
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'.
manual_resume
логический тип
    Варианты:
  • no
  • yes
Указывает, автоматически ли система изменяет состояние ресурса на enabled при следующем успешном проверочном цикле монитора.
Если вы установите это значение в yes, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.
При создании нового монитора, если этот параметр не указан, значение по умолчанию — no.
При значении yes, указывает, что необходимо вручную повторно включить ресурс после неуспешной проверки монитора.
При значении no, указывает, что система автоматически изменяет состояние ресурса на enabled при следующем успешном проверочном цикле монитора.
name
строка / обязательно
Указывает имя монитора.
parent
строка
Родительский шаблон этого шаблона монитора. После установки это значение изменить нельзя.
При создании нового монитора, если этот параметр не указан, используется системный монитор smtp по умолчанию.
partition
строка
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
port
строка
Часть адреса порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Если указывается IP-адрес, необходимо указать значение от 1 до 65535.
provider
словарь
добавлен в версии 1.0.0 модуля f5networks.f5_modules
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem
логический тип
    Варианты:
  • no
  • yes
Если 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
строка
    Варианты:
  • rest ←
Настраивает транспортное соединение для использования при подключении к удаленному устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную среды F5_USER.
validate_certs
логический тип
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте это только на сайтах под своим контролем, использующих самозаверенные сертификаты.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
state
строка
    Варианты:
  • present ←
  • absent
При значении present, гарантирует существование монитора.
При значении absent, гарантирует удаление монитора.
time_until_up
целое число
Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный.
Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла.
Если этот параметр не указан при создании нового монитора, используется значение по умолчанию 0.
timeout
целое число
Количество секунд, в течение которых узел или служба должны ответить на запрос монитора.
Если целевой ресурс отвечает в течение установленного периода, он считается активным.
Если целевой ресурс не отвечает в течение установленного периода, он считается неактивным.
Можно изменить это значение на любое число, однако оно должно быть в 3 раза больше числа интервалов плюс 1 секунда.
Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 31.
up_interval
целое число
Указывает интервал, который система использует для проверки состояния, когда ресурс активен.
При значении 0, система использует интервал, указанный в interval, для проверки состояния ресурса.
При любом другом значении можно указать другой интервал для проверки состояния активного ресурса.
При создании нового монитора, если этот параметр не указан, используется значение по умолчанию 0.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение специфичной для BIG-IP конфигурации в файле, убедитесь, что вы включили по крайней мере одну задачу, которая использует модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create SMTP Monitor
  bigip_monitor_smtp:
    state: present
    ip: 10.10.10.10
    name: my_smtp_monitor
    domain: foo.com
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove SMTP Monitor
  bigip_monitor_smtp:
    state: absent
    name: my_smtp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
app_service
строка
изменённое
Служба iApp, связанная с этим монитором.

Пример:
/Common/good_service.app/good_service
debug
логический тип
изменённое
Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора.
description
строка
изменённое
Описание монитора.

Пример:
Важный монитор
domain
строка
изменённое
Указывает имя домена для проверки.

Пример:
bigipinternal.com
interval
целое число
изменённое
Новый интервал, в котором нужно выполнять проверку монитора.

Пример:
2
ip
строка
изменённое
Новый IP-адрес для определения IP/порта.

Пример:
10.12.13.14
manual_resume
логический тип
изменённое
Указывает, автоматически ли система изменяет статус ресурса на «включён» при следующей успешной проверке монитора.

Пример:
True
parent
строка
изменённое
Родительский монитор.

Пример:
/Common/foo_smtp
port
строка
изменённое
Псевдоним порта или службы для проверки монитором от имени пулов или членов пулов, с которыми связан монитор.

Пример:
80
time_until_up
целое число
изменённое
Новое время, в течение которого система помечается как «включён» после первого успешного ответа.

Пример:
2
timeout
целое число
изменённое
Новый таймаут, в течение которого удалённая система должна ответить на запрос монитора.

Пример:
10
up_interval
целое число
изменённое
Интервал, используемый системой для выполнения проверки состояния, когда ресурс включён.


Авторы

  • Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_monitor_smtp_module.html

Spec-Zone.ru

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