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

Примечание

Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: 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 строка		Варианты: ratio sequential	Указывает метод, используемый при выборе узла из предоставленного списка `peers`.
peers список / элементы=строка			Указывает список объектов ltm messagerouting-peer. Указанный узел должен находиться в том же разделе, что и маршрут.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика авторизации для получения токенов аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `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 строка	Варианты: rest ←	Настраивает транспортное соединение, используемое при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
src_address строка			Указывает исходный адрес маршрута. Установление атрибута в пустую строку создаст подстановочный символ, соответствующий всем адресам источника сообщений, что является значением по умолчанию при создании нового маршрута.
state строка		Варианты: present ← absent	Когда `present`, гарантирует существование маршрута. Когда `absent`, гарантирует удаление маршрута.
type строка		Варианты: 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 строка	changed	Пользовательское описание маршрута. Пример: Некоторое описание
dst_address строка	changed	Адрес назначения маршрута. Пример: blackhole
peer_selection_mode строка	changed	Метод выбора узла. Пример: ratio
peers список / элементы=строка	changed	Список объектов ltm messagerouting-peer. Пример: ['/Common/peer1', '/Common/peer2']
src_address строка	changed	Исходный адрес маршрута. Пример: annyoing_user

Авторы

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_route_module.html