Модуль f5networks.f5_modules.bigip_message_routing_route — Управляет статическими маршрутами для сообщений протокола маршрутизации

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в книге задач укажите: f5networks.f5_modules.bigip_message_routing_route.

Новая функция в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет статическими маршрутами для маршрутизации сообщений протокола сообщений.

Параметры

Параметр	Комментарии
description строка	Пользовательское описание статического маршрута.
dst_address строка	Указывает адрес назначения маршрута. Установка атрибута в пустую строку создаст подстановочный символ, соответствующий всем адресам назначения сообщений, что является значением по умолчанию при создании нового маршрута.
name строка / обязательно	Указывает имя статического маршрута.
partition строка	Раздел устройства для создания объекта маршрута. По умолчанию: `"Common"`
peer_selection_mode строка	Указывает метод выбора узла-партнера из предоставленного списка `peers`. Варианты: `"ratio"` `"sequential"`
peers список / элементы=строка	Указывает список объектов ltm messagerouting-peer. Указанный узел-партнер должен находиться в том же разделе, что и маршрут.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее используемая переменная `F5_TEEM` устарела, так как ее имя вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
src_address строка	Указывает исходный адрес маршрута. Установка атрибута в пустую строку создаст подстановочный символ, соответствующий всем исходным адресам сообщений, что является значением по умолчанию при создании нового маршрута.
state строка	Когда `present`, гарантирует, что маршрут существует. Когда `absent`, гарантирует удаление маршрута. Варианты: `"present"` ← (по умолчанию) `"absent"`

END_OF_DOCUMENT_MARKER

тип

строка

Параметр используется для указания типа маршрута для управления.

Значение по умолчанию — generic с дополнительными опциями.

Варианты:

"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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
описание строка	Пользовательское описание маршрута. Возвращается: changed Пример: `"Some description"`
адрес_назначения строка	Адрес назначения маршрута. Возвращается: changed Пример: `"blackhole"`
режим_выбора_пира строка	Метод выбора пира. Возвращается: changed Пример: `"ratio"`
пиры список / элементы=строка	Список объектов ltm messagerouting-peer. Возвращается: changed Пример: `["/Common/peer1", "/Common/peer2"]`
исходный_адрес строка	Исходный адрес маршрута. Возвращается: changed Пример: `"annyoing_user"`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_message_routing_route_module.html