f5networks.f5_modules.bigip_message_routing_router – Управляет профилями маршрутизаторов для протоколов маршрутизации сообщений
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для установки используйте: 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, удаленный порт на клиентских подключениях (подключениях, где клиент подключен к BIG-IP) игнорируется при поиске существующего подключения. | |
| inherited_traffic_group булево |
| При установке в значение yes, traffic_group будет унаследовано от содержащей папки. Если не указано, система устанавливает это значение в no при создании нового профиля маршрутизатора. | |
| max_pending_bytes целое число | Максимальное количество байтов ожидающих сообщений, которые будут храниться, в ожидании создания подключения к узлу-партнеру. После достижения предела, любые дополнительные сообщения узлу-партнеру будут помечены как непередаваемые и возвращены отправителю. Допустимый диапазон значений от 0 до 4294967295 включительно. | ||
| max_pending_messages целое число | Максимальное количество ожидающих сообщений, которые будут храниться, в ожидании создания подключения к узлу-партнеру. После достижения предела, любые дополнительные сообщения узлу-партнеру будут помечены как непередаваемые и возвращены отправителю. Допустимый диапазон значений от 0 до 65535 включительно. | ||
| max_retries целое число | Устанавливает максимальное количество попыток повторной отправки сообщения для перемаршрутизации командой iRule MR::retry.Допустимый диапазон значений от 0 до 4294967295 включительно. | ||
| mirror булево |
| Включает или отключает зеркальное отображение состояния. Зеркальное отображение состояния может использоваться для поддержания одинаковой информации о состоянии в резервном устройстве, что и в активном. | |
| mirrored_msg_sweeper_interval целое число | Указывает максимальное время в миллисекундах, в течение которого сообщение будет храниться на резервном устройстве, пока оно ожидает, что активное устройство перенаправит сообщение. Сообщения на резервном устройстве, хранящиеся дольше, чем заданный интервал очистки, будут удалены. Допустимый диапазон значений от 0 до 4294967295 включительно. | ||
| name строка / обязательно | Указывает имя профиля маршрутизатора. | ||
| parent строка | Родительская шаблон данного профиля маршрутизатора. После установки этого значения, оно не может быть изменено. Значения по умолчанию устанавливаются системой, если не указаны, и соответствуют типу создаваемого маршрутизатора, например, /Common/messagerouter для generic type и так далее. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для создания профиля маршрутизатора. | |
| 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–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_router_module.html
