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

Примечание

Этот плагин является частью коллекции f5networks.f5_modules (версия 1.6.0).

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

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

Новое в версии 1.0.0: of f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Пользовательское описание профиля общего анализатора.
disable_parser логическое		Варианты: no yes	При `yes`, общий анализатор сообщений отключён, игнорируются все входящие пакеты, и данные сообщений не передаются напрямую. Этот режим поддерживает реализации протоколов скриптов iRule, которые генерируют сообщения из входящего транспортного потока и отправляют исходящие сообщения по исходящему транспортному потоку.
max_egress_buffer целое число			Устанавливает максимальный размер буфера отправки в байтах. Если количество байтов в буфере отправки для соединения превысит это значение, общий протокол сообщений прекратит приём исходящих сообщений от маршрутизатора, пока размер буфера не станет меньше этого значения. Принимаемый диапазон от 0 до 4294967295 включительно.
max_msg_size целое число			Устанавливает максимальный размер полученного сообщения. Если сообщение превышает этот размер, соединение будет прервано. Принимаемый диапазон от 0 до 4294967295 включительно.
msg_terminator строка			Строка символов, используемая для завершения сообщения. Если разделитель сообщения не указан, общий анализатор сообщений не разделит входной поток на сообщения.
name строка / обязательно			Указывает имя профиля общего анализатора.
no_response логическое		Варианты: no yes	При установке отключается сопоставление ответов запросам.
parent строка			Родительская шаблон этого профиля анализатора. После установки этого значения его нельзя изменить. При создании нового профиля, если этот параметр не указан, значение по умолчанию — системный профиль `genericmsg`.
partition строка		Значение по умолчанию: "Общие"	Раздел устройства, на котором нужно создать объект маршрута.
provider словарь добавлен в 1.0.0 of 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`, гарантирует удаление маршрута.

Примечания

Примечание

Требуется 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_message_routing_protocol_module.html