f5networks.f5_modules.bigip_message_routing_peer – Управление узлами для маршрутизации сообщений протокола общих сообщений
Примечание
Этот плагин является частью коллекции f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_message_routing_peer.
Новое в версии 1.0.0: модуля f5networks.f5_modules
Описание
- Управление узлами для маршрутизации сообщений протокола общих сообщений.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auto_init логический тип |
| Если yes, BIG-IP автоматически создаёт исходящие подключения к активным членам пула в указанном pool с использованием конфигурации указанного transport_config.Для попытки автоматической инициализации подключения, узел должен быть включен в маршрут, подключённый к экземпляру маршрутизатора. Для каждого экземпляра маршрутизатора, в котором содержится узел, инициируется подключение. Логика auto_init проверяет в auto_init_interval наличие подключения между BIG-IP и членами пула. Если подключения нет, оно пытается его восстановить. | |
| auto_init_interval целое число | Указывает интервал, в течение которого происходят попытки инициирования подключения. Значение по умолчанию при создании объекта узла, которое предоставляется системой, составляет 5000 миллисекунд.Допустимый диапазон — от 0 до 4294967295 включительно. | ||
| connection_mode строка |
| Определяет, как будет ограничено количество подключений на хост. | |
| description строка | Пользовательское описание узла. | ||
| name строка / обязательно | Указывает имя узла для управления. | ||
| number_of_connections целое число | Определяет распределение подключений между BIG-IP и удалённым хостом. Допустимый диапазон — от 0 до 65535 включительно. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для создания объекта узла. | |
| pool строка | Указывает имя пула, к которому направляются сообщения. Указанный пул должен находиться в том же разделе, что и узел. | ||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логический тип |
| Если yes, данные телеметрии TEEM не отправляются на F5.Вы можете опустить этот параметр, задав переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_SERVER_PORT. | |
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, задав переменную среды F5_USER. | ||
| validate_certs логический тип |
| Если no, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, находящихся под вашим контролем, с самозаверяющимися сертификатами.Вы можете опустить этот параметр, задав переменную среды F5_VALIDATE_CERTS. | |
| ratio целое число | Указывает соотношение, которое будет использоваться для выбора узла в списке узлов в маршруте LTM. Допустимый диапазон — от 0 до 4294967295 включительно. | ||
| state строка |
| При значении present, гарантируется существование узла.При значении absent, гарантируется удаление узла. | |
| transport_config строка | Имя виртуального LTM или LTM transport-config для создания исходящего соединения. Ресурс должен существовать в том же разделе, что и объект узла. | ||
| type строка |
| Параметр, используемый для указания типа узла для управления. Значение по умолчанию — 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: yes
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 | изменённый | Включает создание исходящих соединений с активными членами пула. Пример: True |
| auto_init_interval integer | изменённый | Интервал, через который выполняются попытки инициировать соединение. Пример: 2000 |
| connection_mode string | изменённый | Указывает, как ограничить количество соединений на хост. Пример: per-peer |
| description string | изменённый | Определяемое пользователем описание узла. Пример: Некоторое описание |
| number_of_connections integer | изменённый | Распределение соединений между BIG-IP и удалённым хостом. Пример: 2000 |
| pool string | изменённый | Имя пула, к которому маршрутизируются сообщения. Пример: /Bazbar/foobar |
| ratio integer | изменённый | Коэффициент, используемый для выбора узла из списка узлов в маршруте LTM. Пример: 500 |
| transport_config string | изменённый | Виртуальный LTM или LTM transport-config, используемый для создания исходящего соединения. Пример: /Common/foobar |
Авторы
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_message_routing_peer_module.html
