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

Примечание

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

Новое в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
description строка	Пользовательское описание профиля маршрутизатора.
ignore_client_port логическое	Если `true`, удаленный порт на стороне клиента (соединения, где подключение к BIG-IP) игнорируется при поиске существующего соединения. Варианты: `false` `true`
inherited_traffic_group логическое	Если установлено `true`, `traffic_group` наследуется из содержащей папки. Если не указано, система устанавливает это значение в `false` при создании нового профиля маршрутизатора. Варианты: `false` `true`
max_pending_bytes целое	Максимальное количество байтов ожидающих сообщений, которые будут храниться, ожидая создания соединения с узлом. При достижении этого значения любые дополнительные сообщения узлу будут помечены как недоставленные и возвращены отправителю. Допустимый диапазон от 0 до 4294967295 включительно.
max_pending_messages целое	Максимальное количество ожидающих сообщений, которые будут храниться, ожидая создания соединения с узлом. При достижении этого значения любые дополнительные сообщения узлу будут помечены как недоставленные и возвращены отправителю. Допустимый диапазон от 0 до 65535 включительно.
max_retries целое	Устанавливает максимальное количество попыток повторной отправки сообщения для перенаправления командой iRule `MR::retry`. Допустимый диапазон от 0 до 4294967295 включительно.
mirror логическое	Включает или отключает зеркальное отображение состояния. Зеркальное отображение состояния может использоваться для поддержания одинаковой информации о состоянии в резервной единице, которая находится в активной единице. Варианты: `false` `true`
mirrored_msg_sweeper_interval целое	Указывает максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве, пока оно ожидает перенаправления сообщения активным устройством. Сообщения на резервном устройстве, хранящиеся дольше, чем настроенный интервал, будут удалены. Допустимый диапазон от 0 до 4294967295 включительно.
name строка / обязательно	Указывает имя профиля маршрутизатора.
parent строка	Родительская шаблон этого профиля маршрутизатора. После установки этого значения его нельзя изменить. Значения по умолчанию устанавливаются системой, если не указаны, и они соответствуют типу созданного маршрутизатора, например, `/Common/messagerouter` для `generic` `type` и так далее.
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 integer	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
routes list / elements=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	Пользовательское описание профиля маршрутизатора. Возвращено: changed Пример: `"My description"`
ignore_client_port boolean	Включает игнорирование удаленного порта на соединениях со стороны клиента при поиске существующего соединения. Возвращено: changed Пример: `false`
inherited_traffic_group boolean	Указывает, следует ли наследовать группу трафика из содержащей папки. Возвращено: changed Пример: `true`
max_pending_bytes integer	Максимальное количество байтов ожидающих сообщений, которые будут храниться. Возвращено: changed Пример: `10000`
max_pending_messages integer	Максимальное количество ожидающих сообщений, которые будут храниться. Возвращено: changed Пример: `64`
max_retries integer	Максимальное количество попыток повторной отправки сообщения для перемаршрутизации. Возвращено: changed Пример: `10`
mirror boolean	Включает или отключает зеркалирование состояния. Возвращено: changed Пример: `true`
mirrored_msg_sweeper_interval integer	Максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве. Возвращено: changed Пример: `2000`
parent string	Родительский шаблон этого профиля маршрутизатора. Возвращено: changed Пример: `"/Common/messagerouter"`
routes list / elements=string	Список статических маршрутов для использования экземпляром маршрутизатора. Возвращено: changed Пример: `["/Common/route1", "/Common/route2"]`
traffic_group string	Группа трафика профиля маршрутизатора. Возвращено: changed Пример: `"/Common/traffic-group-1"`
use_local_connection boolean	Включает маршрутизацию сообщений к существующему соединению на том же TMM, где было получено сообщение. Возвращено: changed Пример: `true`

Авторы

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