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

Новая в версии 2.9.

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Пользовательское описание профиля маршрутизатора.
ignore_client_port логическое		Варианты: нет да	Когда `yes`, удаленный порт на стороне клиента, т.е. соединения, где peer подключен к BIG-IP, игнорируется при поиске существующего соединения.
inherited_traffic_group логическое		Варианты: нет да	При установке в `yes`, `traffic_group` будет унаследовано из содержащей папки. Если не указано, система устанавливает это значение в `no`, при создании нового профиля маршрутизатора.
max_pending_bytes целое число			Максимальное количество байтов ожидающих сообщений, которые будут храниться во время ожидания создания соединения с peer. После достижения лимита, любые дополнительные сообщения peer будут помечены как недоставленные и возвращены отправителю. Допустимый диапазон значений от 0 до 4294967295 включительно.
max_pending_messages целое число			Максимальное количество ожидающих сообщений, которые будут храниться во время ожидания создания соединения с peer. После достижения лимита, любые дополнительные сообщения peer будут помечены как недоставленные и возвращены отправителю. Допустимый диапазон значений от 0 до 65535 включительно.
max_retries целое число			Устанавливает максимальное количество попыток повторной отправки сообщения для перемаршрутизации командой `MR::retry` iRule. Допустимый диапазон значений от 0 до 4294967295 включительно.
mirror логическое		Варианты: нет да	Включает или выключает зеркалирование состояния. Зеркалирование состояния можно использовать для поддержания той же информации о состоянии в резервном узле, что и в активном.
mirrored_msg_sweeper_interval целое число			Устанавливает максимальное время в миллисекундах, которое сообщение будет храниться на резервном устройстве, в ожидании перенаправления сообщения активным устройством. Сообщения на резервном устройстве, хранящиеся дольше, чем конфигурируемый интервал очистки, будут удалены. Допустимый диапазон значений от 0 до 4294967295 включительно.
name строка / обязательно			Указывает имя профиля маршрутизатора.
parent строка			Родительская шаблон этого профиля маршрутизатора. После установки этого значения, его нельзя изменить. Значения по умолчанию устанавливаются системой, если не указаны, и соответствуют типу созданного маршрутизатора, т.е. `/Common/messagerouter` для `generic` `type` и так далее.
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 строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
routes список			Указывает список статических маршрутов для использования экземпляром маршрутизатора. Маршрут должен находиться в том же разделе, что и профиль маршрутизатора.
state строка		Варианты: present ← absent	Если `present`, гарантирует, что профиль маршрутизатора существует. Если `absent`, гарантирует удаление профиля маршрутизатора.
traffic_group строка			Указывает группу трафика для профиля маршрутизатора. Указание `traffic_group` пустого значения `""` заставит устройство унаследовать значение от содержащей папки, что означает, что значение `inherited_traffic_group` на устройстве будет `yes`.
type строка		Варианты: generic ←	Параметр, используемый для указания типа управляемого профиля маршрутизатора. Значение по умолчанию — `generic`, с добавлением других вариантов в будущем.
use_local_connection логическое		Варианты: нет да	Если `yes`, маршрутизатор перенаправит сообщение на существующее соединение в том же TMM, что и полученное сообщение.

Примечания

Примечание

Требуется 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 router profile
  bigip_message_routing_router:
    name: foo
    max_retries: 10
    ignore_client_port: yes
    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: no
    mirror: yes
    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 строка	changed	Пользовательское описание профиля маршрутизатора. Пример: Моё описание
ignore_client_port логическое значение	changed	Включает игнорирование удалённого порта при подключении клиента при поиске существующего соединения.
inherited_traffic_group логическое значение	changed	Указывает, должен ли трафик-группа наследоваться из содержащей папки. Пример: True
max_pending_bytes целое число	changed	Максимальное количество байтов ожидающих сообщений, которые будут храниться. Пример: 10000
max_pending_messages целое число	changed	Максимальное количество ожидающих сообщений, которые будут храниться. Пример: 64
max_retries целое число	changed	Максимальное количество попыток повторной отправки сообщения для перенаправления. Пример: 10
mirror логическое значение	changed	Включает или отключает зеркалирование состояния. Пример: True
mirrored_msg_sweeper_interval целое число	changed	Максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве. Пример: 2000
parent строка	changed	Родительская шаблон этого профиля маршрутизатора. Пример: /Common/messagerouter
routes список	changed	Список статических маршрутов, которые нужно использовать для экземпляра маршрутизатора. Пример: ['/Common/route1', '/Common/route2']
traffic_group строка	changed	Группа трафика профиля маршрутизатора. Пример: /Common/traffic-group-1
use_local_connection логическое значение	changed	Включает перенаправление сообщений на существующее подключение на том же TMM, на котором было получено сообщение. Пример: True

Состояние

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается партнёром 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_router_module.html