f5networks.f5_modules.bigip_message_routing_route – Управляет статическими маршрутами для сообщений протокола маршрутизации
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_message_routing_route.
Добавлено в версии 1.0.0: модуля f5networks.f5_modules
Описание
- Управляет статическими маршрутами для сообщений протокола маршрутизации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Определяемое пользователем описание статического маршрута. | ||
| dst_address строка | Указывает адрес назначения маршрута. Установление значения в пустую строку создаст подстановочный символ, соответствующий всем адресам назначения сообщений. Это значение по умолчанию при создании нового маршрута. | ||
| name строка / обязательно | Указывает имя статического маршрута. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для создания объекта маршрута. | |
| peer_selection_mode строка |
| Указывает метод выбора узла из предоставленного списка peers. | |
| peers список / элементы=строка | Указывает список объектов ltm messagerouting-peer. Указанный узел должен находиться в том же разделе, что и маршрут. | ||
| 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. | |
| src_address строка | Указывает исходный адрес маршрута. Установление значения в пустую строку создаст подстановочный символ, соответствующий всем адресам источника сообщений. Это значение по умолчанию при создании нового маршрута. | ||
| state строка |
| При present, гарантирует существование маршрута.При absent, гарантирует удаление маршрута. | |
| 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 generic route
bigip_message_routing_route:
name: foobar
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify a generic route
bigip_message_routing_route:
name: foobar
peers:
- peer1
- peer2
peer_selection_mode: ratio
src_address: annoying_user
dst_address: blackhole
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove a generic
bigip_message_routing_route:
name: foobar
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | изменено | Определяемое пользователем описание маршрута. Пример: Некоторое описание |
| dst_address строка | изменено | Адрес назначения маршрута. Пример: blackhole |
| peer_selection_mode строка | изменено | Метод выбора узла. Пример: ratio |
| peers список / элементы=строка | изменено | Список объектов ltm messagerouting-peer. Пример: ['/Common/peer1', '/Common/peer2'] |
| src_address строка | изменено | Исходный адрес маршрута. Пример: annyoing_user |
Авторы
- 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_route_module.html
