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

Примечание

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

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

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

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

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

Параметры

Параметр	Комментарии
auto_init логический	Если `true`, BIG-IP автоматически создает исходящие подключения к активным участникам указанного пула `pool`, используя конфигурацию указанного `transport_config`. Чтобы автоматическая инициализация могла создать подключение, узел должен входить в маршрут, привязанный к экземпляру маршрутизатора. Для каждого экземпляра маршрутизатора, в который входит узел, инициируется подключение. Логика `auto_init` проверяет `auto_init_interval`, существует ли подключение между BIG-IP и участниками пула. Если подключение отсутствует, выполняется попытка восстановить его. Варианты: `false` `true`
auto_init_interval целое число	Задает интервал между попытками установить подключение. Значение по умолчанию, задаваемое системой при создании объекта узла, составляет `5000` миллисекунд. Допустимый диапазон: от 0 до 4294967295 включительно.
connection_mode строка	Задает способ ограничения количества подключений для каждого хоста. Варианты: `"per-blade"` `"per-client"` `"per-peer"` `"per-tmm"`
description строка	Описание узла, заданное пользователем.
name строка / обязательный	Задает имя узла, которым нужно управлять.
number_of_connections целое число	Задает распределение подключений между BIG-IP и удаленным хостом. Допустимый диапазон: от 0 до 65535 включительно.
partition строка	Раздел устройства, в котором создается объект узла. По умолчанию: `"Common"`
pool строка	Задает имя пула, к которому маршрутизируются сообщения. Указанный пул должен находиться в том же разделе, что и узел.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
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 логический	Если `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
ratio целое число	Задает коэффициент, используемый для выбора узла из списка узлов в маршруте LTM. Допустимый диапазон: от 0 до 4294967295 включительно.
state строка	Если `present`, обеспечивает наличие узла. Если `absent`, обеспечивает удаление узла. Варианты: `"present"` ← (по умолчанию) `"absent"`
transport_config строка	Имя виртуального сервера LTM или объекта transport-config LTM, используемого для создания исходящего подключения. Ресурс должен находиться в том же разделе, что и объект узла.
type строка	Параметр, задающий тип узла, которым нужно управлять. По умолчанию установлено значение `generic`; ожидается добавление других вариантов. Варианты: `"generic"` ← (по умолчанию)

Примечания

Примечание

Требуется 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 simple peer
  bigip_message_routing_peer:
    name: foobar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create message routing peer with additional settings
  bigip_message_routing_peer:
    name: foobar
    connection_mode: per-blade
    pool: /baz/bar
    partition: baz
    transport_config: foovirtual
    ratio: 10
    auto_init: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify message routing peer settings
  bigip_message_routing_peer:
    name: foobar
    partition: baz
    ratio: 20
    auto_init_interval: 2000
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove message routing peer
  bigip_message_routing_peer:
    name: foobar
    partition: baz
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
auto_init логический	Включает создание исходящих подключений к активным участникам пула. Возвращается: при изменении Пример: `true`
auto_init_interval целое число	Интервал между попытками установить подключение. Возвращается: при изменении Пример: `2000`
connection_mode строка	Задает способ ограничения количества подключений для каждого хоста. Возвращается: при изменении Пример: `"per-peer"`
description строка	Описание узла, заданное пользователем. Возвращается: при изменении Пример: `"Some description"`
number_of_connections целое число	Распределение подключений между BIG-IP и удаленным хостом. Возвращается: при изменении Пример: `2000`
pool строка	Имя пула, к которому маршрутизируются сообщения. Возвращается: при изменении Пример: `"/Bazbar/foobar"`
ratio целое число	Коэффициент, используемый для выбора узла из списка узлов в маршруте LTM. Возвращается: при изменении Пример: `500`
transport_config строка	Виртуальный сервер LTM или объект transport-config LTM, используемый для создания исходящего подключения. Возвращается: при изменении Пример: `"/Common/foobar"`

Авторы

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