Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_message_routing_protocol модуль — Управление профилем анализатора универсальных сообщений.

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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

Объект словаря, содержащий данные подключения.

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

boolean

Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, использующих самозаверенные сертификаты.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

state

string

Когда 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

string

Пользовательское описание профиля парсера.

Возвращаемое значение: changed

Пример: "My description"

disable_parser

boolean

Отключает общий парсер сообщений.

Возвращаемое значение: changed

Пример: true

max_egress_buffer

integer

Максимальный размер буфера отправки в байтах.

Возвращаемое значение: changed

Пример: 10000

max_msg_size

integer

Максимальный размер принятого сообщения.

Возвращаемое значение: changed

Пример: 4000

msg_terminator

string

Строка символов, используемых для завершения сообщения.

Возвращаемое значение: changed

Пример: "%%%%"

no_response

boolean

Отключает соответствие ответов запросам.

Возвращаемое значение: changed

Пример: true

parent

string

Родительская шаблон этого профиля парсера.

Возвращаемое значение: changed

Пример: "/Common/genericmsg"

Авторы

  • Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (Исходные коды)

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

Spec-Zone.ru

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