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

Примечание

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

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

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

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

Авторы

Wojciech Wypior (@wojtek0806)

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

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