Модуль f5networks.f5_modules.bigip_message_routing_protocol – управление профилем универсального анализатора сообщений.

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать коллекцию в сценарии, укажите: f5networks.f5_modules.bigip_message_routing_protocol.

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

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

Краткое описание

Управляет профилем универсального анализатора сообщений для использования с платформой маршрутизации сообщений.

Параметры

Параметр	Комментарии
description строка	Описание профиля универсального анализатора, заданное пользователем.
disable_parser логическое значение	Если `true`, универсальный анализатор сообщений отключается, игнорируя все входящие пакеты и не отправляя данные сообщений напрямую. Этот режим поддерживает реализации протоколов на основе сценариев iRule, которые создают сообщения из входящего транспортного потока и отправляют исходящие сообщения в исходящий транспортный поток. Варианты: `false` `true`
max_egress_buffer целое число	Задает максимальный размер буфера отправки в байтах. Если количество байтов в буфере отправки для соединения превышает это значение, универсальный протокол сообщений прекращает получать исходящие сообщения от маршрутизатора, пока размер буфера не станет меньше этого значения. Допустимый диапазон: от 0 до 4294967295 включительно.
max_msg_size целое число	Задает максимальный размер получаемого сообщения. Если размер сообщения превышает это значение, соединение будет сброшено. Допустимый диапазон: от 0 до 4294967295 включительно.
msg_terminator строка	Строка символов, используемая для завершения сообщения. Если терминатор сообщения не указан, универсальный анализатор сообщений не будет разделять входной поток на сообщения.
name строка / обязательный	Задает имя профиля универсального анализатора.
no_response логическое значение	Если параметр задан, сопоставление ответов запросам отключается. Варианты: `false` `true`
parent строка	Родительский шаблон этого профиля анализатора. После задания этого значения его нельзя изменить. При создании нового профиля, если этот параметр не указан, используется системный профиль `genericmsg` по умолчанию.
partition строка	Раздел устройства, в котором создается объект маршрута. По умолчанию: `"Common"`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку ее имя было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server строка / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задает время ожидания в секундах при взаимодействии с сетевым устройством — при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль завершится с ошибкой.
transport строка	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами узлах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state строка	Если `present`, обеспечивает наличие маршрута. Если `absent`, обеспечивает удаление маршрута. Варианты: `"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: true
    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: false
    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 Пример: `"My description"`
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–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_message_routing_protocol_module.html