f5networks.f5_modules.bigip_tunnel – Управление туннелями на BIG-IP
Примечание
Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.7.1).
Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в playbook укажите: f5networks.f5_modules.bigip_tunnel.
Новое в версии 1.0.0: of f5networks.f5_modules
Обзор
- Управляет туннелями на BIG-IP. Туннели обычно основаны на профиле туннеля, который определяет как значения по умолчанию, так и ограничения для туннеля.
- По этой причине этот модуль предоставляет ряд настроек, которые могут или не могут относиться к типу туннеля, с которым вы работаете. Важно учитывать это при объявлении конфигурации туннеля.
- Если конкретный туннель не поддерживает параметр, который вы рассматриваете, в документации к параметру обычно будет об этом упоминаться. В противном случае, при конфигурировании этого параметра на устройстве, устройство уведомит вас об этом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auto_last_hop строка |
| Позволяет настроить авто-последний хоп на основе каждого туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию равно default. Если default, означает, что система использует глобальную настройку авто-последнего хопа для отправки запроса обратно.Если enabled, позволяет системе отправлять трафик возврата на MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. В результате система может отправлять трафик возврата клиентам даже при отсутствии соответствующего маршрута. | |
| description строка | Описание туннеля. | ||
| key целое число | Применительно к туннелю GRE это значение задает необязательное поле в заголовке GRE, используемое для проверки подлинности источника пакета. Применительно к туннелям VXLAN или Geneve это значение задает идентификатор виртуальной сети (VNI). Применительно к туннелю NVGRE это значение задаёт идентификатор виртуальной подсети (VSID). При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию равно 0. | ||
| local_address строка | Указывает IP-адрес локальной точки туннеля. | ||
| mode строка |
| Указывает, как туннель переносит трафик. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию равно bidirectional.При значении bidirectional, указывает, что туннель переносит входящий и исходящий трафик.При значении inbound, указывает, что туннель переносит только входящий трафик.При значении outbound, указывает, что туннель переносит только исходящий трафик. | |
| mtu целое число | Указывает максимальный размер пакета (MTU) туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию равно 0.Допустимый диапазон от 0 до 65515. | ||
| name строка / обязательно | Указывает имя туннеля. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| profile строка | Указывает профиль, который необходимо связать с туннелем для обработки трафика. В зависимости от вашего выбора, другие настройки становятся доступными или исчезают. Этот параметр нельзя изменить после его установки. | ||
| 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. | |
| remote_address строка | Указывает IP-адрес удалённой точки туннеля. Для dslite, fec (при конфигурации туннеля FEC для получения только трафика), v6rd (настроенного как ретранслятор границы) или map, туннель должен иметь неуказанный удалённый адрес (любой). | ||
| secondary_address строка | Указывает не-плавающий IP-адрес для туннеля, который будет использоваться с инициативным трафиком хоста. | ||
| state строка |
| Если present, гарантирует, что туннель существует.Если absent, гарантирует удаление туннеля. | |
| tos строка | Указывает значение Type of Service (TOS), которое необходимо вставить в заголовок оборачивающего пакета передаваемых пакетов. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию равно preserve.Если preserve, система копирует значение TOS из внутреннего заголовка во внешний заголовок.Вы также можете указать числовое значение. Возможные значения от 0 до 255. | ||
| traffic_group строка | Указывает группу трафика, которую необходимо связать с туннелем. Это значение не может быть изменено после установки. Это ограничение BIG-IP. | ||
| transparent булево |
| Указывает, что туннель работает в прозрачном режиме. Когда yes, вы можете просматривать и изменять трафик, зашифрованный в системе BIG-IP.Прозрачный туннель завершает туннель, создавая иллюзию, что туннель проходит через устройство без изменений (то есть система BIG-IP выглядит как промежуточный маршрутизатор, который просто маршрутизирует IP-трафик через устройство). | |
| use_pmtu булево |
| Включает или отключает использование туннелем информации PMTU (Path MTU), предоставляемой сообщениями об ошибке ICMP NeedFrag. Если yes и туннель mtu установлен в 0, туннель будет использовать информацию PMTU.Если yes и туннель mtu фиксирован на ненулевое значение, туннель будет использовать минимум PMTU и MTU.Если no, туннель будет использовать фиксированный MTU или рассчитать его MTU, используя конфигурации инкапсуляции туннеля. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 VXLAN tunnel
bigip_tunnel:
name: openshift-tunnel
local_address: 192.1681.240
key: 0
secondary_address: 192.168.1.100
mtu: 0
use_pmtu: yes
tos: preserve
auto_last_hop: default
traffic_group: traffic-group-1
state: present
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| param1 boolean | changed | Новое значение параметра param1 ресурса. Пример: True |
| param2 string | changed | Новое значение параметра param2 ресурса. Пример: Foo is bar |
Авторы
- Tim Rupp (@caphrim007)
© 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_tunnel_module.html