f5networks.f5_modules.bigip_tunnel модуль — Управление туннелями на BIG-IP

Примечание

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

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

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

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

Новое в f5networks.f5_modules 1.0.0

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

Описание

Управляет туннелями на BIG-IP. Туннели обычно основаны на профиле туннеля, который определяет как значения по умолчанию, так и ограничения для туннеля.
Из-за этого модуль предоставляет ряд настроек, которые могут или не могут быть связаны с типом туннеля, с которым вы работаете. Важно учитывать это при объявлении конфигурации туннеля.
Если конкретный туннель не поддерживает параметр, который вы рассматриваете, в документации к параметру обычно об этом упоминается. В противном случае при настройке этого параметра на устройстве устройство уведомит вас.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
auto_last_hop строка	Позволяет настроить авто-последний хоп для каждого туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `default`. Если `default`, система использует глобальное значение авто-последнего хопа для отправки запроса обратно. Если `enabled`, система отправляет ответный трафик по MAC-адресу, который отправил запрос, даже если маршрутная таблица указывает на другую сеть или интерфейс. В результате система может отправлять ответный трафик клиентам, даже если соответствующий маршрут отсутствует. Варианты: `"default"` `"enabled"` `"disabled"`
description строка	Описание туннеля.
key целое число	Применительно к туннелю GRE это значение определяет необязательное поле в заголовке GRE, используемое для аутентификации источника пакета. Применительно к туннелю VXLAN или Geneve это значение определяет идентификатор виртуальной сети (VNI). Применительно к туннелю NVGRE это значение определяет идентификатор виртуальной подсети (VSID). При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `0`.
local_address строка	Указывает IP-адрес локальной точки туннеля.
mode строка	Определяет, как туннель переносит трафик. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `bidirectional`. Если `bidirectional`, указывает, что туннель переносит входящий и исходящий трафик. Если `inbound`, указывает, что туннель переносит только входящий трафик. Если `outbound`, указывает, что туннель переносит только исходящий трафик. Варианты: `"bidirectional"` `"inbound"` `"outbound"`
mtu целое число	Указывает максимальный размер транспортной единицы (MTU) туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `0`. Допустимый диапазон значений от `0` до `65515`.
name строка / обязательный	Указывает имя туннеля.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
profile строка	Указывает профиль, который необходимо привязать к туннелю для обработки трафика. В зависимости от выбора, другие настройки становятся доступными или исчезают. Этот параметр нельзя изменить после его установки.
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` ← (по умолчанию)
remote_address строка	Указывает IP-адрес удаленного конечного узла туннеля. Для `dslite`, `fec` (при конфигурации туннеля FEC для приема трафика только), `v6rd` (настроен как ретранслятор границы), или `map`, туннель должен иметь неопределенный удаленный адрес (любой).
secondary_address строка	Указывает неплавающий IP-адрес для туннеля, который будет использоваться с трафиком, инициированным узлом.
state строка	Когда `present`, гарантирует, что туннель существует. Когда `absent`, гарантирует удаление туннеля. Варианты: `"present"` ← (по умолчанию) `"absent"`
tos строка	Указывает значение Type of Service (TOS), которое нужно вставить в заголовок инкапсулированных передаваемых пакетов. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, значение по умолчанию — `preserve`. Когда `preserve`, система копирует значение TOS из внутреннего заголовка во внешний заголовок. Вы также можете указать числовое значение. Возможные значения — от `0` до `255`.
traffic_group строка	Указывает группу трафика для ассоциации с туннелем. Это значение нельзя изменить после установки. Это ограничение BIG-IP.
transparent булево	Указывает, что туннель работает в прозрачном режиме. Когда `true`, можно инспектировать и манипулировать инкапсулированным трафиком, проходящим через систему BIG-IP. Прозрачный туннель завершает туннель, создавая иллюзию, что туннель проходит через устройство без изменений (то есть система BIG-IP выглядит как промежуточный маршрутизатор, который просто направляет IP-трафик через устройство). Варианты: `false` `true`
use_pmtu булево	Включает или отключает использование туннелем информации PMTU (Path MTU), предоставляемой сообщениями об ошибках ICMP NeedFrag. Если `true` и туннель `mtu` установлен в `0`, туннель будет использовать информацию PMTU. Если `true` и туннель `mtu` закреплен за ненулевым значением, туннель будет использовать минимум PMTU и MTU. Если `false`, туннель будет использовать фиксированную MTU или вычислять свою MTU, используя настройки инкапсуляции туннеля. Варианты: `false` `true`

Примечания

Примечание

Дополнительную информацию об использовании 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: true
    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 булево	Новое значение param1 ресурса. Возвращается: changed Пример: `true`
param2 строка	Новое значение param2 ресурса. Возвращается: changed Пример: `"Foo is bar"`

Авторы

Tim Rupp (@caphrim007)

Ссылки на сборку

© 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_tunnel_module.html