Модуль f5networks.f5_modules.bigip_message_routing_router — управление профилями маршрутизаторов для протоколов маршрутизации сообщений

Примечание

Этот модуль входит в коллекцию 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_router.

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

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

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

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

Параметры

Параметр	Описание
description string	Описание профиля маршрутизатора, заданное пользователем.
ignore_client_port boolean	Если задано `true`, удалённый порт в клиентских соединениях (соединениях, в которых узел-партнёр подключился к BIG-IP) не учитывается при поиске существующего соединения. Варианты: `false` `true`
inherited_traffic_group boolean	Если задано значение `true`, `traffic_group` наследуется от содержащей папки. Если параметр не указан, при создании профиля маршрутизатора система задаёт для него значение `false`. Варианты: `false` `true`
max_pending_bytes integer	Максимальное количество байтов ожидающих сообщений, которые будут храниться в ожидании создания соединения с узлом-партнёром. При достижении этого предела все последующие сообщения для узла-партнёра будут помечены как недоставляемые и возвращены отправителю. Допустимый диапазон: от 0 до 4294967295 включительно.
max_pending_messages integer	Максимальное количество ожидающих сообщений, которые будут храниться в ожидании создания соединения с узлом-партнёром. При достижении этого предела все последующие сообщения для узла-партнёра будут помечены как недоставляемые и возвращены отправителю. Допустимый диапазон: от 0 до 65535 включительно.
max_retries integer	Задаёт максимальное количество раз, которое сообщение можно повторно отправить на маршрутизацию с помощью команды iRule `MR::retry`. Допустимый диапазон: от 0 до 4294967295 включительно.
mirror boolean	Включает или отключает зеркалирование состояния. Зеркалирование состояния позволяет поддерживать на резервном устройстве ту же информацию о состоянии, что и на активном устройстве. Варианты: `false` `true`
mirrored_msg_sweeper_interval integer	Задаёт максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве в ожидании маршрутизации сообщения активным устройством. Сообщения на резервном устройстве, хранящиеся дольше заданного интервала очистки, будут удалены. Допустимый диапазон: от 0 до 4294967295 включительно.
name string / обязательный	Задаёт имя профиля маршрутизатора.
parent string	Родительский шаблон этого профиля маршрутизатора. После задания этого значения его нельзя изменить. Если значения не указаны, система задаёт значения по умолчанию в соответствии с типом создаваемого маршрутизатора, например `/Common/messagerouter` для `generic` `type` и так далее.
partition string	Раздел устройства, в котором создаётся профиль маршрутизатора. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Словарь, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если задано `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Имя узла BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при обмене данными с сетевым устройством — как при подключении, так и при отправке команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если задано `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
routes list / элементы=string	Задаёт список статических маршрутов, используемых экземпляром маршрутизатора. Маршрут должен находиться в том же разделе, что и профиль маршрутизатора.
state string	Если задано `present`, обеспечивает наличие профиля маршрутизатора. Если задано `absent`, обеспечивает удаление профиля маршрутизатора. Варианты: `"present"` ← (по умолчанию) `"absent"`
traffic_group string	Задаёт группу трафика профиля маршрутизатора. Если задать для `traffic_group` пустую строку `""`, устройство унаследует значение от содержащей папки; это означает, что значение `inherited_traffic_group` на устройстве будет `true`.
type string	Параметр для указания типа профиля маршрутизатора, которым нужно управлять. По умолчанию задано значение `generic`; в дальнейшем появятся дополнительные варианты. Варианты: `"generic"` ← (по умолчанию)
use_local_connection boolean	Если задано `true`, маршрутизатор направляет сообщение к существующему соединению на том же TMM, на котором было получено сообщение. Варианты: `false` `true`

Примечания

Примечание

Требуется 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 router profile
  bigip_message_routing_router:
    name: foo
    max_retries: 10
    ignore_client_port: true
    routes:
      - /Common/route1
      - /Common/route2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a generic router profile
  bigip_message_routing_router:
    name: foo
    ignore_client_port: false
    mirror: true
    mirrored_msg_sweeper_interval: 4000
    traffic_group: /Common/traffic-group-2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove a generic router profile
  bigip_message_routing_router:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:

Ключ	Описание
description string	Описание профиля маршрутизатора, заданное пользователем. Возвращается: при изменении Пример: `"My description"`
ignore_client_port boolean	Включает игнорирование удалённого порта в клиентских соединениях при поиске существующего соединения. Возвращается: при изменении Пример: `false`
inherited_traffic_group boolean	Указывает, следует ли наследовать группу трафика от содержащей папки. Возвращается: при изменении Пример: `true`
max_pending_bytes integer	Максимальное количество байтов ожидающих сообщений, которые будут храниться. Возвращается: при изменении Пример: `10000`
max_pending_messages integer	Максимальное количество ожидающих сообщений, которые будут храниться. Возвращается: при изменении Пример: `64`
max_retries integer	Максимальное количество раз, которое сообщение можно повторно отправить на маршрутизацию. Возвращается: при изменении Пример: `10`
mirror boolean	Включает или отключает зеркалирование состояния. Возвращается: при изменении Пример: `true`
mirrored_msg_sweeper_interval integer	Максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве. Возвращается: при изменении Пример: `2000`
parent string	Родительский шаблон этого профиля маршрутизатора. Возвращается: при изменении Пример: `"/Common/messagerouter"`
routes list / элементы=string	Список статических маршрутов, используемых экземпляром маршрутизатора. Возвращается: при изменении Пример: `["/Common/route1", "/Common/route2"]`
traffic_group string	Группа трафика профиля маршрутизатора. Возвращается: при изменении Пример: `"/Common/traffic-group-1"`
use_local_connection boolean	Включает маршрутизацию сообщений к существующему соединению на том же TMM, на котором было получено сообщение. Возвращается: при изменении Пример: `true`

Авторы

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_router_module.html