f5networks.f5_modules.bigip_message_routing_router – Управляет профилями маршрутизаторов для протоколов маршрутизации сообщений
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_message_routing_router.
Добавлен в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управляет профилями маршрутизаторов для протоколов маршрутизации сообщений.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Пользовательское описание профиля маршрутизатора. | ||
| ignore_client_port логическое значение |
| Когда yes, удаленный порт на клиентских соединениях (соединения, где соединенный peer с BIG-IP) игнорируется при поиске существующего соединения. | |
| inherited_traffic_group логическое значение |
| При установке в yes, traffic_group будет унаследован от содержащей папки. Если не указано, система устанавливает это значение по умолчанию в no при создании нового профиля маршрутизатора. | |
| max_pending_bytes целое число | Максимальное количество байтов ожидающих сообщений, которые будут храниться в ожидании создания подключения к peer. После достижения этого значения любые дополнительные сообщения peer будут помечены как не доставляемые и возвращены отправителю. Допустимый диапазон значений: от 0 до 4294967295 включительно. | ||
| max_pending_messages целое число | Максимальное количество ожидающих сообщений, которые будут храниться в ожидании создания подключения к peer. После достижения этого значения любые дополнительные сообщения peer будут помечены как не доставляемые и возвращены отправителю. Допустимый диапазон значений: от 0 до 65535 включительно. | ||
| max_retries целое число | Устанавливает максимальное количество попыток повторной отправки сообщения для повторного маршрутизирования командой iRule MR::retry.Допустимый диапазон значений: от 0 до 4294967295 включительно. | ||
| mirror логическое значение |
| Включает или отключает зеркалирование состояния. Зеркалирование состояния может использоваться для поддержания одинаковой информации о состоянии в резервном устройстве, что и в активном устройстве. | |
| mirrored_msg_sweeper_interval целое число | Устанавливает максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве, ожидая, пока активное устройство маршрутизирует сообщение. Сообщения на резервном устройстве, хранящиеся дольше, чем конфигурируемый интервал, будут удалены. Допустимый диапазон значений: от 0 до 4294967295 включительно. | ||
| name строка / обязательно | Указывает имя профиля маршрутизатора. | ||
| parent строка | Родительская шаблон этого профиля маршрутизатора. После установки этого значения его изменить нельзя. Значения по умолчанию устанавливаются системой, если не указаны, и соответствуют типу маршрутизатора, созданного, например, /Common/messagerouter для generic type и так далее. | ||
| partition строка | Значение по умолчанию: "Общая" | Раздел устройства для создания профиля маршрутизатора. | |
| 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. | |
| routes список / элементы=строка | Указывает список статических маршрутов для использования экземпляром маршрутизатора. Маршрут должен находиться в том же разделе, что и профиль маршрутизатора. | ||
| state строка |
| Когда present, гарантирует, что профиль маршрутизатора существует.Когда absent, гарантирует удаление профиля маршрутизатора. | |
| traffic_group строка | Указывает группу трафика профиля маршрутизатора. Установка traffic_group в пустое значение "" приведет к тому, что устройство унаследует значение из содержащей папки, что означает, что значение inherited_traffic_group на устройстве будет yes. | ||
| type строка |
| Параметр, используемый для указания типа профиля маршрутизатора для управления. Значение по умолчанию — generic с последующими вариантами. | |
| use_local_connection логическое значение |
| Если yes, маршрутизатор будет маршрутизировать сообщение на существующее соединение в том же TMM, что и принятое сообщение. | |
Примечания
Примечание
- Требуется 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 generic router profile
bigip_message_routing_router:
name: foo
max_retries: 10
ignore_client_port: yes
routes:
- /Common/route1
- /Common/route2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify a generic router profile
bigip_message_routing_router:
name: foo
ignore_client_port: no
mirror: yes
mirrored_msg_sweeper_interval: 4000
traffic_group: /Common/traffic-group-2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove a generic router profile
bigip_message_routing_router:
name: foo
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description string | изменённое | Определяемое пользователем описание профиля маршрутизатора. Пример: Моё описание |
| ignore_client_port boolean | изменённое | Включает игнорирование удалённого порта на стороне клиента при поиске существующего соединения. |
| inherited_traffic_group boolean | изменённое | Указывает, должен ли трафик-группа наследоваться из содержащей папки. Пример: True |
| max_pending_bytes integer | изменённое | Максимальное количество байтов ожидающих сообщений, которые будут храниться. Пример: 10000 |
| max_pending_messages integer | изменённое | Максимальное количество ожидающих сообщений, которые будут храниться. Пример: 64 |
| max_retries integer | изменённое | Максимальное количество попыток повторной отправки сообщения для перенаправления. Пример: 10 |
| mirror boolean | изменённое | Включает или отключает зеркалирование состояния. Пример: True |
| mirrored_msg_sweeper_interval integer | изменённое | Максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве. Пример: 2000 |
| parent string | изменённое | Родительская шаблон этого профиля маршрутизатора. Пример: /Common/messagerouter |
| routes list / elements=string | изменённое | Список статических маршрутов для использования экземпляром маршрутизатора. Пример: ['/Common/route1', '/Common/route2'] |
| traffic_group string | изменённое | Группа трафика профиля маршрутизатора. Пример: /Common/traffic-group-1 |
| use_local_connection boolean | изменённое | Включает маршрутизацию сообщений к существующему соединению на том же TMM, что и полученное сообщение. Пример: True |
Авторы
- 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_router_module.html
