bigip_message_routing_route – Управляет статическими маршрутами для сообщений протокола маршрутизации
Новая версия с 2.9.
Описание
- Управляет статическими маршрутами для маршрутизации сообщений протокола.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Пользовательское описание статического маршрута. | ||
| dst_address строка | Указывает адрес назначения маршрута. Указание пустой строки создаст подстановочный символ, соответствующий всем адресам назначения сообщений, что является значением по умолчанию при создании нового маршрута. | ||
| name строка / обязательно | Указывает имя статического маршрута. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для создания объекта маршрута. | |
| peer_selection_mode строка |
| Указывает метод для выбора узла из предоставленного списка peers. | |
| peers список | Указывает список объектов ltm messagerouting-peer. Указанный узел должен находиться в том же разделе, что и маршрут. | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика авторизации для получения токенов аутентификации от удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| password строка / обязательно | Пароль учётной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл ключа SSH для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| 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 настроек на диске, убедитесь, что включён хотя бы один шаг, использующий модуль 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 |
Статус
- Гарантируется совместимость этого модуля с предыдущими версиями. [preview]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- Войцех Выпиор (@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_route_module.html
