bigip_message_routing_peer – Управление участниками для маршрутизации сообщений протокола общих сообщений
Новое в версии 2.9.
Описание
- Управление участниками для маршрутизации сообщений протокола общих сообщений.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auto_init boolean |
| Если yes, BIG-IP автоматически создаст исходящие подключения к активным членам пула в указанном pool с использованием конфигурации указанного transport_config. Для попытки автоинициализации подключения, участник должен быть включён в маршрут, прикреплённый к экземпляру маршрутизатора. Для каждого экземпляра маршрутизатора, в который входит участник, будет инициировано подключение. Логика auto_init будет проверять в auto_init_interval наличие подключения между BIG-IP и членами пула. Если подключения нет, оно будет попытка восстановления. | |
| auto_init_interval integer | Указывает интервал, в течение которого происходит попытка инициализации подключения. Значение по умолчанию при создании объекта участника, предоставляемое системой, составляет 5000 миллисекунд.Допустимый диапазон - от 0 до 4294967295 включительно. | ||
| connection_mode string |
| Указывает, как будет ограничено количество подключений на хост. | |
| description string | Определённое пользователем описание участника. | ||
| name string / обязательно | Указывает имя участника для управления. | ||
| number_of_connections integer | Указывает распределение подключений между BIG-IP и удалённым хостом. Допустимый диапазон - от 0 до 65535 включительно. | ||
| partition string | По умолчанию: "Common" | Раздел устройства для создания объекта участника. | |
| pool string | Указывает имя пула, к которому будут маршрутизироваться сообщения. Указанный пул должен находиться в том же разделе, что и участник. | ||
| provider dictionary добавлен в 2.5 | Объект dict, содержащий сведения о подключении. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр в основном используется при работе с устройствами BIG-IQ. | ||
| password string / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER. | ||
| server_port integer | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile path | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | ||
| transport string |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user string / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| ratio integer | Указывает коэффициент, используемый для выбора участника в списке участников в маршруте ltm. Допустимый диапазон - от 0 до 4294967295 включительно. | ||
| state string |
| Если present, гарантирует, что участник существует.Если absent, гарантирует удаление участника. | |
| transport_config string | Имя виртуального ltm или ltm transport-config, используемого для создания исходящего подключения. Ресурс должен находиться в том же разделе, что и объект участника. | ||
| type string |
| Параметр, используемый для указания типа управляемого участника. Значение по умолчанию - generic с добавлением дополнительных вариантов в будущем. | |
Примечания
Примечание
- Требуется 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 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 целое число | изменённый | Интервал, в течение которого выполняются попытки инициировать подключение. Пример: 2000 |
| connection_mode строка | изменённый | Определяет, как будет ограничено количество подключений на хост. Пример: per-peer |
| description строка | изменённый | Пользовательское описание участника. Пример: Некоторое описание |
| number_of_connections целое число | изменённый | Распределение подключений между BIG-IP и удалённым хостом. Пример: 2000 |
| pool строка | изменённый | Имя пула, к которому будут маршрутизироваться сообщения. Пример: /Bazbar/foobar |
| ratio целое число | изменённый | Коэффициент, используемый для выбора участника в списке участников в маршруте ltm. Пример: 500 |
| transport_config строка | изменённый | Виртуальный ltm или ltm transport-config, используемый для создания исходящего подключения. Пример: /Common/foobar |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается партнёром 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_peer_module.html
