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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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. Туннели обычно основаны на профиле туннеля, в котором определяются аргументы по умолчанию и ограничения для туннеля.
Поэтому этот модуль предоставляет ряд параметров, которые могут относиться или не относиться к используемому типу туннеля. При объявлении конфигурации туннеля важно это учитывать.
Если конкретный туннель не поддерживает рассматриваемый параметр, это обычно указано в документации к параметру. В противном случае устройство уведомит вас об этом при настройке параметра.

Параметры

Параметр	Комментарии
auto_last_hop string	Позволяет настраивать auto last hop отдельно для каждого туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, используется значение по умолчанию `default`. Если задано `default`, система использует глобальную настройку auto-lasthop для отправки ответа на запрос. Если задано `enabled`, система может отправлять ответный трафик на MAC-адрес, с которого был передан запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. Таким образом, система может отправлять ответный трафик клиентам, даже если соответствующий маршрут отсутствует. Варианты: `"default"` `"enabled"` `"disabled"`
description string	Описание туннеля.
key integer	При применении к туннелю GRE это значение задает необязательное поле заголовка GRE, используемое для проверки подлинности источника пакета. При применении к туннелю VXLAN или Geneve это значение задает идентификатор виртуальной сети (VNI). При применении к туннелю NVGRE это значение задает идентификатор виртуальной подсети (VSID). При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, используется значение по умолчанию `0`.
local_address string	Задает IP-адрес локальной конечной точки туннеля.
mode string	Задает способ передачи трафика через туннель. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, используется значение по умолчанию `bidirectional`. Если задано `bidirectional`, туннель передает входящий и исходящий трафик. Если задано `inbound`, туннель передает только входящий трафик. Если задано `outbound`, туннель передает только исходящий трафик. Варианты: `"bidirectional"` `"inbound"` `"outbound"`
mtu integer	Задает максимальный размер передаваемого блока данных (MTU) туннеля. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, используется значение по умолчанию `0`. Допустимый диапазон: от `0` до `65515`.
name string / обязательный	Задает имя туннеля.
partition string	Раздел устройства, в котором необходимо управлять ресурсами. По умолчанию: `"Common"`
profile string	Задает профиль, связанный с туннелем для обработки трафика. В зависимости от выбранного профиля другие параметры могут появляться или становиться недоступными. После установки это значение нельзя изменить.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict со сведениями о подключении.
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` ← (по умолчанию)
remote_address string	Задает IP-адрес удаленной конечной точки туннеля. Для `dslite`, `fec` (при настройке туннеля FEC только для приема трафика), `v6rd` (настроенного как пограничный ретранслятор) или `map` удаленный адрес туннеля должен быть неопределенным (любой).
secondary_address string	Задает для туннеля не плавающий IP-адрес, используемый для трафика, инициированного узлом.
state string	Если задано `present`, обеспечивает наличие туннеля. Если задано `absent`, обеспечивает удаление туннеля. Варианты: `"present"` ← (по умолчанию) `"absent"`
tos string	Задает значение типа обслуживания (TOS), которое вставляется в инкапсулирующий заголовок передаваемых пакетов. При создании нового туннеля, если этот параметр поддерживается профилем туннеля, но не указан, используется значение по умолчанию `preserve`. Если задано `preserve`, система копирует значение TOS из внутреннего заголовка во внешний. Также можно указать числовое значение. Допустимые значения — от `0` до `255`.
traffic_group string	Задает группу трафика, связанную с туннелем. После установки это значение нельзя изменить. Это ограничение BIG-IP.
transparent boolean	Указывает, что туннель работает в прозрачном режиме. Если задано `true`, можно проверять и изменять инкапсулированный трафик, проходящий через систему BIG-IP. Прозрачный туннель завершает туннель, создавая иллюзию, что туннель проходит через устройство без изменений (то есть система BIG-IP выглядит как промежуточный маршрутизатор, который просто маршрутизирует IP-трафик через устройство). Варианты: `false` `true`
use_pmtu boolean	Включает или отключает использование туннелем информации 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 boolean	Новое значение param1 ресурса. Возвращается: changed Пример: `true`
param2 string	Новое значение param2 ресурса. Возвращается: changed Пример: `"Foo is bar"`

Авторы

Tim Rupp (@caphrim007)

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

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