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

Примечание

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

Впервые появился в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
auto_init boolean	Если `true`, BIG-IP автоматически создает исходящие соединения с активными членами пула в указанном `pool` с использованием конфигурации указанного `transport_config`. Для того, чтобы автоинициализация попыталась установить соединение, пир должен быть включен в маршрут, прикрепленный к экземпляру маршрутизатора. Для каждого экземпляра маршрутизатора, в котором находится пир, инициируется соединение. Логика `auto_init` проверяет в `auto_init_interval` существует ли соединение между BIG-IP и членами пула. Если соединение не существует, оно пытается восстановить его. Варианты: `false` `true`
auto_init_interval integer	Указывает интервал, с которым происходят попытки установить соединение. Значение по умолчанию при создании объекта пира, предоставляемое системой, составляет `5000` миллисекунд. Допустимый диапазон — от 0 до 4294967295 включительно.
connection_mode string	Указывает, как должно быть ограничено количество соединений на хост. Варианты: `"per-blade"` `"per-client"` `"per-peer"` `"per-tmm"`
description string	Определяемое пользователем описание пира.
name string / required	Указывает имя пира для управления.
number_of_connections integer	Указывает распределение соединений между BIG-IP и удаленным хостом. Допустимый диапазон — от 0 до 65535 включительно.
partition string	Раздел устройства для создания объекта пира. По умолчанию: `"Common"`
pool string	Указывает имя пула, к которому направляются сообщения. Указанный пул должен находиться в том же разделе, что и пир.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о соединении.
auth_provider string	Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете пропустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как ее название было запутанным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / required	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете пропустить этот параметр, установив переменную среды `F5_PASSWORD`.
server string / required	Хост BIG-IP или хост BIG-IQ. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение, которое нужно использовать при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / required	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Вы можете пропустить этот параметр, установив переменную среды `F5_USER`.

validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
ratio integer	Указывает отношение, используемое для выбора узла-партнёра в списке узлов-партнёров в маршруте LTM. Принимаемый диапазон значений — от 0 до 4294967295 включительно.
state string	Когда `present`, гарантирует существование узла-партнёра. Когда `absent`, гарантирует удаление узла-партнёра. Варианты: `"present"` ← (по умолчанию) `"absent"`
transport_config string	Имя виртуального узла LTM или LTM транспортной конфигурации для использования при создании исходящего соединения. Ресурс должен существовать в том же разделе, что и объект узла-партнёра.
type string	Параметр, используемый для указания типа узла-партнёра для управления. Значение по умолчанию — `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 boolean	Включает создание исходящих соединений с активными членами пула. Возвращаемое значение: changed Пример: `true`
auto_init_interval integer	Интервал, с которым происходят попытки инициализации соединения. Возвращаемое значение: changed Пример: `2000`
connection_mode string	Определяет, как ограничивается количество соединений на хост. Возвращаемое значение: changed Пример: `"per-peer"`
description string	Пользовательское описание узла-партнёра. Возвращаемое значение: changed Пример: `"Some description"`
...	...

Авторы

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