f5networks.f5_modules.bigip_message_routing_protocol — Управление профилем универсального анализатора сообщений.
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать его в плейбуке, укажите: f5networks.f5_modules.bigip_message_routing_protocol.
Добавлен в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управляет профилем универсального анализатора сообщений для использования с механизмом маршрутизации сообщений.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Пользовательское описание профиля универсального анализатора. | ||
| disable_parser булево |
| При yes, универсальный анализатор сообщений отключен, все входящие пакеты игнорируются и данные сообщения не отправляются напрямую.Этот режим поддерживает реализации протокола сценариев iRule, которые генерируют сообщения из входящего транспортного потока и отправляют исходящие сообщения по исходящему транспортному потоку. | |
| max_egress_buffer целое число | Указывает максимальный размер буфера отправки в байтах. Если количество байтов в буфере отправки для соединения превысит это значение, универсальный протокол сообщений прекратит получение исходящих сообщений от маршрутизатора, пока размер буфера не уменьшится ниже этого значения. Допустимый диапазон от 0 до 4294967295 включительно. | ||
| max_msg_size целое число | Указывает максимальный размер принятого сообщения. Если сообщение превысит этот размер, соединение будет разорвано. Допустимый диапазон от 0 до 4294967295 включительно. | ||
| msg_terminator строка | Строка символов, используемых для завершения сообщения. Если разделитель сообщения не указан, универсальный анализатор сообщений не будет разделять входящий поток на сообщения. | ||
| name строка / обязательно | Указывает имя профиля универсального анализатора. | ||
| no_response булево |
| При установке отключается сопоставление ответов запросам. | |
| parent строка | Родительская шаблон этого профиля анализатора. После установки этого значения его нельзя изменить. При создании нового профиля, если этот параметр не указан, значение по умолчанию — системный профиль genericmsg. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для создания объекта маршрута. | |
| provider словарь добавлен в 1.0.0 версии 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. | |
| state строка |
| Если present, гарантирует существование маршрута.Если absent, гарантирует удаление маршрута. | |
Примечания
Примечание
- Требуется BIG-IP >= 14.0.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 a generic parser
bigip_message_routing_protocol:
name: foo
description: 'This is parser'
no_response: yes
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify a generic parser
bigip_message_routing_protocol:
name: foo
no_response: no
max_egress_buffer: 10000
max_msg_size: 2000
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove generic parser
bigip_message_routing_protocol:
name: foo
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | changed | Пользовательское описание профиля анализатора. Пример: Моё описание |
| disable_parser булево | changed | Отключает универсальный анализатор сообщений. Пример: True |
| max_egress_buffer целое число | changed | Максимальный размер буфера отправки в байтах. Пример: 10000 |
| max_msg_size целое число | changed | Максимальный размер принятого сообщения. Пример: 4000 |
| msg_terminator строка | changed | Строка символов, используемых для завершения сообщения. Пример: %%%% |
| no_response булево | changed | Отключает сопоставление ответов запросам. Пример: True |
| parent строка | changed | Родительский шаблон этого профиля анализатора. Пример: /Common/genericmsg |
Авторы
- 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_message_routing_protocol_module.html