f5networks.f5_modules.bigip_message_routing_peer – Управление узлами для маршрутизации сообщений протокола универсальных сообщений
Примечание
Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: 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, используемого для создания исходящего подключения. Ресурс должен существовать в том же разделе, что и объект узла. | ||
| 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 транспорт-конфигурация, используемая для создания исходящего соединения. Пример: /Common/foobar |
Авторы
- 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.10/collections/f5networks/f5_modules/bigip_message_routing_peer_module.html
