bigip_message_routing_protocol – Управление профилем парсера универсальных сообщений
Новая версия с 2.9.
Описание
- Управляет профилем парсера универсальных сообщений для использования с механизмом маршрутизации сообщений.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Пользовательское описание профиля универсального парсера. | ||
| disable_parser логическое значение |
| Когда yes, универсальный парсер сообщений будет отключен, игнорируя все входящие пакеты и не отправляя данные сообщения напрямую.Этот режим поддерживает реализации протоколов скриптов iRule, которые будут генерировать сообщения из входящего транспортного потока и отправлять исходящие сообщения в исходящий транспортный поток. | |
| max_egress_buffer целое число | Устанавливает максимальный размер буфера отправки в байтах. Если количество байтов в буфере отправки для соединения превысит это значение, универсальный протокол сообщений прекратит прием исходящих сообщений от маршрутизатора, пока размер буфера не станет меньше этого значения. Принимаемые значения находятся в диапазоне от 0 до 4294967295 включительно. | ||
| max_msg_size целое число | Устанавливает максимальный размер полученного сообщения. Если сообщение превышает этот размер, соединение будет прервано. Принимаемые значения находятся в диапазоне от 0 до 4294967295 включительно. | ||
| msg_terminator строка | Строка символов, используемая для завершения сообщения. Если терминатор сообщения не указан, универсальный парсер сообщений не будет разделять входной поток на сообщения. | ||
| name строка / обязательно | Указывает имя профиля универсального парсера. | ||
| no_response логическое значение |
| При установке отключается сопоставление ответов запросам. | |
| parent строка | Родительская шаблон данного профиля парсера. После установки этого значения его изменить нельзя. При создании нового профиля, если этот параметр не указан, значение по умолчанию - системный genericmsg профиль. | ||
| partition строка | Значение по умолчанию: "Общий" | Раздел устройства для создания объекта маршрута. | |
| provider словарь добавлено в 2.5 | Объект словаря, содержащий данные соединения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут будет превышен до завершения операции, модуль вернет ошибку. | ||
| 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 конфигурация сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль 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 строка | изменённое | Определяемое пользователем описание профиля парсера. Пример: Описание моего профиля |
| disable_parser булево | изменённое | Отключает общий парсер сообщений. Пример: True |
| max_egress_buffer целое число | изменённое | Максимальный размер буфера отправки в байтах. Пример: 10000 |
| max_msg_size целое число | изменённое | Максимальный размер полученного сообщения. Пример: 4000 |
| msg_terminator строка | изменённое | Строка символов, используемая для завершения сообщения. Пример: %%%% |
| no_response булево | изменённое | Отключает сопоставление ответов с запросами. Пример: True |
| parent строка | изменённое | Родительская шаблон этого профиля парсера. Пример: /Common/genericmsg |
Статус
- Интерфейс этого модуля не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_message_routing_protocol_module.html
